@wildix/wim-tools-client 4.0.2 → 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.
Files changed (65) hide show
  1. package/dist-cjs/Tools.js +25 -1
  2. package/dist-cjs/commands/CreateConnectorCommand.js +20 -0
  3. package/dist-cjs/commands/DeleteConnectorCommand.js +20 -0
  4. package/dist-cjs/commands/ExecuteConnectorCommand.js +20 -0
  5. package/dist-cjs/commands/GetConnectorCommand.js +20 -0
  6. package/dist-cjs/commands/GetConnectorDefinitionCommand.js +20 -0
  7. package/dist-cjs/commands/ListConnectorDefinitionsCommand.js +20 -0
  8. package/dist-cjs/commands/ListConnectorsCommand.js +20 -0
  9. package/dist-cjs/commands/ResolveConnectorConfigurationCommand.js +20 -0
  10. package/dist-cjs/commands/UpdateConnectorCommand.js +20 -0
  11. package/dist-cjs/commands/index.js +9 -0
  12. package/dist-cjs/index.js +1 -0
  13. package/dist-cjs/models/enums.js +18 -7
  14. package/dist-cjs/pagination/Interfaces.js +2 -0
  15. package/dist-cjs/pagination/ListConnectorDefinitionsPaginator.js +7 -0
  16. package/dist-cjs/pagination/ListConnectorsPaginator.js +7 -0
  17. package/dist-cjs/pagination/index.js +6 -0
  18. package/dist-cjs/schemas/schemas_0.js +340 -57
  19. package/dist-es/Tools.js +25 -1
  20. package/dist-es/commands/CreateConnectorCommand.js +16 -0
  21. package/dist-es/commands/DeleteConnectorCommand.js +16 -0
  22. package/dist-es/commands/ExecuteConnectorCommand.js +16 -0
  23. package/dist-es/commands/GetConnectorCommand.js +16 -0
  24. package/dist-es/commands/GetConnectorDefinitionCommand.js +16 -0
  25. package/dist-es/commands/ListConnectorDefinitionsCommand.js +16 -0
  26. package/dist-es/commands/ListConnectorsCommand.js +16 -0
  27. package/dist-es/commands/ResolveConnectorConfigurationCommand.js +16 -0
  28. package/dist-es/commands/UpdateConnectorCommand.js +16 -0
  29. package/dist-es/commands/index.js +9 -0
  30. package/dist-es/index.js +1 -0
  31. package/dist-es/models/enums.js +17 -6
  32. package/dist-es/pagination/Interfaces.js +1 -0
  33. package/dist-es/pagination/ListConnectorDefinitionsPaginator.js +4 -0
  34. package/dist-es/pagination/ListConnectorsPaginator.js +4 -0
  35. package/dist-es/pagination/index.js +3 -0
  36. package/dist-es/schemas/schemas_0.js +338 -55
  37. package/dist-types/Tools.d.ts +80 -1
  38. package/dist-types/ToolsClient.d.ts +11 -2
  39. package/dist-types/commands/CreateConnectorCommand.d.ts +123 -0
  40. package/dist-types/commands/CreateToolCommand.d.ts +42 -0
  41. package/dist-types/commands/DeleteConnectorCommand.d.ts +87 -0
  42. package/dist-types/commands/DescribeToolsCommand.d.ts +4 -0
  43. package/dist-types/commands/ExecuteConnectorCommand.d.ts +96 -0
  44. package/dist-types/commands/GetConnectorCommand.d.ts +108 -0
  45. package/dist-types/commands/GetConnectorDefinitionCommand.d.ts +152 -0
  46. package/dist-types/commands/GetToolCommand.d.ts +21 -0
  47. package/dist-types/commands/ListConnectorDefinitionsCommand.d.ts +156 -0
  48. package/dist-types/commands/ListConnectorsCommand.d.ts +112 -0
  49. package/dist-types/commands/ListToolsCommand.d.ts +21 -0
  50. package/dist-types/commands/ResolveConnectorConfigurationCommand.d.ts +102 -0
  51. package/dist-types/commands/UpdateConnectorCommand.d.ts +124 -0
  52. package/dist-types/commands/UpdateToolCommand.d.ts +42 -0
  53. package/dist-types/commands/index.d.ts +9 -0
  54. package/dist-types/index.d.ts +1 -0
  55. package/dist-types/models/enums.d.ts +40 -7
  56. package/dist-types/models/models_0.d.ts +816 -50
  57. package/dist-types/pagination/Interfaces.d.ts +8 -0
  58. package/dist-types/pagination/ListConnectorDefinitionsPaginator.d.ts +7 -0
  59. package/dist-types/pagination/ListConnectorsPaginator.d.ts +7 -0
  60. package/dist-types/pagination/index.d.ts +3 -0
  61. package/dist-types/runtimeConfig.browser.d.ts +1 -0
  62. package/dist-types/runtimeConfig.d.ts +1 -0
  63. package/dist-types/runtimeConfig.native.d.ts +1 -0
  64. package/dist-types/schemas/schemas_0.d.ts +41 -0
  65. package/package.json +1 -1
@@ -1,5 +1,442 @@
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 ToolCalendarConfig {
434
+ /**
435
+ * 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.
436
+ * @public
437
+ */
438
+ operation: ToolCalendarOperation;
439
+ }
3
440
  /**
4
441
  * @public
5
442
  */
@@ -74,6 +511,36 @@ export interface ToolChatHandler {
74
511
  */
75
512
  config: ToolChatConfig;
76
513
  }
514
+ /**
515
+ * Handler for a connector-backed Tool created through `CreateTool`.
516
+ *
517
+ * The service resolves agent arguments from the pinned connector tool definition.
518
+ * Create and update requests omit `input` when this handler is used.
519
+ * @public
520
+ */
521
+ export interface ToolConnectorHandler {
522
+ /**
523
+ * Immutable definition used to validate configuration and execute tools.
524
+ * @public
525
+ */
526
+ definition: ConnectorDefinitionRef;
527
+ /**
528
+ * Values validated against the definition configuration schema.
529
+ * @public
530
+ */
531
+ configuration: __DocumentType;
532
+ /**
533
+ * Credential selection, omitted when no authorization is required. The same Nango
534
+ * connection reference may be reused across multiple Tools and Connectors.
535
+ * @public
536
+ */
537
+ authorization?: ConnectorAuthorization | undefined;
538
+ /**
539
+ * Connector tool from the pinned definition executed by this Tool.
540
+ * @public
541
+ */
542
+ toolId: string;
543
+ }
77
544
  /**
78
545
  * @public
79
546
  */
@@ -504,7 +971,7 @@ export interface ToolWebhookConfig {
504
971
  /**
505
972
  * @public
506
973
  */
507
- export type ToolHandler = ToolHandler.ChatMember | ToolHandler.EmailMember | ToolHandler.McpMember | ToolHandler.McpToolMember | ToolHandler.SearchMember | ToolHandler.SmsMember | ToolHandler.WebhookMember | ToolHandler.$UnknownMember;
974
+ export type ToolHandler = ToolHandler.CalendarMember | ToolHandler.ChatMember | ToolHandler.ConnectorMember | ToolHandler.EmailMember | ToolHandler.McpMember | ToolHandler.McpToolMember | ToolHandler.SearchMember | ToolHandler.SmsMember | ToolHandler.WebhookMember | ToolHandler.$UnknownMember;
508
975
  /**
509
976
  * @public
510
977
  */
@@ -515,6 +982,8 @@ export declare namespace ToolHandler {
515
982
  search?: never;
516
983
  chat?: never;
517
984
  sms?: never;
985
+ calendar?: never;
986
+ connector?: never;
518
987
  mcp?: never;
519
988
  mcpTool?: never;
520
989
  $unknown?: never;
@@ -525,6 +994,8 @@ export declare namespace ToolHandler {
525
994
  search?: never;
526
995
  chat?: never;
527
996
  sms?: never;
997
+ calendar?: never;
998
+ connector?: never;
528
999
  mcp?: never;
529
1000
  mcpTool?: never;
530
1001
  $unknown?: never;
@@ -539,6 +1010,8 @@ export declare namespace ToolHandler {
539
1010
  search: ToolSearchConfig;
540
1011
  chat?: never;
541
1012
  sms?: never;
1013
+ calendar?: never;
1014
+ connector?: never;
542
1015
  mcp?: never;
543
1016
  mcpTool?: never;
544
1017
  $unknown?: never;
@@ -549,6 +1022,8 @@ export declare namespace ToolHandler {
549
1022
  search?: never;
550
1023
  chat: ToolChatHandler;
551
1024
  sms?: never;
1025
+ calendar?: never;
1026
+ connector?: never;
552
1027
  mcp?: never;
553
1028
  mcpTool?: never;
554
1029
  $unknown?: never;
@@ -558,7 +1033,37 @@ export declare namespace ToolHandler {
558
1033
  webhook?: never;
559
1034
  search?: never;
560
1035
  chat?: never;
561
- sms: ToolSmsHandler;
1036
+ sms: ToolSmsHandler;
1037
+ calendar?: never;
1038
+ connector?: never;
1039
+ mcp?: never;
1040
+ mcpTool?: never;
1041
+ $unknown?: never;
1042
+ }
1043
+ interface CalendarMember {
1044
+ email?: never;
1045
+ webhook?: never;
1046
+ search?: never;
1047
+ chat?: never;
1048
+ sms?: never;
1049
+ calendar: ToolCalendarConfig;
1050
+ connector?: never;
1051
+ mcp?: never;
1052
+ mcpTool?: never;
1053
+ $unknown?: never;
1054
+ }
1055
+ /**
1056
+ * Connector-backed Tool. Create with `CreateTool` using `handler.connector`. Authorization may reuse the same Nango connection as a Connector.
1057
+ * @public
1058
+ */
1059
+ interface ConnectorMember {
1060
+ email?: never;
1061
+ webhook?: never;
1062
+ search?: never;
1063
+ chat?: never;
1064
+ sms?: never;
1065
+ calendar?: never;
1066
+ connector: ToolConnectorHandler;
562
1067
  mcp?: never;
563
1068
  mcpTool?: never;
564
1069
  $unknown?: never;
@@ -569,6 +1074,8 @@ export declare namespace ToolHandler {
569
1074
  search?: never;
570
1075
  chat?: never;
571
1076
  sms?: never;
1077
+ calendar?: never;
1078
+ connector?: never;
572
1079
  mcp: ToolMcpHandler;
573
1080
  mcpTool?: never;
574
1081
  $unknown?: never;
@@ -579,6 +1086,8 @@ export declare namespace ToolHandler {
579
1086
  search?: never;
580
1087
  chat?: never;
581
1088
  sms?: never;
1089
+ calendar?: never;
1090
+ connector?: never;
582
1091
  mcp?: never;
583
1092
  mcpTool: ToolMcpToolHandler;
584
1093
  $unknown?: never;
@@ -592,6 +1101,8 @@ export declare namespace ToolHandler {
592
1101
  search?: never;
593
1102
  chat?: never;
594
1103
  sms?: never;
1104
+ calendar?: never;
1105
+ connector?: never;
595
1106
  mcp?: never;
596
1107
  mcpTool?: never;
597
1108
  $unknown: [string, any];
@@ -606,51 +1117,13 @@ export declare namespace ToolHandler {
606
1117
  search: (value: ToolSearchConfig) => T;
607
1118
  chat: (value: ToolChatHandler) => T;
608
1119
  sms: (value: ToolSmsHandler) => T;
1120
+ calendar: (value: ToolCalendarConfig) => T;
1121
+ connector: (value: ToolConnectorHandler) => T;
609
1122
  mcp: (value: ToolMcpHandler) => T;
610
1123
  mcpTool: (value: ToolMcpToolHandler) => T;
611
1124
  _: (name: string, value: any) => T;
612
1125
  }
613
1126
  }
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
1127
  /**
655
1128
  * @public
656
1129
  */
@@ -676,10 +1149,10 @@ export interface CreateToolInput {
676
1149
  */
677
1150
  description: string;
678
1151
  /**
679
- * Input of the tool, used to pass data to the tool.
1152
+ * Agent arguments. Omit when handler.connector is set; the service resolves input from the pinned connector tool definition.
680
1153
  * @public
681
1154
  */
682
- input: ToolInput;
1155
+ input?: ToolInput | undefined;
683
1156
  /**
684
1157
  * Handler of the tool, used to execute the tool.
685
1158
  * @public
@@ -716,10 +1189,10 @@ export interface Tool {
716
1189
  */
717
1190
  description: string;
718
1191
  /**
719
- * Input of the tool, used to pass data to the tool
1192
+ * Agent arguments. Required for built-in handlers. Omit when handler.connector is set; the service resolves input from the pinned connector tool definition.
720
1193
  * @public
721
1194
  */
722
- input: ToolInput;
1195
+ input?: ToolInput | undefined;
723
1196
  /**
724
1197
  * Handler of the tool, used to execute the tool
725
1198
  * @public
@@ -732,6 +1205,26 @@ export interface Tool {
732
1205
  export interface CreateToolOutput {
733
1206
  tool: Tool;
734
1207
  }
1208
+ /**
1209
+ * @public
1210
+ */
1211
+ export interface DeleteConnectorInput {
1212
+ /**
1213
+ * The unique identifier of the tenant when a service token is used.
1214
+ * @public
1215
+ */
1216
+ companyId?: string | undefined;
1217
+ /**
1218
+ * Connector instance identifier.
1219
+ * @public
1220
+ */
1221
+ connectorId: string;
1222
+ }
1223
+ /**
1224
+ * @public
1225
+ */
1226
+ export interface DeleteConnectorOutput {
1227
+ }
735
1228
  /**
736
1229
  * @public
737
1230
  */
@@ -787,7 +1280,7 @@ export interface ToolDescription {
787
1280
  */
788
1281
  description: string;
789
1282
  /**
790
- * List of tool variables, used to pass data to the tool
1283
+ * List of tool variables.
791
1284
  * @public
792
1285
  */
793
1286
  variables: ToolVariable[];
@@ -852,6 +1345,47 @@ export interface DiscoverToolsOutput {
852
1345
  */
853
1346
  tools: DiscoveredTool[];
854
1347
  }
1348
+ /**
1349
+ * @public
1350
+ */
1351
+ export interface ExecuteConnectorInput {
1352
+ /**
1353
+ * The unique identifier of the tenant when a service token is used.
1354
+ * @public
1355
+ */
1356
+ companyId?: string | undefined;
1357
+ /**
1358
+ * Connector instance identifier.
1359
+ * @public
1360
+ */
1361
+ connectorId: string;
1362
+ /**
1363
+ * Invocation payload from the model or agent. For multi-tool connectors this
1364
+ * is typically an object with exactly one connector tool id key and argument object.
1365
+ * @public
1366
+ */
1367
+ input: __DocumentType;
1368
+ /**
1369
+ * Service executing the connector, such as `chatbots` or `voicebots`.
1370
+ * @public
1371
+ */
1372
+ service?: string | undefined;
1373
+ /**
1374
+ * User identity required by user-authorized connectors.
1375
+ * @public
1376
+ */
1377
+ user?: string | undefined;
1378
+ }
1379
+ /**
1380
+ * @public
1381
+ */
1382
+ export interface ExecuteConnectorOutput {
1383
+ /**
1384
+ * Structured tool result and execution metadata.
1385
+ * @public
1386
+ */
1387
+ result: ConnectorExecutionResult;
1388
+ }
855
1389
  /**
856
1390
  * @public
857
1391
  */
@@ -902,6 +1436,61 @@ export interface ExecuteToolOutput {
902
1436
  */
903
1437
  result: ToolExecutionResult;
904
1438
  }
1439
+ /**
1440
+ * @public
1441
+ */
1442
+ export interface GetConnectorInput {
1443
+ /**
1444
+ * The unique identifier of the tenant when a service token is used.
1445
+ * @public
1446
+ */
1447
+ companyId?: string | undefined;
1448
+ /**
1449
+ * Connector instance identifier.
1450
+ * @public
1451
+ */
1452
+ connectorId: string;
1453
+ }
1454
+ /**
1455
+ * @public
1456
+ */
1457
+ export interface GetConnectorOutput {
1458
+ /**
1459
+ * Requested connector.
1460
+ * @public
1461
+ */
1462
+ connector: Connector;
1463
+ }
1464
+ /**
1465
+ * @public
1466
+ */
1467
+ export interface GetConnectorDefinitionInput {
1468
+ /**
1469
+ * The unique identifier of the tenant when a service token is used.
1470
+ * @public
1471
+ */
1472
+ companyId?: string | undefined;
1473
+ /**
1474
+ * Stable connector definition key.
1475
+ * @public
1476
+ */
1477
+ key: string;
1478
+ /**
1479
+ * Exact immutable definition version.
1480
+ * @public
1481
+ */
1482
+ version: string;
1483
+ }
1484
+ /**
1485
+ * @public
1486
+ */
1487
+ export interface GetConnectorDefinitionOutput {
1488
+ /**
1489
+ * Requested connector definition.
1490
+ * @public
1491
+ */
1492
+ definition: ConnectorDefinition;
1493
+ }
905
1494
  /**
906
1495
  * @public
907
1496
  */
@@ -927,6 +1516,81 @@ export interface GetToolOutput {
927
1516
  */
928
1517
  tool: Tool;
929
1518
  }
1519
+ /**
1520
+ * @public
1521
+ */
1522
+ export interface ListConnectorDefinitionsInput {
1523
+ /**
1524
+ * The unique identifier of the tenant when a service token is used.
1525
+ * @public
1526
+ */
1527
+ companyId?: string | undefined;
1528
+ /**
1529
+ * Case-insensitive filter applied to connector titles, keys, and descriptions.
1530
+ * @public
1531
+ */
1532
+ query?: string | undefined;
1533
+ /**
1534
+ * Maximum number of definitions to return.
1535
+ * @public
1536
+ */
1537
+ pageSize?: number | undefined;
1538
+ /**
1539
+ * Token returned by the previous request.
1540
+ * @public
1541
+ */
1542
+ nextToken?: string | undefined;
1543
+ }
1544
+ /**
1545
+ * @public
1546
+ */
1547
+ export interface ListConnectorDefinitionsOutput {
1548
+ /**
1549
+ * Connector definitions in the current page.
1550
+ * @public
1551
+ */
1552
+ definitions: ConnectorDefinition[];
1553
+ /**
1554
+ * Token for the next page, omitted when no more results exist.
1555
+ * @public
1556
+ */
1557
+ nextToken?: string | undefined;
1558
+ }
1559
+ /**
1560
+ * @public
1561
+ */
1562
+ export interface ListConnectorsInput {
1563
+ /**
1564
+ * The unique identifier of the tenant when a service token is used.
1565
+ * @public
1566
+ */
1567
+ companyId?: string | undefined;
1568
+ /**
1569
+ * Maximum number of connectors to return.
1570
+ * @public
1571
+ */
1572
+ pageSize?: number | undefined;
1573
+ /**
1574
+ * Token returned by the previous request.
1575
+ * @public
1576
+ */
1577
+ nextToken?: string | undefined;
1578
+ }
1579
+ /**
1580
+ * @public
1581
+ */
1582
+ export interface ListConnectorsOutput {
1583
+ /**
1584
+ * Connectors in the current page.
1585
+ * @public
1586
+ */
1587
+ connectors: Connector[];
1588
+ /**
1589
+ * Token for the next page, omitted when no more results exist.
1590
+ * @public
1591
+ */
1592
+ nextToken?: string | undefined;
1593
+ }
930
1594
  /**
931
1595
  * @public
932
1596
  */
@@ -947,6 +1611,108 @@ export interface ListToolsOutput {
947
1611
  */
948
1612
  tools: Tool[];
949
1613
  }
1614
+ /**
1615
+ * @public
1616
+ */
1617
+ export interface ResolveConnectorConfigurationInput {
1618
+ /**
1619
+ * The unique identifier of the tenant when a service token is used.
1620
+ * @public
1621
+ */
1622
+ companyId?: string | undefined;
1623
+ /**
1624
+ * Stable connector definition key.
1625
+ * @public
1626
+ */
1627
+ key: string;
1628
+ /**
1629
+ * Exact immutable definition version.
1630
+ * @public
1631
+ */
1632
+ version: string;
1633
+ /**
1634
+ * Current partial form values.
1635
+ * @public
1636
+ */
1637
+ values: __DocumentType;
1638
+ /**
1639
+ * Credentials used to resolve account-dependent options.
1640
+ * @public
1641
+ */
1642
+ authorization?: ConnectorAuthorization | undefined;
1643
+ /**
1644
+ * Executing user when user authorization is selected.
1645
+ * @public
1646
+ */
1647
+ user?: string | undefined;
1648
+ }
1649
+ /**
1650
+ * @public
1651
+ */
1652
+ export interface ResolveConnectorConfigurationOutput {
1653
+ /**
1654
+ * Configuration contract resolved for the current values and account.
1655
+ * @public
1656
+ */
1657
+ configuration: ConnectorConfigurationDefinition;
1658
+ }
1659
+ /**
1660
+ * Fields supplied when a connector is created or replaced.
1661
+ * @public
1662
+ */
1663
+ export interface UpdateConnectorInput {
1664
+ /**
1665
+ * Immutable definition used to validate configuration and execute tools.
1666
+ * @public
1667
+ */
1668
+ definition: ConnectorDefinitionRef;
1669
+ /**
1670
+ * Values validated against the definition configuration schema.
1671
+ * @public
1672
+ */
1673
+ configuration: __DocumentType;
1674
+ /**
1675
+ * Credential selection, omitted when no authorization is required. The same Nango
1676
+ * connection reference may be reused across multiple Tools and Connectors.
1677
+ * @public
1678
+ */
1679
+ authorization?: ConnectorAuthorization | undefined;
1680
+ /**
1681
+ * Name exposed to administrators and AI agents.
1682
+ * @public
1683
+ */
1684
+ name: string;
1685
+ /**
1686
+ * Description exposed to administrators and AI agents.
1687
+ * @public
1688
+ */
1689
+ description: string;
1690
+ /**
1691
+ * Explicit allowlist of tools available to callers and agents.
1692
+ * @public
1693
+ */
1694
+ enabledTools: string[];
1695
+ /**
1696
+ * The unique identifier of the tenant when a service token is used.
1697
+ * @public
1698
+ */
1699
+ companyId?: string | undefined;
1700
+ /**
1701
+ * Connector instance identifier.
1702
+ * @public
1703
+ */
1704
+ connectorId: string;
1705
+ }
1706
+ /**
1707
+ * @public
1708
+ */
1709
+ export interface UpdateConnectorOutput {
1710
+ /**
1711
+ * Updated connector.
1712
+ * @public
1713
+ */
1714
+ connector: Connector;
1715
+ }
950
1716
  /**
951
1717
  * @public
952
1718
  */
@@ -977,10 +1743,10 @@ export interface UpdateToolInput {
977
1743
  */
978
1744
  description: string;
979
1745
  /**
980
- * Input of the tool, used to pass data to the tool.
1746
+ * Agent arguments. Omit when handler.connector is set; the service resolves input from the pinned connector tool definition.
981
1747
  * @public
982
1748
  */
983
- input: ToolInput;
1749
+ input?: ToolInput | undefined;
984
1750
  /**
985
1751
  * Handler of the tool, used to execute the tool.
986
1752
  * @public