@versori/run 0.2.29 → 0.3.0-beta.2

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 (417) hide show
  1. package/esm/src/connection/DirectConnectionFactory.d.ts +29 -0
  2. package/esm/src/connection/DirectConnectionFactory.d.ts.map +1 -0
  3. package/esm/src/connection/DirectConnectionFactory.js +82 -0
  4. package/esm/src/connection/DynamicFetchFactory.d.ts +30 -0
  5. package/esm/src/connection/DynamicFetchFactory.d.ts.map +1 -0
  6. package/esm/src/connection/DynamicFetchFactory.js +113 -0
  7. package/esm/src/connection/StaticFetchFactory.d.ts +11 -0
  8. package/esm/src/connection/StaticFetchFactory.d.ts.map +1 -0
  9. package/esm/src/connection/StaticFetchFactory.js +35 -0
  10. package/esm/src/connection/internal/CredentialHolder.d.ts +11 -0
  11. package/esm/src/connection/internal/CredentialHolder.d.ts.map +1 -0
  12. package/esm/src/connection/internal/CredentialHolder.js +66 -0
  13. package/esm/src/connection/internal/FetchBuilder.d.ts +15 -0
  14. package/esm/src/connection/internal/FetchBuilder.d.ts.map +1 -0
  15. package/esm/src/connection/internal/FetchBuilder.js +89 -0
  16. package/esm/src/connection/internal/HttpClientFactory.d.ts +14 -0
  17. package/esm/src/connection/internal/HttpClientFactory.d.ts.map +1 -0
  18. package/esm/src/connection/internal/HttpClientFactory.js +42 -0
  19. package/esm/src/connection/internal/InboundConnectionFactory.d.ts +19 -0
  20. package/esm/src/connection/internal/InboundConnectionFactory.d.ts.map +1 -0
  21. package/esm/src/connection/internal/InboundConnectionFactory.js +390 -0
  22. package/esm/src/connection/internal/OutboundConnectionFactory.d.ts +31 -0
  23. package/esm/src/connection/internal/OutboundConnectionFactory.d.ts.map +1 -0
  24. package/esm/src/connection/internal/OutboundConnectionFactory.js +447 -0
  25. package/esm/src/connection/types.d.ts +32 -0
  26. package/esm/src/connection/types.d.ts.map +1 -0
  27. package/esm/src/connection/types.js +1 -0
  28. package/esm/src/context/ActivationImpl.d.ts +18 -0
  29. package/esm/src/context/ActivationImpl.d.ts.map +1 -0
  30. package/esm/src/context/ActivationImpl.js +82 -0
  31. package/esm/src/context/Context.d.ts +4 -6
  32. package/esm/src/context/Context.d.ts.map +1 -1
  33. package/esm/src/context/Context.js +8 -16
  34. package/esm/src/context/ContextProvider.d.ts +7 -3
  35. package/esm/src/context/ContextProvider.d.ts.map +1 -1
  36. package/esm/src/context/ContextProvider.js +28 -10
  37. package/esm/src/dsl/http/default.d.ts.map +1 -1
  38. package/esm/src/dsl/http/default.js +2 -2
  39. package/esm/src/dsl/http/types.d.ts +9 -4
  40. package/esm/src/dsl/http/types.d.ts.map +1 -1
  41. package/esm/src/dsl/http/versori/configloader.d.ts.map +1 -1
  42. package/esm/src/dsl/http/versori/configloader.js +3 -1
  43. package/esm/src/dsl/http/versori/constants.d.ts.map +1 -1
  44. package/esm/src/dsl/http/versori/constants.js +1 -0
  45. package/esm/src/dsl/http/versori/contextcredentials.d.ts.map +1 -1
  46. package/esm/src/dsl/http/versori/platformapi.d.ts.map +1 -1
  47. package/esm/src/dsl/http/versori/proxyroundtripper.d.ts +5 -3
  48. package/esm/src/dsl/http/versori/proxyroundtripper.d.ts.map +1 -1
  49. package/esm/src/dsl/http/versori/proxyroundtripper.js +31 -8
  50. package/esm/src/dsl/http/versori/webhookmiddleware.d.ts +8 -5
  51. package/esm/src/dsl/http/versori/webhookmiddleware.d.ts.map +1 -1
  52. package/esm/src/dsl/http/versori/webhookmiddleware.js +106 -115
  53. package/esm/src/dsl/tasks/HttpTask.d.ts +6 -5
  54. package/esm/src/dsl/tasks/HttpTask.d.ts.map +1 -1
  55. package/esm/src/dsl/tasks/HttpTask.js +19 -22
  56. package/esm/src/internal/InternalAuth.d.ts +15 -0
  57. package/esm/src/internal/InternalAuth.d.ts.map +1 -0
  58. package/esm/src/internal/InternalAuth.js +90 -0
  59. package/esm/src/internal/cli.d.ts +2 -0
  60. package/esm/src/internal/cli.d.ts.map +1 -0
  61. package/esm/src/internal/cli.js +20 -0
  62. package/esm/src/internal/constants.d.ts +20 -0
  63. package/esm/src/internal/constants.d.ts.map +1 -0
  64. package/esm/src/internal/constants.js +24 -0
  65. package/esm/src/interpreter/durable/DurableInterpreter.d.ts +14 -5
  66. package/esm/src/interpreter/durable/DurableInterpreter.d.ts.map +1 -1
  67. package/esm/src/interpreter/durable/DurableInterpreter.js +20 -18
  68. package/esm/src/interpreter/durable/ObservableCompiler.d.ts +6 -3
  69. package/esm/src/interpreter/durable/ObservableCompiler.d.ts.map +1 -1
  70. package/esm/src/interpreter/durable/compilers/durableworkflow.d.ts.map +1 -1
  71. package/esm/src/interpreter/durable/compilers/durableworkflow.js +10 -1
  72. package/esm/src/interpreter/durable/compilers/http.d.ts.map +1 -1
  73. package/esm/src/interpreter/durable/compilers/http.js +26 -9
  74. package/esm/src/interpreter/durable/compilers/schedule.d.ts.map +1 -1
  75. package/esm/src/interpreter/durable/compilers/schedule.js +41 -18
  76. package/esm/src/interpreter/durable/compilers/webhook.d.ts.map +1 -1
  77. package/esm/src/interpreter/durable/compilers/webhook.js +30 -33
  78. package/esm/src/interpreter/memory/MemoryInterpreter.d.ts +4 -4
  79. package/esm/src/interpreter/memory/MemoryInterpreter.d.ts.map +1 -1
  80. package/esm/src/interpreter/memory/MemoryInterpreter.js +14 -23
  81. package/esm/src/interpreter/memory/ObservableCompiler.d.ts +6 -3
  82. package/esm/src/interpreter/memory/ObservableCompiler.d.ts.map +1 -1
  83. package/esm/src/interpreter/memory/compilers/http.d.ts.map +1 -1
  84. package/esm/src/interpreter/memory/compilers/http.js +26 -9
  85. package/esm/src/interpreter/memory/compilers/schedule.d.ts.map +1 -1
  86. package/esm/src/interpreter/memory/compilers/schedule.js +34 -18
  87. package/esm/src/interpreter/memory/compilers/webhook.d.ts.map +1 -1
  88. package/esm/src/interpreter/memory/compilers/webhook.js +31 -34
  89. package/esm/src/services/credentials/credential-v1alpha1.d.ts +4 -0
  90. package/esm/src/services/credentials/credential-v1alpha1.d.ts.map +1 -0
  91. package/esm/src/services/credentials/credential-v1alpha1.js +3 -0
  92. package/esm/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_metadata_pb.d.ts +119 -0
  93. package/esm/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_metadata_pb.d.ts.map +1 -0
  94. package/esm/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_metadata_pb.js +67 -0
  95. package/esm/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_service_pb.d.ts +245 -0
  96. package/esm/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_service_pb.d.ts.map +1 -0
  97. package/esm/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_service_pb.js +44 -0
  98. package/esm/src/services/credentials/generated/versori/credential/oauth2/v1/token_pb.d.ts +38 -0
  99. package/esm/src/services/credentials/generated/versori/credential/oauth2/v1/token_pb.d.ts.map +1 -0
  100. package/esm/src/{dsl/http → services/credentials/generated}/versori/credential/oauth2/v1/token_pb.js +1 -1
  101. package/esm/src/services/credentials/generated/versori/credential/oauth2/v1/token_service_pb.d.ts +471 -0
  102. package/esm/src/services/credentials/generated/versori/credential/oauth2/v1/token_service_pb.d.ts.map +1 -0
  103. package/esm/src/{dsl/http → services/credentials/generated}/versori/credential/oauth2/v1/token_service_pb.js +1 -1
  104. package/esm/src/services/credentials/generated/versori/credential/tokens/v1/token_pb.d.ts +38 -0
  105. package/esm/src/services/credentials/generated/versori/credential/tokens/v1/token_pb.d.ts.map +1 -0
  106. package/esm/src/{dsl/http → services/credentials/generated}/versori/credential/tokens/v1/token_pb.js +1 -1
  107. package/esm/src/services/credentials/generated/versori/credential/tokens/v1/token_service_pb.d.ts +128 -0
  108. package/esm/src/services/credentials/generated/versori/credential/tokens/v1/token_service_pb.d.ts.map +1 -0
  109. package/esm/src/{dsl/http → services/credentials/generated}/versori/credential/tokens/v1/token_service_pb.js +1 -1
  110. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/common_pb.d.ts +90 -0
  111. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/common_pb.d.ts.map +1 -0
  112. package/esm/src/{dsl/http → services/credentials/generated}/versori/credential/v1alpha1/common_pb.js +16 -6
  113. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/credential_pb.d.ts +1468 -0
  114. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/credential_pb.d.ts.map +1 -0
  115. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/credential_pb.js +534 -0
  116. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/credential_service_pb.d.ts +390 -0
  117. package/esm/src/services/credentials/generated/versori/credential/v1alpha1/credential_service_pb.d.ts.map +1 -0
  118. package/esm/src/{dsl/http → services/credentials/generated}/versori/credential/v1alpha1/credential_service_pb.js +1 -1
  119. package/esm/src/services/credentials/isTokenValid.d.ts +3 -0
  120. package/esm/src/services/credentials/isTokenValid.d.ts.map +1 -0
  121. package/esm/src/services/credentials/isTokenValid.js +8 -0
  122. package/esm/src/services/credentials/mod.d.ts +5 -0
  123. package/esm/src/services/credentials/mod.d.ts.map +1 -0
  124. package/esm/src/services/credentials/mod.js +4 -0
  125. package/esm/src/services/credentials/oauth1-v1.d.ts +3 -0
  126. package/esm/src/services/credentials/oauth1-v1.d.ts.map +1 -0
  127. package/esm/src/services/credentials/oauth1-v1.js +2 -0
  128. package/esm/src/services/credentials/oauth2-v1.d.ts +3 -0
  129. package/esm/src/services/credentials/oauth2-v1.d.ts.map +1 -0
  130. package/esm/src/services/credentials/oauth2-v1.js +2 -0
  131. package/esm/src/services/credentials/tokens-v1.d.ts +3 -0
  132. package/esm/src/services/credentials/tokens-v1.d.ts.map +1 -0
  133. package/esm/src/services/credentials/tokens-v1.js +2 -0
  134. package/esm/src/services/platform/PlatformApi.d.ts +7 -0
  135. package/esm/src/services/platform/PlatformApi.d.ts.map +1 -0
  136. package/esm/src/services/platform/PlatformApi.js +25 -0
  137. package/esm/src/services/platform/generated/client/client.gen.d.ts +3 -0
  138. package/esm/src/services/platform/generated/client/client.gen.d.ts.map +1 -0
  139. package/esm/src/services/platform/generated/client/client.gen.js +176 -0
  140. package/esm/src/services/platform/generated/client/index.d.ts +8 -0
  141. package/esm/src/services/platform/generated/client/index.d.ts.map +1 -0
  142. package/esm/src/services/platform/generated/client/index.js +5 -0
  143. package/esm/src/services/platform/generated/client/types.gen.d.ts +125 -0
  144. package/esm/src/services/platform/generated/client/types.gen.d.ts.map +1 -0
  145. package/esm/src/services/platform/generated/client/types.gen.js +2 -0
  146. package/esm/src/services/platform/generated/client/utils.gen.d.ts +39 -0
  147. package/esm/src/services/platform/generated/client/utils.gen.d.ts.map +1 -0
  148. package/esm/src/services/platform/generated/client/utils.gen.js +234 -0
  149. package/esm/src/services/platform/generated/client.gen.d.ts +13 -0
  150. package/esm/src/services/platform/generated/client.gen.d.ts.map +1 -0
  151. package/esm/src/services/platform/generated/client.gen.js +5 -0
  152. package/esm/src/services/platform/generated/core/auth.gen.d.ts +19 -0
  153. package/esm/src/services/platform/generated/core/auth.gen.d.ts.map +1 -0
  154. package/esm/src/services/platform/generated/core/auth.gen.js +14 -0
  155. package/esm/src/services/platform/generated/core/bodySerializer.gen.d.ts +18 -0
  156. package/esm/src/services/platform/generated/core/bodySerializer.gen.d.ts.map +1 -0
  157. package/esm/src/services/platform/generated/core/bodySerializer.gen.js +57 -0
  158. package/esm/src/services/platform/generated/core/params.gen.d.ts +34 -0
  159. package/esm/src/services/platform/generated/core/params.gen.d.ts.map +1 -0
  160. package/esm/src/services/platform/generated/core/params.gen.js +88 -0
  161. package/esm/src/services/platform/generated/core/pathSerializer.gen.d.ts +34 -0
  162. package/esm/src/services/platform/generated/core/pathSerializer.gen.d.ts.map +1 -0
  163. package/esm/src/services/platform/generated/core/pathSerializer.gen.js +114 -0
  164. package/esm/src/services/platform/generated/core/serverSentEvents.gen.d.ts +60 -0
  165. package/esm/src/services/platform/generated/core/serverSentEvents.gen.d.ts.map +1 -0
  166. package/esm/src/services/platform/generated/core/serverSentEvents.gen.js +121 -0
  167. package/esm/src/services/platform/generated/core/types.gen.d.ts +79 -0
  168. package/esm/src/services/platform/generated/core/types.gen.d.ts.map +1 -0
  169. package/esm/src/services/platform/generated/core/types.gen.js +2 -0
  170. package/esm/src/services/platform/generated/core/utils.gen.d.ts +15 -0
  171. package/esm/src/services/platform/generated/core/utils.gen.d.ts.map +1 -0
  172. package/esm/src/services/platform/generated/core/utils.gen.js +69 -0
  173. package/esm/src/services/platform/generated/index.d.ts +3 -0
  174. package/esm/src/services/platform/generated/index.d.ts.map +1 -0
  175. package/esm/src/services/platform/generated/index.js +3 -0
  176. package/esm/src/services/platform/generated/sdk.gen.d.ts +494 -0
  177. package/esm/src/services/platform/generated/sdk.gen.d.ts.map +1 -0
  178. package/esm/src/services/platform/generated/sdk.gen.js +1908 -0
  179. package/esm/src/services/platform/generated/types.gen.d.ts +3798 -0
  180. package/esm/src/services/platform/generated/types.gen.d.ts.map +1 -0
  181. package/esm/src/services/platform/generated/types.gen.js +2 -0
  182. package/esm/src/services/platform/mod.d.ts +5 -0
  183. package/esm/src/services/platform/mod.d.ts.map +1 -0
  184. package/esm/src/services/platform/mod.js +2 -0
  185. package/package.json +4 -4
  186. package/script/src/connection/DirectConnectionFactory.d.ts +29 -0
  187. package/script/src/connection/DirectConnectionFactory.d.ts.map +1 -0
  188. package/script/src/connection/DirectConnectionFactory.js +86 -0
  189. package/script/src/connection/DynamicFetchFactory.d.ts +30 -0
  190. package/script/src/connection/DynamicFetchFactory.d.ts.map +1 -0
  191. package/script/src/connection/DynamicFetchFactory.js +117 -0
  192. package/script/src/connection/StaticFetchFactory.d.ts +11 -0
  193. package/script/src/connection/StaticFetchFactory.d.ts.map +1 -0
  194. package/script/src/connection/StaticFetchFactory.js +39 -0
  195. package/script/src/connection/internal/CredentialHolder.d.ts +11 -0
  196. package/script/src/connection/internal/CredentialHolder.d.ts.map +1 -0
  197. package/script/src/connection/internal/CredentialHolder.js +71 -0
  198. package/script/src/connection/internal/FetchBuilder.d.ts +15 -0
  199. package/script/src/connection/internal/FetchBuilder.d.ts.map +1 -0
  200. package/script/src/connection/internal/FetchBuilder.js +93 -0
  201. package/script/src/connection/internal/HttpClientFactory.d.ts +14 -0
  202. package/script/src/connection/internal/HttpClientFactory.d.ts.map +1 -0
  203. package/script/src/connection/internal/HttpClientFactory.js +46 -0
  204. package/script/src/connection/internal/InboundConnectionFactory.d.ts +19 -0
  205. package/script/src/connection/internal/InboundConnectionFactory.d.ts.map +1 -0
  206. package/script/src/connection/internal/InboundConnectionFactory.js +394 -0
  207. package/script/src/connection/internal/OutboundConnectionFactory.d.ts +31 -0
  208. package/script/src/connection/internal/OutboundConnectionFactory.d.ts.map +1 -0
  209. package/script/src/connection/internal/OutboundConnectionFactory.js +454 -0
  210. package/script/src/connection/types.d.ts +32 -0
  211. package/script/src/connection/types.d.ts.map +1 -0
  212. package/script/src/connection/types.js +2 -0
  213. package/script/src/context/ActivationImpl.d.ts +18 -0
  214. package/script/src/context/ActivationImpl.d.ts.map +1 -0
  215. package/script/src/context/ActivationImpl.js +86 -0
  216. package/script/src/context/Context.d.ts +4 -6
  217. package/script/src/context/Context.d.ts.map +1 -1
  218. package/script/src/context/Context.js +8 -16
  219. package/script/src/context/ContextProvider.d.ts +7 -3
  220. package/script/src/context/ContextProvider.d.ts.map +1 -1
  221. package/script/src/context/ContextProvider.js +28 -10
  222. package/script/src/dsl/http/default.d.ts.map +1 -1
  223. package/script/src/dsl/http/default.js +2 -2
  224. package/script/src/dsl/http/types.d.ts +9 -4
  225. package/script/src/dsl/http/types.d.ts.map +1 -1
  226. package/script/src/dsl/http/versori/configloader.d.ts.map +1 -1
  227. package/script/src/dsl/http/versori/configloader.js +3 -1
  228. package/script/src/dsl/http/versori/constants.d.ts.map +1 -1
  229. package/script/src/dsl/http/versori/constants.js +1 -0
  230. package/script/src/dsl/http/versori/contextcredentials.d.ts.map +1 -1
  231. package/script/src/dsl/http/versori/platformapi.d.ts.map +1 -1
  232. package/script/src/dsl/http/versori/proxyroundtripper.d.ts +5 -3
  233. package/script/src/dsl/http/versori/proxyroundtripper.d.ts.map +1 -1
  234. package/script/src/dsl/http/versori/proxyroundtripper.js +31 -8
  235. package/script/src/dsl/http/versori/webhookmiddleware.d.ts +8 -5
  236. package/script/src/dsl/http/versori/webhookmiddleware.d.ts.map +1 -1
  237. package/script/src/dsl/http/versori/webhookmiddleware.js +106 -115
  238. package/script/src/dsl/tasks/HttpTask.d.ts +6 -5
  239. package/script/src/dsl/tasks/HttpTask.d.ts.map +1 -1
  240. package/script/src/dsl/tasks/HttpTask.js +19 -22
  241. package/script/src/internal/InternalAuth.d.ts +15 -0
  242. package/script/src/internal/InternalAuth.d.ts.map +1 -0
  243. package/script/src/internal/InternalAuth.js +94 -0
  244. package/script/src/internal/cli.d.ts +2 -0
  245. package/script/src/internal/cli.d.ts.map +1 -0
  246. package/script/src/internal/cli.js +23 -0
  247. package/script/src/internal/constants.d.ts +20 -0
  248. package/script/src/internal/constants.d.ts.map +1 -0
  249. package/script/src/internal/constants.js +27 -0
  250. package/script/src/interpreter/durable/DurableInterpreter.d.ts +14 -5
  251. package/script/src/interpreter/durable/DurableInterpreter.d.ts.map +1 -1
  252. package/script/src/interpreter/durable/DurableInterpreter.js +20 -18
  253. package/script/src/interpreter/durable/ObservableCompiler.d.ts +6 -3
  254. package/script/src/interpreter/durable/ObservableCompiler.d.ts.map +1 -1
  255. package/script/src/interpreter/durable/compilers/durableworkflow.d.ts.map +1 -1
  256. package/script/src/interpreter/durable/compilers/durableworkflow.js +10 -1
  257. package/script/src/interpreter/durable/compilers/http.d.ts.map +1 -1
  258. package/script/src/interpreter/durable/compilers/http.js +26 -9
  259. package/script/src/interpreter/durable/compilers/schedule.d.ts.map +1 -1
  260. package/script/src/interpreter/durable/compilers/schedule.js +41 -18
  261. package/script/src/interpreter/durable/compilers/webhook.d.ts.map +1 -1
  262. package/script/src/interpreter/durable/compilers/webhook.js +30 -33
  263. package/script/src/interpreter/memory/MemoryInterpreter.d.ts +4 -4
  264. package/script/src/interpreter/memory/MemoryInterpreter.d.ts.map +1 -1
  265. package/script/src/interpreter/memory/MemoryInterpreter.js +14 -23
  266. package/script/src/interpreter/memory/ObservableCompiler.d.ts +6 -3
  267. package/script/src/interpreter/memory/ObservableCompiler.d.ts.map +1 -1
  268. package/script/src/interpreter/memory/compilers/http.d.ts.map +1 -1
  269. package/script/src/interpreter/memory/compilers/http.js +26 -9
  270. package/script/src/interpreter/memory/compilers/schedule.d.ts.map +1 -1
  271. package/script/src/interpreter/memory/compilers/schedule.js +34 -18
  272. package/script/src/interpreter/memory/compilers/webhook.d.ts.map +1 -1
  273. package/script/src/interpreter/memory/compilers/webhook.js +31 -34
  274. package/script/src/services/credentials/credential-v1alpha1.d.ts +4 -0
  275. package/script/src/services/credentials/credential-v1alpha1.d.ts.map +1 -0
  276. package/script/src/services/credentials/credential-v1alpha1.js +19 -0
  277. package/script/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_metadata_pb.d.ts +119 -0
  278. package/script/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_metadata_pb.d.ts.map +1 -0
  279. package/script/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_metadata_pb.js +70 -0
  280. package/script/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_service_pb.d.ts +245 -0
  281. package/script/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_service_pb.d.ts.map +1 -0
  282. package/script/src/services/credentials/generated/versori/credential/oauth1/v1/authorization_service_pb.js +47 -0
  283. package/script/src/services/credentials/generated/versori/credential/oauth2/v1/token_pb.d.ts +38 -0
  284. package/script/src/services/credentials/generated/versori/credential/oauth2/v1/token_pb.d.ts.map +1 -0
  285. package/script/src/{dsl/http → services/credentials/generated}/versori/credential/oauth2/v1/token_pb.js +1 -1
  286. package/script/src/services/credentials/generated/versori/credential/oauth2/v1/token_service_pb.d.ts +471 -0
  287. package/script/src/services/credentials/generated/versori/credential/oauth2/v1/token_service_pb.d.ts.map +1 -0
  288. package/script/src/{dsl/http → services/credentials/generated}/versori/credential/oauth2/v1/token_service_pb.js +1 -1
  289. package/script/src/services/credentials/generated/versori/credential/tokens/v1/token_pb.d.ts +38 -0
  290. package/script/src/services/credentials/generated/versori/credential/tokens/v1/token_pb.d.ts.map +1 -0
  291. package/script/src/{dsl/http → services/credentials/generated}/versori/credential/tokens/v1/token_pb.js +1 -1
  292. package/script/src/services/credentials/generated/versori/credential/tokens/v1/token_service_pb.d.ts +128 -0
  293. package/script/src/services/credentials/generated/versori/credential/tokens/v1/token_service_pb.d.ts.map +1 -0
  294. package/script/src/{dsl/http → services/credentials/generated}/versori/credential/tokens/v1/token_service_pb.js +1 -1
  295. package/script/src/services/credentials/generated/versori/credential/v1alpha1/common_pb.d.ts +90 -0
  296. package/script/src/services/credentials/generated/versori/credential/v1alpha1/common_pb.d.ts.map +1 -0
  297. package/script/src/{dsl/http → services/credentials/generated}/versori/credential/v1alpha1/common_pb.js +16 -6
  298. package/script/src/services/credentials/generated/versori/credential/v1alpha1/credential_pb.d.ts +1468 -0
  299. package/script/src/services/credentials/generated/versori/credential/v1alpha1/credential_pb.d.ts.map +1 -0
  300. package/script/src/services/credentials/generated/versori/credential/v1alpha1/credential_pb.js +538 -0
  301. package/script/src/services/credentials/generated/versori/credential/v1alpha1/credential_service_pb.d.ts +390 -0
  302. package/script/src/services/credentials/generated/versori/credential/v1alpha1/credential_service_pb.d.ts.map +1 -0
  303. package/script/src/{dsl/http → services/credentials/generated}/versori/credential/v1alpha1/credential_service_pb.js +1 -1
  304. package/script/src/services/credentials/isTokenValid.d.ts +3 -0
  305. package/script/src/services/credentials/isTokenValid.d.ts.map +1 -0
  306. package/script/src/services/credentials/isTokenValid.js +11 -0
  307. package/script/src/services/credentials/mod.d.ts +5 -0
  308. package/script/src/services/credentials/mod.d.ts.map +1 -0
  309. package/script/src/services/credentials/mod.js +30 -0
  310. package/script/src/services/credentials/oauth1-v1.d.ts +3 -0
  311. package/script/src/services/credentials/oauth1-v1.d.ts.map +1 -0
  312. package/script/src/services/credentials/oauth1-v1.js +18 -0
  313. package/script/src/services/credentials/oauth2-v1.d.ts +3 -0
  314. package/script/src/services/credentials/oauth2-v1.d.ts.map +1 -0
  315. package/script/src/services/credentials/oauth2-v1.js +18 -0
  316. package/script/src/services/credentials/tokens-v1.d.ts +3 -0
  317. package/script/src/services/credentials/tokens-v1.d.ts.map +1 -0
  318. package/script/src/services/credentials/tokens-v1.js +18 -0
  319. package/script/src/services/platform/PlatformApi.d.ts +7 -0
  320. package/script/src/services/platform/PlatformApi.d.ts.map +1 -0
  321. package/script/src/services/platform/PlatformApi.js +52 -0
  322. package/script/src/services/platform/generated/client/client.gen.d.ts +3 -0
  323. package/script/src/services/platform/generated/client/client.gen.d.ts.map +1 -0
  324. package/script/src/services/platform/generated/client/client.gen.js +180 -0
  325. package/script/src/services/platform/generated/client/index.d.ts +8 -0
  326. package/script/src/services/platform/generated/client/index.d.ts.map +1 -0
  327. package/script/src/services/platform/generated/client/index.js +15 -0
  328. package/script/src/services/platform/generated/client/types.gen.d.ts +125 -0
  329. package/script/src/services/platform/generated/client/types.gen.d.ts.map +1 -0
  330. package/script/src/services/platform/generated/client/types.gen.js +3 -0
  331. package/script/src/services/platform/generated/client/utils.gen.d.ts +39 -0
  332. package/script/src/services/platform/generated/client/utils.gen.d.ts.map +1 -0
  333. package/script/src/services/platform/generated/client/utils.gen.js +245 -0
  334. package/script/src/services/platform/generated/client.gen.d.ts +13 -0
  335. package/script/src/services/platform/generated/client.gen.d.ts.map +1 -0
  336. package/script/src/services/platform/generated/client.gen.js +8 -0
  337. package/script/src/services/platform/generated/core/auth.gen.d.ts +19 -0
  338. package/script/src/services/platform/generated/core/auth.gen.d.ts.map +1 -0
  339. package/script/src/services/platform/generated/core/auth.gen.js +18 -0
  340. package/script/src/services/platform/generated/core/bodySerializer.gen.d.ts +18 -0
  341. package/script/src/services/platform/generated/core/bodySerializer.gen.d.ts.map +1 -0
  342. package/script/src/services/platform/generated/core/bodySerializer.gen.js +60 -0
  343. package/script/src/services/platform/generated/core/params.gen.d.ts +34 -0
  344. package/script/src/services/platform/generated/core/params.gen.d.ts.map +1 -0
  345. package/script/src/services/platform/generated/core/params.gen.js +92 -0
  346. package/script/src/services/platform/generated/core/pathSerializer.gen.d.ts +34 -0
  347. package/script/src/services/platform/generated/core/pathSerializer.gen.d.ts.map +1 -0
  348. package/script/src/services/platform/generated/core/pathSerializer.gen.js +123 -0
  349. package/script/src/services/platform/generated/core/serverSentEvents.gen.d.ts +60 -0
  350. package/script/src/services/platform/generated/core/serverSentEvents.gen.d.ts.map +1 -0
  351. package/script/src/services/platform/generated/core/serverSentEvents.gen.js +125 -0
  352. package/script/src/services/platform/generated/core/types.gen.d.ts +79 -0
  353. package/script/src/services/platform/generated/core/types.gen.d.ts.map +1 -0
  354. package/script/src/services/platform/generated/core/types.gen.js +3 -0
  355. package/script/src/services/platform/generated/core/utils.gen.d.ts +15 -0
  356. package/script/src/services/platform/generated/core/utils.gen.d.ts.map +1 -0
  357. package/script/src/services/platform/generated/core/utils.gen.js +74 -0
  358. package/script/src/services/platform/generated/index.d.ts +3 -0
  359. package/script/src/services/platform/generated/index.d.ts.map +1 -0
  360. package/script/src/services/platform/generated/index.js +19 -0
  361. package/script/src/services/platform/generated/sdk.gen.d.ts +494 -0
  362. package/script/src/services/platform/generated/sdk.gen.d.ts.map +1 -0
  363. package/script/src/services/platform/generated/sdk.gen.js +1992 -0
  364. package/script/src/services/platform/generated/types.gen.d.ts +3798 -0
  365. package/script/src/services/platform/generated/types.gen.d.ts.map +1 -0
  366. package/script/src/services/platform/generated/types.gen.js +3 -0
  367. package/script/src/services/platform/mod.d.ts +5 -0
  368. package/script/src/services/platform/mod.d.ts.map +1 -0
  369. package/script/src/services/platform/mod.js +18 -0
  370. package/esm/src/dsl/http/versori/credential/client.d.ts +0 -13
  371. package/esm/src/dsl/http/versori/credential/client.d.ts.map +0 -1
  372. package/esm/src/dsl/http/versori/credential/client.js +0 -35
  373. package/esm/src/dsl/http/versori/credential/credentials.d.ts +0 -98
  374. package/esm/src/dsl/http/versori/credential/credentials.d.ts.map +0 -1
  375. package/esm/src/dsl/http/versori/credential/credentials.js +0 -40
  376. package/esm/src/dsl/http/versori/credential/mod.d.ts +0 -2
  377. package/esm/src/dsl/http/versori/credential/mod.d.ts.map +0 -1
  378. package/esm/src/dsl/http/versori/credential/mod.js +0 -1
  379. package/esm/src/dsl/http/versori/credential/oauth2/v1/token_pb.d.ts +0 -13
  380. package/esm/src/dsl/http/versori/credential/oauth2/v1/token_pb.d.ts.map +0 -1
  381. package/esm/src/dsl/http/versori/credential/oauth2/v1/token_service_pb.d.ts +0 -102
  382. package/esm/src/dsl/http/versori/credential/oauth2/v1/token_service_pb.d.ts.map +0 -1
  383. package/esm/src/dsl/http/versori/credential/tokens/v1/token_pb.d.ts +0 -13
  384. package/esm/src/dsl/http/versori/credential/tokens/v1/token_pb.d.ts.map +0 -1
  385. package/esm/src/dsl/http/versori/credential/tokens/v1/token_service_pb.d.ts +0 -46
  386. package/esm/src/dsl/http/versori/credential/tokens/v1/token_service_pb.d.ts.map +0 -1
  387. package/esm/src/dsl/http/versori/credential/v1alpha1/common_pb.d.ts +0 -40
  388. package/esm/src/dsl/http/versori/credential/v1alpha1/common_pb.d.ts.map +0 -1
  389. package/esm/src/dsl/http/versori/credential/v1alpha1/credential_service_pb.d.ts +0 -129
  390. package/esm/src/dsl/http/versori/credential/v1alpha1/credential_service_pb.d.ts.map +0 -1
  391. package/esm/src/dsl/http/versori/roundtripper.d.ts +0 -61
  392. package/esm/src/dsl/http/versori/roundtripper.d.ts.map +0 -1
  393. package/esm/src/dsl/http/versori/roundtripper.js +0 -967
  394. package/script/src/dsl/http/versori/credential/client.d.ts +0 -13
  395. package/script/src/dsl/http/versori/credential/client.d.ts.map +0 -1
  396. package/script/src/dsl/http/versori/credential/client.js +0 -39
  397. package/script/src/dsl/http/versori/credential/credentials.d.ts +0 -98
  398. package/script/src/dsl/http/versori/credential/credentials.d.ts.map +0 -1
  399. package/script/src/dsl/http/versori/credential/credentials.js +0 -46
  400. package/script/src/dsl/http/versori/credential/mod.d.ts +0 -2
  401. package/script/src/dsl/http/versori/credential/mod.d.ts.map +0 -1
  402. package/script/src/dsl/http/versori/credential/mod.js +0 -5
  403. package/script/src/dsl/http/versori/credential/oauth2/v1/token_pb.d.ts +0 -13
  404. package/script/src/dsl/http/versori/credential/oauth2/v1/token_pb.d.ts.map +0 -1
  405. package/script/src/dsl/http/versori/credential/oauth2/v1/token_service_pb.d.ts +0 -102
  406. package/script/src/dsl/http/versori/credential/oauth2/v1/token_service_pb.d.ts.map +0 -1
  407. package/script/src/dsl/http/versori/credential/tokens/v1/token_pb.d.ts +0 -13
  408. package/script/src/dsl/http/versori/credential/tokens/v1/token_pb.d.ts.map +0 -1
  409. package/script/src/dsl/http/versori/credential/tokens/v1/token_service_pb.d.ts +0 -46
  410. package/script/src/dsl/http/versori/credential/tokens/v1/token_service_pb.d.ts.map +0 -1
  411. package/script/src/dsl/http/versori/credential/v1alpha1/common_pb.d.ts +0 -40
  412. package/script/src/dsl/http/versori/credential/v1alpha1/common_pb.d.ts.map +0 -1
  413. package/script/src/dsl/http/versori/credential/v1alpha1/credential_service_pb.d.ts +0 -129
  414. package/script/src/dsl/http/versori/credential/v1alpha1/credential_service_pb.d.ts.map +0 -1
  415. package/script/src/dsl/http/versori/roundtripper.d.ts +0 -61
  416. package/script/src/dsl/http/versori/roundtripper.d.ts.map +0 -1
  417. package/script/src/dsl/http/versori/roundtripper.js +0 -974
@@ -0,0 +1,3798 @@
1
+ export type Activation = {
2
+ id: string;
3
+ user: EndUser;
4
+ environment?: ProjectEnvironment;
5
+ connections?: Array<Connection>;
6
+ dynamicVariables?: DynamicVariables;
7
+ };
8
+ export type ActivationsList = Array<Activation>;
9
+ /**
10
+ * ActivationCreate is the request payload to activate an environment for End User
11
+ *
12
+ */
13
+ export type ActivationCreate = {
14
+ /**
15
+ * This userID could be the id or the external_id of the user that is being activated.
16
+ */
17
+ userId: string;
18
+ environmentId: string;
19
+ connections: Array<{
20
+ connectionTemplateId: TemplateId;
21
+ connection?: ConnectionCreate;
22
+ /**
23
+ * The id of an existing connection to be linked to the environment. If 'connection' is provided, this field is ignored.
24
+ */
25
+ existingConnectionId?: string;
26
+ }>;
27
+ dynamicVariables?: DynamicVariables;
28
+ };
29
+ /**
30
+ * ConnectionCreate defines the connection to create.
31
+ */
32
+ export type ConnectionCreate = {
33
+ /**
34
+ * Name is the name of the Connection.
35
+ */
36
+ name: string;
37
+ credentials: ConnectionCredentialsCreate;
38
+ /**
39
+ * BaseURL is the base URL for the connection. This allows you to override the baseURL for the system being connected to.
40
+ * An example is where the system's baseURL is https://shopifyplaceholder.com and you want to connect to your own shopify
41
+ * which is at https://myshopify.com. Everything after the top-level domain will be ignored. If the scheme is missing, then
42
+ * https:// will be used.
43
+ *
44
+ */
45
+ baseUrl?: string;
46
+ };
47
+ export type EnvSystemConnectionCreate = {
48
+ connectionTemplateId: TemplateId;
49
+ connection: ConnectionCreate;
50
+ };
51
+ /**
52
+ * LinkConnectionEnvironment is the request payload to link an existing connection to an environment.
53
+ *
54
+ */
55
+ export type LinkConnectionEnvironment = {
56
+ connectionTemplateId: TemplateId;
57
+ };
58
+ /**
59
+ * ProjectCreate is the request body for creating a new Project.
60
+ */
61
+ export type ProjectCreate = {
62
+ /**
63
+ * Name is the name of the project.
64
+ */
65
+ name: string;
66
+ /**
67
+ * The unique identifier for the project.
68
+ */
69
+ id?: string;
70
+ };
71
+ /**
72
+ * ProjectUpdate is the request body for updating a Project.
73
+ */
74
+ export type ProjectUpdate = {
75
+ /**
76
+ * Name is the name of the project.
77
+ */
78
+ name?: string;
79
+ settings?: ProjectSettings;
80
+ metadata?: ProjectMetadata;
81
+ };
82
+ /**
83
+ * ProjectSettings hold configuration for the project
84
+ */
85
+ export type ProjectSettings = {
86
+ acceptCodeChangesAutomatically?: boolean;
87
+ };
88
+ /**
89
+ * ProjectMetadata hold metadata for the project
90
+ */
91
+ export type ProjectMetadata = {
92
+ sentimentHistory?: Array<Sentiment>;
93
+ };
94
+ /**
95
+ * Sentiment is the sentiment of a project
96
+ */
97
+ export type Sentiment = {
98
+ timestamp: string;
99
+ sentimentScore: number;
100
+ messageId: string;
101
+ };
102
+ /**
103
+ * SentimentRequest is the request body for adding a sentiment entry to a project
104
+ */
105
+ export type SentimentRequest = {
106
+ /**
107
+ * The sentiment score for this entry
108
+ */
109
+ sentimentScore: number;
110
+ /**
111
+ * The message ID associated with this sentiment
112
+ */
113
+ messageId: string;
114
+ };
115
+ /**
116
+ * ProjectsList is the response body for listing all projects.
117
+ */
118
+ export type ProjectsList = {
119
+ projects: Array<ProjectSummary>;
120
+ };
121
+ /**
122
+ * The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.
123
+ *
124
+ */
125
+ export type ProjectSummary = {
126
+ /**
127
+ * The unique identifier for the project.
128
+ */
129
+ id: string;
130
+ name: string;
131
+ createdAt: string;
132
+ /**
133
+ * List of environments for the project.
134
+ *
135
+ */
136
+ environments: Array<ProjectEnvironment>;
137
+ };
138
+ /**
139
+ * DynamicVariablesSchema is the JSON schema for the project's dynamic variables.
140
+ *
141
+ */
142
+ export type DynamicVariablesSchema = {
143
+ [key: string]: unknown;
144
+ };
145
+ /**
146
+ * DynamicVariablesSchemaPatch is the request body for updating the project's dynamic variables.
147
+ *
148
+ */
149
+ export type DynamicVariablesSchemaPatch = {
150
+ op: 'add' | 'remove' | 'replace';
151
+ /**
152
+ * The path to the field to update. This should be a JSON path to the field to update. For example, if you want
153
+ * to update/remove the dynamic variables `newVar` in the following schema:
154
+ *
155
+ * ```
156
+ * {
157
+ * "type": "object",
158
+ * "properties": {
159
+ * "newVar": {
160
+ * "type": "string"
161
+ * }
162
+ * }
163
+ * }
164
+ * ```
165
+ *
166
+ * The path would be `/properties/newVar`.
167
+ *
168
+ */
169
+ path: string;
170
+ /**
171
+ * The value to set the field to. This should be valid JSON schema containing the name of the variable, its type
172
+ * and any other properties. An example would be `{"newVar": {"type": "string"}}`.
173
+ *
174
+ */
175
+ value?: {
176
+ [key: string]: unknown;
177
+ };
178
+ };
179
+ /**
180
+ * The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.
181
+ *
182
+ */
183
+ export type Project = {
184
+ /**
185
+ * The unique identifier for the project.
186
+ */
187
+ id: string;
188
+ /**
189
+ * List of environments for the project.
190
+ *
191
+ */
192
+ environments: Array<ProjectEnvironment>;
193
+ name: string;
194
+ currentFiles: Files;
195
+ createdAt: string;
196
+ dynamicVariablesSchema?: DynamicVariablesSchema;
197
+ settings: ProjectSettings;
198
+ metadata: ProjectMetadata;
199
+ };
200
+ export type ProjectEnvironment = {
201
+ /**
202
+ * The unique identifier for the environment.
203
+ */
204
+ id: string;
205
+ name: string;
206
+ /**
207
+ * One of running|suspended|error|draft.
208
+ */
209
+ status: string;
210
+ createdAt: string;
211
+ updatedAt: string;
212
+ publicUrl: string;
213
+ /**
214
+ * The files associated with the project.
215
+ */
216
+ files?: Array<File>;
217
+ labels?: Labels;
218
+ config: EnvironmentConfig;
219
+ };
220
+ export type File = {
221
+ /**
222
+ * The name of the file.
223
+ */
224
+ filename: string;
225
+ /**
226
+ * The content of the file.
227
+ */
228
+ content: string;
229
+ };
230
+ export type Files = {
231
+ /**
232
+ * The files associated with the project.
233
+ */
234
+ files: Array<File>;
235
+ /**
236
+ * The labels associated with the project. Labels are stored as key-value pairs.
237
+ * Only string-string values are allowed
238
+ *
239
+ */
240
+ labels: {
241
+ [key: string]: unknown;
242
+ };
243
+ };
244
+ /**
245
+ * ErrorField denotes a field which has an error.
246
+ */
247
+ export type ErrorField = {
248
+ /**
249
+ * Field is the name of the field which has an error, this may be a path to a nested field, including array
250
+ * elements. The format of this field is of the form: "field1.field2[0].field3"
251
+ *
252
+ */
253
+ field: string;
254
+ /**
255
+ * Message is the error message for this specific field.
256
+ */
257
+ message: string;
258
+ };
259
+ export type _Error = {
260
+ /**
261
+ * Code is a machine-readable error code.
262
+ */
263
+ code: string;
264
+ /**
265
+ * Message is a human-readable error message.
266
+ */
267
+ message: string;
268
+ fields?: Array<ErrorField>;
269
+ details?: string;
270
+ };
271
+ export type Log = {
272
+ timestamp: string;
273
+ severity: string;
274
+ message: string;
275
+ error?: string;
276
+ httpRequest?: {
277
+ [key: string]: unknown;
278
+ };
279
+ fields?: {
280
+ [key: string]: unknown;
281
+ };
282
+ };
283
+ export type Logs = {
284
+ logs: Array<Log>;
285
+ nextToken?: string;
286
+ };
287
+ export type PageInfo = {
288
+ totalCount: number;
289
+ next?: string;
290
+ prev?: string;
291
+ };
292
+ /**
293
+ * This is the ID of the template that the connection is created against.
294
+ *
295
+ */
296
+ export type TemplateId = string;
297
+ /**
298
+ * ConnectionUpdate is the request payload to update an existing connection.
299
+ *
300
+ */
301
+ export type ConnectionUpdate = {
302
+ /**
303
+ * Name is the name of the Connection. This must be unique within the owning Connector.
304
+ */
305
+ name: string;
306
+ credentials: ConnectionCredentials;
307
+ /**
308
+ * The baseUrl on the connection allows a dynamic user to override the base URL of the connection. This is useful
309
+ * when users have their own instance of a service and want to connect to it.
310
+ *
311
+ * For example, a user may have their own instance of shopify and their url is `https://myshopify.com`. They can
312
+ * override the base url of the connection to `https://myshopify.com` and all requests will be made to this url.
313
+ * If it is left as an empty string, it will be ignored.
314
+ *
315
+ */
316
+ baseUrl: string;
317
+ };
318
+ /**
319
+ * Connection defines the credentials for the owning Connector, and additional variables
320
+ * which can be used to customize the Connector in a particular connection.
321
+ *
322
+ */
323
+ export type Connection = {
324
+ /**
325
+ * ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
326
+ * public-facing APIs will use the `name` in combination with the Connector's `id` instead.
327
+ *
328
+ */
329
+ id: string;
330
+ /**
331
+ * Name is the name of the Connection. This must be unique within the owning Connector.
332
+ */
333
+ name: string;
334
+ credentials: ConnectionCredentials;
335
+ /**
336
+ * The baseUrl on the connection allows a dynamic user to override the base URL of the connection. This is useful
337
+ * when users have their own instance of a service and want to connect to it.
338
+ *
339
+ * For example, a user may have their own instance of shopify and their url is `https://myshopify.com`. They can
340
+ * override the base url of the connection to `https://myshopify.com` and all requests will be made to this url.
341
+ * If it is left as an empty string, it will be ignored.
342
+ *
343
+ */
344
+ baseUrl?: string;
345
+ /**
346
+ * CreatedAt is the time the Connection was created.
347
+ */
348
+ createdAt: string;
349
+ /**
350
+ * UpdatedAt is the time the Connection was last updated.
351
+ */
352
+ updatedAt: string;
353
+ /**
354
+ * ID of the system to add the project environment.
355
+ */
356
+ systemId?: string;
357
+ connectionTemplateId?: TemplateId;
358
+ };
359
+ /**
360
+ * ConnectionCredentials defines the credentials for the owning Connector. If multiple
361
+ * credentials are defined for each type, they are applied to the request in the order they are defined. This is to
362
+ * enable Connectors which require both a user session token and an API key to be provided in the request.
363
+ *
364
+ */
365
+ export type ConnectionCredentials = Array<ConnectionCredential>;
366
+ /**
367
+ * ConnectionPage defines a page of Connection summaries.
368
+ */
369
+ export type ConnectionPage = PageInfo & {
370
+ items: Array<Connection>;
371
+ };
372
+ /**
373
+ * ConnectionCredential contains the a Credential and the AuthSchemeConfig to define how the Credential should be used against the Connection's Connector.
374
+ */
375
+ export type ConnectionCredential = {
376
+ id: string;
377
+ authSchemeConfig?: AuthSchemeConfig;
378
+ credential?: Credential;
379
+ };
380
+ /**
381
+ * CredentialBase is the base type for all credentials. It contains the common properties which are shared across
382
+ * all credential types.
383
+ *
384
+ */
385
+ export type Credential = {
386
+ /**
387
+ * ID is the unique identifier of the Credential.
388
+ */
389
+ id: string;
390
+ /**
391
+ * OrganisationID is the unique identifier of the Organisation which owns the Credential.
392
+ */
393
+ organisationId: string;
394
+ type?: CredentialType;
395
+ /**
396
+ * Name is the name of the Credential.
397
+ */
398
+ name?: string;
399
+ /**
400
+ * Errors is a list of errors which occurred when attempting to validate the credential. This field may be
401
+ * undefined, which implies that validation has not occurred and the consumer cannot assume whether this
402
+ * Credential is valid or not. An empty array indicates that the Credential is valid.
403
+ *
404
+ */
405
+ errors?: Array<string>;
406
+ data?: CredentialData;
407
+ /**
408
+ * ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe
409
+ * to deletion events and if the reason is "expired", can trigger the correct notifications to interested
410
+ * parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).
411
+ *
412
+ */
413
+ expiresAt?: string;
414
+ };
415
+ export type CredentialData = {
416
+ binary?: CredentialDataBinary;
417
+ none?: CredentialDataNone;
418
+ string?: CredentialDataString;
419
+ basicAuth?: CredentialDataBasicAuth;
420
+ oauth2Client?: CredentialDataOAuth2Client;
421
+ oauth2Token?: CredentialDataOAuth2Token;
422
+ oauth2Code?: CredentialDataOAuth2Code;
423
+ oauth2Password?: CredentialDataOAuth2Password;
424
+ certificate?: CredentialDataCertificate;
425
+ oauth1?: CredentialDataOAuth1;
426
+ oauth1Token?: CredentialDataOAuth1Token;
427
+ };
428
+ /**
429
+ * CredentialType denotes the type of the credential which determines what the Credential's `data` property will
430
+ * contain.
431
+ *
432
+ * - none: No credential is required to authenticate with the Connector.
433
+ * - string: The credential is a string value, such as an API key or password.
434
+ * - binary: The credential is a binary value, such as a private key, certificate or other file.
435
+ * - basic-auth: The credential is a username and password to be used for basic authentication.
436
+ * - oauth2-client: The credential is an OAuth2 client ID and secret to be used for OAuth2 authentication.
437
+ * - oauth2-code: The credential is a temporary authorization code which will be exchanged for an oauth2-token.
438
+ * - oauth2-password: The credential is an OAuth2 username and password with an optional client ID and secret to be used for OAuth2 authentication.
439
+ * - oauth2-token: The credential is an OAuth2 access_token to be used for OAuth2 authentication.
440
+ * - oauth1: The credential is an OAuth1 access_token to be used for OAuth1 authentication.
441
+ * - oauth1-token: The credential is the oatuh1 token allowing bypassing the user authorization step.
442
+ * - certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.
443
+ *
444
+ */
445
+ export type CredentialType = 'none' | 'string' | 'binary' | 'basic-auth' | 'oauth2-client' | 'oauth1' | 'oauth1-token' | 'oauth2-code' | 'oauth2-password' | 'oauth2-token' | 'certificate';
446
+ /**
447
+ * None
448
+ * CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used
449
+ * purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.
450
+ *
451
+ */
452
+ export type CredentialDataNone = {
453
+ [key: string]: never;
454
+ };
455
+ /**
456
+ * String
457
+ * CredentialDataString contains a string value and nothing else and is commonly used for API keys. This value
458
+ * will be redacted when returned in a response.
459
+ *
460
+ */
461
+ export type CredentialDataString = {
462
+ /**
463
+ * Value is a UTF-8 string containing the credential data. When read from the API this field will be redacted.
464
+ *
465
+ */
466
+ value: string;
467
+ };
468
+ /**
469
+ * JWT
470
+ * CredentialJWTBearer contains the username and password required to authenticate with the Connector. The
471
+ * `secret` property will be redacted when returned in a response.
472
+ *
473
+ */
474
+ export type CredentialJwtBearer = {
475
+ algorithm: 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512';
476
+ /**
477
+ * Secret is the base64 encoded secret used to sign new JWTs.
478
+ *
479
+ */
480
+ secret: string;
481
+ /**
482
+ * Payload is stringified JSON object containing the default set of claims to include in the JWT payload.
483
+ * Issued JWTs may contain additional claims and may overwrite ones defined here, such as `exp` and `iat`.
484
+ *
485
+ */
486
+ payload: string;
487
+ /**
488
+ * Expires in is a duration in the form `1h2m3s` (see Go's `time.Duration` documentation) which defined
489
+ * how long a newly issued JWT should be valid for.
490
+ *
491
+ */
492
+ expiresIn: string;
493
+ /**
494
+ * AuthorizationHeaderPrefix is the prefix to use when setting the Authorization header, for example,
495
+ * "Bearer" or "JWT".
496
+ *
497
+ */
498
+ authorizationHeaderPrefix: string;
499
+ };
500
+ /**
501
+ * Username/Password
502
+ * CredentialDataBasicAuth contains the username and password required to authenticate with the Connector. The
503
+ * `password` property will be redacted when returned in a response.
504
+ *
505
+ */
506
+ export type CredentialDataBasicAuth = {
507
+ /**
508
+ * Username is the username used to authenticate with the Connector.
509
+ */
510
+ username: string;
511
+ /**
512
+ * Password is the password used to authenticate with the Connector. Will be redacted when returned in a
513
+ * response.
514
+ *
515
+ */
516
+ password: string;
517
+ };
518
+ /**
519
+ * Certificate
520
+ * CredentialDataCertificate contains the Certificate, Certificate key and CA(Certificate authority).
521
+ *
522
+ */
523
+ export type CredentialDataCertificate = {
524
+ /**
525
+ * Certificate is the certificate that will be send to the connection.
526
+ */
527
+ certificate: string;
528
+ /**
529
+ * Key is the accompanying key for the certificate.
530
+ */
531
+ key: string;
532
+ /**
533
+ * CA is the Certificate Authority to verify the server certificates against.
534
+ */
535
+ ca: string;
536
+ };
537
+ /**
538
+ * OAuth 2.0 Password
539
+ * CredentialDataOAuth2Password contains the username and password of a Resource Owner within an OAuth 2.0
540
+ * application. The `password` property will be redacted when returned in a response.
541
+ *
542
+ */
543
+ export type CredentialDataOAuth2Password = {
544
+ /**
545
+ * Username is the username used to authenticate with the Connector.
546
+ */
547
+ username: string;
548
+ /**
549
+ * Password is the password used to authenticate with the Connector. Will be redacted when returned in a
550
+ * response.
551
+ *
552
+ */
553
+ password: string;
554
+ };
555
+ /**
556
+ * OAuth 2.0 Client
557
+ * CredentialDataOAuth2Client contains the OAuth2 client credentials required to either issue an access token from
558
+ * a refresh_token, or via the `client_credentials` and `authorization_code` grant types. The `clientSecret` property will be redacted when
559
+ * returned in a response.
560
+ *
561
+ */
562
+ export type CredentialDataOAuth2Client = {
563
+ /**
564
+ * ClientID is the OAuth2 client ID used to authenticate with the Connector.
565
+ *
566
+ */
567
+ clientId: string;
568
+ /**
569
+ * ClientSecret is the OAuth2 client secret used to authenticate with the Connector. Will be redacted when
570
+ * returned in a response.
571
+ *
572
+ */
573
+ clientSecret: string;
574
+ /**
575
+ * TokenURL is the URL which the application will use to issue an access token.
576
+ */
577
+ tokenUrl: string;
578
+ /**
579
+ * Scopes is a list of scopes which should be requested when issuing an access token. This is only required if
580
+ * this credential is being used on a `client_credentials` grant type, for `authorization_code` grant types the
581
+ * requested scopes come from the `CredentialDataOAuth2Token` credential.
582
+ *
583
+ */
584
+ scopes?: Array<string>;
585
+ /**
586
+ * AdditionalParams is a URL-encoded query string which can be used to pass additional
587
+ * parameters to the OAuth 2.0 token endpoint. These parameters are attached to the body
588
+ * in the formatted as the `application/x-www-form-urlencoded` content-type.
589
+ *
590
+ */
591
+ additionalParams?: string;
592
+ /**
593
+ * MTLSEnabled is a boolean flag which determines whether the client should use mutual TLS authentication when
594
+ * communicating with the OAuth2 provider. If enabled, the `mTLSCredentialId` field must be set, or it must be
595
+ * created via the `CreateConnection` endpoint with an associated mTLS credential defined beforehand, in which
596
+ * case the mTLSCredentialID field will be populated upon saving by the API.
597
+ *
598
+ */
599
+ mTLSEnabled?: boolean;
600
+ /**
601
+ * MTLSCredentialID is an optional reference to another credential being created.
602
+ * If set the certificate credential will be used when making a request to the tokenUrl.
603
+ *
604
+ */
605
+ mTLSCredentialId?: string;
606
+ };
607
+ /**
608
+ * OAuth 2.0 Token
609
+ * CredentialDataOAuth2Token is primarily used to store the refresh_token for an user who has authorized an OAuth2
610
+ * Application to access their data. However, this information is not exposed publicly and the only data visible
611
+ * via the API are the `scopes` which the user has granted consent for. This can be used to determine whether
612
+ * the user should be prompted to re-authorize the application with additional scopes in the event they choose to
613
+ * use a new endpoint which requires additional scopes to what they've already consented to.
614
+ *
615
+ */
616
+ export type CredentialDataOAuth2Token = {
617
+ /**
618
+ * Scopes is a list of scopes which the user has granted consent for.
619
+ */
620
+ scopes: Array<string>;
621
+ /**
622
+ * AccessToken is the OAuth2 access token which can be used to authenticate with the Connector. This
623
+ * information is redacted when read from the API.
624
+ *
625
+ */
626
+ accessToken?: string;
627
+ /**
628
+ * TokenType is the type of token which is being issued. Defaults to "Bearer" if not set.
629
+ *
630
+ */
631
+ tokenType?: string;
632
+ /**
633
+ * ExpiresAt is the time at which the access token will expire. If not defined, the accessToken will be
634
+ * reused until a 401 response is received from the Connector, at which point the token should be refreshed
635
+ * with the provided `refreshToken`. Ideally this should be provided so that erroneous failures can be
636
+ * avoided.
637
+ *
638
+ */
639
+ expiresAt?: string;
640
+ /**
641
+ * RefreshToken is the OAuth2 refresh token which can be used to issue new access tokens. This information is
642
+ * redacted when read from the API.
643
+ *
644
+ * This is a required field as it is used to refresh the access token when it expires. If users are providing
645
+ * an access token which does not expire using this credential type, then the same functionality may be
646
+ * achieved by using a simple API key and OAuth 2.0 need not be used.
647
+ *
648
+ */
649
+ refreshToken: string;
650
+ };
651
+ /**
652
+ * OAuth 2.0 Code
653
+ * CredentialDataOAuth2Code is used to exchange an authorization code for an access token and
654
+ * is denoted by the `oauth2-code` type.
655
+ * This is only used when creating or updating an OAuth 2.0 connection using the
656
+ * `authorization_code` grant type. Retrieving this credential will return a payload of
657
+ * type `oauth2-token` in the shape of a `CredentialDataOAuth2Token` object.
658
+ *
659
+ */
660
+ export type CredentialDataOAuth2Code = {
661
+ /**
662
+ * Code is the authorization code which will be exchanged for an access token.
663
+ *
664
+ */
665
+ code: string;
666
+ /**
667
+ * State is the state value which is propagated through the OAuth2 flow.
668
+ *
669
+ */
670
+ state: string;
671
+ };
672
+ /**
673
+ * OAuth1
674
+ */
675
+ export type CredentialDataOAuth1 = {
676
+ state: string;
677
+ oauthToken: string;
678
+ oauthVerifier: string;
679
+ };
680
+ /**
681
+ * OAuth1Token
682
+ */
683
+ export type CredentialDataOAuth1Token = {
684
+ token: string;
685
+ tokenSecret: string;
686
+ additionalParams?: Array<AdditionalParam>;
687
+ };
688
+ export type AdditionalParam = {
689
+ name: string;
690
+ value?: string;
691
+ };
692
+ /**
693
+ * Binary
694
+ * CredentialDataBinary is commonly used to store non-string data such as binary files or encryption keys. This
695
+ * value will be redacted when returned in a response.
696
+ *
697
+ */
698
+ export type CredentialDataBinary = {
699
+ /**
700
+ * Value is a base64 encoded string containing the credential data. This could decode to a valid utf-8 string,
701
+ * or it could decode to a binary file such as a private key etc. When read from the API this field will be
702
+ * redacted.
703
+ *
704
+ */
705
+ valueBase64: string;
706
+ };
707
+ /**
708
+ * An AuthSchemeConfig describes how credentials should be used to authenticate with a System, an example being where
709
+ * an API key should be sent and what the header/query parameter/cookie name is. For OAuth2, this config object also
710
+ * contains data such as the token URL, client ID and secret, and scopes to request.
711
+ * This type contains a string called `type` which denotes which field in this object should be populated.
712
+ * For example if the `type` is `api-key`, then the `apiKey` field will be populated with an
713
+ * `AuthSchemeConfigAPIKey` object.
714
+ *
715
+ */
716
+ export type AuthSchemeConfig = {
717
+ type: AuthSchemeType;
718
+ none?: AuthSchemeConfigNone;
719
+ apiKey?: AuthSchemeConfigApiKey;
720
+ basicAuth?: AuthSchemeConfigBasicAuth;
721
+ oauth2?: AuthSchemeConfigOAuth2;
722
+ oauth1?: AuthSchemeConfigOAuth1;
723
+ hmac?: AuthSchemeConfigHmac;
724
+ certificate?: AuthSchemeConfigCertificate;
725
+ };
726
+ /**
727
+ * API Key
728
+ * AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system.
729
+ *
730
+ */
731
+ export type AuthSchemeConfigApiKey = AuthSchemeConfigBase & {
732
+ /**
733
+ * Name is the query parameter/header/cookie name which will be used to send the API key.
734
+ */
735
+ name: string;
736
+ in: AuthSchemeConfigApiKeyIn;
737
+ };
738
+ /**
739
+ * AuthSchemeConfigAPIKeyIn defines the location of the API key in the request.
740
+ *
741
+ */
742
+ export type AuthSchemeConfigApiKeyIn = 'query' | 'header' | 'cookie';
743
+ /**
744
+ * Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see
745
+ * enum values for possible options.
746
+ *
747
+ */
748
+ export type AuthSchemeType = 'none' | 'api-key' | 'basic-auth' | 'oauth2' | 'hmac' | 'jwt-bearer' | 'certificate' | 'oauth1' | 'secret';
749
+ /**
750
+ * OAuth2Scope represents a single scope which can be requested by an OAuth2 application.
751
+ *
752
+ */
753
+ export type OAuth2Scope = {
754
+ /**
755
+ * Name is the name of the scope as determined by the application to which this Connector
756
+ * is connecting to.
757
+ *
758
+ */
759
+ name: string;
760
+ /**
761
+ * Description describes the scope in human-friendly terminology. This text may be
762
+ * displayed to users via a help tooltip or similar.
763
+ *
764
+ */
765
+ description?: string;
766
+ };
767
+ export type AuthSchemeConfigBase = {
768
+ /**
769
+ * ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and
770
+ * only requires to be unique amongst the elements of the array in which is it contained.
771
+ *
772
+ */
773
+ id: string;
774
+ /**
775
+ * Description enables users to distinguish multiple configurations which use the same
776
+ * schemeType.
777
+ *
778
+ */
779
+ description: string;
780
+ /**
781
+ * ValidationMessages is a list of messages which are generated when the AuthSchemeConfig
782
+ * is validated. This is typically used to provide feedback to the user when they are
783
+ * creating or updating the AuthSchemeConfig.
784
+ *
785
+ * This field will be ignored if sent to the API.
786
+ *
787
+ */
788
+ validationMessages?: Array<Message>;
789
+ };
790
+ export type AuthSchemeConfigOAuth2GrantType = 'authorizationCode' | 'clientCredentials' | 'password';
791
+ /**
792
+ * authorization_code
793
+ * AuthSchemeConfigOAuth2GrantAuthorizationCode contains grant-specific configuration for the
794
+ * `authorization_code` grant type.
795
+ *
796
+ * How the API manages changes to this configuration is as follows:
797
+ *
798
+ * - CredentialID and OrganisationID are not set, a new credential is created containing the
799
+ * sensitive information and the non-sensitive information is updated in the database.
800
+ * - Otherwise, both the credential and the database are updated using JSON Merge Patch, with
801
+ * undefined properties not being updated.
802
+ * - Any other permutation will result in a 400 Bad Request.
803
+ *
804
+ */
805
+ export type AuthSchemeConfigOAuth2GrantAuthorizationCode = {
806
+ /**
807
+ * CredentialID is the unique identifier of the Credential which contains the client ID and
808
+ * client secret to be used as part of the `password` flow.
809
+ *
810
+ */
811
+ credentialId?: string;
812
+ /**
813
+ * OrganisationID is the unique identifier of the Organisation that owns the Credential.
814
+ * This can be different to the Connector's OrganisationID since some may be imported from
815
+ * Versori's public library.
816
+ *
817
+ */
818
+ organisationId?: string;
819
+ /**
820
+ * ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be
821
+ * presented to the user in plaintext.
822
+ *
823
+ */
824
+ clientId?: string;
825
+ /**
826
+ * ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be
827
+ * displayed to the user.
828
+ *
829
+ */
830
+ clientSecret?: string;
831
+ };
832
+ /**
833
+ * client_credentials
834
+ */
835
+ export type AuthSchemeConfigOAuth2GrantClientCredentials = {
836
+ [key: string]: unknown;
837
+ };
838
+ /**
839
+ * password
840
+ * AuthSchemeConfigOAuth2GrantPassword contains grant-specific configuration for the `password`
841
+ * grant type.
842
+ *
843
+ * How the API manages changes to this configuration is as follows:
844
+ *
845
+ * - CredentialID and OrganisationID are not set, a new credential is created containing the
846
+ * sensitive information and the non-sensitive information is created/updated in the
847
+ * database.
848
+ * - Otherwise, both the credential and the database are updated using JSON Merge Patch.
849
+ * - Any other permutation will result in a 400 Bad Request.
850
+ *
851
+ */
852
+ export type AuthSchemeConfigOAuth2GrantPassword = {
853
+ /**
854
+ * CredentialID is the unique identifier of the Credential which contains the client ID and
855
+ * client secret to be used as part of the `password` flow.
856
+ *
857
+ */
858
+ credentialId?: string;
859
+ /**
860
+ * OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different
861
+ * to the Connector's OrganisationID since some may be imported from Versori's public library.
862
+ *
863
+ */
864
+ organisationId?: string;
865
+ /**
866
+ * ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the
867
+ * user in plaintext.
868
+ *
869
+ */
870
+ clientId?: string;
871
+ /**
872
+ * ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the
873
+ * user. It may be populated when updating the Credential.
874
+ *
875
+ */
876
+ clientSecret?: string;
877
+ };
878
+ export type AuthSchemeConfigOAuth2Grant = {
879
+ authorizationCode?: AuthSchemeConfigOAuth2GrantAuthorizationCode;
880
+ clientCredentials?: AuthSchemeConfigOAuth2GrantClientCredentials;
881
+ password?: AuthSchemeConfigOAuth2GrantPassword;
882
+ type: AuthSchemeConfigOAuth2GrantType;
883
+ };
884
+ /**
885
+ * None
886
+ * AuthSchemeConfigNone is a placeholder object with the schemeType set to `none`. There is no other configuration
887
+ * required.
888
+ *
889
+ */
890
+ export type AuthSchemeConfigNone = AuthSchemeConfigBase;
891
+ /**
892
+ * Basic Auth
893
+ * AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to `basic-auth`. There is no other
894
+ * configuration required.
895
+ *
896
+ */
897
+ export type AuthSchemeConfigBasicAuth = AuthSchemeConfigBase;
898
+ /**
899
+ * TLS Certificate
900
+ * AuthSchemeConfigCertificate is a placeholder object with the schemeType set to `certificate`.
901
+ * There is no other config required
902
+ *
903
+ */
904
+ export type AuthSchemeConfigCertificate = AuthSchemeConfigBase;
905
+ /**
906
+ * OAuth 2.0
907
+ * AuthSchemeConfigOAuth2 defines how a Connector uses an OAuth2 credential to authenticate
908
+ * with the system. This is to be used for all OAuth 2.0 flows which require a client ID and
909
+ * client secret as part of the Connector's configuration. Connectors which use the
910
+ * `client_credentials` grant type, where the user provides the Client ID and Client Secret at
911
+ * the point where they connect, should use the `AuthSchemeConfigOAuth2ClientCredentials` type
912
+ * instead.
913
+ *
914
+ */
915
+ export type AuthSchemeConfigOAuth2 = AuthSchemeConfigBase & {
916
+ /**
917
+ * AuthorizeURL is the URL which the user will be redirected to in order to authorize
918
+ * the application.
919
+ *
920
+ */
921
+ authorizeUrl?: string;
922
+ /**
923
+ * TokenURL is the URL which the application will use to issue an access token.
924
+ *
925
+ */
926
+ tokenUrl: string;
927
+ /**
928
+ * Scopes is the list of all OAuth2 scopes which the application supports. The user
929
+ * will be allowed to choose which scopes to request when configuring the Connection.
930
+ *
931
+ */
932
+ scopes: Array<OAuth2Scope>;
933
+ /**
934
+ * DefaultScopes is the list of scopes which will be requested by default when the user
935
+ * connects the Connector. This is useful for Connectors which require a specific set
936
+ * of scopes to function correctly.
937
+ *
938
+ */
939
+ defaultScopes: Array<string>;
940
+ /**
941
+ * AdditionalAuthorizeParams is a URL-encoded query string which should be attached to
942
+ * the AuthorizeURL when the user is redirected to the OAuth 2.0 authorization
943
+ * endpoint.
944
+ *
945
+ * This value is only used by the UI to drive the default values when connecting, the
946
+ * API to `InitialiseOAuth2Connection` can be provided a different value if required.
947
+ *
948
+ */
949
+ additionalAuthorizeParams?: string;
950
+ /**
951
+ * AdditionalTokenParams is a URL-encoded string following the
952
+ * `application/x-www-form-urlencoded` mime-type, which can be used to pass additional
953
+ * parameters to the OAuth 2.0 token endpoint within the request body.
954
+ *
955
+ */
956
+ additionalTokenParams?: string;
957
+ /**
958
+ * MTLSEnabled is a flag which determines whether the Connector should use Mutual TLS
959
+ * (mTLS) to authenticate with the OAuth 2.0 token endpoint. This is useful for
960
+ * Connectors which require a higher level of security.
961
+ *
962
+ */
963
+ mtlsEnabled?: boolean;
964
+ /**
965
+ * MTLSCredentialID is the unique identifier of the Credential which contains the
966
+ * client certificate and private key to be used as part of the mTLS connection.
967
+ *
968
+ * This may be unset when creating a connection, in which case if `mtlsEnabled` is
969
+ * true, then the API will find an associated AuthSchemeConfigCertificate and link
970
+ * them automatically.
971
+ *
972
+ */
973
+ mtlsCredentialId?: string;
974
+ pkce?: boolean;
975
+ grant: AuthSchemeConfigOAuth2Grant;
976
+ };
977
+ /**
978
+ * OAuth 2.0
979
+ */
980
+ export type AuthSchemeConfigOAuth1 = AuthSchemeConfigBase & {
981
+ /**
982
+ * If set to 'true' the endpoints are optional but when connecting you need to use oauth1-token credentials and provide the token and token secret.
983
+ * If left empty or set to 'false' you need to provide all the endpoint and connect using the oauth1 credentials which uses the browser authorize flow.
984
+ *
985
+ */
986
+ tokenAuth?: boolean;
987
+ consumerKey: string;
988
+ consumerSecret: string;
989
+ tempCredentialEndpoint?: Endpoint;
990
+ resourceOwnerAuthorizationEndpoint?: Endpoint;
991
+ tokenEndpoint?: Endpoint;
992
+ /**
993
+ * One of 'sha256', 'sha1'
994
+ */
995
+ signatureMethod: string;
996
+ credentialId?: string;
997
+ };
998
+ export type Endpoint = {
999
+ /**
1000
+ * URL of the endpoint, may contain templated values in curly braces
1001
+ */
1002
+ url: string;
1003
+ additionalParamConfigs?: Array<ParameterConfig>;
1004
+ parameterTransmission?: 'AUTH_STYLE_AUTHORIZATION_HEADER' | 'AUTH_STYLE_FORM' | 'AUTH_STYLE_QUERY';
1005
+ };
1006
+ export type ParameterConfig = {
1007
+ /**
1008
+ * Key of the additional parameter to insert
1009
+ */
1010
+ parameterName: string;
1011
+ /**
1012
+ * Override name for the parameter in endpoint requests
1013
+ */
1014
+ targetName?: string;
1015
+ location: 'LOCATION_IGNORE' | 'LOCATION_BODY' | 'LOCATION_HEADER' | 'LOCATION_QUERY' | 'LOCATION_ENDPOINT' | 'LOCATION_HEADER_PARAMETER';
1016
+ usages?: 'USAGE_UNKNOWN' | 'USAGE_TEMP_CREDENTIAL_ENDPOINT' | 'USAGE_TOKEN_REQUEST_ENDPOINT';
1017
+ /**
1018
+ * Whether parameter is required in requests
1019
+ */
1020
+ required: boolean;
1021
+ /**
1022
+ * Whether parameter can be modified by user
1023
+ */
1024
+ modifiable: boolean;
1025
+ };
1026
+ /**
1027
+ * AuthSchemeConfigHMACIn defines where the signature should be set on requests.
1028
+ */
1029
+ export type AuthSchemeConfigHmacIn = 'query' | 'header' | 'cookie';
1030
+ /**
1031
+ * HMAC
1032
+ * AuthSchemeConfigHMAC defines how a Connector uses an HMAC credential to authenticate with the system.
1033
+ *
1034
+ * This may be used on outbound requests to sign the request body, however it is more commonly used on inbound
1035
+ * requests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger.
1036
+ *
1037
+ */
1038
+ export type AuthSchemeConfigHmac = AuthSchemeConfigBase & {
1039
+ /**
1040
+ * Name is the query parameter/header/cookie name which will be used to send the signature.
1041
+ */
1042
+ name: string;
1043
+ in: AuthSchemeConfigHmacIn;
1044
+ /**
1045
+ * AuthSchemeConfigHMACAlgorithm defines the hashing algorithm to use when generating the HMAC signature.
1046
+ */
1047
+ algorithm: 'sha1' | 'sha256' | 'sha512';
1048
+ /**
1049
+ * AuthSchemeConfigHMACInputs defines what parts of a HTTP request are consumed to generate the HMAC signature. Some systems
1050
+ * only generate the signature from the request body, others may include the URL. The order of this array
1051
+ * defines the order in which the input is fed into the hashing function.
1052
+ *
1053
+ */
1054
+ digestInputs: Array<'body' | 'url'>;
1055
+ /**
1056
+ * Encoding defines how the HMAC signature was encoded. This can be one of `hex`, `base64` or `base64url`.
1057
+ *
1058
+ */
1059
+ encoding: 'hex' | 'base64' | 'base64url';
1060
+ };
1061
+ /**
1062
+ * Message is a message to be displayed to the user to indicate some information about the
1063
+ * preceding request.
1064
+ *
1065
+ */
1066
+ export type Message = {
1067
+ /**
1068
+ * Text contains the text of the message.
1069
+ */
1070
+ text: string;
1071
+ severity: MessageSeverity;
1072
+ /**
1073
+ * Details contains additional information about the message. This is intended to be used
1074
+ * to provide more information about the message, such as a list of validation errors.
1075
+ *
1076
+ */
1077
+ detail?: Array<string>;
1078
+ };
1079
+ export type MessageSeverity = 'info' | 'warning' | 'error';
1080
+ /**
1081
+ * InitialiseOAuth2ConnectionRequest is the payload to initialise an OAuth 2.0 connection.
1082
+ *
1083
+ */
1084
+ export type InitialiseOAuth2ConnectionRequest = {
1085
+ credential: {
1086
+ /**
1087
+ * ID is the unique identifier of the credential which is being used to
1088
+ * initialise the connection. This is used to load the client_secret when the authorisation
1089
+ * code is exchanged for an access token.
1090
+ *
1091
+ */
1092
+ id: string;
1093
+ /**
1094
+ * OrganisationID is the unique identifier of the organisation which the credential is
1095
+ * associated with. This is used to ensure that the credential is only used to initialise
1096
+ * connections for the organisation which owns the credential.
1097
+ *
1098
+ */
1099
+ organisationId: string;
1100
+ };
1101
+ /**
1102
+ * AuthorizeURL is the URL which the user will be redirected to in order to authorize
1103
+ * the application.
1104
+ *
1105
+ */
1106
+ authorizeUrl: string;
1107
+ /**
1108
+ * ClientID is the OAuth 2.0 client ID which is used to identify the application to the
1109
+ * OAuth 2.0 provider.
1110
+ *
1111
+ */
1112
+ clientId: string;
1113
+ /**
1114
+ * Scopes is a list of OAuth 2.0 scopes which the application is requesting access to.
1115
+ *
1116
+ * Unless `disableOfflineAccess` is set to true, the API will also include the standard
1117
+ * `offline_access` scope in addition to the ones provided here.
1118
+ *
1119
+ */
1120
+ scopes?: Array<string>;
1121
+ /**
1122
+ * DisableOfflineAccess is a flag which can be set to true to disable the inclusion of the
1123
+ * standard `offline_access` scope in the list of scopes. This is defined separately to
1124
+ * `scopes` to make it clear that the API will always include the `offline_access` scope
1125
+ * by default, but can be disabled if the system does not implement the standards so that
1126
+ * the user can define their own custom scope as part of `scopes`.
1127
+ *
1128
+ */
1129
+ disableOfflineAccess?: boolean;
1130
+ /**
1131
+ * Prompt controls the behaviour of the OAuth 2.0 provider when the user is redirected to
1132
+ * the authorize URL. This is typically used to force the user to re-authenticate or to
1133
+ * select a user account.
1134
+ *
1135
+ * If set, should be one of "none", "login", "consent", "select_account". However the
1136
+ * specification dictates that arbitrary prompts may be provided in case of new values
1137
+ * added in the future. Some providers also allow multiple values to be provided, separated
1138
+ * by the '+' symbol, i.e. `consent+select_account`.
1139
+ *
1140
+ * If not provided, this API defaults to "login", unless `additionalParams` contains the
1141
+ * `approval_prompt` parameter (thanks, Google refresh tokens), in which case this value
1142
+ * does not default to anything.
1143
+ *
1144
+ */
1145
+ prompt?: string;
1146
+ /**
1147
+ * AdditionalParams is a URL-encoded query string which can be used to pass additional
1148
+ * parameters to the OAuth 2.0 authorize endpoint. These cannot conflict with any of the
1149
+ * other parameters defined by the request, an attempt to do so will result in an error.
1150
+ *
1151
+ * These parameters are attached to returned URL as query parameters.
1152
+ *
1153
+ */
1154
+ additionalParams?: string;
1155
+ };
1156
+ /**
1157
+ * InitialiseOAuth2ConnectionResponse contains the URL to redirect the user to in order to
1158
+ * initiate an OAuth 2.0 `authorization_code` grant flow.
1159
+ *
1160
+ */
1161
+ export type InitialiseOAuth2ConnectionResponse = {
1162
+ /**
1163
+ * The URL to redirect the user to.
1164
+ */
1165
+ url: string;
1166
+ };
1167
+ /**
1168
+ * InitialiseOAuth1ConnectionRequest is the payload to initialise an OAuth 1.0 connection.
1169
+ *
1170
+ */
1171
+ export type InitialiseOAuth1ConnectionRequest = {
1172
+ credential: {
1173
+ id: string;
1174
+ organisationId: string;
1175
+ };
1176
+ };
1177
+ export type InitialiseOAuth1ConnectionResponse = {
1178
+ /**
1179
+ * The URL to redirect the user to.
1180
+ */
1181
+ url: string;
1182
+ };
1183
+ export type ConnectionCredentialsCreate = Array<ConnectionCredential>;
1184
+ export type EndUser = {
1185
+ /**
1186
+ * ID is the Versori identifier for the user. Most APIs will not use this field but instead reference
1187
+ * users by their externalId.
1188
+ *
1189
+ */
1190
+ id: string;
1191
+ /**
1192
+ * ExternalID is the identifier for the user as determined by the organisation. This typically should
1193
+ * be the same as the user's ID on the organisations system. Regardless of the value, it must
1194
+ * be unique within the Organisation.
1195
+ *
1196
+ */
1197
+ externalId: string;
1198
+ /**
1199
+ * DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.
1200
+ *
1201
+ */
1202
+ displayName: string;
1203
+ /**
1204
+ * The organisation ID to which the user belongs to.
1205
+ */
1206
+ organisationId: string;
1207
+ /**
1208
+ * CreatedAt is the time the user was created.
1209
+ */
1210
+ createdAt: string;
1211
+ /**
1212
+ * UpdatedAt is the time the user was last updated.
1213
+ */
1214
+ updatedAt: string;
1215
+ };
1216
+ /**
1217
+ * Request to create a new End User
1218
+ */
1219
+ export type EndUserCreate = {
1220
+ /**
1221
+ * ExternalID is the identifier of the user
1222
+ */
1223
+ externalId: string;
1224
+ /**
1225
+ * DisplayName is a human-readable name for the user
1226
+ */
1227
+ displayName?: string;
1228
+ };
1229
+ export type EndUserPage = PageInfo & {
1230
+ users: Array<EndUser>;
1231
+ };
1232
+ export type Automation = {
1233
+ id: string;
1234
+ name: string;
1235
+ createdAt?: string;
1236
+ promptTemplate: string;
1237
+ secretNames?: Array<string>;
1238
+ };
1239
+ export type AutomationRunCreate = {
1240
+ prompt: string;
1241
+ /**
1242
+ * The maximum number of steps the agent can take.
1243
+ */
1244
+ maxSteps?: number;
1245
+ /**
1246
+ * The webhook URL to send the run results to.
1247
+ */
1248
+ webhookUrl?: string;
1249
+ };
1250
+ export type AutomationRun = {
1251
+ id: string;
1252
+ status: AutomationJobStatus;
1253
+ prompt: string;
1254
+ executionId: string;
1255
+ artifacts?: Array<AutomationRunArtifact>;
1256
+ };
1257
+ export type TranscriptionCreate = {
1258
+ recording_id: string;
1259
+ };
1260
+ export type AutomationRecording = {
1261
+ id: string;
1262
+ transcription: string;
1263
+ status: AutomationJobStatus;
1264
+ };
1265
+ export type AutomationJobStatus = 'pending' | 'running' | 'completed' | 'failed';
1266
+ export type AutomationRunArtifact = {
1267
+ name?: string;
1268
+ url?: string;
1269
+ };
1270
+ export type AutomationRunResponse = {
1271
+ runId: string;
1272
+ };
1273
+ export type AutomationCreate = {
1274
+ name: string;
1275
+ promptTemplate?: string;
1276
+ };
1277
+ export type AutomationUpdate = {
1278
+ /**
1279
+ * The updated name for the automation
1280
+ */
1281
+ name?: string;
1282
+ /**
1283
+ * The updated prompt template for the automation
1284
+ */
1285
+ promptTemplate?: string;
1286
+ secrets?: Array<AutomationSecret>;
1287
+ };
1288
+ export type AutomationSecret = {
1289
+ name?: string;
1290
+ value?: string;
1291
+ };
1292
+ export type UpdateSystem = {
1293
+ name?: string;
1294
+ domain?: string;
1295
+ templateBaseUrl?: string;
1296
+ };
1297
+ export type SystemCreate = {
1298
+ name: string;
1299
+ domain: string;
1300
+ templateBaseUrl: string;
1301
+ authSchemeConfigs: Array<AuthSchemeConfig>;
1302
+ labels?: Labels;
1303
+ };
1304
+ export type LinkSystem = {
1305
+ /**
1306
+ * ID of the system to add the project environment.
1307
+ */
1308
+ systemId: string;
1309
+ /**
1310
+ * How you will reference your system from the SDK.
1311
+ */
1312
+ name: string;
1313
+ /**
1314
+ * The environment to link the system to.
1315
+ */
1316
+ environmentId?: string;
1317
+ /**
1318
+ * If the connections to the system need to be dynamic or static.
1319
+ * Dynamic connections are used when the integration runs for multiple end users.
1320
+ * Defaults to false if not set.
1321
+ *
1322
+ */
1323
+ dynamic?: boolean;
1324
+ };
1325
+ export type System = {
1326
+ id: string;
1327
+ name: string;
1328
+ domain: string;
1329
+ authSchemeConfigs: Array<AuthSchemeConfig>;
1330
+ templateBaseUrl: string;
1331
+ };
1332
+ export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
1333
+ export type ActionType = 'http' | 'graphql';
1334
+ export type ActionParameter = {
1335
+ name: string;
1336
+ in: 'path' | 'query' | 'header';
1337
+ required: boolean;
1338
+ type: 'string' | 'integer' | 'boolean';
1339
+ default?: string;
1340
+ };
1341
+ export type ActionPage = PageInfo & {
1342
+ actions: Array<Action>;
1343
+ };
1344
+ export type TriggerPage = PageInfo & {
1345
+ triggers: Array<Trigger>;
1346
+ };
1347
+ export type Action = {
1348
+ id: string;
1349
+ systemId: string;
1350
+ type: ActionType;
1351
+ name: string;
1352
+ /**
1353
+ * ContentType is the content type that this action expects to receive in the request body if any, and the
1354
+ * content type of the response body if any. If this field is left blank, then "application/json" is assumed.
1355
+ *
1356
+ */
1357
+ contentType?: string;
1358
+ summary?: string;
1359
+ description?: string;
1360
+ method: HttpMethod;
1361
+ /**
1362
+ * Path is the path of the action, which may contain templated values in curly braces.
1363
+ * For example, `/users/{userId}`. The path should be the full path relative to the base URL of the system,
1364
+ * the base URL containing everything before (and including) the top-level domain (.com, .gov, .org etc).
1365
+ *
1366
+ */
1367
+ path: string;
1368
+ /**
1369
+ * Parameters is a list of parameters which are used to configure the action. These may be
1370
+ * used to set values in the path, query string or headers of the request. Note that when creating an action,
1371
+ * if the path contains templated values in curly braces, these will automatically be converted into
1372
+ * parameters of type `path` with the name of the parameter being the name of the templated value.
1373
+ *
1374
+ */
1375
+ parameters: Array<ActionParameter>;
1376
+ /**
1377
+ * GraphQLQuery is the GraphQL query to execute for the action. This is only used if the action type is `graphql`.
1378
+ *
1379
+ */
1380
+ graphqlQuery?: string;
1381
+ /**
1382
+ * Request is the request body of the action. This is only used if the action type is `http`.
1383
+ *
1384
+ */
1385
+ request?: string;
1386
+ /**
1387
+ * Response is the response body of the action. This is only used if the action type is `http`.
1388
+ *
1389
+ */
1390
+ response?: string;
1391
+ };
1392
+ export type Trigger = {
1393
+ id: string;
1394
+ systemId: string;
1395
+ name: string;
1396
+ description: string;
1397
+ summary: string;
1398
+ type: 'http';
1399
+ method: HttpMethod;
1400
+ parameters: Array<ActionParameter>;
1401
+ };
1402
+ export type CreateActions = {
1403
+ projectId?: string;
1404
+ actions: Array<{
1405
+ name: string;
1406
+ description?: string;
1407
+ summary?: string;
1408
+ type: ActionType;
1409
+ method: HttpMethod;
1410
+ path: string;
1411
+ /**
1412
+ * ContentType is the content type that this action expects to receive in the request body if any, and the
1413
+ * content type of the response body if any. If this field is left blank, then "application/json" is assumed.
1414
+ *
1415
+ */
1416
+ contentType?: string;
1417
+ parameters?: Array<ActionParameter>;
1418
+ graphqlQuery?: string;
1419
+ request?: string;
1420
+ response?: string;
1421
+ }>;
1422
+ };
1423
+ export type CreateTriggers = {
1424
+ projectId?: string;
1425
+ triggers: Array<{
1426
+ name: string;
1427
+ description?: string;
1428
+ summary?: string;
1429
+ method: HttpMethod;
1430
+ parameters?: Array<ActionParameter>;
1431
+ }>;
1432
+ };
1433
+ export type UpdateConnectionTemplate = {
1434
+ /**
1435
+ * The name of the template. This is how the connections should be referenced in code.
1436
+ */
1437
+ name?: string;
1438
+ dynamic?: boolean;
1439
+ /**
1440
+ * The IDs of the auth scheme config to use for this connection template. The overwhelming majority of the time,
1441
+ * this will only be a single ID. To see about multiple auth scheme configs, see ConnectionTemplate for details.
1442
+ *
1443
+ */
1444
+ authSchemeConfigIds?: Array<string>;
1445
+ };
1446
+ export type ConnectionTemplate = {
1447
+ /**
1448
+ * The system ID.
1449
+ */
1450
+ id: string;
1451
+ connectionTemplateId?: string;
1452
+ /**
1453
+ * The name of the template. This is how the connections should be referenced in code.
1454
+ */
1455
+ name: string;
1456
+ domain: string;
1457
+ dynamic: boolean;
1458
+ /**
1459
+ * AuthSchemeConfigs is a list of auth scheme configs which are used to authenticate with the system.
1460
+ * This is used to determine how the connection should be authenticated, and may contain multiple
1461
+ * configs for different authentication methods. The overwhelming majority of the time, this will be a single config.
1462
+ * There does exist cases where credentials may need to be applied in sequence, such as mTLS. If there are multiple
1463
+ * auth scheme configs here, it acts like a queue and they are applied in order.
1464
+ *
1465
+ */
1466
+ authSchemeConfigs: Array<AuthSchemeConfig>;
1467
+ templateBaseUrl: string;
1468
+ };
1469
+ /**
1470
+ * TriggerPage defines a paginated list of Triggers.
1471
+ */
1472
+ export type EnvironmentSystemPage = PageInfo & {
1473
+ items: Array<ConnectionTemplate>;
1474
+ next?: string;
1475
+ prev?: string;
1476
+ };
1477
+ /**
1478
+ * TriggerPage defines a paginated list of Triggers.
1479
+ */
1480
+ export type SystemPage = PageInfo & {
1481
+ items: Array<System>;
1482
+ };
1483
+ /**
1484
+ * Labels is a map of key-value pairs that can be used to store arbitrary metadata about a resource.
1485
+ * Keys must start with a letter and can only contain letters, numbers, and underscores.
1486
+ * Values can be any string.
1487
+ *
1488
+ */
1489
+ export type Labels = {
1490
+ [key: string]: unknown;
1491
+ };
1492
+ export type TraceSearch = {
1493
+ items: Array<SpanSummary>;
1494
+ nextToken?: string;
1495
+ };
1496
+ export type Scheduler = {
1497
+ id: string;
1498
+ /**
1499
+ * The name of the scheduler.
1500
+ */
1501
+ name: string;
1502
+ /**
1503
+ * The cron schedule for the scheduler.
1504
+ */
1505
+ schedule: string;
1506
+ /**
1507
+ * The URL to which the scheduler will send requests.
1508
+ */
1509
+ url: string;
1510
+ environment_id: string;
1511
+ };
1512
+ export type SpanSummary = {
1513
+ /**
1514
+ * The unique identifier for the trace
1515
+ */
1516
+ traceId: string;
1517
+ /**
1518
+ * The unique identifier for the span within the trace
1519
+ */
1520
+ spanId: string;
1521
+ /**
1522
+ * The name of the span
1523
+ */
1524
+ name: string;
1525
+ /**
1526
+ * The name of the service that generated the span
1527
+ */
1528
+ serviceName: string;
1529
+ /**
1530
+ * The time when the span started
1531
+ */
1532
+ startTime: string;
1533
+ /**
1534
+ * The duration of the span
1535
+ */
1536
+ duration: string;
1537
+ executionId: string;
1538
+ };
1539
+ export type Trace = {
1540
+ /**
1541
+ * Unique identifier for the trace
1542
+ */
1543
+ traceId: string;
1544
+ spans: Array<Span>;
1545
+ };
1546
+ export type Span = {
1547
+ /**
1548
+ * Unique identifier for the span
1549
+ */
1550
+ spanId: string;
1551
+ /**
1552
+ * ID of the parent span
1553
+ */
1554
+ parentSpanId: string;
1555
+ /**
1556
+ * Name of the span
1557
+ */
1558
+ name: string;
1559
+ /**
1560
+ * Start time of the span
1561
+ */
1562
+ startTime: string;
1563
+ /**
1564
+ * End time of the span
1565
+ */
1566
+ endTime: string;
1567
+ attributes: Array<Attribute>;
1568
+ status: TraceStatus;
1569
+ };
1570
+ export type Attribute = {
1571
+ /**
1572
+ * Attribute key
1573
+ */
1574
+ key: string;
1575
+ /**
1576
+ * Attribute value
1577
+ */
1578
+ value: string;
1579
+ };
1580
+ export type TraceStatus = {
1581
+ /**
1582
+ * Status code of the span
1583
+ */
1584
+ code: 'OK' | 'ERROR';
1585
+ };
1586
+ export type DynamicVariables = {
1587
+ [key: string]: unknown;
1588
+ };
1589
+ export type EnvironmentConfig = {
1590
+ deploymentSpec?: DeploymentSpec;
1591
+ };
1592
+ export type DeploymentSpec = {
1593
+ replicas?: number;
1594
+ affinity?: Affinity;
1595
+ tolerations?: Array<Toleration>;
1596
+ resources?: Resources;
1597
+ };
1598
+ export type Affinity = {
1599
+ nodeAffinity?: NodeAffinity;
1600
+ };
1601
+ export type NodeAffinity = {
1602
+ requiredDuringSchedulingIgnoredDuringExecution?: Array<NodeSelectorTerm>;
1603
+ };
1604
+ export type PreferredSchedulingTerm = {
1605
+ weight?: number;
1606
+ preference?: NodeSelectorTerm;
1607
+ };
1608
+ export type NodeSelectorTerm = {
1609
+ matchExpressions?: Array<NodeSelectorRequirement>;
1610
+ matchFields?: Array<NodeSelectorRequirement>;
1611
+ };
1612
+ export type NodeSelectorRequirement = {
1613
+ key: string;
1614
+ operator: string;
1615
+ values: Array<string>;
1616
+ };
1617
+ export type Toleration = {
1618
+ effect: string;
1619
+ key: string;
1620
+ operator: string;
1621
+ value: string;
1622
+ };
1623
+ export type Resources = {
1624
+ limits?: ResourceRequirements;
1625
+ requests?: ResourceRequirements;
1626
+ };
1627
+ export type ResourceRequirements = {
1628
+ cpu?: string;
1629
+ memory?: string;
1630
+ };
1631
+ export type CreateRecordingResponse = {
1632
+ id: string;
1633
+ /**
1634
+ * The pre-signed URL that can be used to upload the file
1635
+ */
1636
+ url: string;
1637
+ };
1638
+ export type CreateRecordingRequest = {
1639
+ /**
1640
+ * The name of the file to be uploaded
1641
+ */
1642
+ fileName: string;
1643
+ /**
1644
+ * The content type of the file to be uploaded
1645
+ */
1646
+ contentType: string;
1647
+ /**
1648
+ * The number of seconds the signed URL will be valid for
1649
+ */
1650
+ expirySeconds?: number;
1651
+ /**
1652
+ * Whether the recording has voiceover content
1653
+ */
1654
+ hasVoiceover?: boolean;
1655
+ };
1656
+ export type SignedUrlResponse = {
1657
+ /**
1658
+ * The pre-signed URL that can be used to upload the file
1659
+ */
1660
+ url: string;
1661
+ /**
1662
+ * The time when the URL will expire
1663
+ */
1664
+ expiresAt: string;
1665
+ };
1666
+ /**
1667
+ * Reason for the issue creation
1668
+ */
1669
+ export type IssueReasonEnum = 'error' | 'manual';
1670
+ /**
1671
+ * Severity level of the issue
1672
+ */
1673
+ export type IssueSeverityEnum = 'high' | 'low' | 'medium';
1674
+ /**
1675
+ * Current status of the issue
1676
+ */
1677
+ export type IssueStatusEnum = 'open' | 'closed' | 'acked' | 'resolved';
1678
+ /**
1679
+ * Status of the issue resolution
1680
+ */
1681
+ export type IssueResolutionStatusEnum = 'resolved' | 'negated' | 'ignored';
1682
+ export type Issue = {
1683
+ /**
1684
+ * Unique identifier for the issue (ULID)
1685
+ */
1686
+ id: string;
1687
+ /**
1688
+ * ID of the organization the isszue belongs to
1689
+ */
1690
+ organisationId: string;
1691
+ /**
1692
+ * ID of the project the issue belongs to
1693
+ */
1694
+ projectId: string;
1695
+ /**
1696
+ * ID of the environment the issue occurred in
1697
+ */
1698
+ environmentId: string;
1699
+ status: IssueStatusEnum;
1700
+ reason: IssueReasonEnum;
1701
+ /**
1702
+ * Detailed message of the issue
1703
+ */
1704
+ message: string;
1705
+ /**
1706
+ * Title of the issue
1707
+ */
1708
+ title: string;
1709
+ /**
1710
+ * Key-value pairs for searchable labels
1711
+ */
1712
+ labels: {
1713
+ [key: string]: string;
1714
+ };
1715
+ /**
1716
+ * Key-value pairs for additional non-searchable information
1717
+ */
1718
+ annotations: {
1719
+ [key: string]: string;
1720
+ };
1721
+ resolutionStatus?: IssueResolutionStatusEnum;
1722
+ /**
1723
+ * Timestamp when the issue was created
1724
+ */
1725
+ createdAt: string;
1726
+ /**
1727
+ * Timestamp when the issue was resolved
1728
+ */
1729
+ resolvedAt?: string | null;
1730
+ /**
1731
+ * Timestamp when the issue was last seen
1732
+ */
1733
+ lastSeenAt: string;
1734
+ /**
1735
+ * Number of times the issue has been seen
1736
+ */
1737
+ seenCount: number;
1738
+ severity?: IssueSeverityEnum;
1739
+ };
1740
+ export type UpdateIssue = {
1741
+ reason?: IssueReasonEnum;
1742
+ /**
1743
+ * Detailed message of the issue
1744
+ */
1745
+ message?: string;
1746
+ /**
1747
+ * Title of the issue
1748
+ */
1749
+ title?: string;
1750
+ /**
1751
+ * Key-value pairs for searchable labels
1752
+ */
1753
+ labels?: {
1754
+ [key: string]: string;
1755
+ };
1756
+ /**
1757
+ * Key-value pairs for additional non-searchable information
1758
+ */
1759
+ annotations?: {
1760
+ [key: string]: string;
1761
+ };
1762
+ severity?: IssueSeverityEnum;
1763
+ /**
1764
+ * Timestamp when the issue was resolved
1765
+ */
1766
+ resolvedAt?: string | null;
1767
+ resolutionStatus?: IssueResolutionStatusEnum;
1768
+ status?: IssueStatusEnum;
1769
+ };
1770
+ export type CreateIssue = {
1771
+ /**
1772
+ * ID of the organization the issue belongs to
1773
+ */
1774
+ organisationId: string;
1775
+ /**
1776
+ * ID of the project the issue belongs to
1777
+ */
1778
+ projectId?: string;
1779
+ /**
1780
+ * ID of the environment the issue occurred in
1781
+ */
1782
+ environmentId: string;
1783
+ reason: IssueReasonEnum;
1784
+ /**
1785
+ * Detailed message of the issue
1786
+ */
1787
+ message?: string;
1788
+ /**
1789
+ * Title of the issue
1790
+ */
1791
+ title: string;
1792
+ /**
1793
+ * Key-value pairs for searchable labels
1794
+ */
1795
+ labels?: {
1796
+ [key: string]: string;
1797
+ };
1798
+ /**
1799
+ * Key-value pairs for additional non-searchable information
1800
+ */
1801
+ annotations?: {
1802
+ [key: string]: string;
1803
+ };
1804
+ severity: IssueSeverityEnum;
1805
+ };
1806
+ export type NotificationChannelList = {
1807
+ items: Array<NotificationChannel>;
1808
+ };
1809
+ export type NotificationChannel = {
1810
+ id: string;
1811
+ organisation_id: string;
1812
+ name: string;
1813
+ type: string;
1814
+ config: NotificationConfig;
1815
+ created_at: string;
1816
+ updated_at: string;
1817
+ };
1818
+ export type CreateNotificationChannel = {
1819
+ name: string;
1820
+ type: string;
1821
+ config: NotificationConfig;
1822
+ };
1823
+ export type NotificationConfig = {
1824
+ email?: EmailNotificationConfig;
1825
+ };
1826
+ export type EmailNotificationConfig = {
1827
+ to: string;
1828
+ cc?: Array<string>;
1829
+ };
1830
+ export type ProjectNotificationList = {
1831
+ items: Array<ProjectNotification>;
1832
+ };
1833
+ export type ProjectNotification = {
1834
+ id: string;
1835
+ project_id: string;
1836
+ environment_id: string;
1837
+ channel_id: string;
1838
+ created_at: string;
1839
+ name: string;
1840
+ channelName: string;
1841
+ type?: string;
1842
+ config: NotificationConfig;
1843
+ };
1844
+ export type CreateProjectNotification = {
1845
+ channel_id: string;
1846
+ environment_id: string;
1847
+ name: string;
1848
+ };
1849
+ export type OrganisationId = string;
1850
+ export type ConnectionId = string;
1851
+ export type AutomationId = string;
1852
+ export type RecordingId = string;
1853
+ export type RunId = string;
1854
+ export type EnvironmentId = string;
1855
+ export type SchedulerId = string;
1856
+ export type ActivationId = string;
1857
+ /**
1858
+ * The static query parameter is used to list the static activation/user on endpoints.
1859
+ * This query parameter is really only intended for internal use or by the UI.
1860
+ *
1861
+ */
1862
+ export type Static = boolean;
1863
+ export type EnvSystemId = string;
1864
+ export type ProjectId = string;
1865
+ export type SystemId = string;
1866
+ export type ActionId = string;
1867
+ export type EnvId = string;
1868
+ export type ProjectEnv = string;
1869
+ export type ProjectIdQuery = string;
1870
+ export type First = number;
1871
+ export type Before = string;
1872
+ export type After = string;
1873
+ export type Search = string;
1874
+ export type ActivateUserData = {
1875
+ body?: ActivationCreate;
1876
+ path: {
1877
+ organisation_id: string;
1878
+ };
1879
+ query?: never;
1880
+ url: '/o/{organisation_id}/activations';
1881
+ };
1882
+ export type ActivateUserResponses = {
1883
+ /**
1884
+ * OK
1885
+ */
1886
+ 200: Activation;
1887
+ };
1888
+ export type ActivateUserResponse = ActivateUserResponses[keyof ActivateUserResponses];
1889
+ export type ListProjectsData = {
1890
+ body?: never;
1891
+ path: {
1892
+ organisation_id: string;
1893
+ };
1894
+ query?: never;
1895
+ url: '/o/{organisation_id}/projects';
1896
+ };
1897
+ export type ListProjectsErrors = {
1898
+ /**
1899
+ * Error
1900
+ */
1901
+ default: _Error;
1902
+ };
1903
+ export type ListProjectsError = ListProjectsErrors[keyof ListProjectsErrors];
1904
+ export type ListProjectsResponses = {
1905
+ /**
1906
+ * OK
1907
+ */
1908
+ 200: ProjectsList;
1909
+ };
1910
+ export type ListProjectsResponse = ListProjectsResponses[keyof ListProjectsResponses];
1911
+ export type CreateProjectData = {
1912
+ body?: ProjectCreate;
1913
+ path: {
1914
+ organisation_id: string;
1915
+ };
1916
+ query?: never;
1917
+ url: '/o/{organisation_id}/projects';
1918
+ };
1919
+ export type CreateProjectErrors = {
1920
+ /**
1921
+ * Error
1922
+ */
1923
+ default: _Error;
1924
+ };
1925
+ export type CreateProjectError = CreateProjectErrors[keyof CreateProjectErrors];
1926
+ export type CreateProjectResponses = {
1927
+ /**
1928
+ * OK
1929
+ */
1930
+ 200: Project;
1931
+ };
1932
+ export type CreateProjectResponse = CreateProjectResponses[keyof CreateProjectResponses];
1933
+ export type DeleteProjectData = {
1934
+ body?: never;
1935
+ path: {
1936
+ organisation_id: string;
1937
+ project_id: string;
1938
+ };
1939
+ query?: never;
1940
+ url: '/o/{organisation_id}/projects/{project_id}';
1941
+ };
1942
+ export type DeleteProjectErrors = {
1943
+ /**
1944
+ * Error
1945
+ */
1946
+ default: _Error;
1947
+ };
1948
+ export type DeleteProjectError = DeleteProjectErrors[keyof DeleteProjectErrors];
1949
+ export type DeleteProjectResponses = {
1950
+ /**
1951
+ * OK
1952
+ */
1953
+ 204: void;
1954
+ };
1955
+ export type DeleteProjectResponse = DeleteProjectResponses[keyof DeleteProjectResponses];
1956
+ export type GetProjectData = {
1957
+ body?: never;
1958
+ path: {
1959
+ organisation_id: string;
1960
+ project_id: string;
1961
+ };
1962
+ query?: never;
1963
+ url: '/o/{organisation_id}/projects/{project_id}';
1964
+ };
1965
+ export type GetProjectErrors = {
1966
+ /**
1967
+ * Error
1968
+ */
1969
+ default: _Error;
1970
+ };
1971
+ export type GetProjectError = GetProjectErrors[keyof GetProjectErrors];
1972
+ export type GetProjectResponses = {
1973
+ /**
1974
+ * OK
1975
+ */
1976
+ 200: Project;
1977
+ };
1978
+ export type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
1979
+ export type UpdateProjectData = {
1980
+ body: ProjectUpdate;
1981
+ path: {
1982
+ organisation_id: string;
1983
+ project_id: string;
1984
+ };
1985
+ query?: never;
1986
+ url: '/o/{organisation_id}/projects/{project_id}';
1987
+ };
1988
+ export type UpdateProjectErrors = {
1989
+ /**
1990
+ * Error
1991
+ */
1992
+ default: _Error;
1993
+ };
1994
+ export type UpdateProjectError = UpdateProjectErrors[keyof UpdateProjectErrors];
1995
+ export type UpdateProjectResponses = {
1996
+ /**
1997
+ * OK
1998
+ */
1999
+ 200: Project;
2000
+ };
2001
+ export type UpdateProjectResponse = UpdateProjectResponses[keyof UpdateProjectResponses];
2002
+ export type CloneProjectData = {
2003
+ body?: never;
2004
+ path: {
2005
+ organisation_id: string;
2006
+ project_id: string;
2007
+ };
2008
+ query?: never;
2009
+ url: '/o/{organisation_id}/projects/{project_id}/clone';
2010
+ };
2011
+ export type CloneProjectErrors = {
2012
+ /**
2013
+ * Error
2014
+ */
2015
+ default: _Error;
2016
+ };
2017
+ export type CloneProjectError = CloneProjectErrors[keyof CloneProjectErrors];
2018
+ export type CloneProjectResponses = {
2019
+ /**
2020
+ * OK
2021
+ */
2022
+ 200: Project;
2023
+ };
2024
+ export type CloneProjectResponse = CloneProjectResponses[keyof CloneProjectResponses];
2025
+ export type PatchProjectVariablesSchemaData = {
2026
+ body: DynamicVariablesSchemaPatch;
2027
+ path: {
2028
+ organisation_id: string;
2029
+ project_id: string;
2030
+ };
2031
+ query?: never;
2032
+ url: '/o/{organisation_id}/projects/{project_id}/variables';
2033
+ };
2034
+ export type PatchProjectVariablesSchemaErrors = {
2035
+ /**
2036
+ * Error
2037
+ */
2038
+ default: _Error;
2039
+ };
2040
+ export type PatchProjectVariablesSchemaError = PatchProjectVariablesSchemaErrors[keyof PatchProjectVariablesSchemaErrors];
2041
+ export type PatchProjectVariablesSchemaResponses = {
2042
+ /**
2043
+ * OK
2044
+ */
2045
+ 200: DynamicVariablesSchema;
2046
+ };
2047
+ export type PatchProjectVariablesSchemaResponse = PatchProjectVariablesSchemaResponses[keyof PatchProjectVariablesSchemaResponses];
2048
+ export type SetProjectVariablesSchemaData = {
2049
+ body: DynamicVariablesSchema;
2050
+ path: {
2051
+ organisation_id: string;
2052
+ project_id: string;
2053
+ };
2054
+ query?: never;
2055
+ url: '/o/{organisation_id}/projects/{project_id}/variables';
2056
+ };
2057
+ export type SetProjectVariablesSchemaErrors = {
2058
+ /**
2059
+ * Error
2060
+ */
2061
+ default: _Error;
2062
+ };
2063
+ export type SetProjectVariablesSchemaError = SetProjectVariablesSchemaErrors[keyof SetProjectVariablesSchemaErrors];
2064
+ export type SetProjectVariablesSchemaResponses = {
2065
+ /**
2066
+ * OK
2067
+ */
2068
+ 200: DynamicVariablesSchema;
2069
+ };
2070
+ export type SetProjectVariablesSchemaResponse = SetProjectVariablesSchemaResponses[keyof SetProjectVariablesSchemaResponses];
2071
+ export type AddProjectSentimentData = {
2072
+ body: SentimentRequest;
2073
+ path: {
2074
+ organisation_id: string;
2075
+ project_id: string;
2076
+ };
2077
+ query?: never;
2078
+ url: '/o/{organisation_id}/projects/{project_id}/sentiment';
2079
+ };
2080
+ export type AddProjectSentimentErrors = {
2081
+ /**
2082
+ * Error
2083
+ */
2084
+ default: _Error;
2085
+ };
2086
+ export type AddProjectSentimentError = AddProjectSentimentErrors[keyof AddProjectSentimentErrors];
2087
+ export type AddProjectSentimentResponses = {
2088
+ /**
2089
+ * OK
2090
+ */
2091
+ 200: Project;
2092
+ };
2093
+ export type AddProjectSentimentResponse = AddProjectSentimentResponses[keyof AddProjectSentimentResponses];
2094
+ export type GetFilesData = {
2095
+ body?: never;
2096
+ path: {
2097
+ organisation_id: string;
2098
+ project_id: string;
2099
+ };
2100
+ query?: never;
2101
+ url: '/o/{organisation_id}/projects/{project_id}/files';
2102
+ };
2103
+ export type GetFilesErrors = {
2104
+ /**
2105
+ * Error
2106
+ */
2107
+ default: _Error;
2108
+ };
2109
+ export type GetFilesError = GetFilesErrors[keyof GetFilesErrors];
2110
+ export type GetFilesResponses = {
2111
+ /**
2112
+ * OK
2113
+ */
2114
+ 200: Files;
2115
+ };
2116
+ export type GetFilesResponse = GetFilesResponses[keyof GetFilesResponses];
2117
+ export type UpdateFilesData = {
2118
+ body: Files;
2119
+ path: {
2120
+ organisation_id: string;
2121
+ project_id: string;
2122
+ };
2123
+ query?: never;
2124
+ url: '/o/{organisation_id}/projects/{project_id}/files';
2125
+ };
2126
+ export type UpdateFilesErrors = {
2127
+ /**
2128
+ * Error
2129
+ */
2130
+ default: _Error;
2131
+ };
2132
+ export type UpdateFilesError = UpdateFilesErrors[keyof UpdateFilesErrors];
2133
+ export type UpdateFilesResponses = {
2134
+ /**
2135
+ * OK
2136
+ */
2137
+ 200: Files;
2138
+ };
2139
+ export type UpdateFilesResponse = UpdateFilesResponses[keyof UpdateFilesResponses];
2140
+ export type DeployProjectData = {
2141
+ body: Files;
2142
+ path: {
2143
+ organisation_id: string;
2144
+ project_id: string;
2145
+ };
2146
+ query?: {
2147
+ project_env?: string;
2148
+ env_id?: string;
2149
+ };
2150
+ url: '/o/{organisation_id}/projects/{project_id}/deploy';
2151
+ };
2152
+ export type DeployProjectErrors = {
2153
+ /**
2154
+ * Error
2155
+ */
2156
+ default: _Error;
2157
+ };
2158
+ export type DeployProjectError = DeployProjectErrors[keyof DeployProjectErrors];
2159
+ export type DeployProjectResponses = {
2160
+ /**
2161
+ * OK
2162
+ */
2163
+ 200: Project;
2164
+ };
2165
+ export type DeployProjectResponse = DeployProjectResponses[keyof DeployProjectResponses];
2166
+ export type GetProjectLogsData = {
2167
+ body?: never;
2168
+ path: {
2169
+ organisation_id: string;
2170
+ project_id: string;
2171
+ };
2172
+ query?: {
2173
+ project_env?: string;
2174
+ first?: number;
2175
+ next_token?: string;
2176
+ start?: string;
2177
+ end?: string;
2178
+ search?: string;
2179
+ build?: boolean;
2180
+ /**
2181
+ * If true, returns only the latest logs
2182
+ */
2183
+ latest?: boolean;
2184
+ /**
2185
+ * One of 'asc' or 'desc'
2186
+ */
2187
+ order?: string;
2188
+ };
2189
+ url: '/o/{organisation_id}/projects/{project_id}/logs';
2190
+ };
2191
+ export type GetProjectLogsErrors = {
2192
+ /**
2193
+ * Error
2194
+ */
2195
+ default: _Error;
2196
+ };
2197
+ export type GetProjectLogsError = GetProjectLogsErrors[keyof GetProjectLogsErrors];
2198
+ export type GetProjectLogsResponses = {
2199
+ /**
2200
+ * OK
2201
+ */
2202
+ 200: Logs;
2203
+ };
2204
+ export type GetProjectLogsResponse = GetProjectLogsResponses[keyof GetProjectLogsResponses];
2205
+ export type ListTracesData = {
2206
+ body?: never;
2207
+ path: {
2208
+ organisation_id: string;
2209
+ project_id: string;
2210
+ };
2211
+ query?: {
2212
+ project_env?: string;
2213
+ next_token?: string;
2214
+ start?: string;
2215
+ end?: string;
2216
+ /**
2217
+ * Filter executions by attribute.
2218
+ *
2219
+ * Example query: 'http.request.method:POST executionId:01JSPK1SB6S622T6E1P9BBJTWP'
2220
+ *
2221
+ * Available attributes are:
2222
+ * - "taskId"
2223
+ * - "taskType"
2224
+ * - "executionId"
2225
+ * - "error.message"
2226
+ * - "error.stack"
2227
+ * - "schedule"
2228
+ * - "connection"
2229
+ * - "http.request.method"
2230
+ * - "http.response.status_code"
2231
+ * - "server.address"
2232
+ * - "server.port"
2233
+ * - "url.full"
2234
+ * - "url.path"
2235
+ * - "url.query"
2236
+ * - "url.scheme"
2237
+ *
2238
+ */
2239
+ filter?: string;
2240
+ error?: boolean;
2241
+ task?: string;
2242
+ };
2243
+ url: '/o/{organisation_id}/projects/{project_id}/traces';
2244
+ };
2245
+ export type ListTracesErrors = {
2246
+ /**
2247
+ * Error
2248
+ */
2249
+ default: _Error;
2250
+ };
2251
+ export type ListTracesError = ListTracesErrors[keyof ListTracesErrors];
2252
+ export type ListTracesResponses = {
2253
+ /**
2254
+ * OK
2255
+ */
2256
+ 200: TraceSearch;
2257
+ };
2258
+ export type ListTracesResponse = ListTracesResponses[keyof ListTracesResponses];
2259
+ export type GetTraceData = {
2260
+ body?: never;
2261
+ path: {
2262
+ organisation_id: string;
2263
+ project_id: string;
2264
+ trace_id: string;
2265
+ };
2266
+ query?: never;
2267
+ url: '/o/{organisation_id}/projects/{project_id}/traces/{trace_id}';
2268
+ };
2269
+ export type GetTraceErrors = {
2270
+ /**
2271
+ * Error
2272
+ */
2273
+ default: _Error;
2274
+ };
2275
+ export type GetTraceError = GetTraceErrors[keyof GetTraceErrors];
2276
+ export type GetTraceResponses = {
2277
+ /**
2278
+ * OK
2279
+ */
2280
+ 200: Trace;
2281
+ };
2282
+ export type GetTraceResponse = GetTraceResponses[keyof GetTraceResponses];
2283
+ export type SuspendProjectData = {
2284
+ body?: never;
2285
+ path: {
2286
+ organisation_id: string;
2287
+ project_id: string;
2288
+ };
2289
+ query: {
2290
+ /**
2291
+ * The environment to suspend the project in.
2292
+ */
2293
+ environment: string;
2294
+ };
2295
+ url: '/o/{organisation_id}/projects/{project_id}/suspend';
2296
+ };
2297
+ export type SuspendProjectErrors = {
2298
+ /**
2299
+ * Error
2300
+ */
2301
+ default: _Error;
2302
+ };
2303
+ export type SuspendProjectError = SuspendProjectErrors[keyof SuspendProjectErrors];
2304
+ export type SuspendProjectResponses = {
2305
+ /**
2306
+ * OK
2307
+ */
2308
+ 200: Project;
2309
+ };
2310
+ export type SuspendProjectResponse = SuspendProjectResponses[keyof SuspendProjectResponses];
2311
+ export type ListConnectionsData = {
2312
+ body?: never;
2313
+ path: {
2314
+ organisation_id: string;
2315
+ };
2316
+ query?: {
2317
+ first?: number;
2318
+ after?: string;
2319
+ before?: string;
2320
+ system_id?: string;
2321
+ end_user_id?: string;
2322
+ };
2323
+ url: '/o/{organisation_id}/connections';
2324
+ };
2325
+ export type ListConnectionsErrors = {
2326
+ /**
2327
+ * Error
2328
+ */
2329
+ default: _Error;
2330
+ };
2331
+ export type ListConnectionsError = ListConnectionsErrors[keyof ListConnectionsErrors];
2332
+ export type ListConnectionsResponses = {
2333
+ /**
2334
+ * OK
2335
+ */
2336
+ 200: ConnectionPage;
2337
+ };
2338
+ export type ListConnectionsResponse = ListConnectionsResponses[keyof ListConnectionsResponses];
2339
+ export type CreateConnectionData = {
2340
+ body?: EnvSystemConnectionCreate;
2341
+ path: {
2342
+ organisation_id: string;
2343
+ };
2344
+ query?: never;
2345
+ url: '/o/{organisation_id}/connections';
2346
+ };
2347
+ export type CreateConnectionErrors = {
2348
+ /**
2349
+ * Error
2350
+ */
2351
+ default: _Error;
2352
+ };
2353
+ export type CreateConnectionError = CreateConnectionErrors[keyof CreateConnectionErrors];
2354
+ export type CreateConnectionResponses = {
2355
+ /**
2356
+ * Created
2357
+ */
2358
+ 201: Connection;
2359
+ };
2360
+ export type CreateConnectionResponse = CreateConnectionResponses[keyof CreateConnectionResponses];
2361
+ export type GetConnectionData = {
2362
+ body?: never;
2363
+ path: {
2364
+ organisation_id: string;
2365
+ connection_id: string;
2366
+ };
2367
+ query?: never;
2368
+ url: '/o/{organisation_id}/connections/{connection_id}';
2369
+ };
2370
+ export type GetConnectionErrors = {
2371
+ /**
2372
+ * Error
2373
+ */
2374
+ default: _Error;
2375
+ };
2376
+ export type GetConnectionError = GetConnectionErrors[keyof GetConnectionErrors];
2377
+ export type GetConnectionResponses = {
2378
+ /**
2379
+ * OK
2380
+ */
2381
+ 200: Connection;
2382
+ };
2383
+ export type GetConnectionResponse = GetConnectionResponses[keyof GetConnectionResponses];
2384
+ export type UpdateConnectionData = {
2385
+ body: ConnectionUpdate;
2386
+ path: {
2387
+ organisation_id: string;
2388
+ connection_id: string;
2389
+ };
2390
+ query?: never;
2391
+ url: '/o/{organisation_id}/connections/{connection_id}';
2392
+ };
2393
+ export type UpdateConnectionErrors = {
2394
+ /**
2395
+ * Error
2396
+ */
2397
+ default: _Error;
2398
+ };
2399
+ export type UpdateConnectionError = UpdateConnectionErrors[keyof UpdateConnectionErrors];
2400
+ export type UpdateConnectionResponses = {
2401
+ /**
2402
+ * OK
2403
+ */
2404
+ 200: Connection;
2405
+ };
2406
+ export type UpdateConnectionResponse = UpdateConnectionResponses[keyof UpdateConnectionResponses];
2407
+ export type LinkConnectionToEnvironmentData = {
2408
+ body?: LinkConnectionEnvironment;
2409
+ path: {
2410
+ organisation_id: string;
2411
+ connection_id: string;
2412
+ };
2413
+ query?: never;
2414
+ url: '/o/{organisation_id}/connections/{connection_id}/link';
2415
+ };
2416
+ export type LinkConnectionToEnvironmentErrors = {
2417
+ /**
2418
+ * Error
2419
+ */
2420
+ default: _Error;
2421
+ };
2422
+ export type LinkConnectionToEnvironmentError = LinkConnectionToEnvironmentErrors[keyof LinkConnectionToEnvironmentErrors];
2423
+ export type LinkConnectionToEnvironmentResponses = {
2424
+ /**
2425
+ * Created
2426
+ */
2427
+ 201: unknown;
2428
+ };
2429
+ export type ListEndUsersData = {
2430
+ body?: never;
2431
+ path: {
2432
+ organisation_id: string;
2433
+ };
2434
+ query?: {
2435
+ /**
2436
+ * Search is a string that is used to filter the list of End Users. The search string is matched against the
2437
+ * id, externalId and displayName fields.
2438
+ *
2439
+ */
2440
+ search?: string;
2441
+ /**
2442
+ * Filter users by their activation status. Must be used together with environment_id.
2443
+ * If not provided, returns all users regardless of activation status.
2444
+ *
2445
+ */
2446
+ activated?: boolean;
2447
+ /**
2448
+ * Filter users by activations in a specific environment. Must be used together with the 'activated' parameter.
2449
+ * When combined with 'activated=true', it returns users that are activated in the specified environment.
2450
+ * When combined with 'activated=false', it returns users that are not activated in this specific environment.
2451
+ * If not provided, returns users from all environments.
2452
+ *
2453
+ */
2454
+ environment_id?: string;
2455
+ };
2456
+ url: '/o/{organisation_id}/users';
2457
+ };
2458
+ export type ListEndUsersErrors = {
2459
+ /**
2460
+ * Error
2461
+ */
2462
+ default: _Error;
2463
+ };
2464
+ export type ListEndUsersError = ListEndUsersErrors[keyof ListEndUsersErrors];
2465
+ export type ListEndUsersResponses = {
2466
+ /**
2467
+ * OK
2468
+ */
2469
+ 200: EndUserPage;
2470
+ };
2471
+ export type ListEndUsersResponse = ListEndUsersResponses[keyof ListEndUsersResponses];
2472
+ export type CreateEndUserData = {
2473
+ body?: EndUserCreate;
2474
+ path: {
2475
+ organisation_id: string;
2476
+ };
2477
+ query?: never;
2478
+ url: '/o/{organisation_id}/users';
2479
+ };
2480
+ export type CreateEndUserErrors = {
2481
+ /**
2482
+ * Error
2483
+ */
2484
+ default: _Error;
2485
+ };
2486
+ export type CreateEndUserError = CreateEndUserErrors[keyof CreateEndUserErrors];
2487
+ export type CreateEndUserResponses = {
2488
+ /**
2489
+ * Created
2490
+ */
2491
+ 201: EndUser;
2492
+ };
2493
+ export type CreateEndUserResponse = CreateEndUserResponses[keyof CreateEndUserResponses];
2494
+ export type ListAutomationsData = {
2495
+ body?: never;
2496
+ path: {
2497
+ organisation_id: string;
2498
+ };
2499
+ query?: never;
2500
+ url: '/o/{organisation_id}/automations';
2501
+ };
2502
+ export type ListAutomationsErrors = {
2503
+ /**
2504
+ * Error
2505
+ */
2506
+ default: _Error;
2507
+ };
2508
+ export type ListAutomationsError = ListAutomationsErrors[keyof ListAutomationsErrors];
2509
+ export type ListAutomationsResponses = {
2510
+ /**
2511
+ * OK
2512
+ */
2513
+ 200: Array<Automation>;
2514
+ };
2515
+ export type ListAutomationsResponse = ListAutomationsResponses[keyof ListAutomationsResponses];
2516
+ export type CreateAutomationData = {
2517
+ body?: AutomationCreate;
2518
+ path: {
2519
+ organisation_id: string;
2520
+ };
2521
+ query?: never;
2522
+ url: '/o/{organisation_id}/automations';
2523
+ };
2524
+ export type CreateAutomationErrors = {
2525
+ /**
2526
+ * Error
2527
+ */
2528
+ default: _Error;
2529
+ };
2530
+ export type CreateAutomationError = CreateAutomationErrors[keyof CreateAutomationErrors];
2531
+ export type CreateAutomationResponses = {
2532
+ /**
2533
+ * Created
2534
+ */
2535
+ 201: Automation;
2536
+ };
2537
+ export type CreateAutomationResponse = CreateAutomationResponses[keyof CreateAutomationResponses];
2538
+ export type ListAutomationRunsData = {
2539
+ body?: never;
2540
+ path: {
2541
+ organisation_id: string;
2542
+ automation_id: string;
2543
+ };
2544
+ query?: never;
2545
+ url: '/o/{organisation_id}/automations/{automation_id}/run';
2546
+ };
2547
+ export type ListAutomationRunsErrors = {
2548
+ /**
2549
+ * Error
2550
+ */
2551
+ default: _Error;
2552
+ };
2553
+ export type ListAutomationRunsError = ListAutomationRunsErrors[keyof ListAutomationRunsErrors];
2554
+ export type ListAutomationRunsResponses = {
2555
+ /**
2556
+ * OK
2557
+ */
2558
+ 200: Array<AutomationRun>;
2559
+ };
2560
+ export type ListAutomationRunsResponse = ListAutomationRunsResponses[keyof ListAutomationRunsResponses];
2561
+ export type RunAutomationData = {
2562
+ body?: AutomationRunCreate;
2563
+ path: {
2564
+ organisation_id: string;
2565
+ automation_id: string;
2566
+ };
2567
+ query?: never;
2568
+ url: '/o/{organisation_id}/automations/{automation_id}/run';
2569
+ };
2570
+ export type RunAutomationResponses = {
2571
+ /**
2572
+ * Accepted
2573
+ */
2574
+ 202: AutomationRunResponse;
2575
+ };
2576
+ export type RunAutomationResponse = RunAutomationResponses[keyof RunAutomationResponses];
2577
+ export type GetAutomationData = {
2578
+ body?: never;
2579
+ path: {
2580
+ organisation_id: string;
2581
+ automation_id: string;
2582
+ };
2583
+ query?: never;
2584
+ url: '/o/{organisation_id}/automations/{automation_id}';
2585
+ };
2586
+ export type GetAutomationErrors = {
2587
+ /**
2588
+ * Error
2589
+ */
2590
+ default: _Error;
2591
+ };
2592
+ export type GetAutomationError = GetAutomationErrors[keyof GetAutomationErrors];
2593
+ export type GetAutomationResponses = {
2594
+ /**
2595
+ * OK
2596
+ */
2597
+ 200: Automation;
2598
+ };
2599
+ export type GetAutomationResponse = GetAutomationResponses[keyof GetAutomationResponses];
2600
+ export type UpdateAutomationData = {
2601
+ body: AutomationUpdate;
2602
+ path: {
2603
+ organisation_id: string;
2604
+ automation_id: string;
2605
+ };
2606
+ query?: never;
2607
+ url: '/o/{organisation_id}/automations/{automation_id}';
2608
+ };
2609
+ export type UpdateAutomationErrors = {
2610
+ /**
2611
+ * Error
2612
+ */
2613
+ default: _Error;
2614
+ };
2615
+ export type UpdateAutomationError = UpdateAutomationErrors[keyof UpdateAutomationErrors];
2616
+ export type UpdateAutomationResponses = {
2617
+ /**
2618
+ * OK
2619
+ */
2620
+ 200: Automation;
2621
+ };
2622
+ export type UpdateAutomationResponse = UpdateAutomationResponses[keyof UpdateAutomationResponses];
2623
+ export type ListRecordingsData = {
2624
+ body?: never;
2625
+ path: {
2626
+ organisation_id: string;
2627
+ automation_id: string;
2628
+ };
2629
+ query?: never;
2630
+ url: '/o/{organisation_id}/automations/{automation_id}/recordings';
2631
+ };
2632
+ export type ListRecordingsErrors = {
2633
+ /**
2634
+ * Error
2635
+ */
2636
+ default: _Error;
2637
+ };
2638
+ export type ListRecordingsError = ListRecordingsErrors[keyof ListRecordingsErrors];
2639
+ export type ListRecordingsResponses = {
2640
+ /**
2641
+ * OK
2642
+ */
2643
+ 200: Array<AutomationRecording>;
2644
+ };
2645
+ export type ListRecordingsResponse = ListRecordingsResponses[keyof ListRecordingsResponses];
2646
+ export type CreateRecordingData = {
2647
+ body?: CreateRecordingRequest;
2648
+ path: {
2649
+ organisation_id: string;
2650
+ automation_id: string;
2651
+ };
2652
+ query?: never;
2653
+ url: '/o/{organisation_id}/automations/{automation_id}/recordings';
2654
+ };
2655
+ export type CreateRecordingErrors = {
2656
+ /**
2657
+ * Error
2658
+ */
2659
+ default: _Error;
2660
+ };
2661
+ export type CreateRecordingError = CreateRecordingErrors[keyof CreateRecordingErrors];
2662
+ export type CreateRecordingResponses = {
2663
+ /**
2664
+ * OK
2665
+ */
2666
+ 200: CreateRecordingResponse;
2667
+ };
2668
+ export type CreateRecordingResponse2 = CreateRecordingResponses[keyof CreateRecordingResponses];
2669
+ export type GetAutomationRunData = {
2670
+ body?: never;
2671
+ path: {
2672
+ organisation_id: string;
2673
+ automation_id: string;
2674
+ run_id: string;
2675
+ };
2676
+ query?: never;
2677
+ url: '/o/{organisation_id}/automations/{automation_id}/runs/{run_id}';
2678
+ };
2679
+ export type GetAutomationRunErrors = {
2680
+ /**
2681
+ * Error
2682
+ */
2683
+ default: _Error;
2684
+ };
2685
+ export type GetAutomationRunError = GetAutomationRunErrors[keyof GetAutomationRunErrors];
2686
+ export type GetAutomationRunResponses = {
2687
+ /**
2688
+ * OK
2689
+ */
2690
+ 200: AutomationRun;
2691
+ };
2692
+ export type GetAutomationRunResponse = GetAutomationRunResponses[keyof GetAutomationRunResponses];
2693
+ export type GetRecordingData = {
2694
+ body?: never;
2695
+ path: {
2696
+ organisation_id: string;
2697
+ automation_id: string;
2698
+ recording_id: string;
2699
+ };
2700
+ query?: never;
2701
+ url: '/o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}';
2702
+ };
2703
+ export type GetRecordingErrors = {
2704
+ /**
2705
+ * Error
2706
+ */
2707
+ default: unknown;
2708
+ };
2709
+ export type GetRecordingResponses = {
2710
+ /**
2711
+ * OK
2712
+ */
2713
+ 200: AutomationRecording;
2714
+ };
2715
+ export type GetRecordingResponse = GetRecordingResponses[keyof GetRecordingResponses];
2716
+ export type CreateTranscriptionData = {
2717
+ body?: TranscriptionCreate;
2718
+ path: {
2719
+ organisation_id: string;
2720
+ automation_id: string;
2721
+ recording_id: string;
2722
+ };
2723
+ query?: never;
2724
+ url: '/o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}';
2725
+ };
2726
+ export type CreateTranscriptionErrors = {
2727
+ /**
2728
+ * Error
2729
+ */
2730
+ default: _Error;
2731
+ };
2732
+ export type CreateTranscriptionError = CreateTranscriptionErrors[keyof CreateTranscriptionErrors];
2733
+ export type CreateTranscriptionResponses = {
2734
+ /**
2735
+ * Accepted
2736
+ */
2737
+ 202: AutomationRecording;
2738
+ };
2739
+ export type CreateTranscriptionResponse = CreateTranscriptionResponses[keyof CreateTranscriptionResponses];
2740
+ export type ListSchedulersData = {
2741
+ body?: never;
2742
+ path: {
2743
+ organisation_id: string;
2744
+ environment_id: string;
2745
+ };
2746
+ query?: never;
2747
+ url: '/o/{organisation_id}/environments/{environment_id}/schedulers';
2748
+ };
2749
+ export type ListSchedulersErrors = {
2750
+ /**
2751
+ * Error
2752
+ */
2753
+ default: _Error;
2754
+ };
2755
+ export type ListSchedulersError = ListSchedulersErrors[keyof ListSchedulersErrors];
2756
+ export type ListSchedulersResponses = {
2757
+ /**
2758
+ * OK
2759
+ */
2760
+ 200: Array<Scheduler>;
2761
+ };
2762
+ export type ListSchedulersResponse = ListSchedulersResponses[keyof ListSchedulersResponses];
2763
+ export type GetSchedulerData = {
2764
+ body?: never;
2765
+ path: {
2766
+ organisation_id: string;
2767
+ environment_id: string;
2768
+ scheduler_id: string;
2769
+ };
2770
+ query?: never;
2771
+ url: '/o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}';
2772
+ };
2773
+ export type GetSchedulerErrors = {
2774
+ /**
2775
+ * Error
2776
+ */
2777
+ default: _Error;
2778
+ };
2779
+ export type GetSchedulerError = GetSchedulerErrors[keyof GetSchedulerErrors];
2780
+ export type GetSchedulerResponses = {
2781
+ /**
2782
+ * OK
2783
+ */
2784
+ 200: Scheduler;
2785
+ };
2786
+ export type GetSchedulerResponse = GetSchedulerResponses[keyof GetSchedulerResponses];
2787
+ export type TriggerSchedulerData = {
2788
+ body?: never;
2789
+ path: {
2790
+ organisation_id: string;
2791
+ environment_id: string;
2792
+ scheduler_id: string;
2793
+ };
2794
+ query?: never;
2795
+ url: '/o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}';
2796
+ };
2797
+ export type TriggerSchedulerErrors = {
2798
+ /**
2799
+ * Error
2800
+ */
2801
+ default: _Error;
2802
+ };
2803
+ export type TriggerSchedulerError = TriggerSchedulerErrors[keyof TriggerSchedulerErrors];
2804
+ export type TriggerSchedulerResponses = {
2805
+ /**
2806
+ * No Content
2807
+ */
2808
+ 204: void;
2809
+ };
2810
+ export type TriggerSchedulerResponse = TriggerSchedulerResponses[keyof TriggerSchedulerResponses];
2811
+ export type ListActivationsData = {
2812
+ body?: never;
2813
+ path: {
2814
+ organisation_id: string;
2815
+ environment_id: string;
2816
+ };
2817
+ query?: {
2818
+ /**
2819
+ * The static query parameter is used to list the static activation/user on endpoints.
2820
+ * This query parameter is really only intended for internal use or by the UI.
2821
+ *
2822
+ */
2823
+ static?: boolean;
2824
+ };
2825
+ url: '/o/{organisation_id}/environments/{environment_id}/activations';
2826
+ };
2827
+ export type ListActivationsErrors = {
2828
+ /**
2829
+ * Error
2830
+ */
2831
+ default: _Error;
2832
+ };
2833
+ export type ListActivationsError = ListActivationsErrors[keyof ListActivationsErrors];
2834
+ export type ListActivationsResponses = {
2835
+ /**
2836
+ * OK
2837
+ */
2838
+ 200: ActivationsList;
2839
+ };
2840
+ export type ListActivationsResponse = ListActivationsResponses[keyof ListActivationsResponses];
2841
+ export type DeleteActivationData = {
2842
+ body?: never;
2843
+ path: {
2844
+ organisation_id: string;
2845
+ environment_id: string;
2846
+ activation_id: string;
2847
+ };
2848
+ query?: never;
2849
+ url: '/o/{organisation_id}/environments/{environment_id}/activations/{activation_id}';
2850
+ };
2851
+ export type DeleteActivationErrors = {
2852
+ /**
2853
+ * Error
2854
+ */
2855
+ default: _Error;
2856
+ };
2857
+ export type DeleteActivationError = DeleteActivationErrors[keyof DeleteActivationErrors];
2858
+ export type DeleteActivationResponses = {
2859
+ /**
2860
+ * No Content
2861
+ */
2862
+ 204: void;
2863
+ };
2864
+ export type DeleteActivationResponse = DeleteActivationResponses[keyof DeleteActivationResponses];
2865
+ export type GetActivationData = {
2866
+ body?: never;
2867
+ path: {
2868
+ organisation_id: string;
2869
+ environment_id: string;
2870
+ activation_id: string;
2871
+ };
2872
+ query?: never;
2873
+ url: '/o/{organisation_id}/environments/{environment_id}/activations/{activation_id}';
2874
+ };
2875
+ export type GetActivationErrors = {
2876
+ /**
2877
+ * Error
2878
+ */
2879
+ default: _Error;
2880
+ };
2881
+ export type GetActivationError = GetActivationErrors[keyof GetActivationErrors];
2882
+ export type GetActivationResponses = {
2883
+ /**
2884
+ * OK
2885
+ */
2886
+ 200: Activation;
2887
+ };
2888
+ export type GetActivationResponse = GetActivationResponses[keyof GetActivationResponses];
2889
+ export type SetStaticUserVariablesData = {
2890
+ body: DynamicVariables;
2891
+ path: {
2892
+ organisation_id: string;
2893
+ environment_id: string;
2894
+ };
2895
+ query?: never;
2896
+ url: '/o/{organisation_id}/environments/{environment_id}/variables';
2897
+ };
2898
+ export type SetStaticUserVariablesErrors = {
2899
+ /**
2900
+ * Error
2901
+ */
2902
+ default: _Error;
2903
+ };
2904
+ export type SetStaticUserVariablesError = SetStaticUserVariablesErrors[keyof SetStaticUserVariablesErrors];
2905
+ export type SetStaticUserVariablesResponses = {
2906
+ /**
2907
+ * Variables updated successfully
2908
+ */
2909
+ 200: DynamicVariables;
2910
+ };
2911
+ export type SetStaticUserVariablesResponse = SetStaticUserVariablesResponses[keyof SetStaticUserVariablesResponses];
2912
+ export type UpdateEnvironmentConfigData = {
2913
+ body: EnvironmentConfig;
2914
+ path: {
2915
+ organisation_id: string;
2916
+ environment_id: string;
2917
+ };
2918
+ query?: never;
2919
+ url: '/o/{organisation_id}/environments/{environment_id}/config';
2920
+ };
2921
+ export type UpdateEnvironmentConfigErrors = {
2922
+ /**
2923
+ * Error
2924
+ */
2925
+ default: _Error;
2926
+ };
2927
+ export type UpdateEnvironmentConfigError = UpdateEnvironmentConfigErrors[keyof UpdateEnvironmentConfigErrors];
2928
+ export type UpdateEnvironmentConfigResponses = {
2929
+ /**
2930
+ * ok
2931
+ */
2932
+ 204: void;
2933
+ };
2934
+ export type UpdateEnvironmentConfigResponse = UpdateEnvironmentConfigResponses[keyof UpdateEnvironmentConfigResponses];
2935
+ export type SetDynamicVariablesData = {
2936
+ body: DynamicVariables;
2937
+ path: {
2938
+ organisation_id: string;
2939
+ environment_id: string;
2940
+ activation_id: string;
2941
+ };
2942
+ query?: never;
2943
+ url: '/o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables';
2944
+ };
2945
+ export type SetDynamicVariablesErrors = {
2946
+ /**
2947
+ * Error
2948
+ */
2949
+ default: _Error;
2950
+ };
2951
+ export type SetDynamicVariablesError = SetDynamicVariablesErrors[keyof SetDynamicVariablesErrors];
2952
+ export type SetDynamicVariablesResponses = {
2953
+ /**
2954
+ * Variables updated successfully
2955
+ */
2956
+ 200: DynamicVariables;
2957
+ };
2958
+ export type SetDynamicVariablesResponse = SetDynamicVariablesResponses[keyof SetDynamicVariablesResponses];
2959
+ export type SetDynamicVariableData = {
2960
+ body: {
2961
+ /**
2962
+ * The new value for the variable (can be any JSON type)
2963
+ */
2964
+ value: unknown;
2965
+ };
2966
+ path: {
2967
+ organisation_id: string;
2968
+ environment_id: string;
2969
+ activation_id: string;
2970
+ /**
2971
+ * The name of the dynamic variable to update
2972
+ */
2973
+ variable_name: string;
2974
+ };
2975
+ query?: never;
2976
+ url: '/o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables/{variable_name}';
2977
+ };
2978
+ export type SetDynamicVariableErrors = {
2979
+ /**
2980
+ * Error
2981
+ */
2982
+ default: _Error;
2983
+ };
2984
+ export type SetDynamicVariableError = SetDynamicVariableErrors[keyof SetDynamicVariableErrors];
2985
+ export type SetDynamicVariableResponses = {
2986
+ /**
2987
+ * Variable updated successfully
2988
+ */
2989
+ 200: DynamicVariables;
2990
+ };
2991
+ export type SetDynamicVariableResponse = SetDynamicVariableResponses[keyof SetDynamicVariableResponses];
2992
+ export type ListUserActivationsData = {
2993
+ body?: never;
2994
+ path: {
2995
+ organisation_id: string;
2996
+ environment_id: string;
2997
+ /**
2998
+ * The external ID of the user
2999
+ */
3000
+ external_user_id: string;
3001
+ };
3002
+ query?: never;
3003
+ url: '/o/{organisation_id}/environment/{environment_id}/users/{external_user_id}/activations';
3004
+ };
3005
+ export type ListUserActivationsErrors = {
3006
+ /**
3007
+ * Error
3008
+ */
3009
+ default: _Error;
3010
+ };
3011
+ export type ListUserActivationsError = ListUserActivationsErrors[keyof ListUserActivationsErrors];
3012
+ export type ListUserActivationsResponses = {
3013
+ /**
3014
+ * OK
3015
+ */
3016
+ 200: Array<Activation>;
3017
+ };
3018
+ export type ListUserActivationsResponse = ListUserActivationsResponses[keyof ListUserActivationsResponses];
3019
+ export type DeleteEndUserData = {
3020
+ body?: never;
3021
+ path: {
3022
+ organisation_id: string;
3023
+ /**
3024
+ * The ID of the user
3025
+ */
3026
+ user_id: string;
3027
+ };
3028
+ query?: never;
3029
+ url: '/o/{organisation_id}/users/{user_id}';
3030
+ };
3031
+ export type DeleteEndUserErrors = {
3032
+ /**
3033
+ * Error
3034
+ */
3035
+ default: _Error;
3036
+ };
3037
+ export type DeleteEndUserError = DeleteEndUserErrors[keyof DeleteEndUserErrors];
3038
+ export type DeleteEndUserResponses = {
3039
+ /**
3040
+ * No Content
3041
+ */
3042
+ 204: void;
3043
+ };
3044
+ export type DeleteEndUserResponse = DeleteEndUserResponses[keyof DeleteEndUserResponses];
3045
+ export type GetEndUserData = {
3046
+ body?: never;
3047
+ path: {
3048
+ organisation_id: string;
3049
+ /**
3050
+ * The ID of the user
3051
+ */
3052
+ user_id: string;
3053
+ };
3054
+ query?: never;
3055
+ url: '/o/{organisation_id}/users/{user_id}';
3056
+ };
3057
+ export type GetEndUserErrors = {
3058
+ /**
3059
+ * Error
3060
+ */
3061
+ default: _Error;
3062
+ };
3063
+ export type GetEndUserError = GetEndUserErrors[keyof GetEndUserErrors];
3064
+ export type GetEndUserResponses = {
3065
+ /**
3066
+ * OK
3067
+ */
3068
+ 200: EndUser;
3069
+ };
3070
+ export type GetEndUserResponse = GetEndUserResponses[keyof GetEndUserResponses];
3071
+ export type GetActivationConnectionData = {
3072
+ body?: never;
3073
+ path: {
3074
+ organisation_id: string;
3075
+ env_system_id: string;
3076
+ activation_id: string;
3077
+ };
3078
+ query?: never;
3079
+ url: '/o/{organisation_id}/environment-systems/{env_system_id}/activations/{activation_id}';
3080
+ };
3081
+ export type GetActivationConnectionResponses = {
3082
+ /**
3083
+ * OK
3084
+ */
3085
+ 200: Connection;
3086
+ };
3087
+ export type GetActivationConnectionResponse = GetActivationConnectionResponses[keyof GetActivationConnectionResponses];
3088
+ export type ListSystemsData = {
3089
+ body?: never;
3090
+ path: {
3091
+ organisation_id: string;
3092
+ };
3093
+ query?: {
3094
+ first?: number;
3095
+ after?: string;
3096
+ before?: string;
3097
+ search?: string;
3098
+ };
3099
+ url: '/o/{organisation_id}/systems';
3100
+ };
3101
+ export type ListSystemsResponses = {
3102
+ /**
3103
+ * OK
3104
+ */
3105
+ 200: SystemPage;
3106
+ };
3107
+ export type ListSystemsResponse = ListSystemsResponses[keyof ListSystemsResponses];
3108
+ export type CreateSystemData = {
3109
+ body?: SystemCreate;
3110
+ path: {
3111
+ organisation_id: string;
3112
+ };
3113
+ query?: never;
3114
+ url: '/o/{organisation_id}/systems';
3115
+ };
3116
+ export type CreateSystemErrors = {
3117
+ /**
3118
+ * Error
3119
+ */
3120
+ default: _Error;
3121
+ };
3122
+ export type CreateSystemError = CreateSystemErrors[keyof CreateSystemErrors];
3123
+ export type CreateSystemResponses = {
3124
+ /**
3125
+ * Created
3126
+ */
3127
+ 201: System;
3128
+ };
3129
+ export type CreateSystemResponse = CreateSystemResponses[keyof CreateSystemResponses];
3130
+ export type GetSystemData = {
3131
+ body?: never;
3132
+ path: {
3133
+ organisation_id: string;
3134
+ system_id: string;
3135
+ };
3136
+ query?: never;
3137
+ url: '/o/{organisation_id}/systems/{system_id}';
3138
+ };
3139
+ export type GetSystemErrors = {
3140
+ /**
3141
+ * Error
3142
+ */
3143
+ default: _Error;
3144
+ };
3145
+ export type GetSystemError = GetSystemErrors[keyof GetSystemErrors];
3146
+ export type GetSystemResponses = {
3147
+ /**
3148
+ * OK
3149
+ */
3150
+ 200: System;
3151
+ };
3152
+ export type GetSystemResponse = GetSystemResponses[keyof GetSystemResponses];
3153
+ export type UpdateSystemData = {
3154
+ body?: UpdateSystem;
3155
+ path: {
3156
+ organisation_id: string;
3157
+ system_id: string;
3158
+ };
3159
+ query?: never;
3160
+ url: '/o/{organisation_id}/systems/{system_id}';
3161
+ };
3162
+ export type UpdateSystemErrors = {
3163
+ /**
3164
+ * Error
3165
+ */
3166
+ default: _Error;
3167
+ };
3168
+ export type UpdateSystemError = UpdateSystemErrors[keyof UpdateSystemErrors];
3169
+ export type UpdateSystemResponses = {
3170
+ /**
3171
+ * Created
3172
+ */
3173
+ 201: System;
3174
+ };
3175
+ export type UpdateSystemResponse = UpdateSystemResponses[keyof UpdateSystemResponses];
3176
+ export type LinkSystemActionsData = {
3177
+ body?: Array<string>;
3178
+ path: {
3179
+ organisation_id: string;
3180
+ project_id: string;
3181
+ system_id: string;
3182
+ };
3183
+ query?: never;
3184
+ url: '/o/{organisation_id}/systems/{system_id}/projects/{project_id}/actions-link';
3185
+ };
3186
+ export type LinkSystemActionsErrors = {
3187
+ /**
3188
+ * Error
3189
+ */
3190
+ default: _Error;
3191
+ };
3192
+ export type LinkSystemActionsError = LinkSystemActionsErrors[keyof LinkSystemActionsErrors];
3193
+ export type LinkSystemActionsResponses = {
3194
+ /**
3195
+ * Created
3196
+ */
3197
+ 201: unknown;
3198
+ };
3199
+ export type LinkSystemTriggersData = {
3200
+ body?: Array<string>;
3201
+ path: {
3202
+ organisation_id: string;
3203
+ project_id: string;
3204
+ system_id: string;
3205
+ };
3206
+ query?: never;
3207
+ url: '/o/{organisation_id}/systems/{system_id}/projects/{project_id}/triggers-link';
3208
+ };
3209
+ export type LinkSystemTriggersErrors = {
3210
+ /**
3211
+ * Error
3212
+ */
3213
+ default: _Error;
3214
+ };
3215
+ export type LinkSystemTriggersError = LinkSystemTriggersErrors[keyof LinkSystemTriggersErrors];
3216
+ export type LinkSystemTriggersResponses = {
3217
+ /**
3218
+ * Created
3219
+ */
3220
+ 201: unknown;
3221
+ };
3222
+ export type ListSystemActionsData = {
3223
+ body?: never;
3224
+ path: {
3225
+ organisation_id: string;
3226
+ system_id: string;
3227
+ };
3228
+ query?: {
3229
+ project_id?: string;
3230
+ };
3231
+ url: '/o/{organisation_id}/systems/{system_id}/actions';
3232
+ };
3233
+ export type ListSystemActionsErrors = {
3234
+ /**
3235
+ * Error
3236
+ */
3237
+ default: _Error;
3238
+ };
3239
+ export type ListSystemActionsError = ListSystemActionsErrors[keyof ListSystemActionsErrors];
3240
+ export type ListSystemActionsResponses = {
3241
+ /**
3242
+ * OK
3243
+ */
3244
+ 200: ActionPage;
3245
+ };
3246
+ export type ListSystemActionsResponse = ListSystemActionsResponses[keyof ListSystemActionsResponses];
3247
+ export type CreateSystemActionsData = {
3248
+ body?: CreateActions;
3249
+ path: {
3250
+ organisation_id: string;
3251
+ system_id: string;
3252
+ };
3253
+ query?: never;
3254
+ url: '/o/{organisation_id}/systems/{system_id}/actions';
3255
+ };
3256
+ export type CreateSystemActionsErrors = {
3257
+ /**
3258
+ * Error
3259
+ */
3260
+ default: _Error;
3261
+ };
3262
+ export type CreateSystemActionsError = CreateSystemActionsErrors[keyof CreateSystemActionsErrors];
3263
+ export type CreateSystemActionsResponses = {
3264
+ /**
3265
+ * OK
3266
+ */
3267
+ 200: Array<Action>;
3268
+ };
3269
+ export type CreateSystemActionsResponse = CreateSystemActionsResponses[keyof CreateSystemActionsResponses];
3270
+ export type DeleteSystemActionData = {
3271
+ body?: never;
3272
+ path: {
3273
+ organisation_id: string;
3274
+ system_id: string;
3275
+ action_id: string;
3276
+ };
3277
+ query?: never;
3278
+ url: '/o/{organisation_id}/systems/{system_id}/actions/{action_id}';
3279
+ };
3280
+ export type DeleteSystemActionErrors = {
3281
+ /**
3282
+ * Error
3283
+ */
3284
+ default: _Error;
3285
+ };
3286
+ export type DeleteSystemActionError = DeleteSystemActionErrors[keyof DeleteSystemActionErrors];
3287
+ export type DeleteSystemActionResponses = {
3288
+ /**
3289
+ * No Content
3290
+ */
3291
+ 204: void;
3292
+ };
3293
+ export type DeleteSystemActionResponse = DeleteSystemActionResponses[keyof DeleteSystemActionResponses];
3294
+ export type GetSystemActionData = {
3295
+ body?: never;
3296
+ path: {
3297
+ organisation_id: string;
3298
+ system_id: string;
3299
+ action_id: string;
3300
+ };
3301
+ query?: never;
3302
+ url: '/o/{organisation_id}/systems/{system_id}/actions/{action_id}';
3303
+ };
3304
+ export type GetSystemActionErrors = {
3305
+ /**
3306
+ * Error
3307
+ */
3308
+ default: _Error;
3309
+ };
3310
+ export type GetSystemActionError = GetSystemActionErrors[keyof GetSystemActionErrors];
3311
+ export type GetSystemActionResponses = {
3312
+ /**
3313
+ * OK
3314
+ */
3315
+ 200: Action;
3316
+ };
3317
+ export type GetSystemActionResponse = GetSystemActionResponses[keyof GetSystemActionResponses];
3318
+ export type UpdateSystemActionData = {
3319
+ body?: Action;
3320
+ path: {
3321
+ organisation_id: string;
3322
+ system_id: string;
3323
+ action_id: string;
3324
+ };
3325
+ query?: never;
3326
+ url: '/o/{organisation_id}/systems/{system_id}/actions/{action_id}';
3327
+ };
3328
+ export type UpdateSystemActionErrors = {
3329
+ /**
3330
+ * Error
3331
+ */
3332
+ default: _Error;
3333
+ };
3334
+ export type UpdateSystemActionError = UpdateSystemActionErrors[keyof UpdateSystemActionErrors];
3335
+ export type UpdateSystemActionResponses = {
3336
+ /**
3337
+ * OK
3338
+ */
3339
+ 200: Action;
3340
+ };
3341
+ export type UpdateSystemActionResponse = UpdateSystemActionResponses[keyof UpdateSystemActionResponses];
3342
+ export type ListSystemTriggersData = {
3343
+ body?: never;
3344
+ path: {
3345
+ organisation_id: string;
3346
+ system_id: string;
3347
+ };
3348
+ query?: {
3349
+ project_id?: string;
3350
+ };
3351
+ url: '/o/{organisation_id}/systems/{system_id}/triggers';
3352
+ };
3353
+ export type ListSystemTriggersErrors = {
3354
+ /**
3355
+ * Error
3356
+ */
3357
+ default: _Error;
3358
+ };
3359
+ export type ListSystemTriggersError = ListSystemTriggersErrors[keyof ListSystemTriggersErrors];
3360
+ export type ListSystemTriggersResponses = {
3361
+ /**
3362
+ * OK
3363
+ */
3364
+ 200: TriggerPage;
3365
+ };
3366
+ export type ListSystemTriggersResponse = ListSystemTriggersResponses[keyof ListSystemTriggersResponses];
3367
+ export type CreateSystemTriggersData = {
3368
+ body?: CreateTriggers;
3369
+ path: {
3370
+ organisation_id: string;
3371
+ system_id: string;
3372
+ };
3373
+ query?: never;
3374
+ url: '/o/{organisation_id}/systems/{system_id}/triggers';
3375
+ };
3376
+ export type CreateSystemTriggersErrors = {
3377
+ /**
3378
+ * Error
3379
+ */
3380
+ default: _Error;
3381
+ };
3382
+ export type CreateSystemTriggersError = CreateSystemTriggersErrors[keyof CreateSystemTriggersErrors];
3383
+ export type CreateSystemTriggersResponses = {
3384
+ /**
3385
+ * OK
3386
+ */
3387
+ 200: Array<Trigger>;
3388
+ };
3389
+ export type CreateSystemTriggersResponse = CreateSystemTriggersResponses[keyof CreateSystemTriggersResponses];
3390
+ export type DeleteAuthSchemeConfigData = {
3391
+ body?: never;
3392
+ path: {
3393
+ organisation_id: string;
3394
+ system_id: string;
3395
+ auth_scheme_config_id: string;
3396
+ };
3397
+ query?: never;
3398
+ url: '/o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}';
3399
+ };
3400
+ export type DeleteAuthSchemeConfigErrors = {
3401
+ /**
3402
+ * Error
3403
+ */
3404
+ default: _Error;
3405
+ };
3406
+ export type DeleteAuthSchemeConfigError = DeleteAuthSchemeConfigErrors[keyof DeleteAuthSchemeConfigErrors];
3407
+ export type DeleteAuthSchemeConfigResponses = {
3408
+ /**
3409
+ * No Content
3410
+ */
3411
+ 204: void;
3412
+ };
3413
+ export type DeleteAuthSchemeConfigResponse = DeleteAuthSchemeConfigResponses[keyof DeleteAuthSchemeConfigResponses];
3414
+ export type UpsertAuthSchemeConfigData = {
3415
+ body?: AuthSchemeConfig;
3416
+ path: {
3417
+ organisation_id: string;
3418
+ system_id: string;
3419
+ auth_scheme_config_id: string;
3420
+ };
3421
+ query?: never;
3422
+ url: '/o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}';
3423
+ };
3424
+ export type UpsertAuthSchemeConfigErrors = {
3425
+ /**
3426
+ * Error
3427
+ */
3428
+ default: _Error;
3429
+ };
3430
+ export type UpsertAuthSchemeConfigError = UpsertAuthSchemeConfigErrors[keyof UpsertAuthSchemeConfigErrors];
3431
+ export type UpsertAuthSchemeConfigResponses = {
3432
+ /**
3433
+ * Created
3434
+ */
3435
+ 201: AuthSchemeConfig;
3436
+ };
3437
+ export type UpsertAuthSchemeConfigResponse = UpsertAuthSchemeConfigResponses[keyof UpsertAuthSchemeConfigResponses];
3438
+ export type ListEnvironmentConnectionsData = {
3439
+ body?: never;
3440
+ path: {
3441
+ organisation_id: string;
3442
+ project_id: string;
3443
+ };
3444
+ query?: {
3445
+ env_id?: string;
3446
+ };
3447
+ url: '/o/{organisation_id}/projects/{project_id}/connections';
3448
+ };
3449
+ export type ListEnvironmentConnectionsErrors = {
3450
+ /**
3451
+ * Error
3452
+ */
3453
+ default: _Error;
3454
+ };
3455
+ export type ListEnvironmentConnectionsError = ListEnvironmentConnectionsErrors[keyof ListEnvironmentConnectionsErrors];
3456
+ export type ListEnvironmentConnectionsResponses = {
3457
+ /**
3458
+ * OK
3459
+ */
3460
+ 200: ConnectionPage;
3461
+ };
3462
+ export type ListEnvironmentConnectionsResponse = ListEnvironmentConnectionsResponses[keyof ListEnvironmentConnectionsResponses];
3463
+ export type ListProjectConnectionTemplatesData = {
3464
+ body?: never;
3465
+ path: {
3466
+ organisation_id: string;
3467
+ project_id: string;
3468
+ };
3469
+ query?: {
3470
+ env_id?: string;
3471
+ };
3472
+ url: '/o/{organisation_id}/projects/{project_id}/connection-templates';
3473
+ };
3474
+ export type ListProjectConnectionTemplatesResponses = {
3475
+ /**
3476
+ * OK
3477
+ */
3478
+ 200: EnvironmentSystemPage;
3479
+ };
3480
+ export type ListProjectConnectionTemplatesResponse = ListProjectConnectionTemplatesResponses[keyof ListProjectConnectionTemplatesResponses];
3481
+ export type CreateConnectionTemplateData = {
3482
+ body?: LinkSystem;
3483
+ path: {
3484
+ organisation_id: string;
3485
+ project_id: string;
3486
+ };
3487
+ query?: never;
3488
+ url: '/o/{organisation_id}/projects/{project_id}/connection-templates';
3489
+ };
3490
+ export type CreateConnectionTemplateErrors = {
3491
+ /**
3492
+ * Error
3493
+ */
3494
+ default: _Error;
3495
+ };
3496
+ export type CreateConnectionTemplateError = CreateConnectionTemplateErrors[keyof CreateConnectionTemplateErrors];
3497
+ export type CreateConnectionTemplateResponses = {
3498
+ /**
3499
+ * OK
3500
+ */
3501
+ 200: ConnectionTemplate;
3502
+ };
3503
+ export type CreateConnectionTemplateResponse = CreateConnectionTemplateResponses[keyof CreateConnectionTemplateResponses];
3504
+ export type DeleteConnectionTemplateData = {
3505
+ body?: never;
3506
+ path: {
3507
+ organisation_id: string;
3508
+ project_id: string;
3509
+ template_id: string;
3510
+ };
3511
+ query?: never;
3512
+ url: '/o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}';
3513
+ };
3514
+ export type DeleteConnectionTemplateErrors = {
3515
+ /**
3516
+ * Error
3517
+ */
3518
+ default: _Error;
3519
+ };
3520
+ export type DeleteConnectionTemplateError = DeleteConnectionTemplateErrors[keyof DeleteConnectionTemplateErrors];
3521
+ export type DeleteConnectionTemplateResponses = {
3522
+ /**
3523
+ * OK
3524
+ */
3525
+ 204: void;
3526
+ };
3527
+ export type DeleteConnectionTemplateResponse = DeleteConnectionTemplateResponses[keyof DeleteConnectionTemplateResponses];
3528
+ export type UpdateConnectionTemplateData = {
3529
+ body?: UpdateConnectionTemplate;
3530
+ path: {
3531
+ organisation_id: string;
3532
+ project_id: string;
3533
+ template_id: string;
3534
+ };
3535
+ query?: never;
3536
+ url: '/o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}';
3537
+ };
3538
+ export type UpdateConnectionTemplateErrors = {
3539
+ /**
3540
+ * Error
3541
+ */
3542
+ default: _Error;
3543
+ };
3544
+ export type UpdateConnectionTemplateError = UpdateConnectionTemplateErrors[keyof UpdateConnectionTemplateErrors];
3545
+ export type UpdateConnectionTemplateResponses = {
3546
+ /**
3547
+ * OK
3548
+ */
3549
+ 200: ConnectionTemplate;
3550
+ };
3551
+ export type UpdateConnectionTemplateResponse = UpdateConnectionTemplateResponses[keyof UpdateConnectionTemplateResponses];
3552
+ export type InitialiseOAuth2ConnectionData = {
3553
+ body?: InitialiseOAuth2ConnectionRequest;
3554
+ path: {
3555
+ organisation_id: string;
3556
+ system_id: string;
3557
+ };
3558
+ query?: never;
3559
+ url: '/o/{organisation_id}/systems/{system_id}/oauth2/initialise';
3560
+ };
3561
+ export type InitialiseOAuth2ConnectionErrors = {
3562
+ /**
3563
+ * Error
3564
+ */
3565
+ default: _Error;
3566
+ };
3567
+ export type InitialiseOAuth2ConnectionError = InitialiseOAuth2ConnectionErrors[keyof InitialiseOAuth2ConnectionErrors];
3568
+ export type InitialiseOAuth2ConnectionResponses = {
3569
+ /**
3570
+ * OK
3571
+ */
3572
+ 200: InitialiseOAuth2ConnectionResponse;
3573
+ };
3574
+ export type InitialiseOAuth2ConnectionResponse2 = InitialiseOAuth2ConnectionResponses[keyof InitialiseOAuth2ConnectionResponses];
3575
+ export type InitialiseOAuth1ConnectionData = {
3576
+ body?: InitialiseOAuth1ConnectionRequest;
3577
+ path: {
3578
+ organisation_id: string;
3579
+ system_id: string;
3580
+ };
3581
+ query?: never;
3582
+ url: '/o/{organisation_id}/systems/{system_id}/oauth1/initialise';
3583
+ };
3584
+ export type InitialiseOAuth1ConnectionErrors = {
3585
+ /**
3586
+ * Error
3587
+ */
3588
+ default: _Error;
3589
+ };
3590
+ export type InitialiseOAuth1ConnectionError = InitialiseOAuth1ConnectionErrors[keyof InitialiseOAuth1ConnectionErrors];
3591
+ export type InitialiseOAuth1ConnectionResponses = {
3592
+ /**
3593
+ * OK
3594
+ */
3595
+ 200: InitialiseOAuth1ConnectionResponse;
3596
+ };
3597
+ export type InitialiseOAuth1ConnectionResponse2 = InitialiseOAuth1ConnectionResponses[keyof InitialiseOAuth1ConnectionResponses];
3598
+ export type ListIssuesData = {
3599
+ body?: never;
3600
+ path: {
3601
+ organisation_id: string;
3602
+ };
3603
+ query?: {
3604
+ first?: number;
3605
+ after?: string;
3606
+ before?: string;
3607
+ /**
3608
+ * Which date to use in after and before queries. If not provided, defaults to createdAt.
3609
+ * The result will also be ordered by this date.
3610
+ *
3611
+ */
3612
+ search_date?: 'createdAt' | 'lastSeenAt';
3613
+ /**
3614
+ * Filter issues by status. Can be one of 'open', 'closed', 'acked' or 'resolved'.
3615
+ * If not provided, defaults to getting issues of all statuses.
3616
+ *
3617
+ */
3618
+ status?: IssueStatusEnum;
3619
+ /**
3620
+ * Filter issues by project ID. If not provided, issues from all projects are returned.
3621
+ * This is useful for filtering issues related to a specific project.
3622
+ *
3623
+ */
3624
+ project_id?: string;
3625
+ /**
3626
+ * Filter issues by environment ID. If not provided, issues from all projects are returned.
3627
+ * This is useful for filtering issues related to a specific environment.
3628
+ *
3629
+ */
3630
+ environment_id?: string;
3631
+ /**
3632
+ * Filter issues by severity. Can be one of 'low', 'medium', or 'high'.
3633
+ * If not provided, issues of all severities are returned.
3634
+ *
3635
+ */
3636
+ severity?: IssueSeverityEnum;
3637
+ };
3638
+ url: '/o/{organisation_id}/issues';
3639
+ };
3640
+ export type ListIssuesErrors = {
3641
+ /**
3642
+ * Error
3643
+ */
3644
+ default: _Error;
3645
+ };
3646
+ export type ListIssuesError = ListIssuesErrors[keyof ListIssuesErrors];
3647
+ export type ListIssuesResponses = {
3648
+ /**
3649
+ * OK
3650
+ */
3651
+ 200: Array<Issue>;
3652
+ };
3653
+ export type ListIssuesResponse = ListIssuesResponses[keyof ListIssuesResponses];
3654
+ export type CreateIssueData = {
3655
+ body?: CreateIssue;
3656
+ path: {
3657
+ organisation_id: string;
3658
+ };
3659
+ query?: never;
3660
+ url: '/o/{organisation_id}/issues';
3661
+ };
3662
+ export type CreateIssueErrors = {
3663
+ /**
3664
+ * Error
3665
+ */
3666
+ default: _Error;
3667
+ };
3668
+ export type CreateIssueError = CreateIssueErrors[keyof CreateIssueErrors];
3669
+ export type CreateIssueResponses = {
3670
+ /**
3671
+ * Created
3672
+ */
3673
+ 201: Issue;
3674
+ };
3675
+ export type CreateIssueResponse = CreateIssueResponses[keyof CreateIssueResponses];
3676
+ export type UpdateIssueData = {
3677
+ body?: UpdateIssue;
3678
+ path: {
3679
+ organisation_id: string;
3680
+ issue_id: string;
3681
+ };
3682
+ query?: never;
3683
+ url: '/o/{organisation_id}/issues/{issue_id}';
3684
+ };
3685
+ export type UpdateIssueErrors = {
3686
+ /**
3687
+ * Error
3688
+ */
3689
+ default: _Error;
3690
+ };
3691
+ export type UpdateIssueError = UpdateIssueErrors[keyof UpdateIssueErrors];
3692
+ export type UpdateIssueResponses = {
3693
+ /**
3694
+ * OK
3695
+ */
3696
+ 200: Issue;
3697
+ };
3698
+ export type UpdateIssueResponse = UpdateIssueResponses[keyof UpdateIssueResponses];
3699
+ export type ListNotificationChannelsData = {
3700
+ body?: never;
3701
+ path: {
3702
+ organisation_id: string;
3703
+ };
3704
+ query?: never;
3705
+ url: '/o/{organisation_id}/notification_channels';
3706
+ };
3707
+ export type ListNotificationChannelsResponses = {
3708
+ /**
3709
+ * A list of notification channels
3710
+ */
3711
+ 200: NotificationChannelList;
3712
+ };
3713
+ export type ListNotificationChannelsResponse = ListNotificationChannelsResponses[keyof ListNotificationChannelsResponses];
3714
+ export type CreateNotificationChannelData = {
3715
+ body: CreateNotificationChannel;
3716
+ path: {
3717
+ organisation_id: string;
3718
+ };
3719
+ query?: never;
3720
+ url: '/o/{organisation_id}/notification_channels';
3721
+ };
3722
+ export type CreateNotificationChannelResponses = {
3723
+ /**
3724
+ * Notification channel created successfully
3725
+ */
3726
+ 201: NotificationChannel;
3727
+ };
3728
+ export type CreateNotificationChannelResponse = CreateNotificationChannelResponses[keyof CreateNotificationChannelResponses];
3729
+ export type DeleteNotificationChannelData = {
3730
+ body?: never;
3731
+ path: {
3732
+ organisation_id: string;
3733
+ channel_id: string;
3734
+ };
3735
+ query?: never;
3736
+ url: '/o/{organisation_id}/notification_channels/{channel_id}';
3737
+ };
3738
+ export type DeleteNotificationChannelResponses = {
3739
+ /**
3740
+ * Notification channel deleted successfully
3741
+ */
3742
+ 204: void;
3743
+ };
3744
+ export type DeleteNotificationChannelResponse = DeleteNotificationChannelResponses[keyof DeleteNotificationChannelResponses];
3745
+ export type ListProjectNotificationsData = {
3746
+ body?: never;
3747
+ path: {
3748
+ project_id: string;
3749
+ };
3750
+ query?: {
3751
+ env_id?: string;
3752
+ };
3753
+ url: '/projects/{project_id}/notifications';
3754
+ };
3755
+ export type ListProjectNotificationsResponses = {
3756
+ /**
3757
+ * A list of project notifications
3758
+ */
3759
+ 200: ProjectNotificationList;
3760
+ };
3761
+ export type ListProjectNotificationsResponse = ListProjectNotificationsResponses[keyof ListProjectNotificationsResponses];
3762
+ export type CreateProjectNotificationData = {
3763
+ body: CreateProjectNotification;
3764
+ path: {
3765
+ project_id: string;
3766
+ };
3767
+ query?: never;
3768
+ url: '/projects/{project_id}/notifications';
3769
+ };
3770
+ export type CreateProjectNotificationResponses = {
3771
+ /**
3772
+ * Project notification created successfully
3773
+ */
3774
+ 201: ProjectNotification;
3775
+ };
3776
+ export type CreateProjectNotificationResponse = CreateProjectNotificationResponses[keyof CreateProjectNotificationResponses];
3777
+ export type DeleteProjectNotificationData = {
3778
+ body?: never;
3779
+ path: {
3780
+ project_id: string;
3781
+ notification_id: string;
3782
+ };
3783
+ query?: {
3784
+ env_id?: string;
3785
+ };
3786
+ url: '/projects/{project_id}/notifications/{notification_id}';
3787
+ };
3788
+ export type DeleteProjectNotificationResponses = {
3789
+ /**
3790
+ * Project notification deleted successfully
3791
+ */
3792
+ 204: void;
3793
+ };
3794
+ export type DeleteProjectNotificationResponse = DeleteProjectNotificationResponses[keyof DeleteProjectNotificationResponses];
3795
+ export type ClientOptions = {
3796
+ baseUrl: 'https://platform.versori.com/api/v2' | 'https://platform-staging.versori.com/api/v2' | 'http://localhost:8901' | (string & {});
3797
+ };
3798
+ //# sourceMappingURL=types.gen.d.ts.map