@composio/client 0.1.0-alpha.10 → 0.1.0-alpha.11

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 (170) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/client.d.mts +6 -6
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +6 -6
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/auth-configs.d.mts +163 -24
  10. package/resources/auth-configs.d.mts.map +1 -1
  11. package/resources/auth-configs.d.ts +163 -24
  12. package/resources/auth-configs.d.ts.map +1 -1
  13. package/resources/auth-configs.js +50 -4
  14. package/resources/auth-configs.js.map +1 -1
  15. package/resources/auth-configs.mjs +50 -4
  16. package/resources/auth-configs.mjs.map +1 -1
  17. package/resources/connected-accounts.d.mts +80 -17
  18. package/resources/connected-accounts.d.mts.map +1 -1
  19. package/resources/connected-accounts.d.ts +80 -17
  20. package/resources/connected-accounts.d.ts.map +1 -1
  21. package/resources/connected-accounts.js +56 -4
  22. package/resources/connected-accounts.js.map +1 -1
  23. package/resources/connected-accounts.mjs +56 -4
  24. package/resources/connected-accounts.mjs.map +1 -1
  25. package/resources/files.d.mts +56 -23
  26. package/resources/files.d.mts.map +1 -1
  27. package/resources/files.d.ts +56 -23
  28. package/resources/files.d.ts.map +1 -1
  29. package/resources/files.js +20 -2
  30. package/resources/files.js.map +1 -1
  31. package/resources/files.mjs +20 -2
  32. package/resources/files.mjs.map +1 -1
  33. package/resources/index.d.mts +3 -3
  34. package/resources/index.d.mts.map +1 -1
  35. package/resources/index.d.ts +3 -3
  36. package/resources/index.d.ts.map +1 -1
  37. package/resources/index.js.map +1 -1
  38. package/resources/index.mjs.map +1 -1
  39. package/resources/mcp/command.d.mts +0 -33
  40. package/resources/mcp/command.d.mts.map +1 -1
  41. package/resources/mcp/command.d.ts +0 -33
  42. package/resources/mcp/command.d.ts.map +1 -1
  43. package/resources/mcp/command.js +0 -6
  44. package/resources/mcp/command.js.map +1 -1
  45. package/resources/mcp/command.mjs +0 -6
  46. package/resources/mcp/command.mjs.map +1 -1
  47. package/resources/mcp/index.d.mts +2 -2
  48. package/resources/mcp/index.d.mts.map +1 -1
  49. package/resources/mcp/index.d.ts +2 -2
  50. package/resources/mcp/index.d.ts.map +1 -1
  51. package/resources/mcp/index.js.map +1 -1
  52. package/resources/mcp/index.mjs.map +1 -1
  53. package/resources/mcp/mcp.d.mts +232 -235
  54. package/resources/mcp/mcp.d.mts.map +1 -1
  55. package/resources/mcp/mcp.d.ts +232 -235
  56. package/resources/mcp/mcp.d.ts.map +1 -1
  57. package/resources/mcp/mcp.js +55 -19
  58. package/resources/mcp/mcp.js.map +1 -1
  59. package/resources/mcp/mcp.mjs +55 -19
  60. package/resources/mcp/mcp.mjs.map +1 -1
  61. package/resources/migration.d.mts +11 -2
  62. package/resources/migration.d.mts.map +1 -1
  63. package/resources/migration.d.ts +11 -2
  64. package/resources/migration.d.ts.map +1 -1
  65. package/resources/migration.js +3 -1
  66. package/resources/migration.js.map +1 -1
  67. package/resources/migration.mjs +3 -1
  68. package/resources/migration.mjs.map +1 -1
  69. package/resources/org/api-key.d.mts +23 -2
  70. package/resources/org/api-key.d.mts.map +1 -1
  71. package/resources/org/api-key.d.ts +23 -2
  72. package/resources/org/api-key.d.ts.map +1 -1
  73. package/resources/org/api-key.js +15 -2
  74. package/resources/org/api-key.js.map +1 -1
  75. package/resources/org/api-key.mjs +15 -2
  76. package/resources/org/api-key.mjs.map +1 -1
  77. package/resources/org/project/api-keys.d.mts +97 -20
  78. package/resources/org/project/api-keys.d.mts.map +1 -1
  79. package/resources/org/project/api-keys.d.ts +97 -20
  80. package/resources/org/project/api-keys.d.ts.map +1 -1
  81. package/resources/org/project/api-keys.js +57 -0
  82. package/resources/org/project/api-keys.js.map +1 -1
  83. package/resources/org/project/api-keys.mjs +57 -0
  84. package/resources/org/project/api-keys.mjs.map +1 -1
  85. package/resources/org/project/project.d.mts +176 -4
  86. package/resources/org/project/project.d.mts.map +1 -1
  87. package/resources/org/project/project.d.ts +176 -4
  88. package/resources/org/project/project.d.ts.map +1 -1
  89. package/resources/org/project/project.js +46 -3
  90. package/resources/org/project/project.js.map +1 -1
  91. package/resources/org/project/project.mjs +46 -3
  92. package/resources/org/project/project.mjs.map +1 -1
  93. package/resources/org/project/trigger.d.mts +101 -1
  94. package/resources/org/project/trigger.d.mts.map +1 -1
  95. package/resources/org/project/trigger.d.ts +101 -1
  96. package/resources/org/project/trigger.d.ts.map +1 -1
  97. package/resources/org/project/trigger.js +21 -0
  98. package/resources/org/project/trigger.js.map +1 -1
  99. package/resources/org/project/trigger.mjs +21 -0
  100. package/resources/org/project/trigger.mjs.map +1 -1
  101. package/resources/org/project/webhook.d.mts +86 -15
  102. package/resources/org/project/webhook.d.mts.map +1 -1
  103. package/resources/org/project/webhook.d.ts +86 -15
  104. package/resources/org/project/webhook.d.ts.map +1 -1
  105. package/resources/org/project/webhook.js +49 -2
  106. package/resources/org/project/webhook.js.map +1 -1
  107. package/resources/org/project/webhook.mjs +49 -2
  108. package/resources/org/project/webhook.mjs.map +1 -1
  109. package/resources/toolkits.d.mts +195 -7
  110. package/resources/toolkits.d.mts.map +1 -1
  111. package/resources/toolkits.d.ts +195 -7
  112. package/resources/toolkits.d.ts.map +1 -1
  113. package/resources/toolkits.js +14 -6
  114. package/resources/toolkits.js.map +1 -1
  115. package/resources/toolkits.mjs +14 -6
  116. package/resources/toolkits.mjs.map +1 -1
  117. package/resources/tools.d.mts +207 -40
  118. package/resources/tools.d.mts.map +1 -1
  119. package/resources/tools.d.ts +207 -40
  120. package/resources/tools.d.ts.map +1 -1
  121. package/resources/tools.js +58 -5
  122. package/resources/tools.js.map +1 -1
  123. package/resources/tools.mjs +58 -5
  124. package/resources/tools.mjs.map +1 -1
  125. package/resources/trigger-instances/index.d.mts +1 -1
  126. package/resources/trigger-instances/index.d.mts.map +1 -1
  127. package/resources/trigger-instances/index.d.ts +1 -1
  128. package/resources/trigger-instances/index.d.ts.map +1 -1
  129. package/resources/trigger-instances/index.js.map +1 -1
  130. package/resources/trigger-instances/index.mjs.map +1 -1
  131. package/resources/trigger-instances/trigger-instances.d.mts +21 -24
  132. package/resources/trigger-instances/trigger-instances.d.mts.map +1 -1
  133. package/resources/trigger-instances/trigger-instances.d.ts +21 -24
  134. package/resources/trigger-instances/trigger-instances.d.ts.map +1 -1
  135. package/resources/trigger-instances/trigger-instances.js +1 -8
  136. package/resources/trigger-instances/trigger-instances.js.map +1 -1
  137. package/resources/trigger-instances/trigger-instances.mjs +1 -8
  138. package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
  139. package/resources/triggers-types.d.mts +96 -2
  140. package/resources/triggers-types.d.mts.map +1 -1
  141. package/resources/triggers-types.d.ts +96 -2
  142. package/resources/triggers-types.d.ts.map +1 -1
  143. package/resources/triggers-types.js +23 -1
  144. package/resources/triggers-types.js.map +1 -1
  145. package/resources/triggers-types.mjs +23 -1
  146. package/resources/triggers-types.mjs.map +1 -1
  147. package/src/client.ts +4 -14
  148. package/src/resources/auth-configs.ts +164 -24
  149. package/src/resources/connected-accounts.ts +80 -17
  150. package/src/resources/files.ts +56 -23
  151. package/src/resources/index.ts +2 -7
  152. package/src/resources/mcp/command.ts +1 -46
  153. package/src/resources/mcp/index.ts +2 -5
  154. package/src/resources/mcp/mcp.ts +240 -280
  155. package/src/resources/migration.ts +11 -2
  156. package/src/resources/org/api-key.ts +23 -2
  157. package/src/resources/org/project/api-keys.ts +97 -20
  158. package/src/resources/org/project/project.ts +176 -4
  159. package/src/resources/org/project/trigger.ts +101 -1
  160. package/src/resources/org/project/webhook.ts +86 -15
  161. package/src/resources/toolkits.ts +200 -7
  162. package/src/resources/tools.ts +207 -40
  163. package/src/resources/trigger-instances/index.ts +0 -3
  164. package/src/resources/trigger-instances/trigger-instances.ts +22 -38
  165. package/src/resources/triggers-types.ts +96 -2
  166. package/src/version.ts +1 -1
  167. package/version.d.mts +1 -1
  168. package/version.d.ts +1 -1
  169. package/version.js +1 -1
  170. package/version.mjs +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"mcp.d.ts","sourceRoot":"","sources":["../../src/resources/mcp/mcp.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE;OAC3D,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/E;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;OAEG;IACH,IAAI,CAAC,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzG;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI3E;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIzF;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAOnC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;CACpC;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvC;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAExB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEvC;;WAEG;QACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvC;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC;IAEvC,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE3C,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,eAAe,CAAC;CACjD;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAID,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
1
+ {"version":3,"file":"mcp.d.ts","sourceRoot":"","sources":["../../src/resources/mcp/mcp.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OACX,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/E;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI3E;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAOnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAID,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;CAC/B"}
@@ -14,43 +14,79 @@ class Mcp extends resource_1.APIResource {
14
14
  this.command = new CommandAPI.Command(this._client);
15
15
  }
16
16
  /**
17
- * Create a new MCP server
18
- */
19
- create(body, options) {
20
- return this._client.post('/api/v3/mcp/create', { body, ...options });
21
- }
22
- /**
23
- * Get MCP server details by ID
17
+ * Retrieves detailed configuration information for a specific Model Control
18
+ * Protocol (MCP) server. The returned data includes connection details, associated
19
+ * applications, enabled tools, and authentication configuration.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const mcp = await client.mcp.retrieve(
24
+ * '550e8400-e29b-41d4-a716-446655440000',
25
+ * );
26
+ * ```
24
27
  */
25
28
  retrieve(id, options) {
26
29
  return this._client.get((0, path_1.path) `/api/v3/mcp/${id}`, options);
27
30
  }
28
31
  /**
29
- * Update MCP server configuration
32
+ * Updates the configuration of an existing Model Control Protocol (MCP) server.
33
+ * You can modify the server name, associated applications, and enabled tools. Only
34
+ * the fields included in the request will be updated.
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * const mcp = await client.mcp.update(
39
+ * '550e8400-e29b-41d4-a716-446655440000',
40
+ * { name: 'Updated GitHub Integration Server' },
41
+ * );
42
+ * ```
30
43
  */
31
44
  update(id, body = {}, options) {
32
45
  return this._client.patch((0, path_1.path) `/api/v3/mcp/${id}`, { body, ...options });
33
46
  }
34
47
  /**
35
- * List MCP servers with optional filters
36
- */
37
- list(query = {}, options) {
38
- return this._client.get('/api/v3/mcp/list', { query, ...options });
39
- }
40
- /**
41
- * Delete an MCP server
48
+ * Performs a soft delete on a Model Control Protocol (MCP) server, making it
49
+ * unavailable for future use. This operation is reversible in the database but
50
+ * cannot be undone through the API. Any applications or services connected to this
51
+ * server will lose access after deletion.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const mcp = await client.mcp.delete(
56
+ * '550e8400-e29b-41d4-a716-446655440000',
57
+ * );
58
+ * ```
42
59
  */
43
60
  delete(id, options) {
44
61
  return this._client.delete((0, path_1.path) `/api/v3/mcp/${id}`, options);
45
62
  }
46
63
  /**
47
- * List MCP servers for a specific app
64
+ * Retrieves a paginated list of Model Control Protocol (MCP) servers that are
65
+ * configured for a specific application or toolkit. This endpoint allows you to
66
+ * find all MCP server instances that have access to a particular application, such
67
+ * as GitHub, Slack, or Jira.
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * const response = await client.mcp.retrieveApp('github');
72
+ * ```
48
73
  */
49
- retrieveApp(appKey, options) {
50
- return this._client.get((0, path_1.path) `/api/v3/mcp/app/${appKey}`, options);
74
+ retrieveApp(appKey, query = {}, options) {
75
+ return this._client.get((0, path_1.path) `/api/v3/mcp/app/${appKey}`, { query, ...options });
51
76
  }
52
77
  /**
53
- * Validate MCP server and retrieve connection details
78
+ * Admin-only endpoint that validates a Model Control Protocol (MCP) server and
79
+ * retrieves its complete configuration details, including authentication
80
+ * information. This endpoint is typically used by the MCP service itself to
81
+ * authenticate and authorize connection requests from clients.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const response = await client.mcp.validate(
86
+ * '550e8400-e29b-41d4-a716-446655440000',
87
+ * { 'x-composio-admin-token': 'admin_tk_12345abcdef' },
88
+ * );
89
+ * ```
54
90
  */
55
91
  validate(uuid, params, options) {
56
92
  const { 'x-composio-admin-token': xComposioAdminToken } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"mcp.js","sourceRoot":"","sources":["../../src/resources/mcp/mcp.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,iEAAwC;AACxC,0CAAoF;AAEpF,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,GAAI,SAAQ,sBAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8DrE,CAAC;IA5DC;;OAEG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,OAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,QAA0C,EAAE,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAc,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,IAAY,EACZ,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,IAAI,EAAE,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7F,CAAC,CAAC;IACL,CAAC;CACF;AA/DD,kBA+DC;AAkdD,GAAG,CAAC,OAAO,GAAG,iBAAO,CAAC"}
1
+ {"version":3,"file":"mcp.js","sourceRoot":"","sources":["../../src/resources/mcp/mcp.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,iEAAwC;AACxC,0CAAoC;AAEpC,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,GAAI,SAAQ,sBAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoGrE,CAAC;IAlGC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,OAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,mBAAmB,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAY,EACZ,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,wBAAwB,IAAI,EAAE,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7F,CAAC,CAAC;IACL,CAAC;CACF;AArGD,kBAqGC;AA2YD,GAAG,CAAC,OAAO,GAAG,iBAAO,CAAC"}
@@ -10,43 +10,79 @@ export class Mcp extends APIResource {
10
10
  this.command = new CommandAPI.Command(this._client);
11
11
  }
12
12
  /**
13
- * Create a new MCP server
14
- */
15
- create(body, options) {
16
- return this._client.post('/api/v3/mcp/create', { body, ...options });
17
- }
18
- /**
19
- * Get MCP server details by ID
13
+ * Retrieves detailed configuration information for a specific Model Control
14
+ * Protocol (MCP) server. The returned data includes connection details, associated
15
+ * applications, enabled tools, and authentication configuration.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const mcp = await client.mcp.retrieve(
20
+ * '550e8400-e29b-41d4-a716-446655440000',
21
+ * );
22
+ * ```
20
23
  */
21
24
  retrieve(id, options) {
22
25
  return this._client.get(path `/api/v3/mcp/${id}`, options);
23
26
  }
24
27
  /**
25
- * Update MCP server configuration
28
+ * Updates the configuration of an existing Model Control Protocol (MCP) server.
29
+ * You can modify the server name, associated applications, and enabled tools. Only
30
+ * the fields included in the request will be updated.
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * const mcp = await client.mcp.update(
35
+ * '550e8400-e29b-41d4-a716-446655440000',
36
+ * { name: 'Updated GitHub Integration Server' },
37
+ * );
38
+ * ```
26
39
  */
27
40
  update(id, body = {}, options) {
28
41
  return this._client.patch(path `/api/v3/mcp/${id}`, { body, ...options });
29
42
  }
30
43
  /**
31
- * List MCP servers with optional filters
32
- */
33
- list(query = {}, options) {
34
- return this._client.get('/api/v3/mcp/list', { query, ...options });
35
- }
36
- /**
37
- * Delete an MCP server
44
+ * Performs a soft delete on a Model Control Protocol (MCP) server, making it
45
+ * unavailable for future use. This operation is reversible in the database but
46
+ * cannot be undone through the API. Any applications or services connected to this
47
+ * server will lose access after deletion.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const mcp = await client.mcp.delete(
52
+ * '550e8400-e29b-41d4-a716-446655440000',
53
+ * );
54
+ * ```
38
55
  */
39
56
  delete(id, options) {
40
57
  return this._client.delete(path `/api/v3/mcp/${id}`, options);
41
58
  }
42
59
  /**
43
- * List MCP servers for a specific app
60
+ * Retrieves a paginated list of Model Control Protocol (MCP) servers that are
61
+ * configured for a specific application or toolkit. This endpoint allows you to
62
+ * find all MCP server instances that have access to a particular application, such
63
+ * as GitHub, Slack, or Jira.
64
+ *
65
+ * @example
66
+ * ```ts
67
+ * const response = await client.mcp.retrieveApp('github');
68
+ * ```
44
69
  */
45
- retrieveApp(appKey, options) {
46
- return this._client.get(path `/api/v3/mcp/app/${appKey}`, options);
70
+ retrieveApp(appKey, query = {}, options) {
71
+ return this._client.get(path `/api/v3/mcp/app/${appKey}`, { query, ...options });
47
72
  }
48
73
  /**
49
- * Validate MCP server and retrieve connection details
74
+ * Admin-only endpoint that validates a Model Control Protocol (MCP) server and
75
+ * retrieves its complete configuration details, including authentication
76
+ * information. This endpoint is typically used by the MCP service itself to
77
+ * authenticate and authorize connection requests from clients.
78
+ *
79
+ * @example
80
+ * ```ts
81
+ * const response = await client.mcp.validate(
82
+ * '550e8400-e29b-41d4-a716-446655440000',
83
+ * { 'x-composio-admin-token': 'admin_tk_12345abcdef' },
84
+ * );
85
+ * ```
50
86
  */
51
87
  validate(uuid, params, options) {
52
88
  const { 'x-composio-admin-token': xComposioAdminToken } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"mcp.mjs","sourceRoot":"","sources":["../../src/resources/mcp/mcp.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAkD;OAE3D,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,GAAI,SAAQ,WAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8DrE,CAAC;IA5DC;;OAEG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,OAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,QAA0C,EAAE,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAc,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,IAAY,EACZ,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,IAAI,EAAE,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7F,CAAC,CAAC;IACL,CAAC;CACF;AAkdD,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC"}
1
+ {"version":3,"file":"mcp.mjs","sourceRoot":"","sources":["../../src/resources/mcp/mcp.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE;OAEX,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,GAAI,SAAQ,WAAW;IAApC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAoGrE,CAAC;IAlGC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAU,EACV,OAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,MAAc,EACd,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAmB,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAY,EACZ,MAAyB,EACzB,OAAwB;QAExB,MAAM,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,GAAG,MAAM,CAAC;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,wBAAwB,IAAI,EAAE,EAAE;YAC1D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7F,CAAC,CAAC;IACL,CAAC;CACF;AA2YD,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC"}
@@ -3,18 +3,27 @@ import { APIPromise } from "../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../internal/request-options.mjs";
4
4
  export declare class Migration extends APIResource {
5
5
  /**
6
- * Convert a legacy UUID to its corresponding NanoId for migration purposes
6
+ * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
7
+ * endpoint facilitates the transition from UUID-based identifiers to the more
8
+ * compact NanoId format used in the v3 API.
7
9
  */
8
10
  retrieveNanoid(query: MigrationRetrieveNanoidParams, options?: RequestOptions): APIPromise<MigrationRetrieveNanoidResponse>;
9
11
  }
10
12
  export interface MigrationRetrieveNanoidResponse {
11
13
  /**
12
- * The NanoId corresponding to the provided UUID.
14
+ * The NanoId corresponding to the provided UUID. This is the new identifier that
15
+ * should be used in place of the legacy UUID.
13
16
  */
14
17
  nanoid: string;
15
18
  }
16
19
  export interface MigrationRetrieveNanoidParams {
20
+ /**
21
+ * The type of resource that the UUID belongs to
22
+ */
17
23
  type: 'CONNECTED_ACCOUNT' | 'AUTH_CONFIG' | 'TRIGGER_INSTANCE';
24
+ /**
25
+ * The legacy UUID that needs to be converted to a NanoId
26
+ */
18
27
  uuid: string;
19
28
  }
20
29
  export declare namespace Migration {
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.mts","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,cAAc,CACZ,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,kBAAkB,CAAC;IAE/D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
1
+ {"version":3,"file":"migration.d.mts","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,kBAAkB,CAAC;IAE/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
@@ -3,18 +3,27 @@ import { APIPromise } from "../core/api-promise.js";
3
3
  import { RequestOptions } from "../internal/request-options.js";
4
4
  export declare class Migration extends APIResource {
5
5
  /**
6
- * Convert a legacy UUID to its corresponding NanoId for migration purposes
6
+ * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
7
+ * endpoint facilitates the transition from UUID-based identifiers to the more
8
+ * compact NanoId format used in the v3 API.
7
9
  */
8
10
  retrieveNanoid(query: MigrationRetrieveNanoidParams, options?: RequestOptions): APIPromise<MigrationRetrieveNanoidResponse>;
9
11
  }
10
12
  export interface MigrationRetrieveNanoidResponse {
11
13
  /**
12
- * The NanoId corresponding to the provided UUID.
14
+ * The NanoId corresponding to the provided UUID. This is the new identifier that
15
+ * should be used in place of the legacy UUID.
13
16
  */
14
17
  nanoid: string;
15
18
  }
16
19
  export interface MigrationRetrieveNanoidParams {
20
+ /**
21
+ * The type of resource that the UUID belongs to
22
+ */
17
23
  type: 'CONNECTED_ACCOUNT' | 'AUTH_CONFIG' | 'TRIGGER_INSTANCE';
24
+ /**
25
+ * The legacy UUID that needs to be converted to a NanoId
26
+ */
18
27
  uuid: string;
19
28
  }
20
29
  export declare namespace Migration {
@@ -1 +1 @@
1
- {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,cAAc,CACZ,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,kBAAkB,CAAC;IAE/D,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
1
+ {"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;CAG/C;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,kBAAkB,CAAC;IAE/D;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
@@ -5,7 +5,9 @@ exports.Migration = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
6
  class Migration extends resource_1.APIResource {
7
7
  /**
8
- * Convert a legacy UUID to its corresponding NanoId for migration purposes
8
+ * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
9
+ * endpoint facilitates the transition from UUID-based identifiers to the more
10
+ * compact NanoId format used in the v3 API.
9
11
  */
10
12
  retrieveNanoid(query, options) {
11
13
  return this._client.get('/api/v3/migration/get-nanoid', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"migration.js","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,cAAc,CACZ,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAVD,8BAUC"}
1
+ {"version":3,"file":"migration.js","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF;AAZD,8BAYC"}
@@ -2,7 +2,9 @@
2
2
  import { APIResource } from "../core/resource.mjs";
3
3
  export class Migration extends APIResource {
4
4
  /**
5
- * Convert a legacy UUID to its corresponding NanoId for migration purposes
5
+ * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
6
+ * endpoint facilitates the transition from UUID-based identifiers to the more
7
+ * compact NanoId format used in the v3 API.
6
8
  */
7
9
  retrieveNanoid(query, options) {
8
10
  return this._client.get('/api/v3/migration/get-nanoid', { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"migration.mjs","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,cAAc,CACZ,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}
1
+ {"version":3,"file":"migration.mjs","sourceRoot":"","sources":["../src/resources/migration.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;OAIG;IACH,cAAc,CACZ,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}
@@ -3,19 +3,40 @@ import { APIPromise } from "../../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../../internal/request-options.mjs";
4
4
  export declare class APIKey extends APIResource {
5
5
  /**
6
- * Retrieve the API key for the current organization (admin only)
6
+ * Retrieve the API key for the current organization. This endpoint is restricted
7
+ * to organization administrators only. The returned API key can be used for
8
+ * authenticating organization-level API requests.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const apiKey = await client.org.apiKey.retrieve();
13
+ * ```
7
14
  */
8
15
  retrieve(options?: RequestOptions): APIPromise<APIKeyRetrieveResponse>;
9
16
  /**
10
17
  * Generate a new API key for the organization, invalidating the previous one
11
- * (admin only)
18
+ * (admin only). This operation cannot be undone and will immediately invalidate
19
+ * the previous API key.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const response = await client.org.apiKey.regenerate();
24
+ * ```
12
25
  */
13
26
  regenerate(options?: RequestOptions): APIPromise<APIKeyRegenerateResponse>;
14
27
  }
15
28
  export interface APIKeyRetrieveResponse {
29
+ /**
30
+ * The API key for the organization that can be used for authentication. Format:
31
+ * org_xxx
32
+ */
16
33
  org_api_key: string;
17
34
  }
18
35
  export interface APIKeyRegenerateResponse {
36
+ /**
37
+ * The newly generated API key for the organization that can be used for
38
+ * authentication. Format: org_xxx
39
+ */
19
40
  org_api_key: string;
20
41
  }
21
42
  export declare namespace APIKey {
@@ -1 +1 @@
1
- {"version":3,"file":"api-key.d.mts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE;;;OAGG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"api-key.d.mts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -3,19 +3,40 @@ import { APIPromise } from "../../core/api-promise.js";
3
3
  import { RequestOptions } from "../../internal/request-options.js";
4
4
  export declare class APIKey extends APIResource {
5
5
  /**
6
- * Retrieve the API key for the current organization (admin only)
6
+ * Retrieve the API key for the current organization. This endpoint is restricted
7
+ * to organization administrators only. The returned API key can be used for
8
+ * authenticating organization-level API requests.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const apiKey = await client.org.apiKey.retrieve();
13
+ * ```
7
14
  */
8
15
  retrieve(options?: RequestOptions): APIPromise<APIKeyRetrieveResponse>;
9
16
  /**
10
17
  * Generate a new API key for the organization, invalidating the previous one
11
- * (admin only)
18
+ * (admin only). This operation cannot be undone and will immediately invalidate
19
+ * the previous API key.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const response = await client.org.apiKey.regenerate();
24
+ * ```
12
25
  */
13
26
  regenerate(options?: RequestOptions): APIPromise<APIKeyRegenerateResponse>;
14
27
  }
15
28
  export interface APIKeyRetrieveResponse {
29
+ /**
30
+ * The API key for the organization that can be used for authentication. Format:
31
+ * org_xxx
32
+ */
16
33
  org_api_key: string;
17
34
  }
18
35
  export interface APIKeyRegenerateResponse {
36
+ /**
37
+ * The newly generated API key for the organization that can be used for
38
+ * authentication. Format: org_xxx
39
+ */
19
40
  org_api_key: string;
20
41
  }
21
42
  export declare namespace APIKey {
@@ -1 +1 @@
1
- {"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE;;;OAGG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
1
+ {"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAItE;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG3E;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -5,14 +5,27 @@ exports.APIKey = void 0;
5
5
  const resource_1 = require("../../core/resource.js");
6
6
  class APIKey extends resource_1.APIResource {
7
7
  /**
8
- * Retrieve the API key for the current organization (admin only)
8
+ * Retrieve the API key for the current organization. This endpoint is restricted
9
+ * to organization administrators only. The returned API key can be used for
10
+ * authenticating organization-level API requests.
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const apiKey = await client.org.apiKey.retrieve();
15
+ * ```
9
16
  */
10
17
  retrieve(options) {
11
18
  return this._client.get('/api/v3/org/api_key', options);
12
19
  }
13
20
  /**
14
21
  * Generate a new API key for the organization, invalidating the previous one
15
- * (admin only)
22
+ * (admin only). This operation cannot be undone and will immediately invalidate
23
+ * the previous API key.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const response = await client.org.apiKey.regenerate();
28
+ * ```
16
29
  */
17
30
  regenerate(options) {
18
31
  return this._client.post('/api/v3/org/api_key/regenerate', options);
@@ -1 +1 @@
1
- {"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAfD,wBAeC"}
1
+ {"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AA5BD,wBA4BC"}
@@ -2,14 +2,27 @@
2
2
  import { APIResource } from "../../core/resource.mjs";
3
3
  export class APIKey extends APIResource {
4
4
  /**
5
- * Retrieve the API key for the current organization (admin only)
5
+ * Retrieve the API key for the current organization. This endpoint is restricted
6
+ * to organization administrators only. The returned API key can be used for
7
+ * authenticating organization-level API requests.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const apiKey = await client.org.apiKey.retrieve();
12
+ * ```
6
13
  */
7
14
  retrieve(options) {
8
15
  return this._client.get('/api/v3/org/api_key', options);
9
16
  }
10
17
  /**
11
18
  * Generate a new API key for the organization, invalidating the previous one
12
- * (admin only)
19
+ * (admin only). This operation cannot be undone and will immediately invalidate
20
+ * the previous API key.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * const response = await client.org.apiKey.regenerate();
25
+ * ```
13
26
  */
14
27
  regenerate(options) {
15
28
  return this._client.post('/api/v3/org/api_key/regenerate', options);
@@ -1 +1 @@
1
- {"version":3,"file":"api-key.mjs","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}
1
+ {"version":3,"file":"api-key.mjs","sourceRoot":"","sources":["../../src/resources/org/api-key.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,OAAwB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}