@epilot/sdk 2.4.3 → 2.4.4-alpha.0

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 (348) hide show
  1. package/README.md +1 -0
  2. package/definitions/app-runtime.json +1 -1
  3. package/definitions/app.json +346 -10
  4. package/definitions/calendar-runtime.json +1 -0
  5. package/definitions/calendar.json +675 -0
  6. package/definitions/customer-portal.json +29 -0
  7. package/definitions/notes.json +175 -130
  8. package/definitions/pricing.json +5 -1
  9. package/dist/README-46VYEGGW.js +7 -0
  10. package/dist/README-IVBISSWB.cjs +7 -0
  11. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  12. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  13. package/dist/apis/_registry.d.ts +8 -0
  14. package/dist/apis/access-token.cjs +6 -6
  15. package/dist/apis/access-token.d.ts +9 -12
  16. package/dist/apis/access-token.js +1 -1
  17. package/dist/apis/address-suggestions.cjs +6 -6
  18. package/dist/apis/address-suggestions.d.ts +9 -12
  19. package/dist/apis/address-suggestions.js +1 -1
  20. package/dist/apis/address.cjs +6 -6
  21. package/dist/apis/address.d.ts +9 -12
  22. package/dist/apis/address.js +1 -1
  23. package/dist/apis/ai-agents.cjs +6 -6
  24. package/dist/apis/ai-agents.d.ts +9 -12
  25. package/dist/apis/ai-agents.js +1 -1
  26. package/dist/apis/app.cjs +6 -6
  27. package/dist/apis/app.d.ts +9 -12
  28. package/dist/apis/app.js +1 -1
  29. package/dist/apis/audit-logs.cjs +6 -6
  30. package/dist/apis/audit-logs.d.ts +9 -12
  31. package/dist/apis/audit-logs.js +1 -1
  32. package/dist/apis/automation.cjs +6 -6
  33. package/dist/apis/automation.d.ts +9 -12
  34. package/dist/apis/automation.js +1 -1
  35. package/dist/apis/billing.cjs +6 -6
  36. package/dist/apis/billing.d.ts +9 -12
  37. package/dist/apis/billing.js +1 -1
  38. package/dist/apis/blueprint-manifest.cjs +6 -6
  39. package/dist/apis/blueprint-manifest.d.ts +9 -12
  40. package/dist/apis/blueprint-manifest.js +1 -1
  41. package/dist/apis/calendar.cjs +38 -0
  42. package/dist/apis/calendar.d.ts +15 -0
  43. package/dist/apis/calendar.js +38 -0
  44. package/dist/apis/configuration-hub.cjs +6 -6
  45. package/dist/apis/configuration-hub.d.ts +9 -12
  46. package/dist/apis/configuration-hub.js +1 -1
  47. package/dist/apis/consent.cjs +6 -6
  48. package/dist/apis/consent.d.ts +9 -12
  49. package/dist/apis/consent.js +1 -1
  50. package/dist/apis/customer-portal.cjs +6 -6
  51. package/dist/apis/customer-portal.d.ts +9 -12
  52. package/dist/apis/customer-portal.js +1 -1
  53. package/dist/apis/dashboard.cjs +6 -6
  54. package/dist/apis/dashboard.d.ts +9 -12
  55. package/dist/apis/dashboard.js +1 -1
  56. package/dist/apis/data-governance.cjs +6 -6
  57. package/dist/apis/data-governance.d.ts +9 -12
  58. package/dist/apis/data-governance.js +1 -1
  59. package/dist/apis/deduplication.cjs +6 -6
  60. package/dist/apis/deduplication.d.ts +9 -12
  61. package/dist/apis/deduplication.js +1 -1
  62. package/dist/apis/design.cjs +6 -6
  63. package/dist/apis/design.d.ts +9 -12
  64. package/dist/apis/design.js +1 -1
  65. package/dist/apis/document.cjs +6 -6
  66. package/dist/apis/document.d.ts +9 -12
  67. package/dist/apis/document.js +1 -1
  68. package/dist/apis/email-settings.cjs +6 -6
  69. package/dist/apis/email-settings.d.ts +9 -12
  70. package/dist/apis/email-settings.js +1 -1
  71. package/dist/apis/email-template.cjs +6 -6
  72. package/dist/apis/email-template.d.ts +9 -12
  73. package/dist/apis/email-template.js +1 -1
  74. package/dist/apis/entity-mapping.cjs +6 -6
  75. package/dist/apis/entity-mapping.d.ts +9 -12
  76. package/dist/apis/entity-mapping.js +1 -1
  77. package/dist/apis/entity.cjs +6 -6
  78. package/dist/apis/entity.d.ts +9 -12
  79. package/dist/apis/entity.js +1 -1
  80. package/dist/apis/environments.cjs +6 -6
  81. package/dist/apis/environments.d.ts +9 -12
  82. package/dist/apis/environments.js +1 -1
  83. package/dist/apis/event-catalog.cjs +6 -6
  84. package/dist/apis/event-catalog.d.ts +9 -12
  85. package/dist/apis/event-catalog.js +1 -1
  86. package/dist/apis/file.cjs +6 -6
  87. package/dist/apis/file.d.ts +9 -12
  88. package/dist/apis/file.js +1 -1
  89. package/dist/apis/iban.cjs +6 -6
  90. package/dist/apis/iban.d.ts +9 -12
  91. package/dist/apis/iban.js +1 -1
  92. package/dist/apis/integration-toolkit.cjs +6 -6
  93. package/dist/apis/integration-toolkit.d.ts +9 -12
  94. package/dist/apis/integration-toolkit.js +1 -1
  95. package/dist/apis/journey.cjs +6 -6
  96. package/dist/apis/journey.d.ts +9 -12
  97. package/dist/apis/journey.js +1 -1
  98. package/dist/apis/kanban.cjs +6 -6
  99. package/dist/apis/kanban.d.ts +9 -12
  100. package/dist/apis/kanban.js +1 -1
  101. package/dist/apis/message.cjs +6 -6
  102. package/dist/apis/message.d.ts +9 -12
  103. package/dist/apis/message.js +1 -1
  104. package/dist/apis/metering.cjs +6 -6
  105. package/dist/apis/metering.d.ts +9 -12
  106. package/dist/apis/metering.js +1 -1
  107. package/dist/apis/notes.cjs +6 -6
  108. package/dist/apis/notes.d.ts +9 -12
  109. package/dist/apis/notes.js +1 -1
  110. package/dist/apis/notification.cjs +6 -6
  111. package/dist/apis/notification.d.ts +9 -12
  112. package/dist/apis/notification.js +1 -1
  113. package/dist/apis/organization.cjs +6 -6
  114. package/dist/apis/organization.d.ts +9 -12
  115. package/dist/apis/organization.js +1 -1
  116. package/dist/apis/partner-directory.cjs +6 -6
  117. package/dist/apis/partner-directory.d.ts +9 -12
  118. package/dist/apis/partner-directory.js +1 -1
  119. package/dist/apis/permissions.cjs +6 -6
  120. package/dist/apis/permissions.d.ts +9 -12
  121. package/dist/apis/permissions.js +1 -1
  122. package/dist/apis/pricing-tier.cjs +6 -6
  123. package/dist/apis/pricing-tier.d.ts +9 -12
  124. package/dist/apis/pricing-tier.js +1 -1
  125. package/dist/apis/pricing.cjs +6 -6
  126. package/dist/apis/pricing.d.ts +9 -12
  127. package/dist/apis/pricing.js +1 -1
  128. package/dist/apis/purpose.cjs +6 -6
  129. package/dist/apis/purpose.d.ts +9 -12
  130. package/dist/apis/purpose.js +1 -1
  131. package/dist/apis/query.cjs +6 -6
  132. package/dist/apis/query.d.ts +9 -12
  133. package/dist/apis/query.js +1 -1
  134. package/dist/apis/sandbox.cjs +6 -6
  135. package/dist/apis/sandbox.d.ts +9 -12
  136. package/dist/apis/sandbox.js +1 -1
  137. package/dist/apis/sharing.cjs +6 -6
  138. package/dist/apis/sharing.d.ts +9 -12
  139. package/dist/apis/sharing.js +1 -1
  140. package/dist/apis/submission.cjs +6 -6
  141. package/dist/apis/submission.d.ts +9 -12
  142. package/dist/apis/submission.js +1 -1
  143. package/dist/apis/target.cjs +6 -6
  144. package/dist/apis/target.d.ts +9 -591
  145. package/dist/apis/target.js +1 -1
  146. package/dist/apis/targeting.cjs +6 -6
  147. package/dist/apis/targeting.d.ts +9 -12
  148. package/dist/apis/targeting.js +1 -1
  149. package/dist/apis/template-variables.cjs +6 -6
  150. package/dist/apis/template-variables.d.ts +9 -12
  151. package/dist/apis/template-variables.js +1 -1
  152. package/dist/apis/user.cjs +6 -6
  153. package/dist/apis/user.d.ts +9 -12
  154. package/dist/apis/user.js +1 -1
  155. package/dist/apis/validation-rules.cjs +6 -6
  156. package/dist/apis/validation-rules.d.ts +9 -12
  157. package/dist/apis/validation-rules.js +1 -1
  158. package/dist/apis/webhooks.cjs +6 -6
  159. package/dist/apis/webhooks.d.ts +9 -12
  160. package/dist/apis/webhooks.js +1 -1
  161. package/dist/apis/workflow-definition.cjs +6 -6
  162. package/dist/apis/workflow-definition.d.ts +9 -12
  163. package/dist/apis/workflow-definition.js +1 -1
  164. package/dist/apis/workflow.cjs +6 -6
  165. package/dist/apis/workflow.d.ts +9 -12
  166. package/dist/apis/workflow.js +1 -1
  167. package/dist/authorize.d.ts +3 -0
  168. package/dist/bin/cli.d.ts +1 -0
  169. package/dist/bin/cli.js +1 -1
  170. package/dist/calendar-2YDAYG7S.cjs +7 -0
  171. package/dist/calendar-ACFIHQ2N.js +7 -0
  172. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  173. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  174. package/dist/{chunk-AM5TSEMU.cjs → chunk-CD4OX2U6.cjs} +4 -2
  175. package/dist/chunk-CKLEBO4K.cjs +14 -0
  176. package/dist/chunk-JNH37UUH.js +14 -0
  177. package/dist/{chunk-M25MI6ZX.js → chunk-TSV242UN.js} +4 -2
  178. package/dist/client-factory.d.ts +9 -0
  179. package/dist/client-map.d.ts +102 -0
  180. package/dist/compact.d.ts +22 -0
  181. package/dist/help.d.ts +12 -0
  182. package/dist/index.cjs +25 -17
  183. package/dist/index.d.ts +12 -180
  184. package/dist/index.js +21 -13
  185. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  186. package/dist/large-response.d.ts +9 -0
  187. package/dist/openapi.d.ts +12 -0
  188. package/dist/overrides.d.ts +9 -0
  189. package/dist/proxy.d.ts +14 -0
  190. package/dist/registry.d.ts +19 -0
  191. package/dist/retry.d.ts +11 -0
  192. package/dist/sdk.d.ts +29 -0
  193. package/dist/types.d.ts +53 -0
  194. package/docs/calendar.md +441 -0
  195. package/package.json +10 -1
  196. package/dist/README-6MG272KM.cjs +0 -7
  197. package/dist/README-7N542PBL.js +0 -7
  198. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  199. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  200. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  201. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  202. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  203. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  204. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  205. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  206. package/dist/apis/access-token.d.cts +0 -18
  207. package/dist/apis/address-suggestions.d.cts +0 -18
  208. package/dist/apis/address.d.cts +0 -18
  209. package/dist/apis/ai-agents.d.cts +0 -18
  210. package/dist/apis/app.d.cts +0 -18
  211. package/dist/apis/audit-logs.d.cts +0 -18
  212. package/dist/apis/automation.d.cts +0 -18
  213. package/dist/apis/billing.d.cts +0 -18
  214. package/dist/apis/blueprint-manifest.d.cts +0 -18
  215. package/dist/apis/configuration-hub.d.cts +0 -18
  216. package/dist/apis/consent.d.cts +0 -18
  217. package/dist/apis/customer-portal.d.cts +0 -18
  218. package/dist/apis/dashboard.d.cts +0 -18
  219. package/dist/apis/data-governance.d.cts +0 -18
  220. package/dist/apis/deduplication.d.cts +0 -18
  221. package/dist/apis/design.d.cts +0 -18
  222. package/dist/apis/document.d.cts +0 -18
  223. package/dist/apis/email-settings.d.cts +0 -18
  224. package/dist/apis/email-template.d.cts +0 -18
  225. package/dist/apis/entity-mapping.d.cts +0 -18
  226. package/dist/apis/entity.d.cts +0 -18
  227. package/dist/apis/environments.d.cts +0 -18
  228. package/dist/apis/event-catalog.d.cts +0 -18
  229. package/dist/apis/file.d.cts +0 -18
  230. package/dist/apis/iban.d.cts +0 -18
  231. package/dist/apis/integration-toolkit.d.cts +0 -18
  232. package/dist/apis/journey.d.cts +0 -18
  233. package/dist/apis/kanban.d.cts +0 -18
  234. package/dist/apis/message.d.cts +0 -18
  235. package/dist/apis/metering.d.cts +0 -18
  236. package/dist/apis/notes.d.cts +0 -18
  237. package/dist/apis/notification.d.cts +0 -18
  238. package/dist/apis/organization.d.cts +0 -18
  239. package/dist/apis/partner-directory.d.cts +0 -18
  240. package/dist/apis/permissions.d.cts +0 -18
  241. package/dist/apis/pricing-tier.d.cts +0 -18
  242. package/dist/apis/pricing.d.cts +0 -18
  243. package/dist/apis/purpose.d.cts +0 -18
  244. package/dist/apis/query.d.cts +0 -18
  245. package/dist/apis/sandbox.d.cts +0 -18
  246. package/dist/apis/sharing.d.cts +0 -18
  247. package/dist/apis/submission.d.cts +0 -18
  248. package/dist/apis/target.d.cts +0 -597
  249. package/dist/apis/targeting.d.cts +0 -18
  250. package/dist/apis/template-variables.d.cts +0 -18
  251. package/dist/apis/user.d.cts +0 -18
  252. package/dist/apis/validation-rules.d.cts +0 -18
  253. package/dist/apis/webhooks.d.cts +0 -18
  254. package/dist/apis/workflow-definition.d.cts +0 -18
  255. package/dist/apis/workflow.d.cts +0 -18
  256. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  257. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  258. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  259. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  260. package/dist/automation.d-Du6-uiz5.d.cts +0 -5283
  261. package/dist/automation.d-Du6-uiz5.d.ts +0 -5283
  262. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  263. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  264. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  265. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  266. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  267. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  268. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  269. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  270. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  271. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  272. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  273. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  274. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  275. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  276. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  277. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  278. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  279. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  280. package/dist/document.d-DN37pjdx.d.cts +0 -648
  281. package/dist/document.d-DN37pjdx.d.ts +0 -648
  282. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  283. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  284. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  285. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  286. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  287. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  288. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  289. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  290. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  291. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  292. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  293. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  294. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  295. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  296. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  297. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  298. package/dist/index.d.cts +0 -180
  299. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  300. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  301. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  302. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  303. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  304. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  305. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  306. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  307. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  308. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  309. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  310. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  311. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  312. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  313. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  314. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  315. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  316. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  317. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  318. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  319. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  320. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  321. package/dist/pricing.d-BHpMU4KU.d.cts +0 -12255
  322. package/dist/pricing.d-BHpMU4KU.d.ts +0 -12255
  323. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  324. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  325. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  326. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  327. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  328. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  329. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  330. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  331. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  332. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  333. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  334. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  335. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  336. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  337. package/dist/types-ChU9Acbv.d.cts +0 -37
  338. package/dist/types-ChU9Acbv.d.ts +0 -37
  339. package/dist/user.d-D18fe97W.d.cts +0 -2270
  340. package/dist/user.d-D18fe97W.d.ts +0 -2270
  341. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  342. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  343. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  344. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  345. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  346. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  347. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  348. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,3391 +0,0 @@
1
- import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from app-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace RequestBodies {
8
- export interface CreateBundlePresignedRequest {
9
- /**
10
- * Version of the app
11
- */
12
- version: string;
13
- /**
14
- * ID of the journey block component
15
- */
16
- component_id?: string;
17
- }
18
- export interface CreateConfigRequest {
19
- /**
20
- * Name of the app
21
- */
22
- name: string;
23
- description: Schemas.TranslatedString;
24
- category?: string;
25
- /**
26
- * S3 key of the logo file
27
- */
28
- logo_url_key?: string;
29
- }
30
- export interface CreateLogoPresignedRequest {
31
- /**
32
- * Original filename of the logo
33
- * example:
34
- * company-logo.png
35
- */
36
- filename: string;
37
- /**
38
- * MIME type of the logo file
39
- * example:
40
- * image/png
41
- */
42
- mime_type: "image/png" | "image/jpeg" | "image/jpg";
43
- }
44
- export interface CreateReviewRequest {
45
- /**
46
- * Email of the technical contact
47
- */
48
- technical_contact: string;
49
- /**
50
- * Email of the marketing contact
51
- */
52
- marketing_contact: string;
53
- /**
54
- * URL to a demo of the app
55
- */
56
- demo_url?: string;
57
- }
58
- export interface InstallRequest {
59
- /**
60
- * Version of the app to update to
61
- */
62
- version?: string;
63
- /**
64
- * Configuration values for the app components
65
- */
66
- option_values?: Schemas.OptionsRef[];
67
- /**
68
- * Manifest ID used to create/update the entity
69
- */
70
- _manifest?: string /* uuid */[];
71
- }
72
- export interface PatchConfigMetadataRequest {
73
- /**
74
- * Name of the app
75
- */
76
- name?: string;
77
- description?: Schemas.TranslatedString;
78
- category?: string;
79
- documentation_url?: string;
80
- notifications?: Schemas.NotificationConfig;
81
- pricing?: Schemas.Pricing;
82
- /**
83
- * S3 key of the logo file
84
- */
85
- logo_url_key?: string;
86
- /**
87
- * Email address for support requests
88
- */
89
- support_email?: string;
90
- /**
91
- * Flag to indicate if the app is in dev mode. If true, the app takes the override properties of components into account.
92
- */
93
- dev_mode?: boolean;
94
- }
95
- export interface PatchVersionRequest {
96
- /**
97
- * ID of the manifest to use for this version
98
- */
99
- manifest_id?: string;
100
- /**
101
- * Name of the role
102
- */
103
- role_id?: string | null;
104
- grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Schemas.Grants;
105
- }
106
- export type UpsertComponentRequest = Schemas.BaseComponent;
107
- }
108
- namespace Schemas {
109
- export interface Actor {
110
- /**
111
- * Organization ID of the actor
112
- */
113
- org_id?: string;
114
- /**
115
- * User ID of the actor
116
- */
117
- user_id?: string;
118
- /**
119
- * Type of the actor (e.g., user, system)
120
- */
121
- type: "user" | "system";
122
- }
123
- export interface AggregatedEvents {
124
- type?: "aggregated";
125
- groups?: {
126
- /**
127
- * The grouped dimensions e.g., "source": "CUSTOM_JOURNEY_BLOCK", "event_type": "ERROR"
128
- */
129
- dimensions?: {
130
- [name: string]: any;
131
- };
132
- metrics?: {
133
- count?: number;
134
- error_rate?: number;
135
- };
136
- }[];
137
- }
138
- export interface AppBridgeSurfaceConfig {
139
- /**
140
- * URL of the uploaded App Bridge App. This is the entrypoint for the app
141
- */
142
- app_url?: string;
143
- /**
144
- * URL of the uploaded zip file containing the app
145
- */
146
- zip_url?: string;
147
- /**
148
- * URL of the app in dev mode
149
- */
150
- override_url?: string;
151
- }
152
- export interface AppEventData {
153
- /**
154
- * ID of the app configuration
155
- */
156
- app_id: string;
157
- /**
158
- * Version of the app configuration
159
- */
160
- version: string;
161
- event_id?: string;
162
- component_id: string;
163
- timestamp?: string;
164
- correlation_id?: string;
165
- event_type: "ERROR" | "WARNING" | "INFO";
166
- source: /* Type of app component */ ComponentType;
167
- actor: Actor;
168
- /**
169
- * Details about the event
170
- */
171
- details?: {
172
- [name: string]: any;
173
- };
174
- }
175
- export interface Audit {
176
- /**
177
- * Timestamp of the creation
178
- */
179
- created_at?: string;
180
- /**
181
- * User ID of the creator
182
- */
183
- created_by?: string;
184
- /**
185
- * Timestamp of the last update
186
- */
187
- updated_at?: string;
188
- /**
189
- * User ID of the last updater
190
- */
191
- updated_by?: string;
192
- }
193
- export interface Author {
194
- /**
195
- * Name of the author
196
- */
197
- name?: string;
198
- /**
199
- * Company of the author
200
- */
201
- company: string;
202
- /**
203
- * Email of the author
204
- */
205
- email?: string;
206
- }
207
- export type BaseComponent = {
208
- /**
209
- * Unique identifier for the component
210
- */
211
- id: string;
212
- /**
213
- * Name of the component
214
- */
215
- name?: {
216
- /**
217
- * English translation
218
- */
219
- en?: string | null;
220
- /**
221
- * German translation
222
- */
223
- de: string;
224
- };
225
- /**
226
- * Description of the component
227
- */
228
- description?: {
229
- /**
230
- * English translation
231
- */
232
- en?: string | null;
233
- /**
234
- * German translation
235
- */
236
- de: string;
237
- };
238
- /**
239
- * List of options for the app component
240
- */
241
- options?: /* Options for the component configuration */ Options[];
242
- surfaces?: {
243
- [key: string]: any;
244
- };
245
- } & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent | CustomPageComponent);
246
- export interface BaseComponentCommon {
247
- /**
248
- * Unique identifier for the component
249
- */
250
- id: string;
251
- /**
252
- * Name of the component
253
- */
254
- name?: {
255
- /**
256
- * English translation
257
- */
258
- en?: string | null;
259
- /**
260
- * German translation
261
- */
262
- de: string;
263
- };
264
- /**
265
- * Description of the component
266
- */
267
- description?: {
268
- /**
269
- * English translation
270
- */
271
- en?: string | null;
272
- /**
273
- * German translation
274
- */
275
- de: string;
276
- };
277
- /**
278
- * List of options for the app component
279
- */
280
- options?: /* Options for the component configuration */ Options[];
281
- surfaces?: {
282
- [key: string]: any;
283
- };
284
- }
285
- export interface BaseCustomActionConfig {
286
- /**
287
- * Name of the custom action
288
- */
289
- name?: string;
290
- /**
291
- * Description of the custom action
292
- */
293
- description?: string;
294
- /**
295
- * Wait for callback_url to be called before completing the action
296
- */
297
- wait_for_callback?: boolean;
298
- }
299
- export interface BatchEventRequest {
300
- events: [
301
- AppEventData?,
302
- AppEventData?,
303
- AppEventData?,
304
- AppEventData?,
305
- AppEventData?,
306
- AppEventData?,
307
- AppEventData?,
308
- AppEventData?,
309
- AppEventData?,
310
- AppEventData?,
311
- AppEventData?,
312
- AppEventData?,
313
- AppEventData?,
314
- AppEventData?,
315
- AppEventData?,
316
- AppEventData?,
317
- AppEventData?,
318
- AppEventData?,
319
- AppEventData?,
320
- AppEventData?,
321
- AppEventData?,
322
- AppEventData?,
323
- AppEventData?,
324
- AppEventData?,
325
- AppEventData?,
326
- AppEventData?,
327
- AppEventData?,
328
- AppEventData?,
329
- AppEventData?,
330
- AppEventData?,
331
- AppEventData?,
332
- AppEventData?,
333
- AppEventData?,
334
- AppEventData?,
335
- AppEventData?,
336
- AppEventData?,
337
- AppEventData?,
338
- AppEventData?,
339
- AppEventData?,
340
- AppEventData?,
341
- AppEventData?,
342
- AppEventData?,
343
- AppEventData?,
344
- AppEventData?,
345
- AppEventData?,
346
- AppEventData?,
347
- AppEventData?,
348
- AppEventData?,
349
- AppEventData?,
350
- AppEventData?,
351
- AppEventData?,
352
- AppEventData?,
353
- AppEventData?,
354
- AppEventData?,
355
- AppEventData?,
356
- AppEventData?,
357
- AppEventData?,
358
- AppEventData?,
359
- AppEventData?,
360
- AppEventData?,
361
- AppEventData?,
362
- AppEventData?,
363
- AppEventData?,
364
- AppEventData?,
365
- AppEventData?,
366
- AppEventData?,
367
- AppEventData?,
368
- AppEventData?,
369
- AppEventData?,
370
- AppEventData?,
371
- AppEventData?,
372
- AppEventData?,
373
- AppEventData?,
374
- AppEventData?,
375
- AppEventData?,
376
- AppEventData?,
377
- AppEventData?,
378
- AppEventData?,
379
- AppEventData?,
380
- AppEventData?,
381
- AppEventData?,
382
- AppEventData?,
383
- AppEventData?,
384
- AppEventData?,
385
- AppEventData?,
386
- AppEventData?,
387
- AppEventData?,
388
- AppEventData?,
389
- AppEventData?,
390
- AppEventData?,
391
- AppEventData?,
392
- AppEventData?,
393
- AppEventData?,
394
- AppEventData?,
395
- AppEventData?,
396
- AppEventData?,
397
- AppEventData?,
398
- AppEventData?,
399
- AppEventData?,
400
- AppEventData?
401
- ];
402
- }
403
- /**
404
- * How often the subscription is billed
405
- */
406
- export type BillingFrequency = "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM";
407
- export interface BlueprintRef {
408
- /**
409
- * ID of the blueprint
410
- */
411
- manifest_id?: string;
412
- /**
413
- * ID of the job that created the blueprint
414
- */
415
- job_id?: string;
416
- /**
417
- * S3 key of a pre-exported blueprint zip used for cross-org installs
418
- */
419
- source_blueprint_file?: string;
420
- }
421
- export interface BooleanArg {
422
- type?: "boolean";
423
- }
424
- export interface CallerIdentity {
425
- /**
426
- * a human readable name of the caller (e.g. user name, token name or email address)
427
- * example:
428
- * manifest@epilot.cloud
429
- */
430
- name?: any;
431
- /**
432
- * epilot organization id
433
- * example:
434
- * 911690
435
- */
436
- org_id: string;
437
- /**
438
- * epilot user id, when called by a user
439
- * example:
440
- * 11001045
441
- */
442
- user_id?: string;
443
- /**
444
- * token id, when called by API token
445
- * example:
446
- * api_5ZugdRXasLfWBypHi93Fk
447
- */
448
- token_id?: string;
449
- }
450
- /**
451
- * Type of app component
452
- */
453
- export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE";
454
- /**
455
- * Configuration of the published app
456
- */
457
- export interface Configuration {
458
- app_id: string;
459
- /**
460
- * Name of the app
461
- */
462
- name: string;
463
- author?: Author;
464
- /**
465
- * Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
466
- */
467
- dev_mode?: boolean;
468
- /**
469
- * List of available versions of the app
470
- */
471
- versions: string[];
472
- /**
473
- * List of available public versions of the app
474
- */
475
- public_versions?: string[];
476
- /**
477
- * Email address for support requests
478
- */
479
- support_email?: string;
480
- /**
481
- * Latest version of the app
482
- */
483
- latest_version: string;
484
- /**
485
- * Category of the app.
486
- */
487
- category?: string;
488
- /**
489
- * URL of the app icon.
490
- */
491
- icon_url?: string;
492
- /**
493
- * URL of the app documentation.
494
- */
495
- documentation_url?: string;
496
- /**
497
- * Markdown description of the app.
498
- */
499
- description: {
500
- /**
501
- * English translation
502
- */
503
- en?: string | null;
504
- /**
505
- * German translation
506
- */
507
- de: string;
508
- };
509
- /**
510
- * Configuration for developer notifications
511
- */
512
- notifications?: {
513
- /**
514
- * Email address to receive notifications
515
- * example:
516
- * developer@example.com
517
- */
518
- email?: string; // email
519
- /**
520
- * List of events to subscribe to
521
- */
522
- events?: NotificationEvent[];
523
- };
524
- /**
525
- * Organization ID of the app owner
526
- */
527
- owner_org_id: string;
528
- /**
529
- * Flag to indicate if the app is built by epilot.
530
- */
531
- internal?: boolean;
532
- /**
533
- * Pricing information for the app
534
- */
535
- pricing?: {
536
- pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
537
- billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
538
- };
539
- /**
540
- * Audit information for the app
541
- */
542
- configuration_audit?: {
543
- /**
544
- * Timestamp of the creation
545
- */
546
- created_at?: string;
547
- /**
548
- * User ID of the creator
549
- */
550
- created_by?: string;
551
- /**
552
- * Timestamp of the last update
553
- */
554
- updated_at?: string;
555
- /**
556
- * User ID of the last updater
557
- */
558
- updated_by?: string;
559
- };
560
- components: BaseComponent[];
561
- /**
562
- * Visibility of the app version
563
- */
564
- visibility?: "public" | "private";
565
- /**
566
- * Flag to indicate if the app is public.
567
- */
568
- public?: boolean;
569
- /**
570
- * Flag to indicate if the app is pending for verification
571
- */
572
- pending?: boolean;
573
- /**
574
- * Version of the app that is installed
575
- */
576
- version: string;
577
- /**
578
- * Flag to indicate if the app is in beta.
579
- */
580
- is_beta?: boolean;
581
- /**
582
- * Timestamp when the app version is deprecated
583
- */
584
- deprecated_at?: string;
585
- /**
586
- * Changelog for the app version
587
- */
588
- changelog?: string;
589
- /**
590
- * Status of the review process
591
- */
592
- review_status?: "approved" | "rejected" | "pending";
593
- role?: Role;
594
- blueprint_ref?: BlueprintRef;
595
- version_audit: {
596
- /**
597
- * Timestamp of the creation
598
- */
599
- created_at?: string;
600
- /**
601
- * User ID of the creator
602
- */
603
- created_by?: string;
604
- /**
605
- * Timestamp of the last update
606
- */
607
- updated_at?: string;
608
- /**
609
- * User ID of the last updater
610
- */
611
- updated_by?: string;
612
- /**
613
- * Timestamp of the last version update
614
- */
615
- versioned_at?: string;
616
- /**
617
- * User ID of the user who last updated the app
618
- */
619
- versioned_by?: string;
620
- };
621
- }
622
- /**
623
- * Basic metadata about your app configuration which does not get versioned
624
- */
625
- export interface ConfigurationMetadata {
626
- app_id: string;
627
- /**
628
- * Name of the app
629
- */
630
- name: string;
631
- author?: Author;
632
- /**
633
- * Flag to indicate if the app is in dev mode. If true, the app takes the override_url property of components into account.
634
- */
635
- dev_mode?: boolean;
636
- /**
637
- * List of available versions of the app
638
- */
639
- versions: string[];
640
- /**
641
- * List of available public versions of the app
642
- */
643
- public_versions?: string[];
644
- /**
645
- * Email address for support requests
646
- */
647
- support_email?: string;
648
- /**
649
- * Latest version of the app
650
- */
651
- latest_version: string;
652
- /**
653
- * Category of the app.
654
- */
655
- category?: string;
656
- /**
657
- * URL of the app icon.
658
- */
659
- icon_url?: string;
660
- /**
661
- * URL of the app documentation.
662
- */
663
- documentation_url?: string;
664
- /**
665
- * Markdown description of the app.
666
- */
667
- description: {
668
- /**
669
- * English translation
670
- */
671
- en?: string | null;
672
- /**
673
- * German translation
674
- */
675
- de: string;
676
- };
677
- /**
678
- * Configuration for developer notifications
679
- */
680
- notifications?: {
681
- /**
682
- * Email address to receive notifications
683
- * example:
684
- * developer@example.com
685
- */
686
- email?: string; // email
687
- /**
688
- * List of events to subscribe to
689
- */
690
- events?: NotificationEvent[];
691
- };
692
- /**
693
- * Organization ID of the app owner, required for private apps or sandbox accounts
694
- */
695
- owner_org_id: string;
696
- /**
697
- * Flag to indicate if the app is built by epilot.
698
- */
699
- internal?: boolean;
700
- /**
701
- * Pricing information for the app
702
- */
703
- pricing?: {
704
- pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
705
- billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
706
- };
707
- /**
708
- * Audit information for the app
709
- */
710
- configuration_audit?: {
711
- /**
712
- * Timestamp of the creation
713
- */
714
- created_at?: string;
715
- /**
716
- * User ID of the creator
717
- */
718
- created_by?: string;
719
- /**
720
- * Timestamp of the last update
721
- */
722
- updated_at?: string;
723
- /**
724
- * User ID of the last updater
725
- */
726
- updated_by?: string;
727
- };
728
- }
729
- /**
730
- * Configuration data about your app which is versionable
731
- */
732
- export interface ConfigurationVersion {
733
- app_id: string;
734
- /**
735
- * Organization ID of the app owner
736
- */
737
- owner_org_id: string;
738
- components: BaseComponent[];
739
- /**
740
- * Visibility of the app version
741
- */
742
- visibility?: "public" | "private";
743
- /**
744
- * Flag to indicate if the app is public.
745
- */
746
- public?: boolean;
747
- /**
748
- * Flag to indicate if the app is pending for verification
749
- */
750
- pending?: boolean;
751
- /**
752
- * Version of the app that is installed
753
- */
754
- version: string;
755
- /**
756
- * Flag to indicate if the app is in beta.
757
- */
758
- is_beta?: boolean;
759
- /**
760
- * Timestamp when the app version is deprecated
761
- */
762
- deprecated_at?: string;
763
- /**
764
- * Changelog for the app version
765
- */
766
- changelog?: string;
767
- /**
768
- * Status of the review process
769
- */
770
- review_status?: "approved" | "rejected" | "pending";
771
- role?: Role;
772
- blueprint_ref?: BlueprintRef;
773
- version_audit: {
774
- /**
775
- * Timestamp of the creation
776
- */
777
- created_at?: string;
778
- /**
779
- * User ID of the creator
780
- */
781
- created_by?: string;
782
- /**
783
- * Timestamp of the last update
784
- */
785
- updated_at?: string;
786
- /**
787
- * User ID of the last updater
788
- */
789
- updated_by?: string;
790
- /**
791
- * Timestamp of the last version update
792
- */
793
- versioned_at?: string;
794
- /**
795
- * User ID of the user who last updated the app
796
- */
797
- versioned_by?: string;
798
- };
799
- }
800
- export interface CustomCapabilityComponent {
801
- component_type: "CUSTOM_CAPABILITY";
802
- configuration: {
803
- /**
804
- * Define what type of capability this is
805
- */
806
- type?: "tab" | "group";
807
- /**
808
- * Which schemas are supported by the capability. If empty, all schemas are supported.
809
- */
810
- allowed_schemas?: string[];
811
- };
812
- surfaces?: {
813
- capability_config?: AppBridgeSurfaceConfig;
814
- };
815
- }
816
- export interface CustomFlowActionComponent {
817
- component_type: "CUSTOM_FLOW_ACTION";
818
- configuration: CustomFlowConfig;
819
- surfaces?: {
820
- flow_action_config?: AppBridgeSurfaceConfig;
821
- };
822
- }
823
- export type CustomFlowConfig = ExternalIntegrationCustomActionConfig | SandboxCustomActionConfig;
824
- export interface CustomPageComponent {
825
- component_type: "CUSTOM_PAGE";
826
- configuration: CustomPageConfig;
827
- surfaces?: {
828
- page?: AppBridgeSurfaceConfig;
829
- };
830
- }
831
- export interface CustomPageConfig {
832
- /**
833
- * URL slug for the page route. Must be unique per organization.
834
- * example:
835
- * zapier
836
- */
837
- slug: string; // ^[a-z0-9][a-z0-9-]*[a-z0-9]$
838
- /**
839
- * Display label in the navigation sidebar.
840
- * example:
841
- * Zapier
842
- */
843
- nav_label?: string;
844
- /**
845
- * Icon identifier for the navigation item.
846
- * example:
847
- * zap
848
- */
849
- nav_icon?: string;
850
- /**
851
- * Optional tooltip or description for the navigation item.
852
- */
853
- nav_description?: string;
854
- }
855
- export interface EnumArg {
856
- type?: "enum";
857
- /**
858
- * If true, allows selection of multiple values
859
- */
860
- isMulti?: boolean;
861
- /**
862
- * List of options for enum type
863
- */
864
- options: [
865
- {
866
- /**
867
- * Unique identifier for the option
868
- */
869
- id: string;
870
- /**
871
- * Display label for the option
872
- */
873
- label: {
874
- /**
875
- * English translation
876
- */
877
- en?: string | null;
878
- /**
879
- * German translation
880
- */
881
- de: string;
882
- };
883
- },
884
- ...{
885
- /**
886
- * Unique identifier for the option
887
- */
888
- id: string;
889
- /**
890
- * Display label for the option
891
- */
892
- label: {
893
- /**
894
- * English translation
895
- */
896
- en?: string | null;
897
- /**
898
- * German translation
899
- */
900
- de: string;
901
- };
902
- }[]
903
- ];
904
- }
905
- export interface ErpInformToolkitComponent {
906
- component_type: "ERP_INFORM_TOOLKIT";
907
- configuration: {
908
- type: "inbound" | "outbound";
909
- };
910
- }
911
- export interface EventsQuery {
912
- /**
913
- * Either use preset OR start+end
914
- */
915
- time_range?: {
916
- /**
917
- * Start time (ISO 8601)
918
- */
919
- start?: string; // date-time
920
- /**
921
- * End time (ISO 8601)
922
- */
923
- end?: string; // date-time
924
- /**
925
- * Predefined time range (alternative to start/end)
926
- */
927
- preset?: "1h" | "6h" | "24h" | "7d" | "30d";
928
- };
929
- filters?: {
930
- /**
931
- * Filter by component types
932
- */
933
- source?: /* Type of app component */ ComponentType[];
934
- /**
935
- * Filter by specific component IDs
936
- */
937
- component_id?: string[];
938
- /**
939
- * Filter by event types
940
- */
941
- event_type?: ("ERROR" | "WARNING" | "INFO")[];
942
- /**
943
- * Filter by correlation ID for tracing
944
- */
945
- correlation_id?: string;
946
- };
947
- aggregation?: {
948
- /**
949
- * Group results by specified fields
950
- */
951
- group_by?: ("source" | "component_id" | "event_type" | "hour" | "day")[];
952
- /**
953
- * Metrics to calculate
954
- */
955
- metrics?: ("count" | "error_rate" | "unique_users")[];
956
- };
957
- pagination?: {
958
- page?: number;
959
- page_size?: number;
960
- };
961
- sort?: {
962
- field?: "timestamp" | "event_type" | "component_id";
963
- order?: "asc" | "desc";
964
- };
965
- }
966
- export interface EventsQueryResponse {
967
- query?: EventsQuery;
968
- results?: RawEvents | AggregatedEvents;
969
- pagination?: {
970
- page?: number;
971
- page_size?: number;
972
- total_items?: number;
973
- has_next?: boolean;
974
- };
975
- }
976
- export interface ExternalIntegrationCustomActionConfig {
977
- /**
978
- * Name of the custom action
979
- */
980
- name?: string;
981
- /**
982
- * Description of the custom action
983
- */
984
- description?: string;
985
- /**
986
- * Wait for callback_url to be called before completing the action
987
- */
988
- wait_for_callback?: boolean;
989
- type: "external_integration";
990
- external_integration_settings?: {
991
- /**
992
- * URL to call
993
- */
994
- url?: string;
995
- headers?: {
996
- [name: string]: any;
997
- };
998
- };
999
- }
1000
- export interface ExternalProductCatalogAuthBlock {
1001
- /**
1002
- * HTTP method to use for authentication
1003
- */
1004
- method?: string;
1005
- /**
1006
- * URL to use for authentication. Supports variable interpolation.
1007
- */
1008
- url: string;
1009
- /**
1010
- * Parameters to append to the URL. Supports variable interpolation.
1011
- */
1012
- params?: {
1013
- [name: string]: string;
1014
- };
1015
- /**
1016
- * Headers to use for authentication. Supports variable interpolation.
1017
- */
1018
- headers?: {
1019
- [name: string]: string;
1020
- };
1021
- /**
1022
- * JSON body to use for authentication. Supports variable interpolation. Content format is determined by Content-Type header.
1023
- */
1024
- body?: {
1025
- [name: string]: any;
1026
- };
1027
- }
1028
- export interface ExternalProductCatalogComponent {
1029
- component_type: "EXTERNAL_PRODUCT_CATALOG";
1030
- configuration: ExternalProductCatalogConfig;
1031
- }
1032
- export interface ExternalProductCatalogConfig {
1033
- hooks?: (/**
1034
- * Hook for getting products from an external catalog. This hook makes a call to retrieve product data from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
1035
- *
1036
- */
1037
- ExternalProductCatalogHookProducts | /**
1038
- * Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
1039
- *
1040
- */
1041
- ExternalProductCatalogHookProductRecommendations)[];
1042
- }
1043
- /**
1044
- * Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
1045
- *
1046
- */
1047
- export interface ExternalProductCatalogHookProductRecommendations {
1048
- /**
1049
- * Identifier of the hook. Should not change between updates.
1050
- */
1051
- id: string; // ^[a-zA-Z0-9_-]+$
1052
- name?: TranslatedString;
1053
- type: "product-recommendations";
1054
- auth?: ExternalProductCatalogAuthBlock;
1055
- call: {
1056
- /**
1057
- * HTTP method to use for the call
1058
- */
1059
- method?: string;
1060
- /**
1061
- * URL to call. Supports variable interpolation.
1062
- */
1063
- url: string;
1064
- /**
1065
- * Parameters to append to the URL. Supports variable interpolation.
1066
- */
1067
- params?: {
1068
- [name: string]: string;
1069
- };
1070
- /**
1071
- * Headers to use. Supports variable interpolation.
1072
- */
1073
- headers?: {
1074
- [name: string]: string;
1075
- };
1076
- /**
1077
- * JSON body to use for the call. Supports variable interpolation. If empty / not provided, the default request context will be used based on the consumer (e.g. Journey).
1078
- */
1079
- body?: {
1080
- [name: string]: any;
1081
- };
1082
- };
1083
- }
1084
- /**
1085
- * Hook for getting products from an external catalog. This hook makes a call to retrieve product data from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
1086
- *
1087
- */
1088
- export interface ExternalProductCatalogHookProducts {
1089
- /**
1090
- * Identifier of the hook. Should not change between updates.
1091
- */
1092
- id: string; // ^[a-zA-Z0-9_-]+$
1093
- name?: TranslatedString;
1094
- type: "products";
1095
- auth?: ExternalProductCatalogAuthBlock;
1096
- call: {
1097
- /**
1098
- * HTTP method to use for the call
1099
- */
1100
- method?: string;
1101
- /**
1102
- * URL to call. Supports variable interpolation.
1103
- */
1104
- url: string;
1105
- /**
1106
- * Parameters to append to the URL. Supports variable interpolation.
1107
- */
1108
- params?: {
1109
- [name: string]: string;
1110
- };
1111
- /**
1112
- * Headers to use. Supports variable interpolation.
1113
- */
1114
- headers?: {
1115
- [name: string]: string;
1116
- };
1117
- /**
1118
- * JSON body to use for the call. Supports variable interpolation. If empty / not provided, the default request context will be used based on the consumer (e.g. Journey).
1119
- */
1120
- body?: {
1121
- [name: string]: any;
1122
- };
1123
- };
1124
- }
1125
- /**
1126
- * Required grants for the app in order to call APIs for the installing tenant
1127
- */
1128
- export type Grants = {
1129
- /**
1130
- * The action the app can perform
1131
- */
1132
- action: string;
1133
- /**
1134
- * The resource the app can access
1135
- */
1136
- resource?: string;
1137
- }[];
1138
- /**
1139
- * Information about the installed app. Has configuration data of the installed version
1140
- */
1141
- export interface Installation {
1142
- /**
1143
- * ID of the app configuration
1144
- */
1145
- app_id: string;
1146
- /**
1147
- * Unique identifier for the organization the app is installed in
1148
- */
1149
- installer_org_id: string;
1150
- /**
1151
- * Organization ID of the app creator
1152
- */
1153
- owner_org_id?: string;
1154
- /**
1155
- * Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.
1156
- */
1157
- enabled: boolean;
1158
- /**
1159
- * Name of the app
1160
- */
1161
- name: string;
1162
- /**
1163
- * Configuration values for the app components
1164
- */
1165
- option_values?: OptionsRef[];
1166
- /**
1167
- * List of component configurations for the installed version
1168
- */
1169
- components: BaseComponent[];
1170
- /**
1171
- * Version of the app that is installed
1172
- */
1173
- installed_version: string;
1174
- /**
1175
- * The name of the role the app can use to access APIs
1176
- */
1177
- role?: string;
1178
- blueprint_ref?: BlueprintRef;
1179
- /**
1180
- * Audit information for the app
1181
- */
1182
- installation_audit?: {
1183
- /**
1184
- * Timestamp of the creation
1185
- */
1186
- created_at?: string;
1187
- /**
1188
- * User ID of the creator
1189
- */
1190
- created_by?: string;
1191
- /**
1192
- * Timestamp of the last update
1193
- */
1194
- updated_at?: string;
1195
- /**
1196
- * User ID of the last updater
1197
- */
1198
- updated_by?: string;
1199
- };
1200
- /**
1201
- * Manifest ID used to create/update the entity
1202
- */
1203
- _manifest?: string /* uuid */[];
1204
- }
1205
- export interface JourneyBlockComponent {
1206
- component_type: "CUSTOM_JOURNEY_BLOCK";
1207
- configuration: JourneyBlockConfig;
1208
- }
1209
- export type JourneyBlockComponentArgs = {
1210
- /**
1211
- * Unique identifier for this component arg
1212
- */
1213
- key: string;
1214
- type: "text" | "boolean" | "enum";
1215
- /**
1216
- * Flag to indicate if this option is required
1217
- */
1218
- required?: boolean;
1219
- /**
1220
- * Description of what this component arg does
1221
- */
1222
- description?: {
1223
- /**
1224
- * English translation
1225
- */
1226
- en?: string | null;
1227
- /**
1228
- * German translation
1229
- */
1230
- de: string;
1231
- };
1232
- /**
1233
- * Human-readable label for the component arg
1234
- */
1235
- label: {
1236
- /**
1237
- * English translation
1238
- */
1239
- en?: string | null;
1240
- /**
1241
- * German translation
1242
- */
1243
- de: string;
1244
- };
1245
- } & (TextArg | BooleanArg | EnumArg);
1246
- export interface JourneyBlockConfig {
1247
- override_dev_mode?: /* Override URL when app is in dev mode */ OverrideDevMode;
1248
- /**
1249
- * URL of the web component object
1250
- * example:
1251
- * https://cdn.apps.com/123/v1.0.0/bundle.js
1252
- */
1253
- component_url: string;
1254
- /**
1255
- * Custom element tag for the component
1256
- */
1257
- component_tag: string;
1258
- /**
1259
- * Arguments to pass to the component
1260
- */
1261
- component_args?: JourneyBlockComponentArgs[];
1262
- /**
1263
- * Size of the bundle in bytes
1264
- */
1265
- component_size?: number;
1266
- /**
1267
- * Define data which is mapped to entity mapping ui blocks
1268
- */
1269
- component_mapping?: {
1270
- [name: string]: "string" | "boolean" | "date" | "datetime" | "link" | "number";
1271
- };
1272
- }
1273
- export interface NotificationConfig {
1274
- /**
1275
- * Email address to receive notifications
1276
- * example:
1277
- * developer@example.com
1278
- */
1279
- email?: string; // email
1280
- /**
1281
- * List of events to subscribe to
1282
- */
1283
- events?: NotificationEvent[];
1284
- }
1285
- export type NotificationEvent = "app.installed" | "app.uninstalled";
1286
- export interface Option {
1287
- /**
1288
- * Key matching a config_option from the component
1289
- */
1290
- key: string;
1291
- /**
1292
- * The configured value for this option
1293
- */
1294
- value: string | boolean | number;
1295
- }
1296
- /**
1297
- * Options for the component configuration
1298
- */
1299
- export interface Options {
1300
- /**
1301
- * Unique identifier for this configuration option
1302
- */
1303
- key: string;
1304
- /**
1305
- * Human-readable label for the configuration option
1306
- */
1307
- label?: string;
1308
- /**
1309
- * Flag to indicate if this option is required
1310
- */
1311
- required?: boolean;
1312
- /**
1313
- * Detailed description of what this configuration option does
1314
- */
1315
- description?: string;
1316
- /**
1317
- * The configured value for this option. Is only present when the component is installed.
1318
- */
1319
- value?: string | boolean | number;
1320
- type: "text" | "number" | "boolean" | "secret";
1321
- }
1322
- export interface OptionsRef {
1323
- /**
1324
- * ID of the component these values are for
1325
- */
1326
- component_id: string;
1327
- options: Option[];
1328
- }
1329
- /**
1330
- * Override URL when app is in dev mode
1331
- */
1332
- export interface OverrideDevMode {
1333
- /**
1334
- * URL of the web component object in dev mode
1335
- * example:
1336
- * http://localhost:3000
1337
- */
1338
- override_url?: string;
1339
- }
1340
- export interface PortalBlockComponent {
1341
- component_type: "CUSTOM_PORTAL_BLOCK";
1342
- configuration: PortalBlockConfig;
1343
- surfaces?: {
1344
- portal_block?: PortalBlockSurfaceConfig;
1345
- };
1346
- }
1347
- export interface PortalBlockConfig {
1348
- }
1349
- export interface PortalBlockSurfaceConfig {
1350
- /**
1351
- * URL of the uploaded App Bridge App. This is the entrypoint for the app
1352
- */
1353
- app_url?: string;
1354
- /**
1355
- * URL of the uploaded zip file containing the app
1356
- */
1357
- zip_url?: string;
1358
- /**
1359
- * URL of the app in dev mode
1360
- */
1361
- override_url?: string;
1362
- /**
1363
- * Define which surfaces of the portal this block can be placed in
1364
- */
1365
- supported_surfaces?: ("main" | "footer_inline" | "footer_left_absolute" | "footer_right_absolute")[];
1366
- }
1367
- export interface PortalExtensionAuthBlock {
1368
- /**
1369
- * HTTP method to use for authentication
1370
- */
1371
- method?: string;
1372
- /**
1373
- * URL to use for authentication. Supports variable interpolation.
1374
- */
1375
- url: string;
1376
- /**
1377
- * Parameters to append to the URL. Supports variable interpolation.
1378
- */
1379
- params?: {
1380
- [name: string]: string;
1381
- };
1382
- /**
1383
- * Headers to use for authentication. Supports variable interpolation.
1384
- */
1385
- headers?: {
1386
- [name: string]: string;
1387
- };
1388
- /**
1389
- * JSON body to use for authentication. Supports variable interpolation. Content format is determined by Content-Type header.
1390
- */
1391
- body?: {
1392
- [name: string]: any;
1393
- };
1394
- cache?: {
1395
- /**
1396
- * Key to use to identify the auth response. Supports interpolation.
1397
- * example:
1398
- * {{Options.api_key}}
1399
- */
1400
- key: string;
1401
- /**
1402
- * Time to live in seconds for the cache. Supports interpolation.
1403
- * example:
1404
- * {{AuthResponse.data.expires_in}}
1405
- */
1406
- ttl: string;
1407
- };
1408
- }
1409
- export interface PortalExtensionComponent {
1410
- component_type: "PORTAL_EXTENSION";
1411
- configuration: PortalExtensionConfig;
1412
- }
1413
- export interface PortalExtensionConfig {
1414
- hooks?: (/**
1415
- * Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
1416
- * - 200 with contact id if exactly one contact is found
1417
- * - 404 if no contact is found or more than contact is found
1418
- *
1419
- */
1420
- PortalExtensionHookRegistrationIdentifiersCheck | /**
1421
- * Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
1422
- * The expected response http status code to the call is:
1423
- * - 200 if found
1424
- * - 404 if not found
1425
- *
1426
- * The following assignment modes are supported:
1427
- * - `contracts`: We expect the response to contain Contract ids (customizable using `result` property).
1428
- * - `contact_to_contracts`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact as a Customer to the Contracts and (optionally) update the Contact attribute specified by `contact_relation_attribute` to add the matched Contact.
1429
- * - `contact_to_portal_user`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact to the Portal User. Portal User will be able to see all data including Contracts transitively.
1430
- *
1431
- * Defaults to `contact_to_contracts` for backwards compatibility. We recommend using `contact_to_portal_user` as it does not influence the data model of business entities.
1432
- *
1433
- */
1434
- PortalExtensionHookContractIdentification | /**
1435
- * Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
1436
- * - 200 with the time series data
1437
- *
1438
- */
1439
- PortalExtensionHookPriceDataRetrieval | /**
1440
- * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
1441
- * - 200 with the time series data
1442
- *
1443
- */
1444
- PortalExtensionHookConsumptionDataRetrieval | /**
1445
- * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
1446
- * - 200 with the time series data
1447
- *
1448
- */
1449
- PortalExtensionHookCostDataRetrieval | /**
1450
- * Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
1451
- * - 200:
1452
- * If meter reading is plausible, the response should contain:
1453
- * - valid: true
1454
- * If meter reading is not plausible, the response should contain:
1455
- * - valid: false
1456
- *
1457
- */
1458
- PortalExtensionHookMeterReadingPlausibilityCheck)[];
1459
- links?: {
1460
- /**
1461
- * Identifier of the link. Should not change between updates.
1462
- */
1463
- id: string; // ^[a-zA-Z0-9_-]+$
1464
- name: TranslatedString;
1465
- description?: TranslatedString;
1466
- type: "seamless";
1467
- /**
1468
- * Controls whether the link should be shown. Supports variable interpolation.
1469
- * example:
1470
- * {{Contact.customer_number | is_not_empty}}
1471
- */
1472
- condition?: string;
1473
- auth?: PortalExtensionAuthBlock;
1474
- redirect: {
1475
- /**
1476
- * URL to redirect to. Supports variable interpolation.
1477
- */
1478
- url?: string;
1479
- /**
1480
- * Parameters to append to the URL. Supports variable interpolation.
1481
- */
1482
- params?: {
1483
- [name: string]: string;
1484
- };
1485
- };
1486
- }[];
1487
- }
1488
- /**
1489
- * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
1490
- * - 200 with the time series data
1491
- *
1492
- */
1493
- export interface PortalExtensionHookConsumptionDataRetrieval {
1494
- /**
1495
- * Identifier of the hook. Should not change between updates.
1496
- */
1497
- id: string; // ^[a-zA-Z0-9_-]+$
1498
- name?: TranslatedString;
1499
- type: "consumptionDataRetrieval";
1500
- /**
1501
- * Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
1502
- */
1503
- intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
1504
- auth?: PortalExtensionAuthBlock;
1505
- call: {
1506
- /**
1507
- * HTTP method to use for the call
1508
- */
1509
- method?: string;
1510
- /**
1511
- * URL to call. Supports variable interpolation.
1512
- */
1513
- url: string;
1514
- /**
1515
- * Parameters to append to the URL. Supports variable interpolation.
1516
- */
1517
- params?: {
1518
- [name: string]: string;
1519
- };
1520
- /**
1521
- * Headers to use. Supports variable interpolation.
1522
- */
1523
- headers?: {
1524
- [name: string]: string;
1525
- };
1526
- /**
1527
- * Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
1528
- */
1529
- body?: {
1530
- [name: string]: any;
1531
- };
1532
- };
1533
- resolved?: {
1534
- /**
1535
- * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
1536
- */
1537
- dataPath?: string;
1538
- };
1539
- /**
1540
- * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1541
- */
1542
- use_static_ips?: boolean;
1543
- secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
1544
- }
1545
- /**
1546
- * Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
1547
- * The expected response http status code to the call is:
1548
- * - 200 if found
1549
- * - 404 if not found
1550
- *
1551
- * The following assignment modes are supported:
1552
- * - `contracts`: We expect the response to contain Contract ids (customizable using `result` property).
1553
- * - `contact_to_contracts`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact as a Customer to the Contracts and (optionally) update the Contact attribute specified by `contact_relation_attribute` to add the matched Contact.
1554
- * - `contact_to_portal_user`: We expect the response to contain a Contact id (customizable using `result` property) and we will assign the Contact to the Portal User. Portal User will be able to see all data including Contracts transitively.
1555
- *
1556
- * Defaults to `contact_to_contracts` for backwards compatibility. We recommend using `contact_to_portal_user` as it does not influence the data model of business entities.
1557
- *
1558
- */
1559
- export interface PortalExtensionHookContractIdentification {
1560
- /**
1561
- * Identifier of the hook. Should not change between updates.
1562
- */
1563
- id: string; // ^[a-zA-Z0-9_-]+$
1564
- name?: TranslatedString;
1565
- type: "contractIdentification";
1566
- auth?: PortalExtensionAuthBlock;
1567
- call: {
1568
- /**
1569
- * HTTP method to use for the call
1570
- */
1571
- method?: string;
1572
- /**
1573
- * URL to call. Supports variable interpolation.
1574
- */
1575
- url: string;
1576
- /**
1577
- * Parameters to append to the URL. Supports variable interpolation.
1578
- */
1579
- params?: {
1580
- [name: string]: string;
1581
- };
1582
- /**
1583
- * Headers to use. Supports variable interpolation.
1584
- */
1585
- headers: {
1586
- [name: string]: string;
1587
- };
1588
- /**
1589
- * Optional JSON body to use for the call. Defaults to object with all configured identifiers grouped by entity, e.g. `{"contract": {"contract_name": "Name"}}`. Supports variable interpolation.
1590
- */
1591
- body?: {
1592
- [key: string]: any;
1593
- };
1594
- /**
1595
- * Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
1596
- */
1597
- result?: string;
1598
- };
1599
- /**
1600
- * Mode of contract assignment. See hook description for mode details.
1601
- */
1602
- assignment_mode?: "contracts" | "contact_to_contracts" | "contact_to_portal_user";
1603
- /**
1604
- * Name of the Contact attribute to update with the matched Contact ID when using `contact_to_contracts` mode. Must be a Contact relation attribute supporting multiple entities.
1605
- * example:
1606
- * represents_contact
1607
- */
1608
- contact_relation_attribute?: string;
1609
- /**
1610
- * Explanation of the hook.
1611
- */
1612
- explanation?: {
1613
- [name: string]: string;
1614
- /**
1615
- * Explanation of the functionality shown to the end user.
1616
- * example:
1617
- * This process will give you access to the matching Contracts.
1618
- */
1619
- en: string;
1620
- };
1621
- /**
1622
- * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1623
- */
1624
- use_static_ips?: boolean;
1625
- secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
1626
- }
1627
- /**
1628
- * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
1629
- * - 200 with the time series data
1630
- *
1631
- */
1632
- export interface PortalExtensionHookCostDataRetrieval {
1633
- /**
1634
- * Identifier of the hook. Should not change between updates.
1635
- */
1636
- id: string; // ^[a-zA-Z0-9_-]+$
1637
- name?: TranslatedString;
1638
- type: "costDataRetrieval";
1639
- /**
1640
- * Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
1641
- */
1642
- intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
1643
- auth?: PortalExtensionAuthBlock;
1644
- call: {
1645
- /**
1646
- * HTTP method to use for the call
1647
- */
1648
- method?: string;
1649
- /**
1650
- * URL to call. Supports variable interpolation.
1651
- */
1652
- url: string;
1653
- /**
1654
- * Parameters to append to the URL. Supports variable interpolation.
1655
- */
1656
- params?: {
1657
- [name: string]: string;
1658
- };
1659
- /**
1660
- * Headers to use. Supports variable interpolation.
1661
- */
1662
- headers?: {
1663
- [name: string]: string;
1664
- };
1665
- /**
1666
- * Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
1667
- */
1668
- body?: {
1669
- [name: string]: any;
1670
- };
1671
- };
1672
- resolved?: {
1673
- /**
1674
- * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
1675
- */
1676
- dataPath?: string;
1677
- };
1678
- /**
1679
- * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1680
- */
1681
- use_static_ips?: boolean;
1682
- secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
1683
- }
1684
- /**
1685
- * Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
1686
- * - 200:
1687
- * If meter reading is plausible, the response should contain:
1688
- * - valid: true
1689
- * If meter reading is not plausible, the response should contain:
1690
- * - valid: false
1691
- *
1692
- */
1693
- export interface PortalExtensionHookMeterReadingPlausibilityCheck {
1694
- /**
1695
- * Identifier of the hook. Should not change between updates.
1696
- */
1697
- id: string; // ^[a-zA-Z0-9_-]+$
1698
- name?: TranslatedString;
1699
- type: "meterReadingPlausibilityCheck";
1700
- /**
1701
- * Mode for plausibility check:
1702
- * - "check": Validates meter reading and returns valid: boolean (used during submission)
1703
- * - "range": Returns min/max allowed values for each counter for validation before submission
1704
- *
1705
- */
1706
- plausibility_mode?: "check" | "range";
1707
- auth?: PortalExtensionAuthBlock;
1708
- call: {
1709
- /**
1710
- * URL to call. Supports variable interpolation.
1711
- */
1712
- url: string;
1713
- /**
1714
- * JSON body to use for the call. Supports variable interpolation.
1715
- */
1716
- body: {
1717
- [name: string]: any;
1718
- };
1719
- /**
1720
- * Headers to use. Supports variable interpolation.
1721
- */
1722
- headers: {
1723
- [name: string]: string;
1724
- };
1725
- };
1726
- /**
1727
- * Response to the call
1728
- */
1729
- resolved: {
1730
- /**
1731
- * Optional path to an array in the response. If specified and the path points to an array,
1732
- * the hook will map over each item using 'Item' variable for interpolation.
1733
- * Relevant only if plausibility_mode is "range".
1734
- *
1735
- * example:
1736
- * data.results
1737
- */
1738
- dataPath?: string;
1739
- /**
1740
- * Counter identifier(s) used to match against the meter's counters.
1741
- * Can be a string (counter ID) or an object with counter properties.
1742
- * The backend resolves this to meter_counter_id in the final response.
1743
- * Relevant only if plausibility_mode is "range".
1744
- *
1745
- * example:
1746
- * {
1747
- * "obis_code": "{{Item.obis}}"
1748
- * }
1749
- */
1750
- counter_identifiers?: {
1751
- [name: string]: string;
1752
- };
1753
- /**
1754
- * Indicate whether the meter reading is plausible. Relevant only if plausibility_mode is "check".
1755
- * example:
1756
- * {{CallResponse.data.valid}}
1757
- */
1758
- valid?: string;
1759
- /**
1760
- * Upper allowed limit of the meter reading
1761
- * example:
1762
- * {{CallResponse.data.upper_limit}}
1763
- */
1764
- upper_limit?: string;
1765
- /**
1766
- * Lower allowed limit of the meter reading
1767
- * example:
1768
- * {{CallResponse.data.lower_limit}}
1769
- */
1770
- lower_limit?: string;
1771
- };
1772
- /**
1773
- * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1774
- */
1775
- use_static_ips?: boolean;
1776
- secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
1777
- }
1778
- /**
1779
- * Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
1780
- * - 200 with the time series data
1781
- *
1782
- */
1783
- export interface PortalExtensionHookPriceDataRetrieval {
1784
- /**
1785
- * Identifier of the hook. Should not change between updates.
1786
- */
1787
- id: string; // ^[a-zA-Z0-9_-]+$
1788
- name?: TranslatedString;
1789
- type: "priceDataRetrieval";
1790
- /**
1791
- * Intervals supported by the API. If omitted, it is assumed that all intervals are supported.
1792
- */
1793
- intervals?: ("PT15M" | "PT1H" | "P1D" | "P1M")[];
1794
- auth?: PortalExtensionAuthBlock;
1795
- call: {
1796
- /**
1797
- * HTTP method to use for the call
1798
- */
1799
- method?: string;
1800
- /**
1801
- * URL to call. Supports variable interpolation.
1802
- */
1803
- url: string;
1804
- /**
1805
- * Parameters to append to the URL. Supports variable interpolation.
1806
- */
1807
- params?: {
1808
- [name: string]: string;
1809
- };
1810
- /**
1811
- * Headers to use. Supports variable interpolation.
1812
- */
1813
- headers?: {
1814
- [name: string]: string;
1815
- };
1816
- /**
1817
- * Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
1818
- */
1819
- body?: {
1820
- [name: string]: any;
1821
- };
1822
- };
1823
- resolved?: {
1824
- /**
1825
- * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
1826
- */
1827
- dataPath?: string;
1828
- };
1829
- /**
1830
- * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1831
- */
1832
- use_static_ips?: boolean;
1833
- secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
1834
- }
1835
- /**
1836
- * Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
1837
- * - 200 with contact id if exactly one contact is found
1838
- * - 404 if no contact is found or more than contact is found
1839
- *
1840
- */
1841
- export interface PortalExtensionHookRegistrationIdentifiersCheck {
1842
- /**
1843
- * Identifier of the hook. Should not change between updates.
1844
- */
1845
- id: string; // ^[a-zA-Z0-9_-]+$
1846
- name?: TranslatedString;
1847
- type: "registrationIdentifiersCheck";
1848
- auth?: PortalExtensionAuthBlock;
1849
- call: {
1850
- /**
1851
- * HTTP method to use for the call
1852
- */
1853
- method?: string;
1854
- /**
1855
- * URL to call. Supports variable interpolation.
1856
- */
1857
- url: string;
1858
- /**
1859
- * Parameters to append to the URL. Supports variable interpolation.
1860
- */
1861
- params?: {
1862
- [name: string]: string;
1863
- };
1864
- /**
1865
- * Headers to use. Supports variable interpolation.
1866
- */
1867
- headers: {
1868
- [name: string]: string;
1869
- };
1870
- /**
1871
- * Optional JSON body to use for the call. Defaults to object with all configured identifiers grouped by entity, e.g. `{"contract": {"contract_name": "Name"}}`. Supports variable interpolation.
1872
- */
1873
- body?: {
1874
- [key: string]: any;
1875
- };
1876
- /**
1877
- * Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation.
1878
- */
1879
- result: string;
1880
- };
1881
- /**
1882
- * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
1883
- */
1884
- use_static_ips?: boolean;
1885
- secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
1886
- }
1887
- export interface PortalExtensionSeamlessLink {
1888
- /**
1889
- * Identifier of the link. Should not change between updates.
1890
- */
1891
- id: string; // ^[a-zA-Z0-9_-]+$
1892
- name: TranslatedString;
1893
- description?: TranslatedString;
1894
- type: "seamless";
1895
- /**
1896
- * Controls whether the link should be shown. Supports variable interpolation.
1897
- * example:
1898
- * {{Contact.customer_number | is_not_empty}}
1899
- */
1900
- condition?: string;
1901
- auth?: PortalExtensionAuthBlock;
1902
- redirect: {
1903
- /**
1904
- * URL to redirect to. Supports variable interpolation.
1905
- */
1906
- url?: string;
1907
- /**
1908
- * Parameters to append to the URL. Supports variable interpolation.
1909
- */
1910
- params?: {
1911
- [name: string]: string;
1912
- };
1913
- };
1914
- }
1915
- /**
1916
- * If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.
1917
- */
1918
- export interface PortalExtensionSecureProxy {
1919
- /**
1920
- * Integration ID that owns the secure_proxy use case.
1921
- */
1922
- integration_id: string; // uuid
1923
- /**
1924
- * Use case slug for the secure proxy use case.
1925
- */
1926
- use_case_slug: string;
1927
- }
1928
- export interface Pricing {
1929
- pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
1930
- billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
1931
- }
1932
- /**
1933
- * Public configuration of the published app
1934
- */
1935
- export interface PublicConfiguration {
1936
- /**
1937
- * ID of the app configuration
1938
- */
1939
- app_id: string;
1940
- /**
1941
- * Email address for support requests
1942
- */
1943
- support_email?: string;
1944
- /**
1945
- * Organization ID of the app owner
1946
- */
1947
- owner_org_id: string;
1948
- /**
1949
- * Name of the app
1950
- */
1951
- name: string;
1952
- author?: Author;
1953
- /**
1954
- * Flag to indicate if the app is in dev mode.
1955
- */
1956
- dev_mode?: boolean;
1957
- /**
1958
- * Category of the app.
1959
- */
1960
- category?: string;
1961
- /**
1962
- * URL of the app icon.
1963
- */
1964
- icon_url?: string;
1965
- /**
1966
- * URL of the app documentation.
1967
- */
1968
- documentation_url?: string;
1969
- /**
1970
- * Markdown description of the app.
1971
- */
1972
- description?: {
1973
- /**
1974
- * English translation
1975
- */
1976
- en?: string | null;
1977
- /**
1978
- * German translation
1979
- */
1980
- de: string;
1981
- };
1982
- /**
1983
- * Pricing information for the app
1984
- */
1985
- pricing?: {
1986
- pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
1987
- billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
1988
- };
1989
- components: BaseComponent[];
1990
- /**
1991
- * Flag to indicate if the app is in beta.
1992
- */
1993
- is_beta?: boolean;
1994
- /**
1995
- * Timestamp when the app version is deprecated
1996
- */
1997
- deprecated_at?: string;
1998
- /**
1999
- * Version of the app that is installed
2000
- */
2001
- version: string;
2002
- role?: Role;
2003
- blueprint_ref?: BlueprintRef;
2004
- /**
2005
- * Latest version of the app
2006
- */
2007
- latest_version?: string;
2008
- /**
2009
- * Flag to indicate if the app is public.
2010
- */
2011
- public?: boolean;
2012
- /**
2013
- * List of available versions of the app
2014
- */
2015
- versions?: /* Configuration data about your app which is versionable */ ConfigurationVersion[];
2016
- }
2017
- export interface RawEvents {
2018
- type?: "raw";
2019
- events?: AppEventData[];
2020
- }
2021
- export interface Review {
2022
- /**
2023
- * Version of the app that is under review
2024
- */
2025
- version?: string;
2026
- /**
2027
- * Status of the review
2028
- */
2029
- review_status?: "approved" | "rejected" | "pending";
2030
- /**
2031
- * Timestamp of the review
2032
- */
2033
- requested_at?: string;
2034
- /**
2035
- * User ID of the reviewer
2036
- */
2037
- requested_by?: string;
2038
- /**
2039
- * Email of the technical contact
2040
- */
2041
- technical_contact?: string;
2042
- /**
2043
- * Email of the marketing contact
2044
- */
2045
- marketing_contact?: string;
2046
- /**
2047
- * URL of the demo
2048
- */
2049
- demo_url?: string;
2050
- }
2051
- export interface Role {
2052
- /**
2053
- * Name of the role
2054
- */
2055
- id?: string;
2056
- grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Grants;
2057
- }
2058
- export interface S3Reference {
2059
- /**
2060
- * The name of the S3 bucket where the JSON file for import is stored.
2061
- * example:
2062
- * my-bucket
2063
- */
2064
- bucket: string;
2065
- /**
2066
- * The key or path to the JSON file within the S3 bucket.
2067
- * example:
2068
- * manifest.json
2069
- */
2070
- key: string;
2071
- }
2072
- export interface SandboxCustomActionConfig {
2073
- /**
2074
- * Name of the custom action
2075
- */
2076
- name?: string;
2077
- /**
2078
- * Description of the custom action
2079
- */
2080
- description?: string;
2081
- /**
2082
- * Wait for callback_url to be called before completing the action
2083
- */
2084
- wait_for_callback?: boolean;
2085
- type: "sandbox";
2086
- sandbox_settings?: {
2087
- /**
2088
- * JavaScript code to execute for the sandbox action. Maximum size: 300KB (hard limit). Code is stored as raw JavaScript and will be syntax-validated on save. Security restrictions: eval() and Function() constructor are not allowed.
2089
- *
2090
- */
2091
- code?: string;
2092
- };
2093
- }
2094
- export interface TextArg {
2095
- type?: "text";
2096
- }
2097
- export interface TranslatedString {
2098
- /**
2099
- * English translation
2100
- */
2101
- en?: string | null;
2102
- /**
2103
- * German translation
2104
- */
2105
- de: string;
2106
- }
2107
- }
2108
- }
2109
- declare namespace Paths {
2110
- namespace CloneVersion {
2111
- namespace Parameters {
2112
- export type AppId = string;
2113
- export type SourceVersion = string;
2114
- export type TargetVersion = string;
2115
- }
2116
- export interface PathParameters {
2117
- appId: Parameters.AppId;
2118
- sourceVersion: Parameters.SourceVersion;
2119
- targetVersion: Parameters.TargetVersion;
2120
- }
2121
- namespace Responses {
2122
- export interface $201 {
2123
- app_id?: string;
2124
- version?: string;
2125
- status?: "pending" | "published";
2126
- }
2127
- export interface $400 {
2128
- }
2129
- export interface $404 {
2130
- }
2131
- }
2132
- }
2133
- namespace CreateBundleUploadUrl {
2134
- namespace Parameters {
2135
- export type AppId = string;
2136
- }
2137
- export interface PathParameters {
2138
- appId: Parameters.AppId;
2139
- }
2140
- export type RequestBody = Components.RequestBodies.CreateBundlePresignedRequest;
2141
- namespace Responses {
2142
- export interface $200 {
2143
- /**
2144
- * ID of the journye block component
2145
- */
2146
- component_id?: string;
2147
- /**
2148
- * URL of the web component object
2149
- */
2150
- component_url?: string;
2151
- /**
2152
- * Presigned S3 URL for uploading the bundle
2153
- */
2154
- upload_url: string;
2155
- s3ref?: Components.Schemas.S3Reference;
2156
- /**
2157
- * Timestamp when the upload URL expires
2158
- */
2159
- expires_at?: string; // date-time
2160
- }
2161
- export interface $404 {
2162
- }
2163
- }
2164
- }
2165
- namespace CreateComponent {
2166
- namespace Parameters {
2167
- export type AppId = string;
2168
- export type Version = string;
2169
- }
2170
- export interface PathParameters {
2171
- appId: Parameters.AppId;
2172
- version: Parameters.Version;
2173
- }
2174
- export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
2175
- namespace Responses {
2176
- export interface $200 {
2177
- component?: Components.Schemas.BaseComponent;
2178
- }
2179
- export interface $400 {
2180
- }
2181
- export interface $404 {
2182
- }
2183
- }
2184
- }
2185
- namespace CreateConfiguration {
2186
- export type RequestBody = Components.RequestBodies.CreateConfigRequest;
2187
- namespace Responses {
2188
- export interface $201 {
2189
- app_id: string;
2190
- }
2191
- }
2192
- }
2193
- namespace CreateLogoUploadUrl {
2194
- export type RequestBody = Components.RequestBodies.CreateLogoPresignedRequest;
2195
- namespace Responses {
2196
- export interface $200 {
2197
- /**
2198
- * Presigned S3 URL for uploading the logo
2199
- */
2200
- upload_url: string;
2201
- s3ref?: Components.Schemas.S3Reference;
2202
- /**
2203
- * Timestamp when the upload URL expires
2204
- */
2205
- expires_at?: string; // date-time
2206
- }
2207
- export interface $404 {
2208
- }
2209
- }
2210
- }
2211
- namespace CreateReview {
2212
- namespace Parameters {
2213
- export type AppId = string;
2214
- export type Version = string;
2215
- }
2216
- export interface PathParameters {
2217
- appId: Parameters.AppId;
2218
- version: Parameters.Version;
2219
- }
2220
- export type RequestBody = Components.RequestBodies.CreateReviewRequest;
2221
- namespace Responses {
2222
- export interface $200 {
2223
- review?: Components.Schemas.Review;
2224
- }
2225
- export interface $400 {
2226
- }
2227
- export interface $404 {
2228
- }
2229
- }
2230
- }
2231
- namespace CreateZipUploadUrl {
2232
- namespace Parameters {
2233
- export type AppId = string;
2234
- }
2235
- export interface PathParameters {
2236
- appId: Parameters.AppId;
2237
- }
2238
- export interface RequestBody {
2239
- /**
2240
- * Version of the app configuration
2241
- * example:
2242
- * 1.0.0
2243
- */
2244
- version?: string;
2245
- /**
2246
- * ID of the journey block component
2247
- */
2248
- component_id?: string;
2249
- /**
2250
- * example:
2251
- * dist.zip
2252
- */
2253
- filename?: string;
2254
- }
2255
- namespace Responses {
2256
- export interface $200 {
2257
- /**
2258
- * ID of the journye block component
2259
- */
2260
- component_id?: string;
2261
- /**
2262
- * Presigned S3 URL for uploading the bundle
2263
- */
2264
- upload_url: string;
2265
- /**
2266
- * Public CDN URL for the unpacked artifacts
2267
- */
2268
- artifact_url: string;
2269
- s3ref?: Components.Schemas.S3Reference;
2270
- /**
2271
- * Timestamp when the upload URL expires
2272
- */
2273
- expires_at?: string; // date-time
2274
- }
2275
- export interface $404 {
2276
- }
2277
- }
2278
- }
2279
- namespace DeleteComponent {
2280
- namespace Parameters {
2281
- export type AppId = string;
2282
- export type ComponentId = string;
2283
- export type Version = string;
2284
- }
2285
- export interface PathParameters {
2286
- appId: Parameters.AppId;
2287
- version: Parameters.Version;
2288
- componentId: Parameters.ComponentId;
2289
- }
2290
- namespace Responses {
2291
- export interface $204 {
2292
- }
2293
- export interface $404 {
2294
- }
2295
- }
2296
- }
2297
- namespace DeleteConfiguration {
2298
- namespace Responses {
2299
- export interface $204 {
2300
- }
2301
- export interface $404 {
2302
- }
2303
- }
2304
- }
2305
- namespace DeleteLogo {
2306
- namespace Responses {
2307
- export interface $204 {
2308
- }
2309
- export interface $404 {
2310
- }
2311
- }
2312
- }
2313
- namespace DeleteVersion {
2314
- namespace Parameters {
2315
- export type AppId = string;
2316
- export type Version = string;
2317
- }
2318
- export interface PathParameters {
2319
- appId: Parameters.AppId;
2320
- version: Parameters.Version;
2321
- }
2322
- namespace Responses {
2323
- export interface $204 {
2324
- }
2325
- export interface $400 {
2326
- }
2327
- export interface $404 {
2328
- }
2329
- export interface $409 {
2330
- }
2331
- }
2332
- }
2333
- namespace GetConfiguration {
2334
- namespace Parameters {
2335
- export type Version = string;
2336
- }
2337
- export interface QueryParameters {
2338
- version?: Parameters.Version;
2339
- }
2340
- namespace Responses {
2341
- export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
2342
- export interface $404 {
2343
- }
2344
- }
2345
- }
2346
- namespace GetInstallation {
2347
- namespace Parameters {
2348
- export type AppId = string;
2349
- }
2350
- export interface PathParameters {
2351
- appId: Parameters.AppId;
2352
- }
2353
- namespace Responses {
2354
- export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
2355
- export interface $404 {
2356
- }
2357
- }
2358
- }
2359
- namespace GetPublicConfiguration {
2360
- namespace Parameters {
2361
- export type Version = string;
2362
- }
2363
- export interface QueryParameters {
2364
- version?: Parameters.Version;
2365
- }
2366
- namespace Responses {
2367
- export type $200 = /* Public configuration of the published app */ Components.Schemas.PublicConfiguration;
2368
- export interface $404 {
2369
- }
2370
- }
2371
- }
2372
- namespace GetPublicFacingComponent {
2373
- namespace Responses {
2374
- export interface $200 {
2375
- component?: Components.Schemas.BaseComponent;
2376
- }
2377
- export interface $404 {
2378
- }
2379
- }
2380
- }
2381
- namespace GetReview {
2382
- namespace Parameters {
2383
- export type AppId = string;
2384
- export type Version = string;
2385
- }
2386
- export interface PathParameters {
2387
- appId: Parameters.AppId;
2388
- version: Parameters.Version;
2389
- }
2390
- namespace Responses {
2391
- export interface $200 {
2392
- review?: Components.Schemas.Review;
2393
- }
2394
- export interface $404 {
2395
- }
2396
- }
2397
- }
2398
- namespace GetVersion {
2399
- namespace Parameters {
2400
- export type AppId = string;
2401
- export type Version = string;
2402
- }
2403
- export interface PathParameters {
2404
- appId: Parameters.AppId;
2405
- version: Parameters.Version;
2406
- }
2407
- namespace Responses {
2408
- export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
2409
- export interface $404 {
2410
- }
2411
- }
2412
- }
2413
- namespace IngestEvent {
2414
- export type RequestBody = Components.Schemas.AppEventData | Components.Schemas.BatchEventRequest;
2415
- namespace Responses {
2416
- export interface $202 {
2417
- }
2418
- export interface $400 {
2419
- }
2420
- }
2421
- }
2422
- namespace Install {
2423
- namespace Parameters {
2424
- export type AppId = string;
2425
- }
2426
- export interface PathParameters {
2427
- appId: Parameters.AppId;
2428
- }
2429
- export type RequestBody = Components.RequestBodies.InstallRequest;
2430
- namespace Responses {
2431
- export type $201 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
2432
- export interface $404 {
2433
- }
2434
- }
2435
- }
2436
- namespace ListConfigurations {
2437
- namespace Parameters {
2438
- export type Page = number;
2439
- export type PageSize = number;
2440
- }
2441
- export interface QueryParameters {
2442
- page?: Parameters.Page;
2443
- pageSize?: Parameters.PageSize;
2444
- }
2445
- namespace Responses {
2446
- export interface $200 {
2447
- configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
2448
- pagination?: {
2449
- total?: number;
2450
- page?: number;
2451
- pageSize?: number;
2452
- };
2453
- }
2454
- }
2455
- }
2456
- namespace ListInstallations {
2457
- namespace Parameters {
2458
- export type ComponentType = /* Type of app component */ Components.Schemas.ComponentType;
2459
- export type Enabled = boolean;
2460
- export type Page = number;
2461
- export type PageSize = number;
2462
- }
2463
- export interface QueryParameters {
2464
- componentType?: Parameters.ComponentType;
2465
- enabled?: Parameters.Enabled;
2466
- page?: Parameters.Page;
2467
- pageSize?: Parameters.PageSize;
2468
- }
2469
- namespace Responses {
2470
- export interface $200 {
2471
- apps?: /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation[];
2472
- pagination?: {
2473
- total?: number;
2474
- page?: number;
2475
- pageSize?: number;
2476
- };
2477
- }
2478
- }
2479
- }
2480
- namespace ListPublicConfigurations {
2481
- namespace Parameters {
2482
- export type Page = number;
2483
- export type PageSize = number;
2484
- }
2485
- export interface QueryParameters {
2486
- page?: Parameters.Page;
2487
- pageSize?: Parameters.PageSize;
2488
- }
2489
- namespace Responses {
2490
- export interface $200 {
2491
- configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
2492
- pagination?: {
2493
- total?: number;
2494
- page?: number;
2495
- pageSize?: number;
2496
- };
2497
- }
2498
- }
2499
- }
2500
- namespace ListVersions {
2501
- namespace Parameters {
2502
- export type AppId = string;
2503
- export type Page = number;
2504
- export type PageSize = number;
2505
- }
2506
- export interface PathParameters {
2507
- appId: Parameters.AppId;
2508
- }
2509
- export interface QueryParameters {
2510
- page?: Parameters.Page;
2511
- pageSize?: Parameters.PageSize;
2512
- }
2513
- namespace Responses {
2514
- export interface $200 {
2515
- versions?: /* Configuration data about your app which is versionable */ Components.Schemas.ConfigurationVersion[];
2516
- pagination?: {
2517
- total?: number;
2518
- page?: number;
2519
- pageSize?: number;
2520
- };
2521
- }
2522
- export interface $400 {
2523
- }
2524
- }
2525
- }
2526
- namespace PatchComponent {
2527
- namespace Parameters {
2528
- export type AppId = string;
2529
- export type ComponentId = string;
2530
- export type Version = string;
2531
- }
2532
- export interface PathParameters {
2533
- appId: Parameters.AppId;
2534
- version: Parameters.Version;
2535
- componentId: Parameters.ComponentId;
2536
- }
2537
- export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
2538
- namespace Responses {
2539
- export interface $204 {
2540
- }
2541
- export interface $400 {
2542
- }
2543
- export interface $404 {
2544
- }
2545
- }
2546
- }
2547
- namespace PatchInstallation {
2548
- namespace Parameters {
2549
- export type AppId = string;
2550
- }
2551
- export interface PathParameters {
2552
- appId: Parameters.AppId;
2553
- }
2554
- export type RequestBody = Components.RequestBodies.InstallRequest;
2555
- namespace Responses {
2556
- export interface $204 {
2557
- }
2558
- export interface $404 {
2559
- }
2560
- }
2561
- }
2562
- namespace PatchMetadata {
2563
- export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
2564
- namespace Responses {
2565
- export interface $204 {
2566
- }
2567
- export interface $404 {
2568
- }
2569
- }
2570
- }
2571
- namespace PatchVersion {
2572
- namespace Parameters {
2573
- export type AppId = string;
2574
- export type Version = string;
2575
- }
2576
- export interface PathParameters {
2577
- appId: Parameters.AppId;
2578
- version: Parameters.Version;
2579
- }
2580
- export type RequestBody = Components.RequestBodies.PatchVersionRequest;
2581
- namespace Responses {
2582
- export interface $204 {
2583
- }
2584
- export interface $400 {
2585
- }
2586
- export interface $404 {
2587
- }
2588
- }
2589
- }
2590
- namespace PromoteVersion {
2591
- namespace Parameters {
2592
- export type AppId = string;
2593
- export type Version = string;
2594
- }
2595
- export interface PathParameters {
2596
- appId: Parameters.AppId;
2597
- version: Parameters.Version;
2598
- }
2599
- namespace Responses {
2600
- export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
2601
- export interface $400 {
2602
- }
2603
- export interface $404 {
2604
- }
2605
- }
2606
- }
2607
- namespace QueryEvents {
2608
- namespace Parameters {
2609
- export type AppId = string;
2610
- }
2611
- export interface PathParameters {
2612
- appId: Parameters.AppId;
2613
- }
2614
- export type RequestBody = Components.Schemas.EventsQuery;
2615
- namespace Responses {
2616
- export type $200 = Components.Schemas.EventsQueryResponse;
2617
- export interface $400 {
2618
- }
2619
- export interface $404 {
2620
- }
2621
- }
2622
- }
2623
- namespace Uninstall {
2624
- namespace Parameters {
2625
- export type AppId = string;
2626
- }
2627
- export interface PathParameters {
2628
- appId: Parameters.AppId;
2629
- }
2630
- namespace Responses {
2631
- export interface $204 {
2632
- }
2633
- export interface $404 {
2634
- }
2635
- }
2636
- }
2637
- namespace V1AppConfigurations$AppId {
2638
- namespace Parameters {
2639
- export type AppId = string;
2640
- }
2641
- export interface PathParameters {
2642
- appId: Parameters.AppId;
2643
- }
2644
- }
2645
- namespace V1AppConfigurations$AppIdLogo {
2646
- namespace Parameters {
2647
- export type AppId = string;
2648
- }
2649
- export interface PathParameters {
2650
- appId: Parameters.AppId;
2651
- }
2652
- }
2653
- namespace V1AppConfigurationsPublic$AppId {
2654
- namespace Parameters {
2655
- export type AppId = string;
2656
- }
2657
- export interface PathParameters {
2658
- appId: Parameters.AppId;
2659
- }
2660
- }
2661
- namespace V1PublicApp$AppIdComponents$ComponentId {
2662
- namespace Parameters {
2663
- export type AppId = string;
2664
- export type ComponentId = string;
2665
- }
2666
- export interface PathParameters {
2667
- appId: Parameters.AppId;
2668
- componentId: Parameters.ComponentId;
2669
- }
2670
- }
2671
- }
2672
-
2673
-
2674
- interface OperationMethods {
2675
- /**
2676
- * getPublicFacingComponent - getPublicFacingComponent
2677
- *
2678
- * Retrieve public facing components for an installed app
2679
- */
2680
- 'getPublicFacingComponent'(
2681
- parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
2682
- data?: any,
2683
- config?: AxiosRequestConfig
2684
- ): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
2685
- /**
2686
- * listConfigurations - listConfigurations
2687
- *
2688
- * List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
2689
- */
2690
- 'listConfigurations'(
2691
- parameters?: Parameters<Paths.ListConfigurations.QueryParameters> | null,
2692
- data?: any,
2693
- config?: AxiosRequestConfig
2694
- ): OperationResponse<Paths.ListConfigurations.Responses.$200>
2695
- /**
2696
- * createConfiguration - createConfiguration
2697
- *
2698
- * Create a new private app configuration. To make it public a verification process needs to be triggered
2699
- */
2700
- 'createConfiguration'(
2701
- parameters?: Parameters<UnknownParamsObject> | null,
2702
- data?: Paths.CreateConfiguration.RequestBody,
2703
- config?: AxiosRequestConfig
2704
- ): OperationResponse<Paths.CreateConfiguration.Responses.$201>
2705
- /**
2706
- * listPublicConfigurations - listPublicConfigurations
2707
- *
2708
- * List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
2709
- */
2710
- 'listPublicConfigurations'(
2711
- parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
2712
- data?: any,
2713
- config?: AxiosRequestConfig
2714
- ): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
2715
- /**
2716
- * getPublicConfiguration - getPublicConfiguration
2717
- *
2718
- * Retrieve the public configuration of an app to install in your tenant
2719
- */
2720
- 'getPublicConfiguration'(
2721
- parameters?: Parameters<Paths.GetPublicConfiguration.QueryParameters & Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
2722
- data?: any,
2723
- config?: AxiosRequestConfig
2724
- ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
2725
- /**
2726
- * getConfiguration - getConfiguration
2727
- *
2728
- * Retrieve a specific app configuration
2729
- */
2730
- 'getConfiguration'(
2731
- parameters?: Parameters<Paths.GetConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
2732
- data?: any,
2733
- config?: AxiosRequestConfig
2734
- ): OperationResponse<Paths.GetConfiguration.Responses.$200>
2735
- /**
2736
- * patchMetadata - patchMetadata
2737
- *
2738
- * Patch non-versioned configuration metadata of a given app configuration.
2739
- */
2740
- 'patchMetadata'(
2741
- parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
2742
- data?: Paths.PatchMetadata.RequestBody,
2743
- config?: AxiosRequestConfig
2744
- ): OperationResponse<Paths.PatchMetadata.Responses.$204>
2745
- /**
2746
- * deleteConfiguration - Delete app configuration
2747
- *
2748
- * Delete an app configuration and all its versions and components.
2749
- */
2750
- 'deleteConfiguration'(
2751
- parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
2752
- data?: any,
2753
- config?: AxiosRequestConfig
2754
- ): OperationResponse<Paths.DeleteConfiguration.Responses.$204>
2755
- /**
2756
- * queryEvents - queryEvents
2757
- *
2758
- * Query analytics events for a specific app with flexible filtering
2759
- */
2760
- 'queryEvents'(
2761
- parameters?: Parameters<Paths.QueryEvents.PathParameters> | null,
2762
- data?: Paths.QueryEvents.RequestBody,
2763
- config?: AxiosRequestConfig
2764
- ): OperationResponse<Paths.QueryEvents.Responses.$200>
2765
- /**
2766
- * createBundleUploadUrl - createBundleUploadUrl
2767
- *
2768
- * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
2769
- */
2770
- 'createBundleUploadUrl'(
2771
- parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
2772
- data?: Paths.CreateBundleUploadUrl.RequestBody,
2773
- config?: AxiosRequestConfig
2774
- ): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
2775
- /**
2776
- * createZipUploadUrl - createZipUploadUrl
2777
- *
2778
- * Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
2779
- *
2780
- */
2781
- 'createZipUploadUrl'(
2782
- parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
2783
- data?: Paths.CreateZipUploadUrl.RequestBody,
2784
- config?: AxiosRequestConfig
2785
- ): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
2786
- /**
2787
- * createLogoUploadUrl - createLogoUploadUrl
2788
- *
2789
- * Generate a presigned URL for uploading app logo to /<app-id>/logo.png path
2790
- */
2791
- 'createLogoUploadUrl'(
2792
- parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
2793
- data?: Paths.CreateLogoUploadUrl.RequestBody,
2794
- config?: AxiosRequestConfig
2795
- ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
2796
- /**
2797
- * deleteLogo - deleteLogo
2798
- *
2799
- * Delete the app logo from /<app-id>/logo.png path
2800
- */
2801
- 'deleteLogo'(
2802
- parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
2803
- data?: any,
2804
- config?: AxiosRequestConfig
2805
- ): OperationResponse<Paths.DeleteLogo.Responses.$204>
2806
- /**
2807
- * listVersions - listVersions
2808
- *
2809
- * Retrieve a list of versions for an app configuration
2810
- */
2811
- 'listVersions'(
2812
- parameters?: Parameters<Paths.ListVersions.QueryParameters & Paths.ListVersions.PathParameters> | null,
2813
- data?: any,
2814
- config?: AxiosRequestConfig
2815
- ): OperationResponse<Paths.ListVersions.Responses.$200>
2816
- /**
2817
- * getVersion - getVersion
2818
- *
2819
- * Retrieve a specific version of an app configuration
2820
- */
2821
- 'getVersion'(
2822
- parameters?: Parameters<Paths.GetVersion.PathParameters> | null,
2823
- data?: any,
2824
- config?: AxiosRequestConfig
2825
- ): OperationResponse<Paths.GetVersion.Responses.$200>
2826
- /**
2827
- * patchVersion - patchVersion
2828
- *
2829
- * Patch an existing app version
2830
- */
2831
- 'patchVersion'(
2832
- parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
2833
- data?: Paths.PatchVersion.RequestBody,
2834
- config?: AxiosRequestConfig
2835
- ): OperationResponse<Paths.PatchVersion.Responses.$204>
2836
- /**
2837
- * deleteVersion - deleteVersion
2838
- *
2839
- * Delete a specific version of an app configuration
2840
- */
2841
- 'deleteVersion'(
2842
- parameters?: Parameters<Paths.DeleteVersion.PathParameters> | null,
2843
- data?: any,
2844
- config?: AxiosRequestConfig
2845
- ): OperationResponse<Paths.DeleteVersion.Responses.$204>
2846
- /**
2847
- * getReview - getReview
2848
- *
2849
- * Retrieve the review status of a specific app version
2850
- */
2851
- 'getReview'(
2852
- parameters?: Parameters<Paths.GetReview.PathParameters> | null,
2853
- data?: any,
2854
- config?: AxiosRequestConfig
2855
- ): OperationResponse<Paths.GetReview.Responses.$200>
2856
- /**
2857
- * createReview - createReview
2858
- *
2859
- * Submit an app version for review to make it public
2860
- */
2861
- 'createReview'(
2862
- parameters?: Parameters<Paths.CreateReview.PathParameters> | null,
2863
- data?: Paths.CreateReview.RequestBody,
2864
- config?: AxiosRequestConfig
2865
- ): OperationResponse<Paths.CreateReview.Responses.$200>
2866
- /**
2867
- * createComponent - createComponent
2868
- *
2869
- * Patch an existing app version to create/add a component
2870
- */
2871
- 'createComponent'(
2872
- parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
2873
- data?: Paths.CreateComponent.RequestBody,
2874
- config?: AxiosRequestConfig
2875
- ): OperationResponse<Paths.CreateComponent.Responses.$200>
2876
- /**
2877
- * patchComponent - patchComponent
2878
- *
2879
- * Patch an existing app version to update its components
2880
- */
2881
- 'patchComponent'(
2882
- parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
2883
- data?: Paths.PatchComponent.RequestBody,
2884
- config?: AxiosRequestConfig
2885
- ): OperationResponse<Paths.PatchComponent.Responses.$204>
2886
- /**
2887
- * deleteComponent - deleteComponent
2888
- *
2889
- * Delete a specific component from an app version
2890
- */
2891
- 'deleteComponent'(
2892
- parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
2893
- data?: any,
2894
- config?: AxiosRequestConfig
2895
- ): OperationResponse<Paths.DeleteComponent.Responses.$204>
2896
- /**
2897
- * cloneVersion - cloneVersion
2898
- *
2899
- * Clone an existing app version to create a new version
2900
- */
2901
- 'cloneVersion'(
2902
- parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
2903
- data?: any,
2904
- config?: AxiosRequestConfig
2905
- ): OperationResponse<Paths.CloneVersion.Responses.$201>
2906
- /**
2907
- * listInstallations - listInstallations
2908
- *
2909
- * Retrieve a list of installed apps for the organization.
2910
- */
2911
- 'listInstallations'(
2912
- parameters?: Parameters<Paths.ListInstallations.QueryParameters> | null,
2913
- data?: any,
2914
- config?: AxiosRequestConfig
2915
- ): OperationResponse<Paths.ListInstallations.Responses.$200>
2916
- /**
2917
- * getInstallation - getInstallation
2918
- *
2919
- * Retrieve details of an installed app by its ID.
2920
- */
2921
- 'getInstallation'(
2922
- parameters?: Parameters<Paths.GetInstallation.PathParameters> | null,
2923
- data?: any,
2924
- config?: AxiosRequestConfig
2925
- ): OperationResponse<Paths.GetInstallation.Responses.$200>
2926
- /**
2927
- * install - install
2928
- *
2929
- * Upsert app installation by its ID.
2930
- */
2931
- 'install'(
2932
- parameters?: Parameters<Paths.Install.PathParameters> | null,
2933
- data?: Paths.Install.RequestBody,
2934
- config?: AxiosRequestConfig
2935
- ): OperationResponse<Paths.Install.Responses.$201>
2936
- /**
2937
- * patchInstallation - patchInstallation
2938
- *
2939
- * Patch an installed app by its ID.
2940
- */
2941
- 'patchInstallation'(
2942
- parameters?: Parameters<Paths.PatchInstallation.PathParameters> | null,
2943
- data?: Paths.PatchInstallation.RequestBody,
2944
- config?: AxiosRequestConfig
2945
- ): OperationResponse<Paths.PatchInstallation.Responses.$204>
2946
- /**
2947
- * uninstall - uninstall
2948
- *
2949
- * Uninstall an app by its ID.
2950
- */
2951
- 'uninstall'(
2952
- parameters?: Parameters<Paths.Uninstall.PathParameters> | null,
2953
- data?: any,
2954
- config?: AxiosRequestConfig
2955
- ): OperationResponse<Paths.Uninstall.Responses.$204>
2956
- /**
2957
- * promoteVersion - promoteVersion
2958
- *
2959
- * Update an installed app to a new version
2960
- */
2961
- 'promoteVersion'(
2962
- parameters?: Parameters<Paths.PromoteVersion.PathParameters> | null,
2963
- data?: any,
2964
- config?: AxiosRequestConfig
2965
- ): OperationResponse<Paths.PromoteVersion.Responses.$200>
2966
- /**
2967
- * ingestEvent - ingestEvent
2968
- *
2969
- * Internal endpoint for services to submit app events for analytic purposes
2970
- */
2971
- 'ingestEvent'(
2972
- parameters?: Parameters<UnknownParamsObject> | null,
2973
- data?: Paths.IngestEvent.RequestBody,
2974
- config?: AxiosRequestConfig
2975
- ): OperationResponse<Paths.IngestEvent.Responses.$202>
2976
- }
2977
-
2978
- interface PathsDictionary {
2979
- ['/v1/public/app/{appId}/components/{componentId}']: {
2980
- /**
2981
- * getPublicFacingComponent - getPublicFacingComponent
2982
- *
2983
- * Retrieve public facing components for an installed app
2984
- */
2985
- 'get'(
2986
- parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
2987
- data?: any,
2988
- config?: AxiosRequestConfig
2989
- ): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
2990
- }
2991
- ['/v1/app-configurations']: {
2992
- /**
2993
- * listConfigurations - listConfigurations
2994
- *
2995
- * List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
2996
- */
2997
- 'get'(
2998
- parameters?: Parameters<Paths.ListConfigurations.QueryParameters> | null,
2999
- data?: any,
3000
- config?: AxiosRequestConfig
3001
- ): OperationResponse<Paths.ListConfigurations.Responses.$200>
3002
- /**
3003
- * createConfiguration - createConfiguration
3004
- *
3005
- * Create a new private app configuration. To make it public a verification process needs to be triggered
3006
- */
3007
- 'post'(
3008
- parameters?: Parameters<UnknownParamsObject> | null,
3009
- data?: Paths.CreateConfiguration.RequestBody,
3010
- config?: AxiosRequestConfig
3011
- ): OperationResponse<Paths.CreateConfiguration.Responses.$201>
3012
- }
3013
- ['/v1/app-configurations/public']: {
3014
- /**
3015
- * listPublicConfigurations - listPublicConfigurations
3016
- *
3017
- * List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
3018
- */
3019
- 'get'(
3020
- parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
3021
- data?: any,
3022
- config?: AxiosRequestConfig
3023
- ): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
3024
- }
3025
- ['/v1/app-configurations/public/{appId}']: {
3026
- /**
3027
- * getPublicConfiguration - getPublicConfiguration
3028
- *
3029
- * Retrieve the public configuration of an app to install in your tenant
3030
- */
3031
- 'get'(
3032
- parameters?: Parameters<Paths.GetPublicConfiguration.QueryParameters & Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
3033
- data?: any,
3034
- config?: AxiosRequestConfig
3035
- ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
3036
- }
3037
- ['/v1/app-configurations/{appId}']: {
3038
- /**
3039
- * getConfiguration - getConfiguration
3040
- *
3041
- * Retrieve a specific app configuration
3042
- */
3043
- 'get'(
3044
- parameters?: Parameters<Paths.GetConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
3045
- data?: any,
3046
- config?: AxiosRequestConfig
3047
- ): OperationResponse<Paths.GetConfiguration.Responses.$200>
3048
- /**
3049
- * patchMetadata - patchMetadata
3050
- *
3051
- * Patch non-versioned configuration metadata of a given app configuration.
3052
- */
3053
- 'patch'(
3054
- parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
3055
- data?: Paths.PatchMetadata.RequestBody,
3056
- config?: AxiosRequestConfig
3057
- ): OperationResponse<Paths.PatchMetadata.Responses.$204>
3058
- /**
3059
- * deleteConfiguration - Delete app configuration
3060
- *
3061
- * Delete an app configuration and all its versions and components.
3062
- */
3063
- 'delete'(
3064
- parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
3065
- data?: any,
3066
- config?: AxiosRequestConfig
3067
- ): OperationResponse<Paths.DeleteConfiguration.Responses.$204>
3068
- }
3069
- ['/v1/app-configurations/{appId}/events']: {
3070
- /**
3071
- * queryEvents - queryEvents
3072
- *
3073
- * Query analytics events for a specific app with flexible filtering
3074
- */
3075
- 'post'(
3076
- parameters?: Parameters<Paths.QueryEvents.PathParameters> | null,
3077
- data?: Paths.QueryEvents.RequestBody,
3078
- config?: AxiosRequestConfig
3079
- ): OperationResponse<Paths.QueryEvents.Responses.$200>
3080
- }
3081
- ['/v1/app-configurations/{appId}/bundle']: {
3082
- /**
3083
- * createBundleUploadUrl - createBundleUploadUrl
3084
- *
3085
- * Generate a presigned URL for uploading app bundle to /<app-id>/bundle.js path
3086
- */
3087
- 'post'(
3088
- parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
3089
- data?: Paths.CreateBundleUploadUrl.RequestBody,
3090
- config?: AxiosRequestConfig
3091
- ): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
3092
- }
3093
- ['/v1/app-configurations/{appId}/zip']: {
3094
- /**
3095
- * createZipUploadUrl - createZipUploadUrl
3096
- *
3097
- * Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /<app-id>/ path
3098
- *
3099
- */
3100
- 'post'(
3101
- parameters?: Parameters<Paths.CreateZipUploadUrl.PathParameters> | null,
3102
- data?: Paths.CreateZipUploadUrl.RequestBody,
3103
- config?: AxiosRequestConfig
3104
- ): OperationResponse<Paths.CreateZipUploadUrl.Responses.$200>
3105
- }
3106
- ['/v1/app-configurations/{appId}/logo']: {
3107
- /**
3108
- * createLogoUploadUrl - createLogoUploadUrl
3109
- *
3110
- * Generate a presigned URL for uploading app logo to /<app-id>/logo.png path
3111
- */
3112
- 'post'(
3113
- parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
3114
- data?: Paths.CreateLogoUploadUrl.RequestBody,
3115
- config?: AxiosRequestConfig
3116
- ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
3117
- /**
3118
- * deleteLogo - deleteLogo
3119
- *
3120
- * Delete the app logo from /<app-id>/logo.png path
3121
- */
3122
- 'delete'(
3123
- parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
3124
- data?: any,
3125
- config?: AxiosRequestConfig
3126
- ): OperationResponse<Paths.DeleteLogo.Responses.$204>
3127
- }
3128
- ['/v1/app-configurations/{appId}/versions']: {
3129
- /**
3130
- * listVersions - listVersions
3131
- *
3132
- * Retrieve a list of versions for an app configuration
3133
- */
3134
- 'get'(
3135
- parameters?: Parameters<Paths.ListVersions.QueryParameters & Paths.ListVersions.PathParameters> | null,
3136
- data?: any,
3137
- config?: AxiosRequestConfig
3138
- ): OperationResponse<Paths.ListVersions.Responses.$200>
3139
- }
3140
- ['/v1/app-configurations/{appId}/versions/{version}']: {
3141
- /**
3142
- * getVersion - getVersion
3143
- *
3144
- * Retrieve a specific version of an app configuration
3145
- */
3146
- 'get'(
3147
- parameters?: Parameters<Paths.GetVersion.PathParameters> | null,
3148
- data?: any,
3149
- config?: AxiosRequestConfig
3150
- ): OperationResponse<Paths.GetVersion.Responses.$200>
3151
- /**
3152
- * deleteVersion - deleteVersion
3153
- *
3154
- * Delete a specific version of an app configuration
3155
- */
3156
- 'delete'(
3157
- parameters?: Parameters<Paths.DeleteVersion.PathParameters> | null,
3158
- data?: any,
3159
- config?: AxiosRequestConfig
3160
- ): OperationResponse<Paths.DeleteVersion.Responses.$204>
3161
- /**
3162
- * patchVersion - patchVersion
3163
- *
3164
- * Patch an existing app version
3165
- */
3166
- 'patch'(
3167
- parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
3168
- data?: Paths.PatchVersion.RequestBody,
3169
- config?: AxiosRequestConfig
3170
- ): OperationResponse<Paths.PatchVersion.Responses.$204>
3171
- }
3172
- ['/v1/app-configurations/{appId}/versions/{version}/review']: {
3173
- /**
3174
- * getReview - getReview
3175
- *
3176
- * Retrieve the review status of a specific app version
3177
- */
3178
- 'get'(
3179
- parameters?: Parameters<Paths.GetReview.PathParameters> | null,
3180
- data?: any,
3181
- config?: AxiosRequestConfig
3182
- ): OperationResponse<Paths.GetReview.Responses.$200>
3183
- /**
3184
- * createReview - createReview
3185
- *
3186
- * Submit an app version for review to make it public
3187
- */
3188
- 'post'(
3189
- parameters?: Parameters<Paths.CreateReview.PathParameters> | null,
3190
- data?: Paths.CreateReview.RequestBody,
3191
- config?: AxiosRequestConfig
3192
- ): OperationResponse<Paths.CreateReview.Responses.$200>
3193
- }
3194
- ['/v1/app-configurations/{appId}/versions/{version}/components']: {
3195
- /**
3196
- * createComponent - createComponent
3197
- *
3198
- * Patch an existing app version to create/add a component
3199
- */
3200
- 'post'(
3201
- parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
3202
- data?: Paths.CreateComponent.RequestBody,
3203
- config?: AxiosRequestConfig
3204
- ): OperationResponse<Paths.CreateComponent.Responses.$200>
3205
- }
3206
- ['/v1/app-configurations/{appId}/versions/{version}/components/{componentId}']: {
3207
- /**
3208
- * patchComponent - patchComponent
3209
- *
3210
- * Patch an existing app version to update its components
3211
- */
3212
- 'patch'(
3213
- parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
3214
- data?: Paths.PatchComponent.RequestBody,
3215
- config?: AxiosRequestConfig
3216
- ): OperationResponse<Paths.PatchComponent.Responses.$204>
3217
- /**
3218
- * deleteComponent - deleteComponent
3219
- *
3220
- * Delete a specific component from an app version
3221
- */
3222
- 'delete'(
3223
- parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
3224
- data?: any,
3225
- config?: AxiosRequestConfig
3226
- ): OperationResponse<Paths.DeleteComponent.Responses.$204>
3227
- }
3228
- ['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
3229
- /**
3230
- * cloneVersion - cloneVersion
3231
- *
3232
- * Clone an existing app version to create a new version
3233
- */
3234
- 'post'(
3235
- parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
3236
- data?: any,
3237
- config?: AxiosRequestConfig
3238
- ): OperationResponse<Paths.CloneVersion.Responses.$201>
3239
- }
3240
- ['/v1/app']: {
3241
- /**
3242
- * listInstallations - listInstallations
3243
- *
3244
- * Retrieve a list of installed apps for the organization.
3245
- */
3246
- 'get'(
3247
- parameters?: Parameters<Paths.ListInstallations.QueryParameters> | null,
3248
- data?: any,
3249
- config?: AxiosRequestConfig
3250
- ): OperationResponse<Paths.ListInstallations.Responses.$200>
3251
- }
3252
- ['/v1/app/{appId}']: {
3253
- /**
3254
- * getInstallation - getInstallation
3255
- *
3256
- * Retrieve details of an installed app by its ID.
3257
- */
3258
- 'get'(
3259
- parameters?: Parameters<Paths.GetInstallation.PathParameters> | null,
3260
- data?: any,
3261
- config?: AxiosRequestConfig
3262
- ): OperationResponse<Paths.GetInstallation.Responses.$200>
3263
- /**
3264
- * install - install
3265
- *
3266
- * Upsert app installation by its ID.
3267
- */
3268
- 'post'(
3269
- parameters?: Parameters<Paths.Install.PathParameters> | null,
3270
- data?: Paths.Install.RequestBody,
3271
- config?: AxiosRequestConfig
3272
- ): OperationResponse<Paths.Install.Responses.$201>
3273
- /**
3274
- * patchInstallation - patchInstallation
3275
- *
3276
- * Patch an installed app by its ID.
3277
- */
3278
- 'patch'(
3279
- parameters?: Parameters<Paths.PatchInstallation.PathParameters> | null,
3280
- data?: Paths.PatchInstallation.RequestBody,
3281
- config?: AxiosRequestConfig
3282
- ): OperationResponse<Paths.PatchInstallation.Responses.$204>
3283
- /**
3284
- * uninstall - uninstall
3285
- *
3286
- * Uninstall an app by its ID.
3287
- */
3288
- 'delete'(
3289
- parameters?: Parameters<Paths.Uninstall.PathParameters> | null,
3290
- data?: any,
3291
- config?: AxiosRequestConfig
3292
- ): OperationResponse<Paths.Uninstall.Responses.$204>
3293
- }
3294
- ['/v1/app/{appId}/promote-to/{version}']: {
3295
- /**
3296
- * promoteVersion - promoteVersion
3297
- *
3298
- * Update an installed app to a new version
3299
- */
3300
- 'post'(
3301
- parameters?: Parameters<Paths.PromoteVersion.PathParameters> | null,
3302
- data?: any,
3303
- config?: AxiosRequestConfig
3304
- ): OperationResponse<Paths.PromoteVersion.Responses.$200>
3305
- }
3306
- ['/v1/app-events']: {
3307
- /**
3308
- * ingestEvent - ingestEvent
3309
- *
3310
- * Internal endpoint for services to submit app events for analytic purposes
3311
- */
3312
- 'post'(
3313
- parameters?: Parameters<UnknownParamsObject> | null,
3314
- data?: Paths.IngestEvent.RequestBody,
3315
- config?: AxiosRequestConfig
3316
- ): OperationResponse<Paths.IngestEvent.Responses.$202>
3317
- }
3318
- }
3319
-
3320
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
3321
-
3322
-
3323
- type Actor = Components.Schemas.Actor;
3324
- type AggregatedEvents = Components.Schemas.AggregatedEvents;
3325
- type AppBridgeSurfaceConfig = Components.Schemas.AppBridgeSurfaceConfig;
3326
- type AppEventData = Components.Schemas.AppEventData;
3327
- type Audit = Components.Schemas.Audit;
3328
- type Author = Components.Schemas.Author;
3329
- type BaseComponent = Components.Schemas.BaseComponent;
3330
- type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
3331
- type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
3332
- type BatchEventRequest = Components.Schemas.BatchEventRequest;
3333
- type BillingFrequency = Components.Schemas.BillingFrequency;
3334
- type BlueprintRef = Components.Schemas.BlueprintRef;
3335
- type BooleanArg = Components.Schemas.BooleanArg;
3336
- type CallerIdentity = Components.Schemas.CallerIdentity;
3337
- type ComponentType = Components.Schemas.ComponentType;
3338
- type Configuration = Components.Schemas.Configuration;
3339
- type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
3340
- type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
3341
- type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
3342
- type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
3343
- type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
3344
- type CustomPageComponent = Components.Schemas.CustomPageComponent;
3345
- type CustomPageConfig = Components.Schemas.CustomPageConfig;
3346
- type EnumArg = Components.Schemas.EnumArg;
3347
- type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
3348
- type EventsQuery = Components.Schemas.EventsQuery;
3349
- type EventsQueryResponse = Components.Schemas.EventsQueryResponse;
3350
- type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalIntegrationCustomActionConfig;
3351
- type ExternalProductCatalogAuthBlock = Components.Schemas.ExternalProductCatalogAuthBlock;
3352
- type ExternalProductCatalogComponent = Components.Schemas.ExternalProductCatalogComponent;
3353
- type ExternalProductCatalogConfig = Components.Schemas.ExternalProductCatalogConfig;
3354
- type ExternalProductCatalogHookProductRecommendations = Components.Schemas.ExternalProductCatalogHookProductRecommendations;
3355
- type ExternalProductCatalogHookProducts = Components.Schemas.ExternalProductCatalogHookProducts;
3356
- type Grants = Components.Schemas.Grants;
3357
- type Installation = Components.Schemas.Installation;
3358
- type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
3359
- type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
3360
- type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
3361
- type NotificationConfig = Components.Schemas.NotificationConfig;
3362
- type NotificationEvent = Components.Schemas.NotificationEvent;
3363
- type Option = Components.Schemas.Option;
3364
- type Options = Components.Schemas.Options;
3365
- type OptionsRef = Components.Schemas.OptionsRef;
3366
- type OverrideDevMode = Components.Schemas.OverrideDevMode;
3367
- type PortalBlockComponent = Components.Schemas.PortalBlockComponent;
3368
- type PortalBlockConfig = Components.Schemas.PortalBlockConfig;
3369
- type PortalBlockSurfaceConfig = Components.Schemas.PortalBlockSurfaceConfig;
3370
- type PortalExtensionAuthBlock = Components.Schemas.PortalExtensionAuthBlock;
3371
- type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
3372
- type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
3373
- type PortalExtensionHookConsumptionDataRetrieval = Components.Schemas.PortalExtensionHookConsumptionDataRetrieval;
3374
- type PortalExtensionHookContractIdentification = Components.Schemas.PortalExtensionHookContractIdentification;
3375
- type PortalExtensionHookCostDataRetrieval = Components.Schemas.PortalExtensionHookCostDataRetrieval;
3376
- type PortalExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.PortalExtensionHookMeterReadingPlausibilityCheck;
3377
- type PortalExtensionHookPriceDataRetrieval = Components.Schemas.PortalExtensionHookPriceDataRetrieval;
3378
- type PortalExtensionHookRegistrationIdentifiersCheck = Components.Schemas.PortalExtensionHookRegistrationIdentifiersCheck;
3379
- type PortalExtensionSeamlessLink = Components.Schemas.PortalExtensionSeamlessLink;
3380
- type PortalExtensionSecureProxy = Components.Schemas.PortalExtensionSecureProxy;
3381
- type Pricing = Components.Schemas.Pricing;
3382
- type PublicConfiguration = Components.Schemas.PublicConfiguration;
3383
- type RawEvents = Components.Schemas.RawEvents;
3384
- type Review = Components.Schemas.Review;
3385
- type Role = Components.Schemas.Role;
3386
- type S3Reference = Components.Schemas.S3Reference;
3387
- type SandboxCustomActionConfig = Components.Schemas.SandboxCustomActionConfig;
3388
- type TextArg = Components.Schemas.TextArg;
3389
- type TranslatedString = Components.Schemas.TranslatedString;
3390
-
3391
- export { type PortalExtensionComponent as $, type Actor as A, type BaseComponent as B, type Client as C, type ExternalIntegrationCustomActionConfig as D, type EnumArg as E, type ExternalProductCatalogAuthBlock as F, type ExternalProductCatalogComponent as G, type ExternalProductCatalogConfig as H, type ExternalProductCatalogHookProductRecommendations as I, type ExternalProductCatalogHookProducts as J, type Grants as K, type Installation as L, type JourneyBlockComponent as M, type JourneyBlockComponentArgs as N, type OperationMethods as O, Paths as P, type JourneyBlockConfig as Q, type NotificationConfig as R, type NotificationEvent as S, type Option as T, type Options as U, type OptionsRef as V, type OverrideDevMode as W, type PortalBlockComponent as X, type PortalBlockConfig as Y, type PortalBlockSurfaceConfig as Z, type PortalExtensionAuthBlock as _, Components as a, type PortalExtensionConfig as a0, type PortalExtensionHookConsumptionDataRetrieval as a1, type PortalExtensionHookContractIdentification as a2, type PortalExtensionHookCostDataRetrieval as a3, type PortalExtensionHookMeterReadingPlausibilityCheck as a4, type PortalExtensionHookPriceDataRetrieval as a5, type PortalExtensionHookRegistrationIdentifiersCheck as a6, type PortalExtensionSeamlessLink as a7, type PortalExtensionSecureProxy as a8, type Pricing as a9, type PublicConfiguration as aa, type RawEvents as ab, type Review as ac, type Role as ad, type S3Reference as ae, type SandboxCustomActionConfig as af, type TextArg as ag, type TranslatedString as ah, type PathsDictionary as b, type AggregatedEvents as c, type AppBridgeSurfaceConfig as d, type AppEventData as e, type Audit as f, type Author as g, type BaseComponentCommon as h, type BaseCustomActionConfig as i, type BatchEventRequest as j, type BillingFrequency as k, type BlueprintRef as l, type BooleanArg as m, type CallerIdentity as n, type ComponentType as o, type Configuration as p, type ConfigurationMetadata as q, type ConfigurationVersion as r, type CustomCapabilityComponent as s, type CustomFlowActionComponent as t, type CustomFlowConfig as u, type CustomPageComponent as v, type CustomPageConfig as w, type ErpInformToolkitComponent as x, type EventsQuery as y, type EventsQueryResponse as z };