@composio/client 0.1.0-alpha.61 → 0.1.0-alpha.62

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 (69) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/package.json +12 -1
  3. package/resources/auth-configs.d.mts +16 -0
  4. package/resources/auth-configs.d.mts.map +1 -1
  5. package/resources/auth-configs.d.ts +16 -0
  6. package/resources/auth-configs.d.ts.map +1 -1
  7. package/resources/connected-accounts.d.mts +890 -174
  8. package/resources/connected-accounts.d.mts.map +1 -1
  9. package/resources/connected-accounts.d.ts +890 -174
  10. package/resources/connected-accounts.d.ts.map +1 -1
  11. package/resources/link.d.mts +168 -1
  12. package/resources/link.d.mts.map +1 -1
  13. package/resources/link.d.ts +168 -1
  14. package/resources/link.d.ts.map +1 -1
  15. package/resources/tool-router/index.d.mts +1 -1
  16. package/resources/tool-router/index.d.mts.map +1 -1
  17. package/resources/tool-router/index.d.ts +1 -1
  18. package/resources/tool-router/index.d.ts.map +1 -1
  19. package/resources/tool-router/index.js.map +1 -1
  20. package/resources/tool-router/index.mjs.map +1 -1
  21. package/resources/tool-router/session/index.d.mts +1 -1
  22. package/resources/tool-router/session/index.d.mts.map +1 -1
  23. package/resources/tool-router/session/index.d.ts +1 -1
  24. package/resources/tool-router/session/index.d.ts.map +1 -1
  25. package/resources/tool-router/session/index.js.map +1 -1
  26. package/resources/tool-router/session/index.mjs.map +1 -1
  27. package/resources/tool-router/session/session.d.mts +793 -4
  28. package/resources/tool-router/session/session.d.mts.map +1 -1
  29. package/resources/tool-router/session/session.d.ts +793 -4
  30. package/resources/tool-router/session/session.d.ts.map +1 -1
  31. package/resources/tool-router/session/session.js +28 -0
  32. package/resources/tool-router/session/session.js.map +1 -1
  33. package/resources/tool-router/session/session.mjs +28 -0
  34. package/resources/tool-router/session/session.mjs.map +1 -1
  35. package/resources/tool-router/tool-router.d.mts +2 -2
  36. package/resources/tool-router/tool-router.d.mts.map +1 -1
  37. package/resources/tool-router/tool-router.d.ts +2 -2
  38. package/resources/tool-router/tool-router.d.ts.map +1 -1
  39. package/resources/tool-router/tool-router.js.map +1 -1
  40. package/resources/tool-router/tool-router.mjs.map +1 -1
  41. package/resources/toolkits.d.mts +13 -0
  42. package/resources/toolkits.d.mts.map +1 -1
  43. package/resources/toolkits.d.ts +13 -0
  44. package/resources/toolkits.d.ts.map +1 -1
  45. package/resources/tools.d.mts +80 -2
  46. package/resources/tools.d.mts.map +1 -1
  47. package/resources/tools.d.ts +80 -2
  48. package/resources/tools.d.ts.map +1 -1
  49. package/resources/trigger-instances/trigger-instances.d.mts +4 -0
  50. package/resources/trigger-instances/trigger-instances.d.mts.map +1 -1
  51. package/resources/trigger-instances/trigger-instances.d.ts +4 -0
  52. package/resources/trigger-instances/trigger-instances.d.ts.map +1 -1
  53. package/resources/trigger-instances/trigger-instances.js.map +1 -1
  54. package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
  55. package/src/resources/auth-configs.ts +20 -0
  56. package/src/resources/connected-accounts.ts +3140 -1744
  57. package/src/resources/link.ts +329 -1
  58. package/src/resources/tool-router/index.ts +2 -0
  59. package/src/resources/tool-router/session/index.ts +2 -0
  60. package/src/resources/tool-router/session/session.ts +1207 -3
  61. package/src/resources/tool-router/tool-router.ts +4 -0
  62. package/src/resources/toolkits.ts +16 -0
  63. package/src/resources/tools.ts +148 -2
  64. package/src/resources/trigger-instances/trigger-instances.ts +5 -0
  65. package/src/version.ts +1 -1
  66. package/version.d.mts +1 -1
  67. package/version.d.ts +1 -1
  68. package/version.js +1 -1
  69. package/version.mjs +1 -1
@@ -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
@@ -344,6 +377,12 @@ export namespace SessionCreateResponse {
344
377
  */
345
378
  auto_offload_threshold?: number;
346
379
 
380
+ /**
381
+ * Whether the workbench (code execution sandbox) is enabled. When false,
382
+ * COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
383
+ */
384
+ enable?: boolean;
385
+
347
386
  /**
348
387
  * Whether proxy execution is enabled in the workbench
349
388
  */
@@ -369,10 +408,75 @@ export namespace SessionCreateResponse {
369
408
  */
370
409
  export interface Experimental {
371
410
  /**
372
- * The assistive system prompt to inject into your agent for optimal tool router
373
- * usage
411
+ * The assistive system prompt for the tool router session
412
+ */
413
+ assistive_prompt?: string;
414
+
415
+ /**
416
+ * User-defined custom toolkits with grouped tools (no-auth)
417
+ */
418
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
419
+
420
+ /**
421
+ * Custom tools — standalone or extending Composio toolkits
374
422
  */
375
- assistive_prompt: string;
423
+ custom_tools?: Array<Experimental.CustomTool>;
424
+ }
425
+
426
+ export namespace Experimental {
427
+ export interface CustomToolkit {
428
+ description: string;
429
+
430
+ name: string;
431
+
432
+ slug: string;
433
+
434
+ tools: Array<CustomToolkit.Tool>;
435
+ }
436
+
437
+ export namespace CustomToolkit {
438
+ export interface Tool {
439
+ description: string;
440
+
441
+ input_schema: { [key: string]: unknown };
442
+
443
+ name: string;
444
+
445
+ /**
446
+ * Original tool slug as provided by the user
447
+ */
448
+ original_slug: string;
449
+
450
+ /**
451
+ * Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
452
+ */
453
+ slug: string;
454
+
455
+ output_schema?: { [key: string]: unknown };
456
+ }
457
+ }
458
+
459
+ export interface CustomTool {
460
+ description: string;
461
+
462
+ input_schema: { [key: string]: unknown };
463
+
464
+ name: string;
465
+
466
+ /**
467
+ * Original tool slug as provided by the user
468
+ */
469
+ original_slug: string;
470
+
471
+ /**
472
+ * Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
473
+ */
474
+ slug: string;
475
+
476
+ extends_toolkit?: string;
477
+
478
+ output_schema?: { [key: string]: unknown };
479
+ }
376
480
  }
377
481
  }
378
482
 
@@ -393,6 +497,11 @@ export interface SessionRetrieveResponse {
393
497
  * List of available tools in this session
394
498
  */
395
499
  tool_router_tools: Array<string>;
500
+
501
+ /**
502
+ * Experimental features
503
+ */
504
+ experimental?: SessionRetrieveResponse.Experimental;
396
505
  }
397
506
 
398
507
  export namespace SessionRetrieveResponse {
@@ -526,6 +635,12 @@ export namespace SessionRetrieveResponse {
526
635
  */
527
636
  auto_offload_threshold?: number;
528
637
 
638
+ /**
639
+ * Whether the workbench (code execution sandbox) is enabled. When false,
640
+ * COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
641
+ */
642
+ enable?: boolean;
643
+
529
644
  /**
530
645
  * Whether proxy execution is enabled in the workbench
531
646
  */
@@ -544,6 +659,82 @@ export namespace SessionRetrieveResponse {
544
659
  */
545
660
  url: string;
546
661
  }
662
+
663
+ /**
664
+ * Experimental features
665
+ */
666
+ export interface Experimental {
667
+ /**
668
+ * The assistive system prompt for the tool router session
669
+ */
670
+ assistive_prompt?: string;
671
+
672
+ /**
673
+ * User-defined custom toolkits with grouped tools (no-auth)
674
+ */
675
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
676
+
677
+ /**
678
+ * Custom tools — standalone or extending Composio toolkits
679
+ */
680
+ custom_tools?: Array<Experimental.CustomTool>;
681
+ }
682
+
683
+ export namespace Experimental {
684
+ export interface CustomToolkit {
685
+ description: string;
686
+
687
+ name: string;
688
+
689
+ slug: string;
690
+
691
+ tools: Array<CustomToolkit.Tool>;
692
+ }
693
+
694
+ export namespace CustomToolkit {
695
+ export interface Tool {
696
+ description: string;
697
+
698
+ input_schema: { [key: string]: unknown };
699
+
700
+ name: string;
701
+
702
+ /**
703
+ * Original tool slug as provided by the user
704
+ */
705
+ original_slug: string;
706
+
707
+ /**
708
+ * Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
709
+ */
710
+ slug: string;
711
+
712
+ output_schema?: { [key: string]: unknown };
713
+ }
714
+ }
715
+
716
+ export interface CustomTool {
717
+ description: string;
718
+
719
+ input_schema: { [key: string]: unknown };
720
+
721
+ name: string;
722
+
723
+ /**
724
+ * Original tool slug as provided by the user
725
+ */
726
+ original_slug: string;
727
+
728
+ /**
729
+ * Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
730
+ */
731
+ slug: string;
732
+
733
+ extends_toolkit?: string;
734
+
735
+ output_schema?: { [key: string]: unknown };
736
+ }
737
+ }
547
738
  }
548
739
 
549
740
  export interface SessionExecuteResponse {
@@ -597,6 +788,55 @@ export interface SessionLinkResponse {
597
788
  redirect_url: string;
598
789
  }
599
790
 
791
+ export interface SessionProxyExecuteResponse {
792
+ /**
793
+ * The HTTP status code returned from the proxied API
794
+ */
795
+ status: number;
796
+
797
+ /**
798
+ * Binary body response data. Present when the response is a binary file.
799
+ */
800
+ binary_data?: SessionProxyExecuteResponse.BinaryData;
801
+
802
+ /**
803
+ * The response data returned from the proxied API
804
+ */
805
+ data?: unknown;
806
+
807
+ /**
808
+ * The HTTP headers returned from the proxied API
809
+ */
810
+ headers?: { [key: string]: string };
811
+ }
812
+
813
+ export namespace SessionProxyExecuteResponse {
814
+ /**
815
+ * Binary body response data. Present when the response is a binary file.
816
+ */
817
+ export interface BinaryData {
818
+ /**
819
+ * Content-Type of the binary data
820
+ */
821
+ content_type: string;
822
+
823
+ /**
824
+ * File size in bytes
825
+ */
826
+ size: number;
827
+
828
+ /**
829
+ * URL to download binary content
830
+ */
831
+ url: string;
832
+
833
+ /**
834
+ * ISO 8601 timestamp when the URL expires
835
+ */
836
+ expires_at?: string;
837
+ }
838
+ }
839
+
600
840
  export interface SessionSearchResponse {
601
841
  /**
602
842
  * Error message if any searches failed, null if all succeeded. Format: "X out of Y
@@ -1194,6 +1434,18 @@ export namespace SessionCreateParams {
1194
1434
  * Customize assistive prompt generation (e.g., timezone).
1195
1435
  */
1196
1436
  assistive_prompt_config?: Experimental.AssistivePromptConfig;
1437
+
1438
+ /**
1439
+ * Custom toolkits with grouped tools. Toolkit slugs must not conflict with
1440
+ * existing Composio toolkits. All tools are no-auth.
1441
+ */
1442
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
1443
+
1444
+ /**
1445
+ * Custom tools to include in search. Standalone tools need no auth. Tools with
1446
+ * extends_toolkit inherit the Composio toolkit's connection.
1447
+ */
1448
+ custom_tools?: Array<Experimental.CustomTool>;
1197
1449
  }
1198
1450
 
1199
1451
  export namespace Experimental {
@@ -1207,6 +1459,93 @@ export namespace SessionCreateParams {
1207
1459
  */
1208
1460
  user_timezone?: string;
1209
1461
  }
1462
+
1463
+ export interface CustomToolkit {
1464
+ /**
1465
+ * Used for BM25 search matching and shown in toolkit connection statuses.
1466
+ */
1467
+ description: string;
1468
+
1469
+ /**
1470
+ * Display name shown to the LLM and in search results.
1471
+ */
1472
+ name: string;
1473
+
1474
+ /**
1475
+ * Unique slug for the toolkit. Must not conflict with existing Composio toolkit
1476
+ * slugs. Alphanumeric, underscores, and hyphens only.
1477
+ */
1478
+ slug: string;
1479
+
1480
+ /**
1481
+ * Tools in this custom toolkit
1482
+ */
1483
+ tools: Array<CustomToolkit.Tool>;
1484
+ }
1485
+
1486
+ export namespace CustomToolkit {
1487
+ export interface Tool {
1488
+ /**
1489
+ * Used for BM25 search matching and shown to the LLM.
1490
+ */
1491
+ description: string;
1492
+
1493
+ /**
1494
+ * Must have type: "object" and a properties field.
1495
+ */
1496
+ input_schema: { [key: string]: unknown };
1497
+
1498
+ /**
1499
+ * Human-readable display name
1500
+ */
1501
+ name: string;
1502
+
1503
+ /**
1504
+ * Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
1505
+ * chars total).
1506
+ */
1507
+ slug: string;
1508
+
1509
+ /**
1510
+ * Optional output schema for the tool response.
1511
+ */
1512
+ output_schema?: { [key: string]: unknown };
1513
+ }
1514
+ }
1515
+
1516
+ export interface CustomTool {
1517
+ /**
1518
+ * Used for BM25 search matching and shown to the LLM.
1519
+ */
1520
+ description: string;
1521
+
1522
+ /**
1523
+ * Must have type: "object" and a properties field.
1524
+ */
1525
+ input_schema: { [key: string]: unknown };
1526
+
1527
+ /**
1528
+ * Human-readable display name
1529
+ */
1530
+ name: string;
1531
+
1532
+ /**
1533
+ * Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
1534
+ * (extending). Max 60 chars total.
1535
+ */
1536
+ slug: string;
1537
+
1538
+ /**
1539
+ * If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
1540
+ * auth/connection status. If omitted, the tool is standalone (no-auth).
1541
+ */
1542
+ extends_toolkit?: string;
1543
+
1544
+ /**
1545
+ * JSON Schema describing tool output (optional)
1546
+ */
1547
+ output_schema?: { [key: string]: unknown };
1548
+ }
1210
1549
  }
1211
1550
 
1212
1551
  /**
@@ -1314,6 +1653,12 @@ export namespace SessionCreateParams {
1314
1653
  */
1315
1654
  auto_offload_threshold?: number;
1316
1655
 
1656
+ /**
1657
+ * Set to false to disable the workbench entirely. When disabled, no code execution
1658
+ * tools are available in the session.
1659
+ */
1660
+ enable?: boolean;
1661
+
1317
1662
  /**
1318
1663
  * Whether proxy execution is enabled. When enabled, workbench can call URLs and
1319
1664
  * APIs directly.
@@ -1367,6 +1712,863 @@ export interface SessionLinkParams {
1367
1712
  callback_url?: string;
1368
1713
  }
1369
1714
 
1715
+ export interface SessionProxyExecuteParams {
1716
+ /**
1717
+ * The API endpoint to call (absolute URL or path relative to base URL of the
1718
+ * connected account)
1719
+ */
1720
+ endpoint: string;
1721
+
1722
+ /**
1723
+ * The HTTP method to use for the request
1724
+ */
1725
+ method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';
1726
+
1727
+ /**
1728
+ * The slug of the toolkit to use for the request
1729
+ */
1730
+ toolkit_slug: string;
1731
+
1732
+ /**
1733
+ * Binary body to send. For binary upload via URL: use {url: "https://...",
1734
+ * content_type?: "..."}. For binary upload via base64: use {base64: "...",
1735
+ * content_type?: "..."}.
1736
+ */
1737
+ binary_body?: SessionProxyExecuteParams.UnionMember0 | SessionProxyExecuteParams.UnionMember1;
1738
+
1739
+ /**
1740
+ * The request body (for POST, PUT, and PATCH requests)
1741
+ */
1742
+ body?: unknown;
1743
+
1744
+ custom_connection_data?:
1745
+ | SessionProxyExecuteParams.UnionMember0
1746
+ | SessionProxyExecuteParams.UnionMember1
1747
+ | SessionProxyExecuteParams.UnionMember2
1748
+ | SessionProxyExecuteParams.UnionMember3
1749
+ | SessionProxyExecuteParams.UnionMember4
1750
+ | SessionProxyExecuteParams.UnionMember5
1751
+ | SessionProxyExecuteParams.UnionMember6
1752
+ | SessionProxyExecuteParams.UnionMember7
1753
+ | SessionProxyExecuteParams.UnionMember8
1754
+ | SessionProxyExecuteParams.UnionMember9
1755
+ | SessionProxyExecuteParams.UnionMember10;
1756
+
1757
+ /**
1758
+ * Additional HTTP headers or query parameters to include in the request
1759
+ */
1760
+ parameters?: Array<SessionProxyExecuteParams.Parameter>;
1761
+ }
1762
+
1763
+ export namespace SessionProxyExecuteParams {
1764
+ export interface UnionMember0 {
1765
+ /**
1766
+ * URL to fetch binary content from
1767
+ */
1768
+ url: string;
1769
+
1770
+ /**
1771
+ * Content-Type header to use for the request
1772
+ */
1773
+ content_type?: string;
1774
+ }
1775
+
1776
+ export interface UnionMember1 {
1777
+ /**
1778
+ * Base64-encoded binary data
1779
+ */
1780
+ base64: string;
1781
+
1782
+ /**
1783
+ * Content-Type header to use for the request
1784
+ */
1785
+ content_type?: string;
1786
+ }
1787
+
1788
+ export interface UnionMember0 {
1789
+ authScheme: 'OAUTH2';
1790
+
1791
+ toolkitSlug: string;
1792
+
1793
+ val: UnionMember0.Val;
1794
+ }
1795
+
1796
+ export namespace UnionMember0 {
1797
+ export interface Val {
1798
+ access_token: string;
1799
+
1800
+ account_id?: string;
1801
+
1802
+ account_url?: string;
1803
+
1804
+ api_url?: string;
1805
+
1806
+ /**
1807
+ * for slack user scopes
1808
+ */
1809
+ authed_user?: Val.AuthedUser;
1810
+
1811
+ base_url?: string;
1812
+
1813
+ borneo_dashboard_url?: string;
1814
+
1815
+ COMPANYDOMAIN?: string;
1816
+
1817
+ dc?: string;
1818
+
1819
+ domain?: string;
1820
+
1821
+ expires_in?: number | string | null;
1822
+
1823
+ extension?: string;
1824
+
1825
+ form_api_base_url?: string;
1826
+
1827
+ id_token?: string;
1828
+
1829
+ instanceEndpoint?: string;
1830
+
1831
+ instanceName?: string;
1832
+
1833
+ /**
1834
+ * Whether to return the redirect url without shortening
1835
+ */
1836
+ long_redirect_url?: boolean;
1837
+
1838
+ proxy_password?: string;
1839
+
1840
+ proxy_username?: string;
1841
+
1842
+ refresh_token?: string | null;
1843
+
1844
+ region?: string;
1845
+
1846
+ scope?: string | Array<string> | null;
1847
+
1848
+ server_location?: string;
1849
+
1850
+ shop?: string;
1851
+
1852
+ site_name?: string;
1853
+
1854
+ /**
1855
+ * The oauth2 state prefix for the connection
1856
+ */
1857
+ state_prefix?: string;
1858
+
1859
+ subdomain?: string;
1860
+
1861
+ token_type?: string;
1862
+
1863
+ version?: string;
1864
+
1865
+ webhook_signature?: string;
1866
+
1867
+ your_server?: string;
1868
+
1869
+ 'your-domain'?: string;
1870
+
1871
+ [k: string]: unknown;
1872
+ }
1873
+
1874
+ export namespace Val {
1875
+ /**
1876
+ * for slack user scopes
1877
+ */
1878
+ export interface AuthedUser {
1879
+ access_token?: string;
1880
+
1881
+ scope?: string;
1882
+ }
1883
+ }
1884
+ }
1885
+
1886
+ export interface UnionMember1 {
1887
+ authScheme: 'DCR_OAUTH';
1888
+
1889
+ toolkitSlug: string;
1890
+
1891
+ val: UnionMember1.Val;
1892
+ }
1893
+
1894
+ export namespace UnionMember1 {
1895
+ export interface Val {
1896
+ access_token: string;
1897
+
1898
+ /**
1899
+ * Dynamically registered client ID
1900
+ */
1901
+ client_id: string;
1902
+
1903
+ account_id?: string;
1904
+
1905
+ account_url?: string;
1906
+
1907
+ api_url?: string;
1908
+
1909
+ base_url?: string;
1910
+
1911
+ borneo_dashboard_url?: string;
1912
+
1913
+ client_id_issued_at?: number;
1914
+
1915
+ /**
1916
+ * Dynamically registered client secret
1917
+ */
1918
+ client_secret?: string;
1919
+
1920
+ client_secret_expires_at?: number;
1921
+
1922
+ COMPANYDOMAIN?: string;
1923
+
1924
+ dc?: string;
1925
+
1926
+ domain?: string;
1927
+
1928
+ expires_in?: number | string | null;
1929
+
1930
+ extension?: string;
1931
+
1932
+ form_api_base_url?: string;
1933
+
1934
+ id_token?: string;
1935
+
1936
+ instanceEndpoint?: string;
1937
+
1938
+ instanceName?: string;
1939
+
1940
+ /**
1941
+ * Whether to return the redirect url without shortening
1942
+ */
1943
+ long_redirect_url?: boolean;
1944
+
1945
+ proxy_password?: string;
1946
+
1947
+ proxy_username?: string;
1948
+
1949
+ refresh_token?: string | null;
1950
+
1951
+ region?: string;
1952
+
1953
+ scope?: string | Array<string> | null;
1954
+
1955
+ server_location?: string;
1956
+
1957
+ shop?: string;
1958
+
1959
+ site_name?: string;
1960
+
1961
+ /**
1962
+ * The oauth2 state prefix for the connection
1963
+ */
1964
+ state_prefix?: string;
1965
+
1966
+ subdomain?: string;
1967
+
1968
+ token_type?: string;
1969
+
1970
+ version?: string;
1971
+
1972
+ your_server?: string;
1973
+
1974
+ 'your-domain'?: string;
1975
+
1976
+ [k: string]: unknown;
1977
+ }
1978
+ }
1979
+
1980
+ export interface UnionMember2 {
1981
+ authScheme: 'API_KEY';
1982
+
1983
+ toolkitSlug: string;
1984
+
1985
+ val: UnionMember2.Val;
1986
+ }
1987
+
1988
+ export namespace UnionMember2 {
1989
+ export interface Val {
1990
+ account_id?: string;
1991
+
1992
+ account_url?: string;
1993
+
1994
+ api_key?: string;
1995
+
1996
+ api_url?: string;
1997
+
1998
+ base_url?: string;
1999
+
2000
+ basic_encoded?: string;
2001
+
2002
+ bearer_token?: string;
2003
+
2004
+ borneo_dashboard_url?: string;
2005
+
2006
+ COMPANYDOMAIN?: string;
2007
+
2008
+ dc?: string;
2009
+
2010
+ domain?: string;
2011
+
2012
+ extension?: string;
2013
+
2014
+ form_api_base_url?: string;
2015
+
2016
+ generic_api_key?: string;
2017
+
2018
+ instanceEndpoint?: string;
2019
+
2020
+ instanceName?: string;
2021
+
2022
+ proxy_password?: string;
2023
+
2024
+ proxy_username?: string;
2025
+
2026
+ region?: string;
2027
+
2028
+ server_location?: string;
2029
+
2030
+ shop?: string;
2031
+
2032
+ site_name?: string;
2033
+
2034
+ subdomain?: string;
2035
+
2036
+ version?: string;
2037
+
2038
+ your_server?: string;
2039
+
2040
+ 'your-domain'?: string;
2041
+
2042
+ [k: string]: unknown;
2043
+ }
2044
+ }
2045
+
2046
+ export interface UnionMember3 {
2047
+ authScheme: 'BASIC_WITH_JWT';
2048
+
2049
+ toolkitSlug: string;
2050
+
2051
+ val: UnionMember3.Val;
2052
+ }
2053
+
2054
+ export namespace UnionMember3 {
2055
+ export interface Val {
2056
+ password: string;
2057
+
2058
+ username: string;
2059
+
2060
+ account_id?: string;
2061
+
2062
+ account_url?: string;
2063
+
2064
+ api_url?: string;
2065
+
2066
+ base_url?: string;
2067
+
2068
+ borneo_dashboard_url?: string;
2069
+
2070
+ COMPANYDOMAIN?: string;
2071
+
2072
+ dc?: string;
2073
+
2074
+ domain?: string;
2075
+
2076
+ extension?: string;
2077
+
2078
+ form_api_base_url?: string;
2079
+
2080
+ instanceEndpoint?: string;
2081
+
2082
+ instanceName?: string;
2083
+
2084
+ proxy_password?: string;
2085
+
2086
+ proxy_username?: string;
2087
+
2088
+ region?: string;
2089
+
2090
+ server_location?: string;
2091
+
2092
+ shop?: string;
2093
+
2094
+ site_name?: string;
2095
+
2096
+ subdomain?: string;
2097
+
2098
+ version?: string;
2099
+
2100
+ your_server?: string;
2101
+
2102
+ 'your-domain'?: string;
2103
+
2104
+ [k: string]: unknown;
2105
+ }
2106
+ }
2107
+
2108
+ export interface UnionMember4 {
2109
+ authScheme: 'BASIC';
2110
+
2111
+ toolkitSlug: string;
2112
+
2113
+ val: UnionMember4.Val;
2114
+ }
2115
+
2116
+ export namespace UnionMember4 {
2117
+ export interface Val {
2118
+ username: string;
2119
+
2120
+ account_id?: string;
2121
+
2122
+ account_url?: string;
2123
+
2124
+ api_url?: string;
2125
+
2126
+ base_url?: string;
2127
+
2128
+ borneo_dashboard_url?: string;
2129
+
2130
+ COMPANYDOMAIN?: string;
2131
+
2132
+ dc?: string;
2133
+
2134
+ domain?: string;
2135
+
2136
+ extension?: string;
2137
+
2138
+ form_api_base_url?: string;
2139
+
2140
+ instanceEndpoint?: string;
2141
+
2142
+ instanceName?: string;
2143
+
2144
+ password?: string;
2145
+
2146
+ proxy_password?: string;
2147
+
2148
+ proxy_username?: string;
2149
+
2150
+ region?: string;
2151
+
2152
+ server_location?: string;
2153
+
2154
+ shop?: string;
2155
+
2156
+ site_name?: string;
2157
+
2158
+ subdomain?: string;
2159
+
2160
+ version?: string;
2161
+
2162
+ your_server?: string;
2163
+
2164
+ 'your-domain'?: string;
2165
+
2166
+ [k: string]: unknown;
2167
+ }
2168
+ }
2169
+
2170
+ export interface UnionMember5 {
2171
+ authScheme: 'BEARER_TOKEN';
2172
+
2173
+ toolkitSlug: string;
2174
+
2175
+ val: UnionMember5.Val;
2176
+ }
2177
+
2178
+ export namespace UnionMember5 {
2179
+ export interface Val {
2180
+ token: string;
2181
+
2182
+ account_id?: string;
2183
+
2184
+ account_url?: string;
2185
+
2186
+ api_url?: string;
2187
+
2188
+ base_url?: string;
2189
+
2190
+ borneo_dashboard_url?: string;
2191
+
2192
+ COMPANYDOMAIN?: string;
2193
+
2194
+ dc?: string;
2195
+
2196
+ domain?: string;
2197
+
2198
+ extension?: string;
2199
+
2200
+ form_api_base_url?: string;
2201
+
2202
+ instanceEndpoint?: string;
2203
+
2204
+ instanceName?: string;
2205
+
2206
+ proxy_password?: string;
2207
+
2208
+ proxy_username?: string;
2209
+
2210
+ region?: string;
2211
+
2212
+ server_location?: string;
2213
+
2214
+ shop?: string;
2215
+
2216
+ site_name?: string;
2217
+
2218
+ subdomain?: string;
2219
+
2220
+ version?: string;
2221
+
2222
+ your_server?: string;
2223
+
2224
+ 'your-domain'?: string;
2225
+
2226
+ [k: string]: unknown;
2227
+ }
2228
+ }
2229
+
2230
+ export interface UnionMember6 {
2231
+ authScheme: 'OAUTH1';
2232
+
2233
+ toolkitSlug: string;
2234
+
2235
+ val: UnionMember6.Val;
2236
+ }
2237
+
2238
+ export namespace UnionMember6 {
2239
+ export interface Val {
2240
+ oauth_token: string;
2241
+
2242
+ oauth_token_secret: string;
2243
+
2244
+ account_id?: string;
2245
+
2246
+ account_url?: string;
2247
+
2248
+ api_url?: string;
2249
+
2250
+ base_url?: string;
2251
+
2252
+ borneo_dashboard_url?: string;
2253
+
2254
+ callback_url?: string;
2255
+
2256
+ COMPANYDOMAIN?: string;
2257
+
2258
+ consumer_key?: string;
2259
+
2260
+ dc?: string;
2261
+
2262
+ domain?: string;
2263
+
2264
+ extension?: string;
2265
+
2266
+ form_api_base_url?: string;
2267
+
2268
+ instanceEndpoint?: string;
2269
+
2270
+ instanceName?: string;
2271
+
2272
+ oauth_verifier?: string;
2273
+
2274
+ proxy_password?: string;
2275
+
2276
+ proxy_username?: string;
2277
+
2278
+ redirectUrl?: string;
2279
+
2280
+ region?: string;
2281
+
2282
+ server_location?: string;
2283
+
2284
+ shop?: string;
2285
+
2286
+ site_name?: string;
2287
+
2288
+ subdomain?: string;
2289
+
2290
+ version?: string;
2291
+
2292
+ your_server?: string;
2293
+
2294
+ 'your-domain'?: string;
2295
+
2296
+ [k: string]: unknown;
2297
+ }
2298
+ }
2299
+
2300
+ export interface UnionMember7 {
2301
+ authScheme: 'NO_AUTH';
2302
+
2303
+ toolkitSlug: string;
2304
+
2305
+ val: UnionMember7.Val;
2306
+ }
2307
+
2308
+ export namespace UnionMember7 {
2309
+ export interface Val {
2310
+ account_id?: string;
2311
+
2312
+ account_url?: string;
2313
+
2314
+ api_url?: string;
2315
+
2316
+ base_url?: string;
2317
+
2318
+ borneo_dashboard_url?: string;
2319
+
2320
+ COMPANYDOMAIN?: string;
2321
+
2322
+ dc?: string;
2323
+
2324
+ domain?: string;
2325
+
2326
+ extension?: string;
2327
+
2328
+ form_api_base_url?: string;
2329
+
2330
+ instanceEndpoint?: string;
2331
+
2332
+ instanceName?: string;
2333
+
2334
+ proxy_password?: string;
2335
+
2336
+ proxy_username?: string;
2337
+
2338
+ region?: string;
2339
+
2340
+ server_location?: string;
2341
+
2342
+ shop?: string;
2343
+
2344
+ site_name?: string;
2345
+
2346
+ subdomain?: string;
2347
+
2348
+ version?: string;
2349
+
2350
+ your_server?: string;
2351
+
2352
+ 'your-domain'?: string;
2353
+
2354
+ [k: string]: unknown;
2355
+ }
2356
+ }
2357
+
2358
+ export interface UnionMember8 {
2359
+ authScheme: 'SERVICE_ACCOUNT';
2360
+
2361
+ toolkitSlug: string;
2362
+
2363
+ val: UnionMember8.Val;
2364
+ }
2365
+
2366
+ export namespace UnionMember8 {
2367
+ export interface Val {
2368
+ application_id: string;
2369
+
2370
+ installation_id: string;
2371
+
2372
+ private_key: string;
2373
+
2374
+ account_id?: string;
2375
+
2376
+ account_url?: string;
2377
+
2378
+ api_url?: string;
2379
+
2380
+ base_url?: string;
2381
+
2382
+ borneo_dashboard_url?: string;
2383
+
2384
+ COMPANYDOMAIN?: string;
2385
+
2386
+ dc?: string;
2387
+
2388
+ domain?: string;
2389
+
2390
+ extension?: string;
2391
+
2392
+ form_api_base_url?: string;
2393
+
2394
+ instanceEndpoint?: string;
2395
+
2396
+ instanceName?: string;
2397
+
2398
+ proxy_password?: string;
2399
+
2400
+ proxy_username?: string;
2401
+
2402
+ region?: string;
2403
+
2404
+ server_location?: string;
2405
+
2406
+ shop?: string;
2407
+
2408
+ site_name?: string;
2409
+
2410
+ subdomain?: string;
2411
+
2412
+ version?: string;
2413
+
2414
+ your_server?: string;
2415
+
2416
+ 'your-domain'?: string;
2417
+
2418
+ [k: string]: unknown;
2419
+ }
2420
+ }
2421
+
2422
+ export interface UnionMember9 {
2423
+ authScheme: 'GOOGLE_SERVICE_ACCOUNT';
2424
+
2425
+ toolkitSlug: string;
2426
+
2427
+ val: UnionMember9.Val;
2428
+ }
2429
+
2430
+ export namespace UnionMember9 {
2431
+ export interface Val {
2432
+ credentials_json: string;
2433
+
2434
+ account_id?: string;
2435
+
2436
+ account_url?: string;
2437
+
2438
+ api_url?: string;
2439
+
2440
+ base_url?: string;
2441
+
2442
+ borneo_dashboard_url?: string;
2443
+
2444
+ COMPANYDOMAIN?: string;
2445
+
2446
+ dc?: string;
2447
+
2448
+ domain?: string;
2449
+
2450
+ extension?: string;
2451
+
2452
+ form_api_base_url?: string;
2453
+
2454
+ instanceEndpoint?: string;
2455
+
2456
+ instanceName?: string;
2457
+
2458
+ proxy_password?: string;
2459
+
2460
+ proxy_username?: string;
2461
+
2462
+ region?: string;
2463
+
2464
+ server_location?: string;
2465
+
2466
+ shop?: string;
2467
+
2468
+ site_name?: string;
2469
+
2470
+ subdomain?: string;
2471
+
2472
+ version?: string;
2473
+
2474
+ your_server?: string;
2475
+
2476
+ 'your-domain'?: string;
2477
+
2478
+ [k: string]: unknown;
2479
+ }
2480
+ }
2481
+
2482
+ export interface UnionMember10 {
2483
+ authScheme: 'S2S_OAUTH2';
2484
+
2485
+ toolkitSlug: string;
2486
+
2487
+ val: UnionMember10.Val;
2488
+ }
2489
+
2490
+ export namespace UnionMember10 {
2491
+ export interface Val {
2492
+ access_token: string;
2493
+
2494
+ client_id: string;
2495
+
2496
+ client_secret: string;
2497
+
2498
+ account_id?: string;
2499
+
2500
+ account_url?: string;
2501
+
2502
+ api_url?: string;
2503
+
2504
+ base_url?: string;
2505
+
2506
+ borneo_dashboard_url?: string;
2507
+
2508
+ COMPANYDOMAIN?: string;
2509
+
2510
+ dc?: string;
2511
+
2512
+ domain?: string;
2513
+
2514
+ expires_at?: string;
2515
+
2516
+ expires_in?: number | string | null;
2517
+
2518
+ extension?: string;
2519
+
2520
+ form_api_base_url?: string;
2521
+
2522
+ instanceEndpoint?: string;
2523
+
2524
+ instanceName?: string;
2525
+
2526
+ proxy_password?: string;
2527
+
2528
+ proxy_username?: string;
2529
+
2530
+ region?: string;
2531
+
2532
+ scope?: string | Array<string> | null;
2533
+
2534
+ server_location?: string;
2535
+
2536
+ shop?: string;
2537
+
2538
+ site_name?: string;
2539
+
2540
+ subdomain?: string;
2541
+
2542
+ token_type?: string;
2543
+
2544
+ version?: string;
2545
+
2546
+ your_server?: string;
2547
+
2548
+ 'your-domain'?: string;
2549
+
2550
+ [k: string]: unknown;
2551
+ }
2552
+ }
2553
+
2554
+ export interface Parameter {
2555
+ /**
2556
+ * Parameter name
2557
+ */
2558
+ name: string;
2559
+
2560
+ /**
2561
+ * Parameter type (header or query)
2562
+ */
2563
+ type: 'header' | 'query';
2564
+
2565
+ /**
2566
+ * Parameter value
2567
+ */
2568
+ value: string;
2569
+ }
2570
+ }
2571
+
1370
2572
  export interface SessionSearchParams {
1371
2573
  /**
1372
2574
  * List of search queries to execute in parallel. Up to 7 queries supported.
@@ -1439,6 +2641,7 @@ export declare namespace Session {
1439
2641
  type SessionExecuteResponse as SessionExecuteResponse,
1440
2642
  type SessionExecuteMetaResponse as SessionExecuteMetaResponse,
1441
2643
  type SessionLinkResponse as SessionLinkResponse,
2644
+ type SessionProxyExecuteResponse as SessionProxyExecuteResponse,
1442
2645
  type SessionSearchResponse as SessionSearchResponse,
1443
2646
  type SessionToolkitsResponse as SessionToolkitsResponse,
1444
2647
  type SessionToolsResponse as SessionToolsResponse,
@@ -1446,6 +2649,7 @@ export declare namespace Session {
1446
2649
  type SessionExecuteParams as SessionExecuteParams,
1447
2650
  type SessionExecuteMetaParams as SessionExecuteMetaParams,
1448
2651
  type SessionLinkParams as SessionLinkParams,
2652
+ type SessionProxyExecuteParams as SessionProxyExecuteParams,
1449
2653
  type SessionSearchParams as SessionSearchParams,
1450
2654
  type SessionToolkitsParams as SessionToolkitsParams,
1451
2655
  type SessionToolsParams as SessionToolsParams,