@composio/client 0.1.0-alpha.61 → 0.1.0-alpha.63
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/CHANGELOG.md +53 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/package.json +12 -1
- package/resources/auth-configs.d.mts +17 -0
- package/resources/auth-configs.d.mts.map +1 -1
- package/resources/auth-configs.d.ts +17 -0
- package/resources/auth-configs.d.ts.map +1 -1
- package/resources/connected-accounts.d.mts +981 -137
- package/resources/connected-accounts.d.mts.map +1 -1
- package/resources/connected-accounts.d.ts +981 -137
- package/resources/connected-accounts.d.ts.map +1 -1
- package/resources/connected-accounts.js +27 -4
- package/resources/connected-accounts.js.map +1 -1
- package/resources/connected-accounts.mjs +27 -4
- package/resources/connected-accounts.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/link.d.mts +168 -1
- package/resources/link.d.mts.map +1 -1
- package/resources/link.d.ts +168 -1
- package/resources/link.d.ts.map +1 -1
- package/resources/mcp/mcp.d.mts +1 -1
- package/resources/mcp/mcp.d.ts +1 -1
- package/resources/mcp/mcp.js +1 -1
- package/resources/mcp/mcp.mjs +1 -1
- package/resources/tool-router/index.d.mts +1 -1
- package/resources/tool-router/index.d.mts.map +1 -1
- package/resources/tool-router/index.d.ts +1 -1
- package/resources/tool-router/index.d.ts.map +1 -1
- package/resources/tool-router/index.js.map +1 -1
- package/resources/tool-router/index.mjs.map +1 -1
- package/resources/tool-router/session/index.d.mts +1 -1
- package/resources/tool-router/session/index.d.mts.map +1 -1
- package/resources/tool-router/session/index.d.ts +1 -1
- package/resources/tool-router/session/index.d.ts.map +1 -1
- package/resources/tool-router/session/index.js.map +1 -1
- package/resources/tool-router/session/index.mjs.map +1 -1
- package/resources/tool-router/session/session.d.mts +879 -12
- package/resources/tool-router/session/session.d.mts.map +1 -1
- package/resources/tool-router/session/session.d.ts +879 -12
- package/resources/tool-router/session/session.d.ts.map +1 -1
- package/resources/tool-router/session/session.js +29 -1
- package/resources/tool-router/session/session.js.map +1 -1
- package/resources/tool-router/session/session.mjs +29 -1
- package/resources/tool-router/session/session.mjs.map +1 -1
- package/resources/tool-router/tool-router.d.mts +4 -4
- package/resources/tool-router/tool-router.d.mts.map +1 -1
- package/resources/tool-router/tool-router.d.ts +4 -4
- package/resources/tool-router/tool-router.d.ts.map +1 -1
- package/resources/tool-router/tool-router.js +2 -2
- package/resources/tool-router/tool-router.js.map +1 -1
- package/resources/tool-router/tool-router.mjs +2 -2
- package/resources/tool-router/tool-router.mjs.map +1 -1
- package/resources/toolkits.d.mts +13 -0
- package/resources/toolkits.d.mts.map +1 -1
- package/resources/toolkits.d.ts +13 -0
- package/resources/toolkits.d.ts.map +1 -1
- package/resources/tools.d.mts +114 -2
- package/resources/tools.d.mts.map +1 -1
- package/resources/tools.d.ts +114 -2
- package/resources/tools.d.ts.map +1 -1
- package/resources/trigger-instances/trigger-instances.d.mts +6 -1
- package/resources/trigger-instances/trigger-instances.d.mts.map +1 -1
- package/resources/trigger-instances/trigger-instances.d.ts +6 -1
- package/resources/trigger-instances/trigger-instances.d.ts.map +1 -1
- package/resources/trigger-instances/trigger-instances.js.map +1 -1
- package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
- package/src/client.ts +4 -0
- package/src/internal/utils/env.ts +2 -2
- package/src/resources/auth-configs.ts +22 -0
- package/src/resources/connected-accounts.ts +3698 -2112
- package/src/resources/index.ts +2 -0
- package/src/resources/link.ts +329 -1
- package/src/resources/mcp/mcp.ts +1 -1
- package/src/resources/tool-router/index.ts +2 -0
- package/src/resources/tool-router/session/index.ts +2 -0
- package/src/resources/tool-router/session/session.ts +1343 -48
- package/src/resources/tool-router/tool-router.ts +6 -2
- package/src/resources/toolkits.ts +16 -0
- package/src/resources/tools.ts +188 -2
- package/src/resources/trigger-instances/trigger-instances.ts +7 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -66,7 +66,7 @@ export class Session extends APIResource {
|
|
|
66
66
|
* ```ts
|
|
67
67
|
* const response = await client.toolRouter.session.execute(
|
|
68
68
|
* 'trs_LX9uJKBinWWr',
|
|
69
|
-
* { tool_slug: '
|
|
69
|
+
* { tool_slug: 'GITHUB_CREATE_AN_ISSUE' },
|
|
70
70
|
* );
|
|
71
71
|
* ```
|
|
72
72
|
*/
|
|
@@ -122,6 +122,39 @@ export class Session extends APIResource {
|
|
|
122
122
|
return this._client.post(path`/api/v3/tool_router/session/${sessionID}/link`, { body, ...options });
|
|
123
123
|
}
|
|
124
124
|
|
|
125
|
+
/**
|
|
126
|
+
* Execute any native API call on a toolkit with authentication automatically
|
|
127
|
+
* injected from Composio. This endpoint proxies HTTP requests to third-party APIs
|
|
128
|
+
* using connected account credentials resolved from the session context. Provide
|
|
129
|
+
* the toolkit slug, API endpoint, and HTTP method — Composio handles
|
|
130
|
+
* authentication injection, abstracting away credential management. Supports all
|
|
131
|
+
* HTTP methods, custom headers/query parameters, and binary request/response
|
|
132
|
+
* bodies.
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* ```ts
|
|
136
|
+
* const response =
|
|
137
|
+
* await client.toolRouter.session.proxyExecute(
|
|
138
|
+
* 'trs_LX9uJKBinWWr',
|
|
139
|
+
* {
|
|
140
|
+
* endpoint: '/api/v1/resources',
|
|
141
|
+
* method: 'GET',
|
|
142
|
+
* toolkit_slug: 'gmail',
|
|
143
|
+
* },
|
|
144
|
+
* );
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
147
|
+
proxyExecute(
|
|
148
|
+
sessionID: string,
|
|
149
|
+
body: SessionProxyExecuteParams,
|
|
150
|
+
options?: RequestOptions,
|
|
151
|
+
): APIPromise<SessionProxyExecuteResponse> {
|
|
152
|
+
return this._client.post(path`/api/v3/tool_router/session/${sessionID}/proxy_execute`, {
|
|
153
|
+
body,
|
|
154
|
+
...options,
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
|
|
125
158
|
/**
|
|
126
159
|
* Search for tools matching a given use case query within a tool router session.
|
|
127
160
|
* Returns matching tool slugs, full tool schemas, toolkit connection statuses, and
|
|
@@ -271,6 +304,11 @@ export namespace SessionCreateResponse {
|
|
|
271
304
|
*/
|
|
272
305
|
callback_url?: string;
|
|
273
306
|
|
|
307
|
+
/**
|
|
308
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
|
|
309
|
+
*/
|
|
310
|
+
enable_connection_removal?: boolean;
|
|
311
|
+
|
|
274
312
|
/**
|
|
275
313
|
* Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
|
|
276
314
|
* Default false. May not work reliably with GPT models.
|
|
@@ -344,6 +382,12 @@ export namespace SessionCreateResponse {
|
|
|
344
382
|
*/
|
|
345
383
|
auto_offload_threshold?: number;
|
|
346
384
|
|
|
385
|
+
/**
|
|
386
|
+
* Whether the workbench (code execution sandbox) is enabled. When false,
|
|
387
|
+
* COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
|
|
388
|
+
*/
|
|
389
|
+
enable?: boolean;
|
|
390
|
+
|
|
347
391
|
/**
|
|
348
392
|
* Whether proxy execution is enabled in the workbench
|
|
349
393
|
*/
|
|
@@ -369,10 +413,75 @@ export namespace SessionCreateResponse {
|
|
|
369
413
|
*/
|
|
370
414
|
export interface Experimental {
|
|
371
415
|
/**
|
|
372
|
-
* The assistive system prompt
|
|
373
|
-
|
|
416
|
+
* The assistive system prompt for the tool router session
|
|
417
|
+
*/
|
|
418
|
+
assistive_prompt?: string;
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* User-defined custom toolkits with grouped tools (no-auth)
|
|
422
|
+
*/
|
|
423
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* Custom tools — standalone or extending Composio toolkits
|
|
374
427
|
*/
|
|
375
|
-
|
|
428
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
export namespace Experimental {
|
|
432
|
+
export interface CustomToolkit {
|
|
433
|
+
description: string;
|
|
434
|
+
|
|
435
|
+
name: string;
|
|
436
|
+
|
|
437
|
+
slug: string;
|
|
438
|
+
|
|
439
|
+
tools: Array<CustomToolkit.Tool>;
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
export namespace CustomToolkit {
|
|
443
|
+
export interface Tool {
|
|
444
|
+
description: string;
|
|
445
|
+
|
|
446
|
+
input_schema: { [key: string]: unknown };
|
|
447
|
+
|
|
448
|
+
name: string;
|
|
449
|
+
|
|
450
|
+
/**
|
|
451
|
+
* Original tool slug as provided by the user
|
|
452
|
+
*/
|
|
453
|
+
original_slug: string;
|
|
454
|
+
|
|
455
|
+
/**
|
|
456
|
+
* Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
|
|
457
|
+
*/
|
|
458
|
+
slug: string;
|
|
459
|
+
|
|
460
|
+
output_schema?: { [key: string]: unknown };
|
|
461
|
+
}
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
export interface CustomTool {
|
|
465
|
+
description: string;
|
|
466
|
+
|
|
467
|
+
input_schema: { [key: string]: unknown };
|
|
468
|
+
|
|
469
|
+
name: string;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Original tool slug as provided by the user
|
|
473
|
+
*/
|
|
474
|
+
original_slug: string;
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
|
|
478
|
+
*/
|
|
479
|
+
slug: string;
|
|
480
|
+
|
|
481
|
+
extends_toolkit?: string;
|
|
482
|
+
|
|
483
|
+
output_schema?: { [key: string]: unknown };
|
|
484
|
+
}
|
|
376
485
|
}
|
|
377
486
|
}
|
|
378
487
|
|
|
@@ -393,6 +502,11 @@ export interface SessionRetrieveResponse {
|
|
|
393
502
|
* List of available tools in this session
|
|
394
503
|
*/
|
|
395
504
|
tool_router_tools: Array<string>;
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* Experimental features
|
|
508
|
+
*/
|
|
509
|
+
experimental?: SessionRetrieveResponse.Experimental;
|
|
396
510
|
}
|
|
397
511
|
|
|
398
512
|
export namespace SessionRetrieveResponse {
|
|
@@ -453,6 +567,11 @@ export namespace SessionRetrieveResponse {
|
|
|
453
567
|
*/
|
|
454
568
|
callback_url?: string;
|
|
455
569
|
|
|
570
|
+
/**
|
|
571
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
|
|
572
|
+
*/
|
|
573
|
+
enable_connection_removal?: boolean;
|
|
574
|
+
|
|
456
575
|
/**
|
|
457
576
|
* Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
|
|
458
577
|
* Default false. May not work reliably with GPT models.
|
|
@@ -526,6 +645,12 @@ export namespace SessionRetrieveResponse {
|
|
|
526
645
|
*/
|
|
527
646
|
auto_offload_threshold?: number;
|
|
528
647
|
|
|
648
|
+
/**
|
|
649
|
+
* Whether the workbench (code execution sandbox) is enabled. When false,
|
|
650
|
+
* COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
|
|
651
|
+
*/
|
|
652
|
+
enable?: boolean;
|
|
653
|
+
|
|
529
654
|
/**
|
|
530
655
|
* Whether proxy execution is enabled in the workbench
|
|
531
656
|
*/
|
|
@@ -544,6 +669,82 @@ export namespace SessionRetrieveResponse {
|
|
|
544
669
|
*/
|
|
545
670
|
url: string;
|
|
546
671
|
}
|
|
672
|
+
|
|
673
|
+
/**
|
|
674
|
+
* Experimental features
|
|
675
|
+
*/
|
|
676
|
+
export interface Experimental {
|
|
677
|
+
/**
|
|
678
|
+
* The assistive system prompt for the tool router session
|
|
679
|
+
*/
|
|
680
|
+
assistive_prompt?: string;
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* User-defined custom toolkits with grouped tools (no-auth)
|
|
684
|
+
*/
|
|
685
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* Custom tools — standalone or extending Composio toolkits
|
|
689
|
+
*/
|
|
690
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
691
|
+
}
|
|
692
|
+
|
|
693
|
+
export namespace Experimental {
|
|
694
|
+
export interface CustomToolkit {
|
|
695
|
+
description: string;
|
|
696
|
+
|
|
697
|
+
name: string;
|
|
698
|
+
|
|
699
|
+
slug: string;
|
|
700
|
+
|
|
701
|
+
tools: Array<CustomToolkit.Tool>;
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
export namespace CustomToolkit {
|
|
705
|
+
export interface Tool {
|
|
706
|
+
description: string;
|
|
707
|
+
|
|
708
|
+
input_schema: { [key: string]: unknown };
|
|
709
|
+
|
|
710
|
+
name: string;
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* Original tool slug as provided by the user
|
|
714
|
+
*/
|
|
715
|
+
original_slug: string;
|
|
716
|
+
|
|
717
|
+
/**
|
|
718
|
+
* Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
|
|
719
|
+
*/
|
|
720
|
+
slug: string;
|
|
721
|
+
|
|
722
|
+
output_schema?: { [key: string]: unknown };
|
|
723
|
+
}
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
export interface CustomTool {
|
|
727
|
+
description: string;
|
|
728
|
+
|
|
729
|
+
input_schema: { [key: string]: unknown };
|
|
730
|
+
|
|
731
|
+
name: string;
|
|
732
|
+
|
|
733
|
+
/**
|
|
734
|
+
* Original tool slug as provided by the user
|
|
735
|
+
*/
|
|
736
|
+
original_slug: string;
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
|
|
740
|
+
*/
|
|
741
|
+
slug: string;
|
|
742
|
+
|
|
743
|
+
extends_toolkit?: string;
|
|
744
|
+
|
|
745
|
+
output_schema?: { [key: string]: unknown };
|
|
746
|
+
}
|
|
747
|
+
}
|
|
547
748
|
}
|
|
548
749
|
|
|
549
750
|
export interface SessionExecuteResponse {
|
|
@@ -597,6 +798,55 @@ export interface SessionLinkResponse {
|
|
|
597
798
|
redirect_url: string;
|
|
598
799
|
}
|
|
599
800
|
|
|
801
|
+
export interface SessionProxyExecuteResponse {
|
|
802
|
+
/**
|
|
803
|
+
* The HTTP status code returned from the proxied API
|
|
804
|
+
*/
|
|
805
|
+
status: number;
|
|
806
|
+
|
|
807
|
+
/**
|
|
808
|
+
* Binary body response data. Present when the response is a binary file.
|
|
809
|
+
*/
|
|
810
|
+
binary_data?: SessionProxyExecuteResponse.BinaryData;
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* The response data returned from the proxied API
|
|
814
|
+
*/
|
|
815
|
+
data?: unknown;
|
|
816
|
+
|
|
817
|
+
/**
|
|
818
|
+
* The HTTP headers returned from the proxied API
|
|
819
|
+
*/
|
|
820
|
+
headers?: { [key: string]: string };
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
export namespace SessionProxyExecuteResponse {
|
|
824
|
+
/**
|
|
825
|
+
* Binary body response data. Present when the response is a binary file.
|
|
826
|
+
*/
|
|
827
|
+
export interface BinaryData {
|
|
828
|
+
/**
|
|
829
|
+
* Content-Type of the binary data
|
|
830
|
+
*/
|
|
831
|
+
content_type: string;
|
|
832
|
+
|
|
833
|
+
/**
|
|
834
|
+
* File size in bytes
|
|
835
|
+
*/
|
|
836
|
+
size: number;
|
|
837
|
+
|
|
838
|
+
/**
|
|
839
|
+
* URL to download binary content
|
|
840
|
+
*/
|
|
841
|
+
url: string;
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* ISO 8601 timestamp when the URL expires
|
|
845
|
+
*/
|
|
846
|
+
expires_at?: string;
|
|
847
|
+
}
|
|
848
|
+
}
|
|
849
|
+
|
|
600
850
|
export interface SessionSearchResponse {
|
|
601
851
|
/**
|
|
602
852
|
* Error message if any searches failed, null if all succeeded. Format: "X out of Y
|
|
@@ -798,7 +1048,8 @@ export namespace SessionSearchResponse {
|
|
|
798
1048
|
input_schema?: { [key: string]: unknown };
|
|
799
1049
|
|
|
800
1050
|
/**
|
|
801
|
-
* Output/response schema for the tool
|
|
1051
|
+
* Output/response schema for the tool. Only included when include_output_schemas
|
|
1052
|
+
* is true.
|
|
802
1053
|
*/
|
|
803
1054
|
output_schema?: { [key: string]: unknown };
|
|
804
1055
|
|
|
@@ -819,14 +1070,14 @@ export namespace SessionSearchResponse {
|
|
|
819
1070
|
args: SchemaRef.Args;
|
|
820
1071
|
|
|
821
1072
|
/**
|
|
822
|
-
*
|
|
1073
|
+
* Tool to call
|
|
823
1074
|
*/
|
|
824
|
-
|
|
1075
|
+
tool: 'COMPOSIO_GET_TOOL_SCHEMAS';
|
|
825
1076
|
|
|
826
1077
|
/**
|
|
827
|
-
*
|
|
1078
|
+
* Instruction message for the LLM
|
|
828
1079
|
*/
|
|
829
|
-
|
|
1080
|
+
message?: string;
|
|
830
1081
|
}
|
|
831
1082
|
|
|
832
1083
|
export namespace SchemaRef {
|
|
@@ -863,6 +1114,18 @@ export namespace SessionSearchResponse {
|
|
|
863
1114
|
*/
|
|
864
1115
|
toolkit: string;
|
|
865
1116
|
|
|
1117
|
+
/**
|
|
1118
|
+
* When "required", the agent must specify which account to use. Present only when
|
|
1119
|
+
* multiple accounts exist.
|
|
1120
|
+
*/
|
|
1121
|
+
account_selection?: 'required';
|
|
1122
|
+
|
|
1123
|
+
/**
|
|
1124
|
+
* List of connected accounts for this toolkit. Present when multi-account is
|
|
1125
|
+
* enabled.
|
|
1126
|
+
*/
|
|
1127
|
+
accounts?: Array<ToolkitConnectionStatus.Account>;
|
|
1128
|
+
|
|
866
1129
|
/**
|
|
867
1130
|
* Connection details including auth config and connected account IDs. Only present
|
|
868
1131
|
* when has_active_connection is true.
|
|
@@ -874,6 +1137,40 @@ export namespace SessionSearchResponse {
|
|
|
874
1137
|
*/
|
|
875
1138
|
current_user_info?: { [key: string]: unknown };
|
|
876
1139
|
}
|
|
1140
|
+
|
|
1141
|
+
export namespace ToolkitConnectionStatus {
|
|
1142
|
+
export interface Account {
|
|
1143
|
+
/**
|
|
1144
|
+
* Unique identifier for this account
|
|
1145
|
+
*/
|
|
1146
|
+
id: string;
|
|
1147
|
+
|
|
1148
|
+
/**
|
|
1149
|
+
* ISO 8601 timestamp of when the account was connected
|
|
1150
|
+
*/
|
|
1151
|
+
created_at: string;
|
|
1152
|
+
|
|
1153
|
+
/**
|
|
1154
|
+
* Whether this is the default account for the toolkit
|
|
1155
|
+
*/
|
|
1156
|
+
is_default: boolean;
|
|
1157
|
+
|
|
1158
|
+
/**
|
|
1159
|
+
* Connection status (e.g., "active")
|
|
1160
|
+
*/
|
|
1161
|
+
status: string;
|
|
1162
|
+
|
|
1163
|
+
/**
|
|
1164
|
+
* User-assigned alias for this account
|
|
1165
|
+
*/
|
|
1166
|
+
alias?: string;
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* Information about the connected user (email, name, etc.)
|
|
1170
|
+
*/
|
|
1171
|
+
user_info?: { [key: string]: unknown };
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
877
1174
|
}
|
|
878
1175
|
|
|
879
1176
|
export interface SessionToolkitsResponse {
|
|
@@ -1042,6 +1339,12 @@ export namespace SessionToolsResponse {
|
|
|
1042
1339
|
*/
|
|
1043
1340
|
output_parameters: { [key: string]: unknown };
|
|
1044
1341
|
|
|
1342
|
+
/**
|
|
1343
|
+
* Structured scope requirements for the tool. Null means the tool is legacy and
|
|
1344
|
+
* only exposes flat scopes.
|
|
1345
|
+
*/
|
|
1346
|
+
scope_requirements: Item.ScopeRequirements | null;
|
|
1347
|
+
|
|
1045
1348
|
/**
|
|
1046
1349
|
* List of scopes associated with the tool
|
|
1047
1350
|
*/
|
|
@@ -1104,6 +1407,20 @@ export namespace SessionToolsResponse {
|
|
|
1104
1407
|
}
|
|
1105
1408
|
}
|
|
1106
1409
|
|
|
1410
|
+
/**
|
|
1411
|
+
* Structured scope requirements for the tool. Null means the tool is legacy and
|
|
1412
|
+
* only exposes flat scopes.
|
|
1413
|
+
*/
|
|
1414
|
+
export interface ScopeRequirements {
|
|
1415
|
+
all_of: Array<string | ScopeRequirements.AnyOf>;
|
|
1416
|
+
}
|
|
1417
|
+
|
|
1418
|
+
export namespace ScopeRequirements {
|
|
1419
|
+
export interface AnyOf {
|
|
1420
|
+
any_of: Array<string>;
|
|
1421
|
+
}
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1107
1424
|
export interface Toolkit {
|
|
1108
1425
|
/**
|
|
1109
1426
|
* URL to the toolkit logo image
|
|
@@ -1194,6 +1511,18 @@ export namespace SessionCreateParams {
|
|
|
1194
1511
|
* Customize assistive prompt generation (e.g., timezone).
|
|
1195
1512
|
*/
|
|
1196
1513
|
assistive_prompt_config?: Experimental.AssistivePromptConfig;
|
|
1514
|
+
|
|
1515
|
+
/**
|
|
1516
|
+
* Custom toolkits with grouped tools. Toolkit slugs must not conflict with
|
|
1517
|
+
* existing Composio toolkits. All tools are no-auth.
|
|
1518
|
+
*/
|
|
1519
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
1520
|
+
|
|
1521
|
+
/**
|
|
1522
|
+
* Custom tools to include in search. Standalone tools need no auth. Tools with
|
|
1523
|
+
* extends_toolkit inherit the Composio toolkit's connection.
|
|
1524
|
+
*/
|
|
1525
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
1197
1526
|
}
|
|
1198
1527
|
|
|
1199
1528
|
export namespace Experimental {
|
|
@@ -1207,49 +1536,142 @@ export namespace SessionCreateParams {
|
|
|
1207
1536
|
*/
|
|
1208
1537
|
user_timezone?: string;
|
|
1209
1538
|
}
|
|
1210
|
-
}
|
|
1211
1539
|
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
* The URL to redirect to after a user completes authentication for a connected
|
|
1218
|
-
* account. This allows you to handle the auth callback in your own application.
|
|
1219
|
-
*/
|
|
1220
|
-
callback_url?: string;
|
|
1540
|
+
export interface CustomToolkit {
|
|
1541
|
+
/**
|
|
1542
|
+
* Used for BM25 search matching and shown in toolkit connection statuses.
|
|
1543
|
+
*/
|
|
1544
|
+
description: string;
|
|
1221
1545
|
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
* connections manually.
|
|
1227
|
-
*/
|
|
1228
|
-
enable?: boolean | null;
|
|
1546
|
+
/**
|
|
1547
|
+
* Display name shown to the LLM and in search results.
|
|
1548
|
+
*/
|
|
1549
|
+
name: string;
|
|
1229
1550
|
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
enable_wait_for_connections?: boolean | null;
|
|
1236
|
-
}
|
|
1551
|
+
/**
|
|
1552
|
+
* Unique slug for the toolkit. Must not conflict with existing Composio toolkit
|
|
1553
|
+
* slugs. Alphanumeric, underscores, and hyphens only.
|
|
1554
|
+
*/
|
|
1555
|
+
slug: string;
|
|
1237
1556
|
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
|
|
1557
|
+
/**
|
|
1558
|
+
* Tools in this custom toolkit
|
|
1559
|
+
*/
|
|
1560
|
+
tools: Array<CustomToolkit.Tool>;
|
|
1561
|
+
}
|
|
1243
1562
|
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1563
|
+
export namespace CustomToolkit {
|
|
1564
|
+
export interface Tool {
|
|
1565
|
+
/**
|
|
1566
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
1567
|
+
*/
|
|
1568
|
+
description: string;
|
|
1249
1569
|
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1570
|
+
/**
|
|
1571
|
+
* Must have type: "object" and a properties field.
|
|
1572
|
+
*/
|
|
1573
|
+
input_schema: { [key: string]: unknown };
|
|
1574
|
+
|
|
1575
|
+
/**
|
|
1576
|
+
* Human-readable display name
|
|
1577
|
+
*/
|
|
1578
|
+
name: string;
|
|
1579
|
+
|
|
1580
|
+
/**
|
|
1581
|
+
* Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
|
|
1582
|
+
* chars total).
|
|
1583
|
+
*/
|
|
1584
|
+
slug: string;
|
|
1585
|
+
|
|
1586
|
+
/**
|
|
1587
|
+
* Optional output schema for the tool response.
|
|
1588
|
+
*/
|
|
1589
|
+
output_schema?: { [key: string]: unknown };
|
|
1590
|
+
}
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
export interface CustomTool {
|
|
1594
|
+
/**
|
|
1595
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
1596
|
+
*/
|
|
1597
|
+
description: string;
|
|
1598
|
+
|
|
1599
|
+
/**
|
|
1600
|
+
* Must have type: "object" and a properties field.
|
|
1601
|
+
*/
|
|
1602
|
+
input_schema: { [key: string]: unknown };
|
|
1603
|
+
|
|
1604
|
+
/**
|
|
1605
|
+
* Human-readable display name
|
|
1606
|
+
*/
|
|
1607
|
+
name: string;
|
|
1608
|
+
|
|
1609
|
+
/**
|
|
1610
|
+
* Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
|
|
1611
|
+
* (extending). Max 60 chars total.
|
|
1612
|
+
*/
|
|
1613
|
+
slug: string;
|
|
1614
|
+
|
|
1615
|
+
/**
|
|
1616
|
+
* If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
|
|
1617
|
+
* auth/connection status. If omitted, the tool is standalone (no-auth).
|
|
1618
|
+
*/
|
|
1619
|
+
extends_toolkit?: string;
|
|
1620
|
+
|
|
1621
|
+
/**
|
|
1622
|
+
* JSON Schema describing tool output (optional)
|
|
1623
|
+
*/
|
|
1624
|
+
output_schema?: { [key: string]: unknown };
|
|
1625
|
+
}
|
|
1626
|
+
}
|
|
1627
|
+
|
|
1628
|
+
/**
|
|
1629
|
+
* Configuration for connection management settings
|
|
1630
|
+
*/
|
|
1631
|
+
export interface ManageConnections {
|
|
1632
|
+
/**
|
|
1633
|
+
* The URL to redirect to after a user completes authentication for a connected
|
|
1634
|
+
* account. This allows you to handle the auth callback in your own application.
|
|
1635
|
+
*/
|
|
1636
|
+
callback_url?: string;
|
|
1637
|
+
|
|
1638
|
+
/**
|
|
1639
|
+
* Whether to enable the connection manager for automatic connection handling. If
|
|
1640
|
+
* true, we will provide a tool your agent can use to initiate connections to
|
|
1641
|
+
* toolkits if it doesnt exist. If set to false, then you have to manage
|
|
1642
|
+
* connections manually.
|
|
1643
|
+
*/
|
|
1644
|
+
enable?: boolean | null;
|
|
1645
|
+
|
|
1646
|
+
/**
|
|
1647
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting
|
|
1648
|
+
* connected accounts. Default true.
|
|
1649
|
+
*/
|
|
1650
|
+
enable_connection_removal?: boolean | null;
|
|
1651
|
+
|
|
1652
|
+
/**
|
|
1653
|
+
* When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to
|
|
1654
|
+
* poll connection status after sharing auth URLs. Default is false (disabled). May
|
|
1655
|
+
* not work reliably with GPT models.
|
|
1656
|
+
*/
|
|
1657
|
+
enable_wait_for_connections?: boolean | null;
|
|
1658
|
+
}
|
|
1659
|
+
|
|
1660
|
+
export interface UnionMember1 {
|
|
1661
|
+
/**
|
|
1662
|
+
* Tags that the tool must NOT have any of
|
|
1663
|
+
*/
|
|
1664
|
+
disable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1665
|
+
|
|
1666
|
+
/**
|
|
1667
|
+
* Tags that the tool must have at least one of
|
|
1668
|
+
*/
|
|
1669
|
+
enable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1670
|
+
}
|
|
1671
|
+
|
|
1672
|
+
/**
|
|
1673
|
+
* Enable only specific toolkits (allowlist)
|
|
1674
|
+
*/
|
|
1253
1675
|
export interface Enable {
|
|
1254
1676
|
/**
|
|
1255
1677
|
* Only these specific toolkits will be enabled
|
|
@@ -1314,6 +1736,12 @@ export namespace SessionCreateParams {
|
|
|
1314
1736
|
*/
|
|
1315
1737
|
auto_offload_threshold?: number;
|
|
1316
1738
|
|
|
1739
|
+
/**
|
|
1740
|
+
* Set to false to disable the workbench entirely. When disabled, no code execution
|
|
1741
|
+
* tools are available in the session.
|
|
1742
|
+
*/
|
|
1743
|
+
enable?: boolean;
|
|
1744
|
+
|
|
1317
1745
|
/**
|
|
1318
1746
|
* Whether proxy execution is enabled. When enabled, workbench can call URLs and
|
|
1319
1747
|
* APIs directly.
|
|
@@ -1328,6 +1756,14 @@ export interface SessionExecuteParams {
|
|
|
1328
1756
|
*/
|
|
1329
1757
|
tool_slug: string;
|
|
1330
1758
|
|
|
1759
|
+
/**
|
|
1760
|
+
* Account identifier to specify which connected account to use. Use the account ID
|
|
1761
|
+
* (e.g. "coup_hurricane_dal_analytical") or an alias. When omitted with a single
|
|
1762
|
+
* account, the default is used. When omitted with multiple accounts, an error
|
|
1763
|
+
* lists available accounts.
|
|
1764
|
+
*/
|
|
1765
|
+
account?: string;
|
|
1766
|
+
|
|
1331
1767
|
/**
|
|
1332
1768
|
* The arguments required by the tool
|
|
1333
1769
|
*/
|
|
@@ -1367,6 +1803,863 @@ export interface SessionLinkParams {
|
|
|
1367
1803
|
callback_url?: string;
|
|
1368
1804
|
}
|
|
1369
1805
|
|
|
1806
|
+
export interface SessionProxyExecuteParams {
|
|
1807
|
+
/**
|
|
1808
|
+
* The API endpoint to call (absolute URL or path relative to base URL of the
|
|
1809
|
+
* connected account)
|
|
1810
|
+
*/
|
|
1811
|
+
endpoint: string;
|
|
1812
|
+
|
|
1813
|
+
/**
|
|
1814
|
+
* The HTTP method to use for the request
|
|
1815
|
+
*/
|
|
1816
|
+
method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';
|
|
1817
|
+
|
|
1818
|
+
/**
|
|
1819
|
+
* The slug of the toolkit to use for the request
|
|
1820
|
+
*/
|
|
1821
|
+
toolkit_slug: string;
|
|
1822
|
+
|
|
1823
|
+
/**
|
|
1824
|
+
* Binary body to send. For binary upload via URL: use {url: "https://...",
|
|
1825
|
+
* content_type?: "..."}. For binary upload via base64: use {base64: "...",
|
|
1826
|
+
* content_type?: "..."}.
|
|
1827
|
+
*/
|
|
1828
|
+
binary_body?: SessionProxyExecuteParams.UnionMember0 | SessionProxyExecuteParams.UnionMember1;
|
|
1829
|
+
|
|
1830
|
+
/**
|
|
1831
|
+
* The request body (for POST, PUT, and PATCH requests)
|
|
1832
|
+
*/
|
|
1833
|
+
body?: unknown;
|
|
1834
|
+
|
|
1835
|
+
custom_connection_data?:
|
|
1836
|
+
| SessionProxyExecuteParams.UnionMember0
|
|
1837
|
+
| SessionProxyExecuteParams.UnionMember1
|
|
1838
|
+
| SessionProxyExecuteParams.UnionMember2
|
|
1839
|
+
| SessionProxyExecuteParams.UnionMember3
|
|
1840
|
+
| SessionProxyExecuteParams.UnionMember4
|
|
1841
|
+
| SessionProxyExecuteParams.UnionMember5
|
|
1842
|
+
| SessionProxyExecuteParams.UnionMember6
|
|
1843
|
+
| SessionProxyExecuteParams.UnionMember7
|
|
1844
|
+
| SessionProxyExecuteParams.UnionMember8
|
|
1845
|
+
| SessionProxyExecuteParams.UnionMember9
|
|
1846
|
+
| SessionProxyExecuteParams.UnionMember10;
|
|
1847
|
+
|
|
1848
|
+
/**
|
|
1849
|
+
* Additional HTTP headers or query parameters to include in the request
|
|
1850
|
+
*/
|
|
1851
|
+
parameters?: Array<SessionProxyExecuteParams.Parameter>;
|
|
1852
|
+
}
|
|
1853
|
+
|
|
1854
|
+
export namespace SessionProxyExecuteParams {
|
|
1855
|
+
export interface UnionMember0 {
|
|
1856
|
+
/**
|
|
1857
|
+
* URL to fetch binary content from
|
|
1858
|
+
*/
|
|
1859
|
+
url: string;
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
* Content-Type header to use for the request
|
|
1863
|
+
*/
|
|
1864
|
+
content_type?: string;
|
|
1865
|
+
}
|
|
1866
|
+
|
|
1867
|
+
export interface UnionMember1 {
|
|
1868
|
+
/**
|
|
1869
|
+
* Base64-encoded binary data
|
|
1870
|
+
*/
|
|
1871
|
+
base64: string;
|
|
1872
|
+
|
|
1873
|
+
/**
|
|
1874
|
+
* Content-Type header to use for the request
|
|
1875
|
+
*/
|
|
1876
|
+
content_type?: string;
|
|
1877
|
+
}
|
|
1878
|
+
|
|
1879
|
+
export interface UnionMember0 {
|
|
1880
|
+
authScheme: 'OAUTH2';
|
|
1881
|
+
|
|
1882
|
+
toolkitSlug: string;
|
|
1883
|
+
|
|
1884
|
+
val: UnionMember0.Val;
|
|
1885
|
+
}
|
|
1886
|
+
|
|
1887
|
+
export namespace UnionMember0 {
|
|
1888
|
+
export interface Val {
|
|
1889
|
+
access_token: string;
|
|
1890
|
+
|
|
1891
|
+
account_id?: string;
|
|
1892
|
+
|
|
1893
|
+
account_url?: string;
|
|
1894
|
+
|
|
1895
|
+
api_url?: string;
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* for slack user scopes
|
|
1899
|
+
*/
|
|
1900
|
+
authed_user?: Val.AuthedUser;
|
|
1901
|
+
|
|
1902
|
+
base_url?: string;
|
|
1903
|
+
|
|
1904
|
+
borneo_dashboard_url?: string;
|
|
1905
|
+
|
|
1906
|
+
COMPANYDOMAIN?: string;
|
|
1907
|
+
|
|
1908
|
+
dc?: string;
|
|
1909
|
+
|
|
1910
|
+
domain?: string;
|
|
1911
|
+
|
|
1912
|
+
expires_in?: number | string | null;
|
|
1913
|
+
|
|
1914
|
+
extension?: string;
|
|
1915
|
+
|
|
1916
|
+
form_api_base_url?: string;
|
|
1917
|
+
|
|
1918
|
+
id_token?: string;
|
|
1919
|
+
|
|
1920
|
+
instanceEndpoint?: string;
|
|
1921
|
+
|
|
1922
|
+
instanceName?: string;
|
|
1923
|
+
|
|
1924
|
+
/**
|
|
1925
|
+
* Whether to return the redirect url without shortening
|
|
1926
|
+
*/
|
|
1927
|
+
long_redirect_url?: boolean;
|
|
1928
|
+
|
|
1929
|
+
proxy_password?: string;
|
|
1930
|
+
|
|
1931
|
+
proxy_username?: string;
|
|
1932
|
+
|
|
1933
|
+
refresh_token?: string | null;
|
|
1934
|
+
|
|
1935
|
+
region?: string;
|
|
1936
|
+
|
|
1937
|
+
scope?: string | Array<string> | null;
|
|
1938
|
+
|
|
1939
|
+
server_location?: string;
|
|
1940
|
+
|
|
1941
|
+
shop?: string;
|
|
1942
|
+
|
|
1943
|
+
site_name?: string;
|
|
1944
|
+
|
|
1945
|
+
/**
|
|
1946
|
+
* The oauth2 state prefix for the connection
|
|
1947
|
+
*/
|
|
1948
|
+
state_prefix?: string;
|
|
1949
|
+
|
|
1950
|
+
subdomain?: string;
|
|
1951
|
+
|
|
1952
|
+
token_type?: string;
|
|
1953
|
+
|
|
1954
|
+
version?: string;
|
|
1955
|
+
|
|
1956
|
+
webhook_signature?: string;
|
|
1957
|
+
|
|
1958
|
+
your_server?: string;
|
|
1959
|
+
|
|
1960
|
+
'your-domain'?: string;
|
|
1961
|
+
|
|
1962
|
+
[k: string]: unknown;
|
|
1963
|
+
}
|
|
1964
|
+
|
|
1965
|
+
export namespace Val {
|
|
1966
|
+
/**
|
|
1967
|
+
* for slack user scopes
|
|
1968
|
+
*/
|
|
1969
|
+
export interface AuthedUser {
|
|
1970
|
+
access_token?: string;
|
|
1971
|
+
|
|
1972
|
+
scope?: string;
|
|
1973
|
+
}
|
|
1974
|
+
}
|
|
1975
|
+
}
|
|
1976
|
+
|
|
1977
|
+
export interface UnionMember1 {
|
|
1978
|
+
authScheme: 'DCR_OAUTH';
|
|
1979
|
+
|
|
1980
|
+
toolkitSlug: string;
|
|
1981
|
+
|
|
1982
|
+
val: UnionMember1.Val;
|
|
1983
|
+
}
|
|
1984
|
+
|
|
1985
|
+
export namespace UnionMember1 {
|
|
1986
|
+
export interface Val {
|
|
1987
|
+
access_token: string;
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* Dynamically registered client ID
|
|
1991
|
+
*/
|
|
1992
|
+
client_id: string;
|
|
1993
|
+
|
|
1994
|
+
account_id?: string;
|
|
1995
|
+
|
|
1996
|
+
account_url?: string;
|
|
1997
|
+
|
|
1998
|
+
api_url?: string;
|
|
1999
|
+
|
|
2000
|
+
base_url?: string;
|
|
2001
|
+
|
|
2002
|
+
borneo_dashboard_url?: string;
|
|
2003
|
+
|
|
2004
|
+
client_id_issued_at?: number;
|
|
2005
|
+
|
|
2006
|
+
/**
|
|
2007
|
+
* Dynamically registered client secret
|
|
2008
|
+
*/
|
|
2009
|
+
client_secret?: string;
|
|
2010
|
+
|
|
2011
|
+
client_secret_expires_at?: number;
|
|
2012
|
+
|
|
2013
|
+
COMPANYDOMAIN?: string;
|
|
2014
|
+
|
|
2015
|
+
dc?: string;
|
|
2016
|
+
|
|
2017
|
+
domain?: string;
|
|
2018
|
+
|
|
2019
|
+
expires_in?: number | string | null;
|
|
2020
|
+
|
|
2021
|
+
extension?: string;
|
|
2022
|
+
|
|
2023
|
+
form_api_base_url?: string;
|
|
2024
|
+
|
|
2025
|
+
id_token?: string;
|
|
2026
|
+
|
|
2027
|
+
instanceEndpoint?: string;
|
|
2028
|
+
|
|
2029
|
+
instanceName?: string;
|
|
2030
|
+
|
|
2031
|
+
/**
|
|
2032
|
+
* Whether to return the redirect url without shortening
|
|
2033
|
+
*/
|
|
2034
|
+
long_redirect_url?: boolean;
|
|
2035
|
+
|
|
2036
|
+
proxy_password?: string;
|
|
2037
|
+
|
|
2038
|
+
proxy_username?: string;
|
|
2039
|
+
|
|
2040
|
+
refresh_token?: string | null;
|
|
2041
|
+
|
|
2042
|
+
region?: string;
|
|
2043
|
+
|
|
2044
|
+
scope?: string | Array<string> | null;
|
|
2045
|
+
|
|
2046
|
+
server_location?: string;
|
|
2047
|
+
|
|
2048
|
+
shop?: string;
|
|
2049
|
+
|
|
2050
|
+
site_name?: string;
|
|
2051
|
+
|
|
2052
|
+
/**
|
|
2053
|
+
* The oauth2 state prefix for the connection
|
|
2054
|
+
*/
|
|
2055
|
+
state_prefix?: string;
|
|
2056
|
+
|
|
2057
|
+
subdomain?: string;
|
|
2058
|
+
|
|
2059
|
+
token_type?: string;
|
|
2060
|
+
|
|
2061
|
+
version?: string;
|
|
2062
|
+
|
|
2063
|
+
your_server?: string;
|
|
2064
|
+
|
|
2065
|
+
'your-domain'?: string;
|
|
2066
|
+
|
|
2067
|
+
[k: string]: unknown;
|
|
2068
|
+
}
|
|
2069
|
+
}
|
|
2070
|
+
|
|
2071
|
+
export interface UnionMember2 {
|
|
2072
|
+
authScheme: 'API_KEY';
|
|
2073
|
+
|
|
2074
|
+
toolkitSlug: string;
|
|
2075
|
+
|
|
2076
|
+
val: UnionMember2.Val;
|
|
2077
|
+
}
|
|
2078
|
+
|
|
2079
|
+
export namespace UnionMember2 {
|
|
2080
|
+
export interface Val {
|
|
2081
|
+
account_id?: string;
|
|
2082
|
+
|
|
2083
|
+
account_url?: string;
|
|
2084
|
+
|
|
2085
|
+
api_key?: string;
|
|
2086
|
+
|
|
2087
|
+
api_url?: string;
|
|
2088
|
+
|
|
2089
|
+
base_url?: string;
|
|
2090
|
+
|
|
2091
|
+
basic_encoded?: string;
|
|
2092
|
+
|
|
2093
|
+
bearer_token?: string;
|
|
2094
|
+
|
|
2095
|
+
borneo_dashboard_url?: string;
|
|
2096
|
+
|
|
2097
|
+
COMPANYDOMAIN?: string;
|
|
2098
|
+
|
|
2099
|
+
dc?: string;
|
|
2100
|
+
|
|
2101
|
+
domain?: string;
|
|
2102
|
+
|
|
2103
|
+
extension?: string;
|
|
2104
|
+
|
|
2105
|
+
form_api_base_url?: string;
|
|
2106
|
+
|
|
2107
|
+
generic_api_key?: string;
|
|
2108
|
+
|
|
2109
|
+
instanceEndpoint?: string;
|
|
2110
|
+
|
|
2111
|
+
instanceName?: string;
|
|
2112
|
+
|
|
2113
|
+
proxy_password?: string;
|
|
2114
|
+
|
|
2115
|
+
proxy_username?: string;
|
|
2116
|
+
|
|
2117
|
+
region?: string;
|
|
2118
|
+
|
|
2119
|
+
server_location?: string;
|
|
2120
|
+
|
|
2121
|
+
shop?: string;
|
|
2122
|
+
|
|
2123
|
+
site_name?: string;
|
|
2124
|
+
|
|
2125
|
+
subdomain?: string;
|
|
2126
|
+
|
|
2127
|
+
version?: string;
|
|
2128
|
+
|
|
2129
|
+
your_server?: string;
|
|
2130
|
+
|
|
2131
|
+
'your-domain'?: string;
|
|
2132
|
+
|
|
2133
|
+
[k: string]: unknown;
|
|
2134
|
+
}
|
|
2135
|
+
}
|
|
2136
|
+
|
|
2137
|
+
export interface UnionMember3 {
|
|
2138
|
+
authScheme: 'BASIC_WITH_JWT';
|
|
2139
|
+
|
|
2140
|
+
toolkitSlug: string;
|
|
2141
|
+
|
|
2142
|
+
val: UnionMember3.Val;
|
|
2143
|
+
}
|
|
2144
|
+
|
|
2145
|
+
export namespace UnionMember3 {
|
|
2146
|
+
export interface Val {
|
|
2147
|
+
password: string;
|
|
2148
|
+
|
|
2149
|
+
username: string;
|
|
2150
|
+
|
|
2151
|
+
account_id?: string;
|
|
2152
|
+
|
|
2153
|
+
account_url?: string;
|
|
2154
|
+
|
|
2155
|
+
api_url?: string;
|
|
2156
|
+
|
|
2157
|
+
base_url?: string;
|
|
2158
|
+
|
|
2159
|
+
borneo_dashboard_url?: string;
|
|
2160
|
+
|
|
2161
|
+
COMPANYDOMAIN?: string;
|
|
2162
|
+
|
|
2163
|
+
dc?: string;
|
|
2164
|
+
|
|
2165
|
+
domain?: string;
|
|
2166
|
+
|
|
2167
|
+
extension?: string;
|
|
2168
|
+
|
|
2169
|
+
form_api_base_url?: string;
|
|
2170
|
+
|
|
2171
|
+
instanceEndpoint?: string;
|
|
2172
|
+
|
|
2173
|
+
instanceName?: string;
|
|
2174
|
+
|
|
2175
|
+
proxy_password?: string;
|
|
2176
|
+
|
|
2177
|
+
proxy_username?: string;
|
|
2178
|
+
|
|
2179
|
+
region?: string;
|
|
2180
|
+
|
|
2181
|
+
server_location?: string;
|
|
2182
|
+
|
|
2183
|
+
shop?: string;
|
|
2184
|
+
|
|
2185
|
+
site_name?: string;
|
|
2186
|
+
|
|
2187
|
+
subdomain?: string;
|
|
2188
|
+
|
|
2189
|
+
version?: string;
|
|
2190
|
+
|
|
2191
|
+
your_server?: string;
|
|
2192
|
+
|
|
2193
|
+
'your-domain'?: string;
|
|
2194
|
+
|
|
2195
|
+
[k: string]: unknown;
|
|
2196
|
+
}
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
export interface UnionMember4 {
|
|
2200
|
+
authScheme: 'BASIC';
|
|
2201
|
+
|
|
2202
|
+
toolkitSlug: string;
|
|
2203
|
+
|
|
2204
|
+
val: UnionMember4.Val;
|
|
2205
|
+
}
|
|
2206
|
+
|
|
2207
|
+
export namespace UnionMember4 {
|
|
2208
|
+
export interface Val {
|
|
2209
|
+
username: string;
|
|
2210
|
+
|
|
2211
|
+
account_id?: string;
|
|
2212
|
+
|
|
2213
|
+
account_url?: string;
|
|
2214
|
+
|
|
2215
|
+
api_url?: string;
|
|
2216
|
+
|
|
2217
|
+
base_url?: string;
|
|
2218
|
+
|
|
2219
|
+
borneo_dashboard_url?: string;
|
|
2220
|
+
|
|
2221
|
+
COMPANYDOMAIN?: string;
|
|
2222
|
+
|
|
2223
|
+
dc?: string;
|
|
2224
|
+
|
|
2225
|
+
domain?: string;
|
|
2226
|
+
|
|
2227
|
+
extension?: string;
|
|
2228
|
+
|
|
2229
|
+
form_api_base_url?: string;
|
|
2230
|
+
|
|
2231
|
+
instanceEndpoint?: string;
|
|
2232
|
+
|
|
2233
|
+
instanceName?: string;
|
|
2234
|
+
|
|
2235
|
+
password?: string;
|
|
2236
|
+
|
|
2237
|
+
proxy_password?: string;
|
|
2238
|
+
|
|
2239
|
+
proxy_username?: string;
|
|
2240
|
+
|
|
2241
|
+
region?: string;
|
|
2242
|
+
|
|
2243
|
+
server_location?: string;
|
|
2244
|
+
|
|
2245
|
+
shop?: string;
|
|
2246
|
+
|
|
2247
|
+
site_name?: string;
|
|
2248
|
+
|
|
2249
|
+
subdomain?: string;
|
|
2250
|
+
|
|
2251
|
+
version?: string;
|
|
2252
|
+
|
|
2253
|
+
your_server?: string;
|
|
2254
|
+
|
|
2255
|
+
'your-domain'?: string;
|
|
2256
|
+
|
|
2257
|
+
[k: string]: unknown;
|
|
2258
|
+
}
|
|
2259
|
+
}
|
|
2260
|
+
|
|
2261
|
+
export interface UnionMember5 {
|
|
2262
|
+
authScheme: 'BEARER_TOKEN';
|
|
2263
|
+
|
|
2264
|
+
toolkitSlug: string;
|
|
2265
|
+
|
|
2266
|
+
val: UnionMember5.Val;
|
|
2267
|
+
}
|
|
2268
|
+
|
|
2269
|
+
export namespace UnionMember5 {
|
|
2270
|
+
export interface Val {
|
|
2271
|
+
token: string;
|
|
2272
|
+
|
|
2273
|
+
account_id?: string;
|
|
2274
|
+
|
|
2275
|
+
account_url?: string;
|
|
2276
|
+
|
|
2277
|
+
api_url?: string;
|
|
2278
|
+
|
|
2279
|
+
base_url?: string;
|
|
2280
|
+
|
|
2281
|
+
borneo_dashboard_url?: string;
|
|
2282
|
+
|
|
2283
|
+
COMPANYDOMAIN?: string;
|
|
2284
|
+
|
|
2285
|
+
dc?: string;
|
|
2286
|
+
|
|
2287
|
+
domain?: string;
|
|
2288
|
+
|
|
2289
|
+
extension?: string;
|
|
2290
|
+
|
|
2291
|
+
form_api_base_url?: string;
|
|
2292
|
+
|
|
2293
|
+
instanceEndpoint?: string;
|
|
2294
|
+
|
|
2295
|
+
instanceName?: string;
|
|
2296
|
+
|
|
2297
|
+
proxy_password?: string;
|
|
2298
|
+
|
|
2299
|
+
proxy_username?: string;
|
|
2300
|
+
|
|
2301
|
+
region?: string;
|
|
2302
|
+
|
|
2303
|
+
server_location?: string;
|
|
2304
|
+
|
|
2305
|
+
shop?: string;
|
|
2306
|
+
|
|
2307
|
+
site_name?: string;
|
|
2308
|
+
|
|
2309
|
+
subdomain?: string;
|
|
2310
|
+
|
|
2311
|
+
version?: string;
|
|
2312
|
+
|
|
2313
|
+
your_server?: string;
|
|
2314
|
+
|
|
2315
|
+
'your-domain'?: string;
|
|
2316
|
+
|
|
2317
|
+
[k: string]: unknown;
|
|
2318
|
+
}
|
|
2319
|
+
}
|
|
2320
|
+
|
|
2321
|
+
export interface UnionMember6 {
|
|
2322
|
+
authScheme: 'OAUTH1';
|
|
2323
|
+
|
|
2324
|
+
toolkitSlug: string;
|
|
2325
|
+
|
|
2326
|
+
val: UnionMember6.Val;
|
|
2327
|
+
}
|
|
2328
|
+
|
|
2329
|
+
export namespace UnionMember6 {
|
|
2330
|
+
export interface Val {
|
|
2331
|
+
oauth_token: string;
|
|
2332
|
+
|
|
2333
|
+
oauth_token_secret: string;
|
|
2334
|
+
|
|
2335
|
+
account_id?: string;
|
|
2336
|
+
|
|
2337
|
+
account_url?: string;
|
|
2338
|
+
|
|
2339
|
+
api_url?: string;
|
|
2340
|
+
|
|
2341
|
+
base_url?: string;
|
|
2342
|
+
|
|
2343
|
+
borneo_dashboard_url?: string;
|
|
2344
|
+
|
|
2345
|
+
callback_url?: string;
|
|
2346
|
+
|
|
2347
|
+
COMPANYDOMAIN?: string;
|
|
2348
|
+
|
|
2349
|
+
consumer_key?: string;
|
|
2350
|
+
|
|
2351
|
+
dc?: string;
|
|
2352
|
+
|
|
2353
|
+
domain?: string;
|
|
2354
|
+
|
|
2355
|
+
extension?: string;
|
|
2356
|
+
|
|
2357
|
+
form_api_base_url?: string;
|
|
2358
|
+
|
|
2359
|
+
instanceEndpoint?: string;
|
|
2360
|
+
|
|
2361
|
+
instanceName?: string;
|
|
2362
|
+
|
|
2363
|
+
oauth_verifier?: string;
|
|
2364
|
+
|
|
2365
|
+
proxy_password?: string;
|
|
2366
|
+
|
|
2367
|
+
proxy_username?: string;
|
|
2368
|
+
|
|
2369
|
+
redirectUrl?: string;
|
|
2370
|
+
|
|
2371
|
+
region?: string;
|
|
2372
|
+
|
|
2373
|
+
server_location?: string;
|
|
2374
|
+
|
|
2375
|
+
shop?: string;
|
|
2376
|
+
|
|
2377
|
+
site_name?: string;
|
|
2378
|
+
|
|
2379
|
+
subdomain?: string;
|
|
2380
|
+
|
|
2381
|
+
version?: string;
|
|
2382
|
+
|
|
2383
|
+
your_server?: string;
|
|
2384
|
+
|
|
2385
|
+
'your-domain'?: string;
|
|
2386
|
+
|
|
2387
|
+
[k: string]: unknown;
|
|
2388
|
+
}
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2391
|
+
export interface UnionMember7 {
|
|
2392
|
+
authScheme: 'NO_AUTH';
|
|
2393
|
+
|
|
2394
|
+
toolkitSlug: string;
|
|
2395
|
+
|
|
2396
|
+
val: UnionMember7.Val;
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2399
|
+
export namespace UnionMember7 {
|
|
2400
|
+
export interface Val {
|
|
2401
|
+
account_id?: string;
|
|
2402
|
+
|
|
2403
|
+
account_url?: string;
|
|
2404
|
+
|
|
2405
|
+
api_url?: string;
|
|
2406
|
+
|
|
2407
|
+
base_url?: string;
|
|
2408
|
+
|
|
2409
|
+
borneo_dashboard_url?: string;
|
|
2410
|
+
|
|
2411
|
+
COMPANYDOMAIN?: string;
|
|
2412
|
+
|
|
2413
|
+
dc?: string;
|
|
2414
|
+
|
|
2415
|
+
domain?: string;
|
|
2416
|
+
|
|
2417
|
+
extension?: string;
|
|
2418
|
+
|
|
2419
|
+
form_api_base_url?: string;
|
|
2420
|
+
|
|
2421
|
+
instanceEndpoint?: string;
|
|
2422
|
+
|
|
2423
|
+
instanceName?: string;
|
|
2424
|
+
|
|
2425
|
+
proxy_password?: string;
|
|
2426
|
+
|
|
2427
|
+
proxy_username?: string;
|
|
2428
|
+
|
|
2429
|
+
region?: string;
|
|
2430
|
+
|
|
2431
|
+
server_location?: string;
|
|
2432
|
+
|
|
2433
|
+
shop?: string;
|
|
2434
|
+
|
|
2435
|
+
site_name?: string;
|
|
2436
|
+
|
|
2437
|
+
subdomain?: string;
|
|
2438
|
+
|
|
2439
|
+
version?: string;
|
|
2440
|
+
|
|
2441
|
+
your_server?: string;
|
|
2442
|
+
|
|
2443
|
+
'your-domain'?: string;
|
|
2444
|
+
|
|
2445
|
+
[k: string]: unknown;
|
|
2446
|
+
}
|
|
2447
|
+
}
|
|
2448
|
+
|
|
2449
|
+
export interface UnionMember8 {
|
|
2450
|
+
authScheme: 'SERVICE_ACCOUNT';
|
|
2451
|
+
|
|
2452
|
+
toolkitSlug: string;
|
|
2453
|
+
|
|
2454
|
+
val: UnionMember8.Val;
|
|
2455
|
+
}
|
|
2456
|
+
|
|
2457
|
+
export namespace UnionMember8 {
|
|
2458
|
+
export interface Val {
|
|
2459
|
+
application_id: string;
|
|
2460
|
+
|
|
2461
|
+
installation_id: string;
|
|
2462
|
+
|
|
2463
|
+
private_key: string;
|
|
2464
|
+
|
|
2465
|
+
account_id?: string;
|
|
2466
|
+
|
|
2467
|
+
account_url?: string;
|
|
2468
|
+
|
|
2469
|
+
api_url?: string;
|
|
2470
|
+
|
|
2471
|
+
base_url?: string;
|
|
2472
|
+
|
|
2473
|
+
borneo_dashboard_url?: string;
|
|
2474
|
+
|
|
2475
|
+
COMPANYDOMAIN?: string;
|
|
2476
|
+
|
|
2477
|
+
dc?: string;
|
|
2478
|
+
|
|
2479
|
+
domain?: string;
|
|
2480
|
+
|
|
2481
|
+
extension?: string;
|
|
2482
|
+
|
|
2483
|
+
form_api_base_url?: string;
|
|
2484
|
+
|
|
2485
|
+
instanceEndpoint?: string;
|
|
2486
|
+
|
|
2487
|
+
instanceName?: string;
|
|
2488
|
+
|
|
2489
|
+
proxy_password?: string;
|
|
2490
|
+
|
|
2491
|
+
proxy_username?: string;
|
|
2492
|
+
|
|
2493
|
+
region?: string;
|
|
2494
|
+
|
|
2495
|
+
server_location?: string;
|
|
2496
|
+
|
|
2497
|
+
shop?: string;
|
|
2498
|
+
|
|
2499
|
+
site_name?: string;
|
|
2500
|
+
|
|
2501
|
+
subdomain?: string;
|
|
2502
|
+
|
|
2503
|
+
version?: string;
|
|
2504
|
+
|
|
2505
|
+
your_server?: string;
|
|
2506
|
+
|
|
2507
|
+
'your-domain'?: string;
|
|
2508
|
+
|
|
2509
|
+
[k: string]: unknown;
|
|
2510
|
+
}
|
|
2511
|
+
}
|
|
2512
|
+
|
|
2513
|
+
export interface UnionMember9 {
|
|
2514
|
+
authScheme: 'GOOGLE_SERVICE_ACCOUNT';
|
|
2515
|
+
|
|
2516
|
+
toolkitSlug: string;
|
|
2517
|
+
|
|
2518
|
+
val: UnionMember9.Val;
|
|
2519
|
+
}
|
|
2520
|
+
|
|
2521
|
+
export namespace UnionMember9 {
|
|
2522
|
+
export interface Val {
|
|
2523
|
+
credentials_json: string;
|
|
2524
|
+
|
|
2525
|
+
account_id?: string;
|
|
2526
|
+
|
|
2527
|
+
account_url?: string;
|
|
2528
|
+
|
|
2529
|
+
api_url?: string;
|
|
2530
|
+
|
|
2531
|
+
base_url?: string;
|
|
2532
|
+
|
|
2533
|
+
borneo_dashboard_url?: string;
|
|
2534
|
+
|
|
2535
|
+
COMPANYDOMAIN?: string;
|
|
2536
|
+
|
|
2537
|
+
dc?: string;
|
|
2538
|
+
|
|
2539
|
+
domain?: string;
|
|
2540
|
+
|
|
2541
|
+
extension?: string;
|
|
2542
|
+
|
|
2543
|
+
form_api_base_url?: string;
|
|
2544
|
+
|
|
2545
|
+
instanceEndpoint?: string;
|
|
2546
|
+
|
|
2547
|
+
instanceName?: string;
|
|
2548
|
+
|
|
2549
|
+
proxy_password?: string;
|
|
2550
|
+
|
|
2551
|
+
proxy_username?: string;
|
|
2552
|
+
|
|
2553
|
+
region?: string;
|
|
2554
|
+
|
|
2555
|
+
server_location?: string;
|
|
2556
|
+
|
|
2557
|
+
shop?: string;
|
|
2558
|
+
|
|
2559
|
+
site_name?: string;
|
|
2560
|
+
|
|
2561
|
+
subdomain?: string;
|
|
2562
|
+
|
|
2563
|
+
version?: string;
|
|
2564
|
+
|
|
2565
|
+
your_server?: string;
|
|
2566
|
+
|
|
2567
|
+
'your-domain'?: string;
|
|
2568
|
+
|
|
2569
|
+
[k: string]: unknown;
|
|
2570
|
+
}
|
|
2571
|
+
}
|
|
2572
|
+
|
|
2573
|
+
export interface UnionMember10 {
|
|
2574
|
+
authScheme: 'S2S_OAUTH2';
|
|
2575
|
+
|
|
2576
|
+
toolkitSlug: string;
|
|
2577
|
+
|
|
2578
|
+
val: UnionMember10.Val;
|
|
2579
|
+
}
|
|
2580
|
+
|
|
2581
|
+
export namespace UnionMember10 {
|
|
2582
|
+
export interface Val {
|
|
2583
|
+
access_token: string;
|
|
2584
|
+
|
|
2585
|
+
client_id: string;
|
|
2586
|
+
|
|
2587
|
+
client_secret: string;
|
|
2588
|
+
|
|
2589
|
+
account_id?: string;
|
|
2590
|
+
|
|
2591
|
+
account_url?: string;
|
|
2592
|
+
|
|
2593
|
+
api_url?: string;
|
|
2594
|
+
|
|
2595
|
+
base_url?: string;
|
|
2596
|
+
|
|
2597
|
+
borneo_dashboard_url?: string;
|
|
2598
|
+
|
|
2599
|
+
COMPANYDOMAIN?: string;
|
|
2600
|
+
|
|
2601
|
+
dc?: string;
|
|
2602
|
+
|
|
2603
|
+
domain?: string;
|
|
2604
|
+
|
|
2605
|
+
expires_at?: string;
|
|
2606
|
+
|
|
2607
|
+
expires_in?: number | string | null;
|
|
2608
|
+
|
|
2609
|
+
extension?: string;
|
|
2610
|
+
|
|
2611
|
+
form_api_base_url?: string;
|
|
2612
|
+
|
|
2613
|
+
instanceEndpoint?: string;
|
|
2614
|
+
|
|
2615
|
+
instanceName?: string;
|
|
2616
|
+
|
|
2617
|
+
proxy_password?: string;
|
|
2618
|
+
|
|
2619
|
+
proxy_username?: string;
|
|
2620
|
+
|
|
2621
|
+
region?: string;
|
|
2622
|
+
|
|
2623
|
+
scope?: string | Array<string> | null;
|
|
2624
|
+
|
|
2625
|
+
server_location?: string;
|
|
2626
|
+
|
|
2627
|
+
shop?: string;
|
|
2628
|
+
|
|
2629
|
+
site_name?: string;
|
|
2630
|
+
|
|
2631
|
+
subdomain?: string;
|
|
2632
|
+
|
|
2633
|
+
token_type?: string;
|
|
2634
|
+
|
|
2635
|
+
version?: string;
|
|
2636
|
+
|
|
2637
|
+
your_server?: string;
|
|
2638
|
+
|
|
2639
|
+
'your-domain'?: string;
|
|
2640
|
+
|
|
2641
|
+
[k: string]: unknown;
|
|
2642
|
+
}
|
|
2643
|
+
}
|
|
2644
|
+
|
|
2645
|
+
export interface Parameter {
|
|
2646
|
+
/**
|
|
2647
|
+
* Parameter name
|
|
2648
|
+
*/
|
|
2649
|
+
name: string;
|
|
2650
|
+
|
|
2651
|
+
/**
|
|
2652
|
+
* Parameter type (header or query)
|
|
2653
|
+
*/
|
|
2654
|
+
type: 'header' | 'query';
|
|
2655
|
+
|
|
2656
|
+
/**
|
|
2657
|
+
* Parameter value
|
|
2658
|
+
*/
|
|
2659
|
+
value: string;
|
|
2660
|
+
}
|
|
2661
|
+
}
|
|
2662
|
+
|
|
1370
2663
|
export interface SessionSearchParams {
|
|
1371
2664
|
/**
|
|
1372
2665
|
* List of search queries to execute in parallel. Up to 7 queries supported.
|
|
@@ -1412,9 +2705,9 @@ export interface SessionToolkitsParams {
|
|
|
1412
2705
|
is_connected?: boolean | null;
|
|
1413
2706
|
|
|
1414
2707
|
/**
|
|
1415
|
-
* Number of items per page, max allowed is
|
|
2708
|
+
* Number of items per page, max allowed is 50
|
|
1416
2709
|
*/
|
|
1417
|
-
limit?: number
|
|
2710
|
+
limit?: number;
|
|
1418
2711
|
|
|
1419
2712
|
/**
|
|
1420
2713
|
* Search query to filter toolkits by name, slug, or description
|
|
@@ -1439,6 +2732,7 @@ export declare namespace Session {
|
|
|
1439
2732
|
type SessionExecuteResponse as SessionExecuteResponse,
|
|
1440
2733
|
type SessionExecuteMetaResponse as SessionExecuteMetaResponse,
|
|
1441
2734
|
type SessionLinkResponse as SessionLinkResponse,
|
|
2735
|
+
type SessionProxyExecuteResponse as SessionProxyExecuteResponse,
|
|
1442
2736
|
type SessionSearchResponse as SessionSearchResponse,
|
|
1443
2737
|
type SessionToolkitsResponse as SessionToolkitsResponse,
|
|
1444
2738
|
type SessionToolsResponse as SessionToolsResponse,
|
|
@@ -1446,6 +2740,7 @@ export declare namespace Session {
|
|
|
1446
2740
|
type SessionExecuteParams as SessionExecuteParams,
|
|
1447
2741
|
type SessionExecuteMetaParams as SessionExecuteMetaParams,
|
|
1448
2742
|
type SessionLinkParams as SessionLinkParams,
|
|
2743
|
+
type SessionProxyExecuteParams as SessionProxyExecuteParams,
|
|
1449
2744
|
type SessionSearchParams as SessionSearchParams,
|
|
1450
2745
|
type SessionToolkitsParams as SessionToolkitsParams,
|
|
1451
2746
|
type SessionToolsParams as SessionToolsParams,
|