@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.
Files changed (99) hide show
  1. package/CHANGELOG.md +53 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/internal/utils/env.js +2 -2
  9. package/internal/utils/env.js.map +1 -1
  10. package/internal/utils/env.mjs +2 -2
  11. package/internal/utils/env.mjs.map +1 -1
  12. package/package.json +12 -1
  13. package/resources/auth-configs.d.mts +17 -0
  14. package/resources/auth-configs.d.mts.map +1 -1
  15. package/resources/auth-configs.d.ts +17 -0
  16. package/resources/auth-configs.d.ts.map +1 -1
  17. package/resources/connected-accounts.d.mts +981 -137
  18. package/resources/connected-accounts.d.mts.map +1 -1
  19. package/resources/connected-accounts.d.ts +981 -137
  20. package/resources/connected-accounts.d.ts.map +1 -1
  21. package/resources/connected-accounts.js +27 -4
  22. package/resources/connected-accounts.js.map +1 -1
  23. package/resources/connected-accounts.mjs +27 -4
  24. package/resources/connected-accounts.mjs.map +1 -1
  25. package/resources/index.d.mts +1 -1
  26. package/resources/index.d.mts.map +1 -1
  27. package/resources/index.d.ts +1 -1
  28. package/resources/index.d.ts.map +1 -1
  29. package/resources/index.js.map +1 -1
  30. package/resources/index.mjs.map +1 -1
  31. package/resources/link.d.mts +168 -1
  32. package/resources/link.d.mts.map +1 -1
  33. package/resources/link.d.ts +168 -1
  34. package/resources/link.d.ts.map +1 -1
  35. package/resources/mcp/mcp.d.mts +1 -1
  36. package/resources/mcp/mcp.d.ts +1 -1
  37. package/resources/mcp/mcp.js +1 -1
  38. package/resources/mcp/mcp.mjs +1 -1
  39. package/resources/tool-router/index.d.mts +1 -1
  40. package/resources/tool-router/index.d.mts.map +1 -1
  41. package/resources/tool-router/index.d.ts +1 -1
  42. package/resources/tool-router/index.d.ts.map +1 -1
  43. package/resources/tool-router/index.js.map +1 -1
  44. package/resources/tool-router/index.mjs.map +1 -1
  45. package/resources/tool-router/session/index.d.mts +1 -1
  46. package/resources/tool-router/session/index.d.mts.map +1 -1
  47. package/resources/tool-router/session/index.d.ts +1 -1
  48. package/resources/tool-router/session/index.d.ts.map +1 -1
  49. package/resources/tool-router/session/index.js.map +1 -1
  50. package/resources/tool-router/session/index.mjs.map +1 -1
  51. package/resources/tool-router/session/session.d.mts +879 -12
  52. package/resources/tool-router/session/session.d.mts.map +1 -1
  53. package/resources/tool-router/session/session.d.ts +879 -12
  54. package/resources/tool-router/session/session.d.ts.map +1 -1
  55. package/resources/tool-router/session/session.js +29 -1
  56. package/resources/tool-router/session/session.js.map +1 -1
  57. package/resources/tool-router/session/session.mjs +29 -1
  58. package/resources/tool-router/session/session.mjs.map +1 -1
  59. package/resources/tool-router/tool-router.d.mts +4 -4
  60. package/resources/tool-router/tool-router.d.mts.map +1 -1
  61. package/resources/tool-router/tool-router.d.ts +4 -4
  62. package/resources/tool-router/tool-router.d.ts.map +1 -1
  63. package/resources/tool-router/tool-router.js +2 -2
  64. package/resources/tool-router/tool-router.js.map +1 -1
  65. package/resources/tool-router/tool-router.mjs +2 -2
  66. package/resources/tool-router/tool-router.mjs.map +1 -1
  67. package/resources/toolkits.d.mts +13 -0
  68. package/resources/toolkits.d.mts.map +1 -1
  69. package/resources/toolkits.d.ts +13 -0
  70. package/resources/toolkits.d.ts.map +1 -1
  71. package/resources/tools.d.mts +114 -2
  72. package/resources/tools.d.mts.map +1 -1
  73. package/resources/tools.d.ts +114 -2
  74. package/resources/tools.d.ts.map +1 -1
  75. package/resources/trigger-instances/trigger-instances.d.mts +6 -1
  76. package/resources/trigger-instances/trigger-instances.d.mts.map +1 -1
  77. package/resources/trigger-instances/trigger-instances.d.ts +6 -1
  78. package/resources/trigger-instances/trigger-instances.d.ts.map +1 -1
  79. package/resources/trigger-instances/trigger-instances.js.map +1 -1
  80. package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
  81. package/src/client.ts +4 -0
  82. package/src/internal/utils/env.ts +2 -2
  83. package/src/resources/auth-configs.ts +22 -0
  84. package/src/resources/connected-accounts.ts +3698 -2112
  85. package/src/resources/index.ts +2 -0
  86. package/src/resources/link.ts +329 -1
  87. package/src/resources/mcp/mcp.ts +1 -1
  88. package/src/resources/tool-router/index.ts +2 -0
  89. package/src/resources/tool-router/session/index.ts +2 -0
  90. package/src/resources/tool-router/session/session.ts +1343 -48
  91. package/src/resources/tool-router/tool-router.ts +6 -2
  92. package/src/resources/toolkits.ts +16 -0
  93. package/src/resources/tools.ts +188 -2
  94. package/src/resources/trigger-instances/trigger-instances.ts +7 -1
  95. package/src/version.ts +1 -1
  96. package/version.d.mts +1 -1
  97. package/version.d.ts +1 -1
  98. package/version.js +1 -1
  99. package/version.mjs +1 -1
@@ -45,7 +45,7 @@ export declare class Session extends APIResource {
45
45
  * ```ts
46
46
  * const response = await client.toolRouter.session.execute(
47
47
  * 'trs_LX9uJKBinWWr',
48
- * { tool_slug: 'GITHUB_CREATE_ISSUE' },
48
+ * { tool_slug: 'GITHUB_CREATE_AN_ISSUE' },
49
49
  * );
50
50
  * ```
51
51
  */
@@ -77,6 +77,29 @@ export declare class Session extends APIResource {
77
77
  * ```
78
78
  */
79
79
  link(sessionID: string, body: SessionLinkParams, options?: RequestOptions): APIPromise<SessionLinkResponse>;
80
+ /**
81
+ * Execute any native API call on a toolkit with authentication automatically
82
+ * injected from Composio. This endpoint proxies HTTP requests to third-party APIs
83
+ * using connected account credentials resolved from the session context. Provide
84
+ * the toolkit slug, API endpoint, and HTTP method — Composio handles
85
+ * authentication injection, abstracting away credential management. Supports all
86
+ * HTTP methods, custom headers/query parameters, and binary request/response
87
+ * bodies.
88
+ *
89
+ * @example
90
+ * ```ts
91
+ * const response =
92
+ * await client.toolRouter.session.proxyExecute(
93
+ * 'trs_LX9uJKBinWWr',
94
+ * {
95
+ * endpoint: '/api/v1/resources',
96
+ * method: 'GET',
97
+ * toolkit_slug: 'gmail',
98
+ * },
99
+ * );
100
+ * ```
101
+ */
102
+ proxyExecute(sessionID: string, body: SessionProxyExecuteParams, options?: RequestOptions): APIPromise<SessionProxyExecuteResponse>;
80
103
  /**
81
104
  * Search for tools matching a given use case query within a tool router session.
82
105
  * Returns matching tool slugs, full tool schemas, toolkit connection statuses, and
@@ -197,6 +220,10 @@ export declare namespace SessionCreateResponse {
197
220
  * Custom callback URL for connected account auth flows
198
221
  */
199
222
  callback_url?: string;
223
+ /**
224
+ * Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
225
+ */
226
+ enable_connection_removal?: boolean;
200
227
  /**
201
228
  * Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
202
229
  * Default false. May not work reliably with GPT models.
@@ -258,6 +285,11 @@ export declare namespace SessionCreateResponse {
258
285
  * workbench. Default is 20k.
259
286
  */
260
287
  auto_offload_threshold?: number;
288
+ /**
289
+ * Whether the workbench (code execution sandbox) is enabled. When false,
290
+ * COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
291
+ */
292
+ enable?: boolean;
261
293
  /**
262
294
  * Whether proxy execution is enabled in the workbench
263
295
  */
@@ -280,10 +312,64 @@ export declare namespace SessionCreateResponse {
280
312
  */
281
313
  interface Experimental {
282
314
  /**
283
- * The assistive system prompt to inject into your agent for optimal tool router
284
- * usage
315
+ * The assistive system prompt for the tool router session
316
+ */
317
+ assistive_prompt?: string;
318
+ /**
319
+ * User-defined custom toolkits with grouped tools (no-auth)
320
+ */
321
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
322
+ /**
323
+ * Custom tools — standalone or extending Composio toolkits
285
324
  */
286
- assistive_prompt: string;
325
+ custom_tools?: Array<Experimental.CustomTool>;
326
+ }
327
+ namespace Experimental {
328
+ interface CustomToolkit {
329
+ description: string;
330
+ name: string;
331
+ slug: string;
332
+ tools: Array<CustomToolkit.Tool>;
333
+ }
334
+ namespace CustomToolkit {
335
+ interface Tool {
336
+ description: string;
337
+ input_schema: {
338
+ [key: string]: unknown;
339
+ };
340
+ name: string;
341
+ /**
342
+ * Original tool slug as provided by the user
343
+ */
344
+ original_slug: string;
345
+ /**
346
+ * Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
347
+ */
348
+ slug: string;
349
+ output_schema?: {
350
+ [key: string]: unknown;
351
+ };
352
+ }
353
+ }
354
+ interface CustomTool {
355
+ description: string;
356
+ input_schema: {
357
+ [key: string]: unknown;
358
+ };
359
+ name: string;
360
+ /**
361
+ * Original tool slug as provided by the user
362
+ */
363
+ original_slug: string;
364
+ /**
365
+ * Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
366
+ */
367
+ slug: string;
368
+ extends_toolkit?: string;
369
+ output_schema?: {
370
+ [key: string]: unknown;
371
+ };
372
+ }
287
373
  }
288
374
  }
289
375
  export interface SessionRetrieveResponse {
@@ -300,6 +386,10 @@ export interface SessionRetrieveResponse {
300
386
  * List of available tools in this session
301
387
  */
302
388
  tool_router_tools: Array<string>;
389
+ /**
390
+ * Experimental features
391
+ */
392
+ experimental?: SessionRetrieveResponse.Experimental;
303
393
  }
304
394
  export declare namespace SessionRetrieveResponse {
305
395
  /**
@@ -356,6 +446,10 @@ export declare namespace SessionRetrieveResponse {
356
446
  * Custom callback URL for connected account auth flows
357
447
  */
358
448
  callback_url?: string;
449
+ /**
450
+ * Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
451
+ */
452
+ enable_connection_removal?: boolean;
359
453
  /**
360
454
  * Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
361
455
  * Default false. May not work reliably with GPT models.
@@ -417,6 +511,11 @@ export declare namespace SessionRetrieveResponse {
417
511
  * workbench. Default is 20k.
418
512
  */
419
513
  auto_offload_threshold?: number;
514
+ /**
515
+ * Whether the workbench (code execution sandbox) is enabled. When false,
516
+ * COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
517
+ */
518
+ enable?: boolean;
420
519
  /**
421
520
  * Whether proxy execution is enabled in the workbench
422
521
  */
@@ -433,6 +532,70 @@ export declare namespace SessionRetrieveResponse {
433
532
  */
434
533
  url: string;
435
534
  }
535
+ /**
536
+ * Experimental features
537
+ */
538
+ interface Experimental {
539
+ /**
540
+ * The assistive system prompt for the tool router session
541
+ */
542
+ assistive_prompt?: string;
543
+ /**
544
+ * User-defined custom toolkits with grouped tools (no-auth)
545
+ */
546
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
547
+ /**
548
+ * Custom tools — standalone or extending Composio toolkits
549
+ */
550
+ custom_tools?: Array<Experimental.CustomTool>;
551
+ }
552
+ namespace Experimental {
553
+ interface CustomToolkit {
554
+ description: string;
555
+ name: string;
556
+ slug: string;
557
+ tools: Array<CustomToolkit.Tool>;
558
+ }
559
+ namespace CustomToolkit {
560
+ interface Tool {
561
+ description: string;
562
+ input_schema: {
563
+ [key: string]: unknown;
564
+ };
565
+ name: string;
566
+ /**
567
+ * Original tool slug as provided by the user
568
+ */
569
+ original_slug: string;
570
+ /**
571
+ * Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
572
+ */
573
+ slug: string;
574
+ output_schema?: {
575
+ [key: string]: unknown;
576
+ };
577
+ }
578
+ }
579
+ interface CustomTool {
580
+ description: string;
581
+ input_schema: {
582
+ [key: string]: unknown;
583
+ };
584
+ name: string;
585
+ /**
586
+ * Original tool slug as provided by the user
587
+ */
588
+ original_slug: string;
589
+ /**
590
+ * Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
591
+ */
592
+ slug: string;
593
+ extends_toolkit?: string;
594
+ output_schema?: {
595
+ [key: string]: unknown;
596
+ };
597
+ }
598
+ }
436
599
  }
437
600
  export interface SessionExecuteResponse {
438
601
  /**
@@ -480,6 +643,49 @@ export interface SessionLinkResponse {
480
643
  */
481
644
  redirect_url: string;
482
645
  }
646
+ export interface SessionProxyExecuteResponse {
647
+ /**
648
+ * The HTTP status code returned from the proxied API
649
+ */
650
+ status: number;
651
+ /**
652
+ * Binary body response data. Present when the response is a binary file.
653
+ */
654
+ binary_data?: SessionProxyExecuteResponse.BinaryData;
655
+ /**
656
+ * The response data returned from the proxied API
657
+ */
658
+ data?: unknown;
659
+ /**
660
+ * The HTTP headers returned from the proxied API
661
+ */
662
+ headers?: {
663
+ [key: string]: string;
664
+ };
665
+ }
666
+ export declare namespace SessionProxyExecuteResponse {
667
+ /**
668
+ * Binary body response data. Present when the response is a binary file.
669
+ */
670
+ interface BinaryData {
671
+ /**
672
+ * Content-Type of the binary data
673
+ */
674
+ content_type: string;
675
+ /**
676
+ * File size in bytes
677
+ */
678
+ size: number;
679
+ /**
680
+ * URL to download binary content
681
+ */
682
+ url: string;
683
+ /**
684
+ * ISO 8601 timestamp when the URL expires
685
+ */
686
+ expires_at?: string;
687
+ }
688
+ }
483
689
  export interface SessionSearchResponse {
484
690
  /**
485
691
  * Error message if any searches failed, null if all succeeded. Format: "X out of Y
@@ -653,7 +859,8 @@ export declare namespace SessionSearchResponse {
653
859
  [key: string]: unknown;
654
860
  };
655
861
  /**
656
- * Output/response schema for the tool
862
+ * Output/response schema for the tool. Only included when include_output_schemas
863
+ * is true.
657
864
  */
658
865
  output_schema?: {
659
866
  [key: string]: unknown;
@@ -672,14 +879,14 @@ export declare namespace SessionSearchResponse {
672
879
  * Arguments to pass to the tool
673
880
  */
674
881
  args: SchemaRef.Args;
675
- /**
676
- * Instruction message for the LLM
677
- */
678
- message: string;
679
882
  /**
680
883
  * Tool to call
681
884
  */
682
885
  tool: 'COMPOSIO_GET_TOOL_SCHEMAS';
886
+ /**
887
+ * Instruction message for the LLM
888
+ */
889
+ message?: string;
683
890
  }
684
891
  namespace SchemaRef {
685
892
  /**
@@ -710,6 +917,16 @@ export declare namespace SessionSearchResponse {
710
917
  * The toolkit slug identifier (e.g., "gmail", "slack")
711
918
  */
712
919
  toolkit: string;
920
+ /**
921
+ * When "required", the agent must specify which account to use. Present only when
922
+ * multiple accounts exist.
923
+ */
924
+ account_selection?: 'required';
925
+ /**
926
+ * List of connected accounts for this toolkit. Present when multi-account is
927
+ * enabled.
928
+ */
929
+ accounts?: Array<ToolkitConnectionStatus.Account>;
713
930
  /**
714
931
  * Connection details including auth config and connected account IDs. Only present
715
932
  * when has_active_connection is true.
@@ -724,6 +941,36 @@ export declare namespace SessionSearchResponse {
724
941
  [key: string]: unknown;
725
942
  };
726
943
  }
944
+ namespace ToolkitConnectionStatus {
945
+ interface Account {
946
+ /**
947
+ * Unique identifier for this account
948
+ */
949
+ id: string;
950
+ /**
951
+ * ISO 8601 timestamp of when the account was connected
952
+ */
953
+ created_at: string;
954
+ /**
955
+ * Whether this is the default account for the toolkit
956
+ */
957
+ is_default: boolean;
958
+ /**
959
+ * Connection status (e.g., "active")
960
+ */
961
+ status: string;
962
+ /**
963
+ * User-assigned alias for this account
964
+ */
965
+ alias?: string;
966
+ /**
967
+ * Information about the connected user (email, name, etc.)
968
+ */
969
+ user_info?: {
970
+ [key: string]: unknown;
971
+ };
972
+ }
973
+ }
727
974
  }
728
975
  export interface SessionToolkitsResponse {
729
976
  current_page: number;
@@ -864,6 +1111,11 @@ export declare namespace SessionToolsResponse {
864
1111
  output_parameters: {
865
1112
  [key: string]: unknown;
866
1113
  };
1114
+ /**
1115
+ * Structured scope requirements for the tool. Null means the tool is legacy and
1116
+ * only exposes flat scopes.
1117
+ */
1118
+ scope_requirements: Item.ScopeRequirements | null;
867
1119
  /**
868
1120
  * List of scopes associated with the tool
869
1121
  */
@@ -914,6 +1166,18 @@ export declare namespace SessionToolsResponse {
914
1166
  logo: string;
915
1167
  }
916
1168
  }
1169
+ /**
1170
+ * Structured scope requirements for the tool. Null means the tool is legacy and
1171
+ * only exposes flat scopes.
1172
+ */
1173
+ interface ScopeRequirements {
1174
+ all_of: Array<string | ScopeRequirements.AnyOf>;
1175
+ }
1176
+ namespace ScopeRequirements {
1177
+ interface AnyOf {
1178
+ any_of: Array<string>;
1179
+ }
1180
+ }
917
1181
  interface Toolkit {
918
1182
  /**
919
1183
  * URL to the toolkit logo image
@@ -994,6 +1258,16 @@ export declare namespace SessionCreateParams {
994
1258
  * Customize assistive prompt generation (e.g., timezone).
995
1259
  */
996
1260
  assistive_prompt_config?: Experimental.AssistivePromptConfig;
1261
+ /**
1262
+ * Custom toolkits with grouped tools. Toolkit slugs must not conflict with
1263
+ * existing Composio toolkits. All tools are no-auth.
1264
+ */
1265
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
1266
+ /**
1267
+ * Custom tools to include in search. Standalone tools need no auth. Tools with
1268
+ * extends_toolkit inherit the Composio toolkit's connection.
1269
+ */
1270
+ custom_tools?: Array<Experimental.CustomTool>;
997
1271
  }
998
1272
  namespace Experimental {
999
1273
  /**
@@ -1006,6 +1280,86 @@ export declare namespace SessionCreateParams {
1006
1280
  */
1007
1281
  user_timezone?: string;
1008
1282
  }
1283
+ interface CustomToolkit {
1284
+ /**
1285
+ * Used for BM25 search matching and shown in toolkit connection statuses.
1286
+ */
1287
+ description: string;
1288
+ /**
1289
+ * Display name shown to the LLM and in search results.
1290
+ */
1291
+ name: string;
1292
+ /**
1293
+ * Unique slug for the toolkit. Must not conflict with existing Composio toolkit
1294
+ * slugs. Alphanumeric, underscores, and hyphens only.
1295
+ */
1296
+ slug: string;
1297
+ /**
1298
+ * Tools in this custom toolkit
1299
+ */
1300
+ tools: Array<CustomToolkit.Tool>;
1301
+ }
1302
+ namespace CustomToolkit {
1303
+ interface Tool {
1304
+ /**
1305
+ * Used for BM25 search matching and shown to the LLM.
1306
+ */
1307
+ description: string;
1308
+ /**
1309
+ * Must have type: "object" and a properties field.
1310
+ */
1311
+ input_schema: {
1312
+ [key: string]: unknown;
1313
+ };
1314
+ /**
1315
+ * Human-readable display name
1316
+ */
1317
+ name: string;
1318
+ /**
1319
+ * Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
1320
+ * chars total).
1321
+ */
1322
+ slug: string;
1323
+ /**
1324
+ * Optional output schema for the tool response.
1325
+ */
1326
+ output_schema?: {
1327
+ [key: string]: unknown;
1328
+ };
1329
+ }
1330
+ }
1331
+ interface CustomTool {
1332
+ /**
1333
+ * Used for BM25 search matching and shown to the LLM.
1334
+ */
1335
+ description: string;
1336
+ /**
1337
+ * Must have type: "object" and a properties field.
1338
+ */
1339
+ input_schema: {
1340
+ [key: string]: unknown;
1341
+ };
1342
+ /**
1343
+ * Human-readable display name
1344
+ */
1345
+ name: string;
1346
+ /**
1347
+ * Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
1348
+ * (extending). Max 60 chars total.
1349
+ */
1350
+ slug: string;
1351
+ /**
1352
+ * If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
1353
+ * auth/connection status. If omitted, the tool is standalone (no-auth).
1354
+ */
1355
+ extends_toolkit?: string;
1356
+ /**
1357
+ * JSON Schema describing tool output (optional)
1358
+ */
1359
+ output_schema?: {
1360
+ [key: string]: unknown;
1361
+ };
1362
+ }
1009
1363
  }
1010
1364
  /**
1011
1365
  * Configuration for connection management settings
@@ -1023,6 +1377,11 @@ export declare namespace SessionCreateParams {
1023
1377
  * connections manually.
1024
1378
  */
1025
1379
  enable?: boolean | null;
1380
+ /**
1381
+ * Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting
1382
+ * connected accounts. Default true.
1383
+ */
1384
+ enable_connection_removal?: boolean | null;
1026
1385
  /**
1027
1386
  * When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to
1028
1387
  * poll connection status after sharing auth URLs. Default is false (disabled). May
@@ -1099,6 +1458,11 @@ export declare namespace SessionCreateParams {
1099
1458
  * automatically based on the response size.
1100
1459
  */
1101
1460
  auto_offload_threshold?: number;
1461
+ /**
1462
+ * Set to false to disable the workbench entirely. When disabled, no code execution
1463
+ * tools are available in the session.
1464
+ */
1465
+ enable?: boolean;
1102
1466
  /**
1103
1467
  * Whether proxy execution is enabled. When enabled, workbench can call URLs and
1104
1468
  * APIs directly.
@@ -1111,6 +1475,13 @@ export interface SessionExecuteParams {
1111
1475
  * The unique slug identifier of the tool to execute
1112
1476
  */
1113
1477
  tool_slug: string;
1478
+ /**
1479
+ * Account identifier to specify which connected account to use. Use the account ID
1480
+ * (e.g. "coup_hurricane_dal_analytical") or an alias. When omitted with a single
1481
+ * account, the default is used. When omitted with multiple accounts, an error
1482
+ * lists available accounts.
1483
+ */
1484
+ account?: string;
1114
1485
  /**
1115
1486
  * The arguments required by the tool
1116
1487
  */
@@ -1140,6 +1511,502 @@ export interface SessionLinkParams {
1140
1511
  */
1141
1512
  callback_url?: string;
1142
1513
  }
1514
+ export interface SessionProxyExecuteParams {
1515
+ /**
1516
+ * The API endpoint to call (absolute URL or path relative to base URL of the
1517
+ * connected account)
1518
+ */
1519
+ endpoint: string;
1520
+ /**
1521
+ * The HTTP method to use for the request
1522
+ */
1523
+ method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';
1524
+ /**
1525
+ * The slug of the toolkit to use for the request
1526
+ */
1527
+ toolkit_slug: string;
1528
+ /**
1529
+ * Binary body to send. For binary upload via URL: use {url: "https://...",
1530
+ * content_type?: "..."}. For binary upload via base64: use {base64: "...",
1531
+ * content_type?: "..."}.
1532
+ */
1533
+ binary_body?: SessionProxyExecuteParams.UnionMember0 | SessionProxyExecuteParams.UnionMember1;
1534
+ /**
1535
+ * The request body (for POST, PUT, and PATCH requests)
1536
+ */
1537
+ body?: unknown;
1538
+ custom_connection_data?: SessionProxyExecuteParams.UnionMember0 | SessionProxyExecuteParams.UnionMember1 | SessionProxyExecuteParams.UnionMember2 | SessionProxyExecuteParams.UnionMember3 | SessionProxyExecuteParams.UnionMember4 | SessionProxyExecuteParams.UnionMember5 | SessionProxyExecuteParams.UnionMember6 | SessionProxyExecuteParams.UnionMember7 | SessionProxyExecuteParams.UnionMember8 | SessionProxyExecuteParams.UnionMember9 | SessionProxyExecuteParams.UnionMember10;
1539
+ /**
1540
+ * Additional HTTP headers or query parameters to include in the request
1541
+ */
1542
+ parameters?: Array<SessionProxyExecuteParams.Parameter>;
1543
+ }
1544
+ export declare namespace SessionProxyExecuteParams {
1545
+ interface UnionMember0 {
1546
+ /**
1547
+ * URL to fetch binary content from
1548
+ */
1549
+ url: string;
1550
+ /**
1551
+ * Content-Type header to use for the request
1552
+ */
1553
+ content_type?: string;
1554
+ }
1555
+ interface UnionMember1 {
1556
+ /**
1557
+ * Base64-encoded binary data
1558
+ */
1559
+ base64: string;
1560
+ /**
1561
+ * Content-Type header to use for the request
1562
+ */
1563
+ content_type?: string;
1564
+ }
1565
+ interface UnionMember0 {
1566
+ authScheme: 'OAUTH2';
1567
+ toolkitSlug: string;
1568
+ val: UnionMember0.Val;
1569
+ }
1570
+ namespace UnionMember0 {
1571
+ interface Val {
1572
+ access_token: string;
1573
+ account_id?: string;
1574
+ account_url?: string;
1575
+ api_url?: string;
1576
+ /**
1577
+ * for slack user scopes
1578
+ */
1579
+ authed_user?: Val.AuthedUser;
1580
+ base_url?: string;
1581
+ borneo_dashboard_url?: string;
1582
+ COMPANYDOMAIN?: string;
1583
+ dc?: string;
1584
+ domain?: string;
1585
+ expires_in?: number | string | null;
1586
+ extension?: string;
1587
+ form_api_base_url?: string;
1588
+ id_token?: string;
1589
+ instanceEndpoint?: string;
1590
+ instanceName?: string;
1591
+ /**
1592
+ * Whether to return the redirect url without shortening
1593
+ */
1594
+ long_redirect_url?: boolean;
1595
+ proxy_password?: string;
1596
+ proxy_username?: string;
1597
+ refresh_token?: string | null;
1598
+ region?: string;
1599
+ scope?: string | Array<string> | null;
1600
+ server_location?: string;
1601
+ shop?: string;
1602
+ site_name?: string;
1603
+ /**
1604
+ * The oauth2 state prefix for the connection
1605
+ */
1606
+ state_prefix?: string;
1607
+ subdomain?: string;
1608
+ token_type?: string;
1609
+ version?: string;
1610
+ webhook_signature?: string;
1611
+ your_server?: string;
1612
+ 'your-domain'?: string;
1613
+ [k: string]: unknown;
1614
+ }
1615
+ namespace Val {
1616
+ /**
1617
+ * for slack user scopes
1618
+ */
1619
+ interface AuthedUser {
1620
+ access_token?: string;
1621
+ scope?: string;
1622
+ }
1623
+ }
1624
+ }
1625
+ interface UnionMember1 {
1626
+ authScheme: 'DCR_OAUTH';
1627
+ toolkitSlug: string;
1628
+ val: UnionMember1.Val;
1629
+ }
1630
+ namespace UnionMember1 {
1631
+ interface Val {
1632
+ access_token: string;
1633
+ /**
1634
+ * Dynamically registered client ID
1635
+ */
1636
+ client_id: string;
1637
+ account_id?: string;
1638
+ account_url?: string;
1639
+ api_url?: string;
1640
+ base_url?: string;
1641
+ borneo_dashboard_url?: string;
1642
+ client_id_issued_at?: number;
1643
+ /**
1644
+ * Dynamically registered client secret
1645
+ */
1646
+ client_secret?: string;
1647
+ client_secret_expires_at?: number;
1648
+ COMPANYDOMAIN?: string;
1649
+ dc?: string;
1650
+ domain?: string;
1651
+ expires_in?: number | string | null;
1652
+ extension?: string;
1653
+ form_api_base_url?: string;
1654
+ id_token?: string;
1655
+ instanceEndpoint?: string;
1656
+ instanceName?: string;
1657
+ /**
1658
+ * Whether to return the redirect url without shortening
1659
+ */
1660
+ long_redirect_url?: boolean;
1661
+ proxy_password?: string;
1662
+ proxy_username?: string;
1663
+ refresh_token?: string | null;
1664
+ region?: string;
1665
+ scope?: string | Array<string> | null;
1666
+ server_location?: string;
1667
+ shop?: string;
1668
+ site_name?: string;
1669
+ /**
1670
+ * The oauth2 state prefix for the connection
1671
+ */
1672
+ state_prefix?: string;
1673
+ subdomain?: string;
1674
+ token_type?: string;
1675
+ version?: string;
1676
+ your_server?: string;
1677
+ 'your-domain'?: string;
1678
+ [k: string]: unknown;
1679
+ }
1680
+ }
1681
+ interface UnionMember2 {
1682
+ authScheme: 'API_KEY';
1683
+ toolkitSlug: string;
1684
+ val: UnionMember2.Val;
1685
+ }
1686
+ namespace UnionMember2 {
1687
+ interface Val {
1688
+ account_id?: string;
1689
+ account_url?: string;
1690
+ api_key?: string;
1691
+ api_url?: string;
1692
+ base_url?: string;
1693
+ basic_encoded?: string;
1694
+ bearer_token?: string;
1695
+ borneo_dashboard_url?: string;
1696
+ COMPANYDOMAIN?: string;
1697
+ dc?: string;
1698
+ domain?: string;
1699
+ extension?: string;
1700
+ form_api_base_url?: string;
1701
+ generic_api_key?: string;
1702
+ instanceEndpoint?: string;
1703
+ instanceName?: string;
1704
+ proxy_password?: string;
1705
+ proxy_username?: string;
1706
+ region?: string;
1707
+ server_location?: string;
1708
+ shop?: string;
1709
+ site_name?: string;
1710
+ subdomain?: string;
1711
+ version?: string;
1712
+ your_server?: string;
1713
+ 'your-domain'?: string;
1714
+ [k: string]: unknown;
1715
+ }
1716
+ }
1717
+ interface UnionMember3 {
1718
+ authScheme: 'BASIC_WITH_JWT';
1719
+ toolkitSlug: string;
1720
+ val: UnionMember3.Val;
1721
+ }
1722
+ namespace UnionMember3 {
1723
+ interface Val {
1724
+ password: string;
1725
+ username: string;
1726
+ account_id?: string;
1727
+ account_url?: string;
1728
+ api_url?: string;
1729
+ base_url?: string;
1730
+ borneo_dashboard_url?: string;
1731
+ COMPANYDOMAIN?: string;
1732
+ dc?: string;
1733
+ domain?: string;
1734
+ extension?: string;
1735
+ form_api_base_url?: string;
1736
+ instanceEndpoint?: string;
1737
+ instanceName?: string;
1738
+ proxy_password?: string;
1739
+ proxy_username?: string;
1740
+ region?: string;
1741
+ server_location?: string;
1742
+ shop?: string;
1743
+ site_name?: string;
1744
+ subdomain?: string;
1745
+ version?: string;
1746
+ your_server?: string;
1747
+ 'your-domain'?: string;
1748
+ [k: string]: unknown;
1749
+ }
1750
+ }
1751
+ interface UnionMember4 {
1752
+ authScheme: 'BASIC';
1753
+ toolkitSlug: string;
1754
+ val: UnionMember4.Val;
1755
+ }
1756
+ namespace UnionMember4 {
1757
+ interface Val {
1758
+ username: string;
1759
+ account_id?: string;
1760
+ account_url?: string;
1761
+ api_url?: string;
1762
+ base_url?: string;
1763
+ borneo_dashboard_url?: string;
1764
+ COMPANYDOMAIN?: string;
1765
+ dc?: string;
1766
+ domain?: string;
1767
+ extension?: string;
1768
+ form_api_base_url?: string;
1769
+ instanceEndpoint?: string;
1770
+ instanceName?: string;
1771
+ password?: string;
1772
+ proxy_password?: string;
1773
+ proxy_username?: string;
1774
+ region?: string;
1775
+ server_location?: string;
1776
+ shop?: string;
1777
+ site_name?: string;
1778
+ subdomain?: string;
1779
+ version?: string;
1780
+ your_server?: string;
1781
+ 'your-domain'?: string;
1782
+ [k: string]: unknown;
1783
+ }
1784
+ }
1785
+ interface UnionMember5 {
1786
+ authScheme: 'BEARER_TOKEN';
1787
+ toolkitSlug: string;
1788
+ val: UnionMember5.Val;
1789
+ }
1790
+ namespace UnionMember5 {
1791
+ interface Val {
1792
+ token: string;
1793
+ account_id?: string;
1794
+ account_url?: string;
1795
+ api_url?: string;
1796
+ base_url?: string;
1797
+ borneo_dashboard_url?: string;
1798
+ COMPANYDOMAIN?: string;
1799
+ dc?: string;
1800
+ domain?: string;
1801
+ extension?: string;
1802
+ form_api_base_url?: string;
1803
+ instanceEndpoint?: string;
1804
+ instanceName?: string;
1805
+ proxy_password?: string;
1806
+ proxy_username?: string;
1807
+ region?: string;
1808
+ server_location?: string;
1809
+ shop?: string;
1810
+ site_name?: string;
1811
+ subdomain?: string;
1812
+ version?: string;
1813
+ your_server?: string;
1814
+ 'your-domain'?: string;
1815
+ [k: string]: unknown;
1816
+ }
1817
+ }
1818
+ interface UnionMember6 {
1819
+ authScheme: 'OAUTH1';
1820
+ toolkitSlug: string;
1821
+ val: UnionMember6.Val;
1822
+ }
1823
+ namespace UnionMember6 {
1824
+ interface Val {
1825
+ oauth_token: string;
1826
+ oauth_token_secret: string;
1827
+ account_id?: string;
1828
+ account_url?: string;
1829
+ api_url?: string;
1830
+ base_url?: string;
1831
+ borneo_dashboard_url?: string;
1832
+ callback_url?: string;
1833
+ COMPANYDOMAIN?: string;
1834
+ consumer_key?: string;
1835
+ dc?: string;
1836
+ domain?: string;
1837
+ extension?: string;
1838
+ form_api_base_url?: string;
1839
+ instanceEndpoint?: string;
1840
+ instanceName?: string;
1841
+ oauth_verifier?: string;
1842
+ proxy_password?: string;
1843
+ proxy_username?: string;
1844
+ redirectUrl?: string;
1845
+ region?: string;
1846
+ server_location?: string;
1847
+ shop?: string;
1848
+ site_name?: string;
1849
+ subdomain?: string;
1850
+ version?: string;
1851
+ your_server?: string;
1852
+ 'your-domain'?: string;
1853
+ [k: string]: unknown;
1854
+ }
1855
+ }
1856
+ interface UnionMember7 {
1857
+ authScheme: 'NO_AUTH';
1858
+ toolkitSlug: string;
1859
+ val: UnionMember7.Val;
1860
+ }
1861
+ namespace UnionMember7 {
1862
+ interface Val {
1863
+ account_id?: string;
1864
+ account_url?: string;
1865
+ api_url?: string;
1866
+ base_url?: string;
1867
+ borneo_dashboard_url?: string;
1868
+ COMPANYDOMAIN?: string;
1869
+ dc?: string;
1870
+ domain?: string;
1871
+ extension?: string;
1872
+ form_api_base_url?: string;
1873
+ instanceEndpoint?: string;
1874
+ instanceName?: string;
1875
+ proxy_password?: string;
1876
+ proxy_username?: string;
1877
+ region?: string;
1878
+ server_location?: string;
1879
+ shop?: string;
1880
+ site_name?: string;
1881
+ subdomain?: string;
1882
+ version?: string;
1883
+ your_server?: string;
1884
+ 'your-domain'?: string;
1885
+ [k: string]: unknown;
1886
+ }
1887
+ }
1888
+ interface UnionMember8 {
1889
+ authScheme: 'SERVICE_ACCOUNT';
1890
+ toolkitSlug: string;
1891
+ val: UnionMember8.Val;
1892
+ }
1893
+ namespace UnionMember8 {
1894
+ interface Val {
1895
+ application_id: string;
1896
+ installation_id: string;
1897
+ private_key: string;
1898
+ account_id?: string;
1899
+ account_url?: string;
1900
+ api_url?: string;
1901
+ base_url?: string;
1902
+ borneo_dashboard_url?: string;
1903
+ COMPANYDOMAIN?: string;
1904
+ dc?: string;
1905
+ domain?: string;
1906
+ extension?: string;
1907
+ form_api_base_url?: string;
1908
+ instanceEndpoint?: string;
1909
+ instanceName?: string;
1910
+ proxy_password?: string;
1911
+ proxy_username?: string;
1912
+ region?: string;
1913
+ server_location?: string;
1914
+ shop?: string;
1915
+ site_name?: string;
1916
+ subdomain?: string;
1917
+ version?: string;
1918
+ your_server?: string;
1919
+ 'your-domain'?: string;
1920
+ [k: string]: unknown;
1921
+ }
1922
+ }
1923
+ interface UnionMember9 {
1924
+ authScheme: 'GOOGLE_SERVICE_ACCOUNT';
1925
+ toolkitSlug: string;
1926
+ val: UnionMember9.Val;
1927
+ }
1928
+ namespace UnionMember9 {
1929
+ interface Val {
1930
+ credentials_json: string;
1931
+ account_id?: string;
1932
+ account_url?: string;
1933
+ api_url?: string;
1934
+ base_url?: string;
1935
+ borneo_dashboard_url?: string;
1936
+ COMPANYDOMAIN?: string;
1937
+ dc?: string;
1938
+ domain?: string;
1939
+ extension?: string;
1940
+ form_api_base_url?: string;
1941
+ instanceEndpoint?: string;
1942
+ instanceName?: string;
1943
+ proxy_password?: string;
1944
+ proxy_username?: string;
1945
+ region?: string;
1946
+ server_location?: string;
1947
+ shop?: string;
1948
+ site_name?: string;
1949
+ subdomain?: string;
1950
+ version?: string;
1951
+ your_server?: string;
1952
+ 'your-domain'?: string;
1953
+ [k: string]: unknown;
1954
+ }
1955
+ }
1956
+ interface UnionMember10 {
1957
+ authScheme: 'S2S_OAUTH2';
1958
+ toolkitSlug: string;
1959
+ val: UnionMember10.Val;
1960
+ }
1961
+ namespace UnionMember10 {
1962
+ interface Val {
1963
+ access_token: string;
1964
+ client_id: string;
1965
+ client_secret: string;
1966
+ account_id?: string;
1967
+ account_url?: string;
1968
+ api_url?: string;
1969
+ base_url?: string;
1970
+ borneo_dashboard_url?: string;
1971
+ COMPANYDOMAIN?: string;
1972
+ dc?: string;
1973
+ domain?: string;
1974
+ expires_at?: string;
1975
+ expires_in?: number | string | null;
1976
+ extension?: string;
1977
+ form_api_base_url?: string;
1978
+ instanceEndpoint?: string;
1979
+ instanceName?: string;
1980
+ proxy_password?: string;
1981
+ proxy_username?: string;
1982
+ region?: string;
1983
+ scope?: string | Array<string> | null;
1984
+ server_location?: string;
1985
+ shop?: string;
1986
+ site_name?: string;
1987
+ subdomain?: string;
1988
+ token_type?: string;
1989
+ version?: string;
1990
+ your_server?: string;
1991
+ 'your-domain'?: string;
1992
+ [k: string]: unknown;
1993
+ }
1994
+ }
1995
+ interface Parameter {
1996
+ /**
1997
+ * Parameter name
1998
+ */
1999
+ name: string;
2000
+ /**
2001
+ * Parameter type (header or query)
2002
+ */
2003
+ type: 'header' | 'query';
2004
+ /**
2005
+ * Parameter value
2006
+ */
2007
+ value: string;
2008
+ }
2009
+ }
1143
2010
  export interface SessionSearchParams {
1144
2011
  /**
1145
2012
  * List of search queries to execute in parallel. Up to 7 queries supported.
@@ -1179,9 +2046,9 @@ export interface SessionToolkitsParams {
1179
2046
  */
1180
2047
  is_connected?: boolean | null;
1181
2048
  /**
1182
- * Number of items per page, max allowed is 1000
2049
+ * Number of items per page, max allowed is 50
1183
2050
  */
1184
- limit?: number | null;
2051
+ limit?: number;
1185
2052
  /**
1186
2053
  * Search query to filter toolkits by name, slug, or description
1187
2054
  */
@@ -1195,7 +2062,7 @@ export interface SessionToolkitsParams {
1195
2062
  export interface SessionToolsParams {
1196
2063
  }
1197
2064
  export declare namespace Session {
1198
- export { type SessionCreateResponse as SessionCreateResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionExecuteResponse as SessionExecuteResponse, type SessionExecuteMetaResponse as SessionExecuteMetaResponse, type SessionLinkResponse as SessionLinkResponse, type SessionSearchResponse as SessionSearchResponse, type SessionToolkitsResponse as SessionToolkitsResponse, type SessionToolsResponse as SessionToolsResponse, type SessionCreateParams as SessionCreateParams, type SessionExecuteParams as SessionExecuteParams, type SessionExecuteMetaParams as SessionExecuteMetaParams, type SessionLinkParams as SessionLinkParams, type SessionSearchParams as SessionSearchParams, type SessionToolkitsParams as SessionToolkitsParams, type SessionToolsParams as SessionToolsParams, };
2065
+ export { type SessionCreateResponse as SessionCreateResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionExecuteResponse as SessionExecuteResponse, type SessionExecuteMetaResponse as SessionExecuteMetaResponse, type SessionLinkResponse as SessionLinkResponse, type SessionProxyExecuteResponse as SessionProxyExecuteResponse, type SessionSearchResponse as SessionSearchResponse, type SessionToolkitsResponse as SessionToolkitsResponse, type SessionToolsResponse as SessionToolsResponse, type SessionCreateParams as SessionCreateParams, type SessionExecuteParams as SessionExecuteParams, type SessionExecuteMetaParams as SessionExecuteMetaParams, type SessionLinkParams as SessionLinkParams, type SessionProxyExecuteParams as SessionProxyExecuteParams, type SessionSearchParams as SessionSearchParams, type SessionToolkitsParams as SessionToolkitsParams, type SessionToolsParams as SessionToolsParams, };
1199
2066
  export { Files as Files, type FileListResponse as FileListResponse, type FileDeleteResponse as FileDeleteResponse, type FileCreateDownloadURLResponse as FileCreateDownloadURLResponse, type FileCreateUploadURLResponse as FileCreateUploadURLResponse, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, type FileCreateDownloadURLParams as FileCreateDownloadURLParams, type FileCreateUploadURLParams as FileCreateUploadURLParams, };
1200
2067
  }
1201
2068
  //# sourceMappingURL=session.d.ts.map