@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,1271 +0,0 @@
1
- import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from organization-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Schemas {
8
- /**
9
- * Request payload for creating a new organization
10
- */
11
- export interface CreateOrganizationRequest {
12
- /**
13
- * Core organization information for the new tenant
14
- */
15
- organization_detail?: {
16
- /**
17
- * Display name for the organization
18
- * example:
19
- * epilot
20
- */
21
- name: string;
22
- /**
23
- * Primary contact email for the organization
24
- * example:
25
- * epilot@epilot.cloud
26
- */
27
- email_address?: string;
28
- /**
29
- * Organization type classification.
30
- * - Vendor: Primary organization type for epilot customers
31
- * - Partner: Partner organization type
32
- *
33
- * example:
34
- * Vendor
35
- */
36
- type: string;
37
- /**
38
- * Whether this is a production or sandbox environment.
39
- * Sandbox organizations are for testing and linked to a production org.
40
- *
41
- */
42
- organization_use?: "Production" | "Sandbox";
43
- /**
44
- * The ULID of the pricing tier to assign to this organization.
45
- * Determines feature access and billing.
46
- *
47
- * example:
48
- * 01GEKHZHSN19KK10ZS92Y3WY9B
49
- */
50
- pricing_tier_id: string;
51
- };
52
- /**
53
- * Initial owner user details.
54
- * This user will receive an invitation email to complete registration
55
- * and become the organization administrator.
56
- *
57
- */
58
- owner_user?: {
59
- /**
60
- * Full name of the owner user
61
- * example:
62
- * Ny Huynh
63
- */
64
- full_name?: string;
65
- /**
66
- * Email address for the invitation (must be unique in the platform)
67
- * example:
68
- * ny.huynhthi@axonactive.com
69
- */
70
- email_address: string;
71
- };
72
- }
73
- /**
74
- * Data point metrics for a single organization, used for usage tracking and billing
75
- */
76
- export interface DataPoint {
77
- /**
78
- * The organization ID (numeric format)
79
- * example:
80
- * 206801
81
- */
82
- id?: number;
83
- /**
84
- * Maximum number of customer entities recorded in the previous month.
85
- * Used as a high-water mark for billing calculations.
86
- *
87
- * example:
88
- * 10
89
- */
90
- max_customer?: number;
91
- /**
92
- * Current count of customer entities in the organization.
93
- * Represents the actual usage at the time of the query.
94
- *
95
- * example:
96
- * 10
97
- */
98
- actual_customer?: number;
99
- }
100
- /**
101
- * List of data point metrics for all organizations
102
- */
103
- export type DataPointsResponse = /* Data point metrics for a single organization, used for usage tracking and billing */ DataPoint[];
104
- /**
105
- * Metadata for a single feature flag toggle
106
- */
107
- export interface FeatureFlagMetadata {
108
- /**
109
- * Unique identifier matching the organization setting key
110
- * example:
111
- * canary
112
- */
113
- feature_name: string;
114
- title?: /* Internationalized string with a translation key and optional default value */ I18nString;
115
- description?: /* Internationalized string with a translation key and optional default value */ I18nString;
116
- /**
117
- * Badge label shown next to the feature toggle
118
- */
119
- badge?: "alpha" | "beta" | "new" | "advanced" | "experiment" | "deprecated";
120
- /**
121
- * Whether to show confetti animation when enabled
122
- */
123
- confetti?: boolean;
124
- /**
125
- * Whether the toggle can only be turned on (not off)
126
- */
127
- one_way?: boolean;
128
- /**
129
- * Whether the toggle value is inverted (checked = disabled)
130
- */
131
- reverse_checked?: boolean;
132
- /**
133
- * Whether this feature is visible for partner organizations
134
- */
135
- is_visible_for_partner?: boolean;
136
- /**
137
- * Rules that must ALL pass for this feature to be visible (implicit AND)
138
- */
139
- visibility_rules: /**
140
- * A rule that determines feature visibility. Rules are combined with AND logic
141
- * at the top level. Supports boolean combinators (and, or, not) for complex logic.
142
- *
143
- */
144
- VisibilityRule[];
145
- }
146
- /**
147
- * Feature settings metadata served to frontend applications.
148
- */
149
- export interface FeatureSettings {
150
- /**
151
- * Schema version for backwards compatibility
152
- * example:
153
- * 1.0.0
154
- */
155
- version: string;
156
- /**
157
- * Feature flag metadata for the settings page
158
- */
159
- feature_flags: /* Metadata for a single feature flag toggle */ FeatureFlagMetadata[];
160
- }
161
- /**
162
- * Response containing a list of HubSpot companies matching the search criteria
163
- */
164
- export interface HubspotCompaniesResponse {
165
- /**
166
- * List of HubSpot companies matching the query
167
- */
168
- results?: /**
169
- * Represents a company record from HubSpot CRM synchronized to the epilot data warehouse.
170
- * Used for CRM integration and organization mapping.
171
- *
172
- */
173
- HubspotCompany[];
174
- /**
175
- * Total number of companies in the response
176
- * example:
177
- * 10
178
- */
179
- total?: number;
180
- }
181
- /**
182
- * Represents a company record from HubSpot CRM synchronized to the epilot data warehouse.
183
- * Used for CRM integration and organization mapping.
184
- *
185
- */
186
- export interface HubspotCompany {
187
- /**
188
- * The unique HubSpot company identifier
189
- * example:
190
- * 12345678901
191
- */
192
- company_id?: string;
193
- /**
194
- * The display name of the company in HubSpot
195
- * example:
196
- * Acme Corp
197
- */
198
- company_name?: string | null;
199
- /**
200
- * The primary web domain associated with the company
201
- * example:
202
- * acme.com
203
- */
204
- domain?: string | null;
205
- }
206
- /**
207
- * HubSpot company data associated with an epilot organization.
208
- * Contains business metrics and CRM properties synced from HubSpot.
209
- *
210
- */
211
- export interface HubspotOrganizationData {
212
- /**
213
- * The unique HubSpot company identifier
214
- * example:
215
- * 5278308807
216
- */
217
- company_id?: string;
218
- /**
219
- * The display name of the company in HubSpot
220
- * example:
221
- * Stadtwerke Meerbusch Willich Netz
222
- */
223
- company_name?: string | null;
224
- /**
225
- * The primary web domain associated with the company
226
- * example:
227
- * stadtwerke-service.de
228
- */
229
- domain?: string | null;
230
- /**
231
- * Current Monthly Recurring Revenue
232
- * example:
233
- * 11033.33
234
- */
235
- current_mrr?: string | null;
236
- /**
237
- * Potential Monthly Recurring Revenue
238
- * example:
239
- * 20000
240
- */
241
- potential_mrr?: string | null;
242
- /**
243
- * Company size classification
244
- * example:
245
- * Large
246
- */
247
- company_size?: string | null;
248
- /**
249
- * Current pricing tier
250
- * example:
251
- * Professional
252
- */
253
- pricing_tier?: string | null;
254
- /**
255
- * HubSpot lifecycle stage
256
- * example:
257
- * customer
258
- */
259
- lifecyclestage?: string | null;
260
- /**
261
- * Industry classification
262
- * example:
263
- * Energiedienstleister
264
- */
265
- industry?: string | null;
266
- /**
267
- * Number of employees
268
- * example:
269
- * 200
270
- */
271
- numberofemployees?: string | null;
272
- /**
273
- * epilot customer number
274
- * example:
275
- * 10031
276
- */
277
- customer_number?: string | null;
278
- /**
279
- * Number of active users
280
- * example:
281
- * 34
282
- */
283
- no_of_users?: string | null;
284
- /**
285
- * User activation rate
286
- * example:
287
- * 0.647059
288
- */
289
- activation_rate?: string | null;
290
- /**
291
- * List of active features
292
- * example:
293
- * Installer Portal
294
- */
295
- active_features?: string | null;
296
- /**
297
- * Implemented use cases
298
- * example:
299
- * GRID: Installations (MGA);GRID: House Connections
300
- */
301
- usecases_implemented?: string | null;
302
- /**
303
- * Current buyer's journey stage
304
- * example:
305
- * Expansion-Ready
306
- */
307
- buyer_journey?: string | null;
308
- /**
309
- * Company country
310
- * example:
311
- * Germany
312
- */
313
- country?: string | null;
314
- /**
315
- * Company city
316
- * example:
317
- * Willich
318
- */
319
- city?: string | null;
320
- /**
321
- * Full HubSpot properties object with all available fields
322
- */
323
- properties?: {
324
- [name: string]: any;
325
- };
326
- }
327
- /**
328
- * Internationalized string with a translation key and optional default value
329
- */
330
- export interface I18nString {
331
- /**
332
- * Translation key for i18n lookup
333
- * example:
334
- * canary_setting.title
335
- */
336
- key: string;
337
- /**
338
- * Fallback value when translation is not available
339
- * example:
340
- * Canary Updates
341
- */
342
- default_value?: string;
343
- }
344
- /**
345
- * Extended organization object with internal-only fields.
346
- *
347
- * Includes all fields from the base Organization schema plus additional
348
- * internal metadata used for platform administration and support.
349
- *
350
- */
351
- export interface InternalOrganization {
352
- id?: /**
353
- * Unique identifier for an organization (tenant) in the epilot platform
354
- * example:
355
- * 739224
356
- */
357
- OrganizationId;
358
- /**
359
- * Organization name
360
- * example:
361
- * Epilot
362
- */
363
- name?: string | null;
364
- /**
365
- * Organization contact email
366
- * example:
367
- * someone@epilot.cloud
368
- */
369
- email?: string | null;
370
- /**
371
- * Organization contact phone
372
- * example:
373
- * +49123123123
374
- */
375
- phone?: string | null;
376
- /**
377
- * Organization website
378
- * example:
379
- * https://epilot.cloud
380
- */
381
- website?: string | null;
382
- /**
383
- * Organization postal address
384
- */
385
- address?: {
386
- [name: string]: any;
387
- country?: string | null;
388
- city?: string | null;
389
- postal_code?: string | null;
390
- street?: string | null;
391
- street_number?: string | null;
392
- };
393
- /**
394
- * Indicates whether this is a production or sandbox organization.
395
- * Sandbox organizations are linked to a parent production organization for testing purposes.
396
- *
397
- */
398
- organization_use?: "Production" | "Sandbox";
399
- /**
400
- * The ID of the parent production organization.
401
- * Only set for sandbox organizations to link them to their production counterpart.
402
- *
403
- */
404
- parent_production_org_id?: string | null;
405
- /**
406
- * Organization created date
407
- */
408
- created_date?: string; // date-time
409
- /**
410
- * Organization logo URL
411
- * example:
412
- * https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
413
- */
414
- logo_url?: string | null;
415
- /**
416
- * Organization logo thumbnail URL
417
- * example:
418
- * https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
419
- */
420
- logo_thumbnail_url?: string | null;
421
- /**
422
- * Default email signature of organization
423
- * example:
424
- * <p>Thanks</p>
425
- */
426
- signature?: string | null;
427
- /**
428
- * example:
429
- * false
430
- */
431
- is_unlicensed_org?: boolean | null;
432
- /**
433
- * Organization style setting (e.g. font setting)
434
- */
435
- style?: {
436
- [name: string]: any;
437
- } | null;
438
- type?: "Vendor" | "Partner";
439
- /**
440
- * example:
441
- * EPI
442
- */
443
- symbol?: string | null;
444
- /**
445
- * Deprecated - Please use pricing tier api
446
- * example:
447
- * professional
448
- */
449
- pricing_tier?: string | null;
450
- /**
451
- * example:
452
- * 50
453
- */
454
- free_user_limit?: number | null;
455
- /**
456
- * Labels/tags associated with the organization for categorization and filtering.
457
- * Used internally to classify organizations (e.g., "enterprise", "beta-tester", "test org").
458
- *
459
- */
460
- tags?: string[] | null;
461
- }
462
- /**
463
- * Represents an epilot organization (tenant).
464
- *
465
- * An organization contains all the configuration, branding, and contact information
466
- * for a tenant account on the epilot platform.
467
- *
468
- */
469
- export interface Organization {
470
- id?: /**
471
- * Unique identifier for an organization (tenant) in the epilot platform
472
- * example:
473
- * 739224
474
- */
475
- OrganizationId;
476
- /**
477
- * Organization name
478
- * example:
479
- * Epilot
480
- */
481
- name?: string | null;
482
- /**
483
- * Organization contact email
484
- * example:
485
- * someone@epilot.cloud
486
- */
487
- email?: string | null;
488
- /**
489
- * Organization contact phone
490
- * example:
491
- * +49123123123
492
- */
493
- phone?: string | null;
494
- /**
495
- * Organization website
496
- * example:
497
- * https://epilot.cloud
498
- */
499
- website?: string | null;
500
- /**
501
- * Organization postal address
502
- */
503
- address?: {
504
- [name: string]: any;
505
- country?: string | null;
506
- city?: string | null;
507
- postal_code?: string | null;
508
- street?: string | null;
509
- street_number?: string | null;
510
- };
511
- /**
512
- * Indicates whether this is a production or sandbox organization.
513
- * Sandbox organizations are linked to a parent production organization for testing purposes.
514
- *
515
- */
516
- organization_use?: "Production" | "Sandbox";
517
- /**
518
- * The ID of the parent production organization.
519
- * Only set for sandbox organizations to link them to their production counterpart.
520
- *
521
- */
522
- parent_production_org_id?: string | null;
523
- /**
524
- * Organization created date
525
- */
526
- created_date?: string; // date-time
527
- /**
528
- * Organization logo URL
529
- * example:
530
- * https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
531
- */
532
- logo_url?: string | null;
533
- /**
534
- * Organization logo thumbnail URL
535
- * example:
536
- * https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
537
- */
538
- logo_thumbnail_url?: string | null;
539
- /**
540
- * Default email signature of organization
541
- * example:
542
- * <p>Thanks</p>
543
- */
544
- signature?: string | null;
545
- /**
546
- * example:
547
- * false
548
- */
549
- is_unlicensed_org?: boolean | null;
550
- /**
551
- * Organization style setting (e.g. font setting)
552
- */
553
- style?: {
554
- [name: string]: any;
555
- } | null;
556
- type?: "Vendor" | "Partner";
557
- /**
558
- * example:
559
- * EPI
560
- */
561
- symbol?: string | null;
562
- /**
563
- * Deprecated - Please use pricing tier api
564
- * example:
565
- * professional
566
- */
567
- pricing_tier?: string | null;
568
- /**
569
- * example:
570
- * 50
571
- */
572
- free_user_limit?: number | null;
573
- /**
574
- * Labels/tags associated with the organization for categorization and filtering.
575
- * Used internally to classify organizations (e.g., "enterprise", "beta-tester", "test org").
576
- *
577
- */
578
- tags?: string[] | null;
579
- }
580
- /**
581
- * Records the cleanup status reported by a specific service for an organization.
582
- * Each service that stores organization data reports its cleanup operations here.
583
- *
584
- */
585
- export interface OrganizationCleanupStatus {
586
- org_id: /**
587
- * Unique identifier for an organization (tenant) in the epilot platform
588
- * example:
589
- * 739224
590
- */
591
- OrganizationId;
592
- /**
593
- * Name of the service reporting its cleanup status
594
- * example:
595
- * organization-api
596
- */
597
- service_name: string;
598
- /**
599
- * List of cleanup operations performed by the service.
600
- * Each operation describes what action was taken on which resource.
601
- *
602
- * example:
603
- * [
604
- * {
605
- * "action": "Delete",
606
- * "resource": "OrgTable",
607
- * "extra_info": "pk: ORG#739224"
608
- * },
609
- * {
610
- * "action": "Archive",
611
- * "resource": "s3://my-bucket",
612
- * "extra_info": "my-bucket/my-key.txt"
613
- * }
614
- * ]
615
- */
616
- operations?: {
617
- [name: string]: any;
618
- /**
619
- * The type of cleanup action performed.
620
- * Common values: Delete, Archive, Purge
621
- *
622
- * example:
623
- * Delete
624
- */
625
- action?: string;
626
- /**
627
- * The resource that was cleaned up.
628
- * Can be a table name, S3 bucket, or other resource identifier.
629
- *
630
- * example:
631
- * OrgTable
632
- */
633
- resource?: string;
634
- /**
635
- * Additional context about the cleanup operation
636
- */
637
- extra_info?: /* Additional context about the cleanup operation */ string | number | boolean | {
638
- [name: string]: any;
639
- }[] | {
640
- [name: string]: any;
641
- };
642
- }[];
643
- }
644
- /**
645
- * Unique identifier for an organization (tenant) in the epilot platform
646
- * example:
647
- * 739224
648
- */
649
- export type OrganizationId = string;
650
- /**
651
- * Represents an organization that has been marked for deletion and requires cleanup.
652
- * Contains metadata about the deletion request.
653
- *
654
- */
655
- export interface OrganizationToCleanup {
656
- org_id: /**
657
- * Unique identifier for an organization (tenant) in the epilot platform
658
- * example:
659
- * 739224
660
- */
661
- OrganizationId;
662
- /**
663
- * Timestamp when the organization was marked for deletion
664
- * example:
665
- * 2021-06-01T00:00:00Z
666
- */
667
- deleted_at: string; // date-time
668
- /**
669
- * User ID of the person who initiated the deletion
670
- * example:
671
- * 123456
672
- */
673
- deleted_by: string;
674
- }
675
- /**
676
- * A unique key identifying an organization setting.
677
- * Common setting keys include: double_opt_in, email_tracking, default_language, workflow_notifications
678
- *
679
- * example:
680
- * double_opt_in
681
- */
682
- export type SettingKey = string;
683
- /**
684
- * A key-value map of all organization settings.
685
- * Keys are setting identifiers and values can be any valid JSON type.
686
- *
687
- * example:
688
- * {
689
- * "double_opt_in": {
690
- * "enabled": true
691
- * },
692
- * "email_tracking": {
693
- * "enabled": true,
694
- * "track_opens": true
695
- * },
696
- * "default_language": "de"
697
- * }
698
- */
699
- export interface Settings {
700
- [name: string]: any;
701
- }
702
- /**
703
- * The value of an organization setting.
704
- * Can be any valid JSON type: string, number, boolean, array, or object.
705
- *
706
- * example:
707
- * {
708
- * "enabled": true
709
- * }
710
- */
711
- export type SettingsValue = /**
712
- * The value of an organization setting.
713
- * Can be any valid JSON type: string, number, boolean, array, or object.
714
- *
715
- * example:
716
- * {
717
- * "enabled": true
718
- * }
719
- */
720
- string | number | boolean | {
721
- [name: string]: any;
722
- }[] | {
723
- [name: string]: any;
724
- };
725
- /**
726
- * A rule that determines feature visibility. Rules are combined with AND logic
727
- * at the top level. Supports boolean combinators (and, or, not) for complex logic.
728
- *
729
- */
730
- export interface VisibilityRule {
731
- /**
732
- * The rule type discriminator
733
- */
734
- type: "always" | "never" | "advanced_mode" | "pricing_tier" | "feature_flag" | "permission" | "setting_enabled" | "flag_enabled" | "not" | "and" | "or";
735
- /**
736
- * Setting key for pricing_tier and setting_enabled rules
737
- */
738
- setting_key?: string;
739
- /**
740
- * Flag name for feature_flag and flag_enabled rules
741
- */
742
- flag_name?: string;
743
- /**
744
- * Permission action for permission rules
745
- */
746
- action?: string;
747
- /**
748
- * Optional resource for permission rules
749
- */
750
- resource?: string;
751
- rule?: /**
752
- * A rule that determines feature visibility. Rules are combined with AND logic
753
- * at the top level. Supports boolean combinators (and, or, not) for complex logic.
754
- *
755
- */
756
- VisibilityRule;
757
- /**
758
- * Child rules for and/or combinators
759
- */
760
- rules?: /**
761
- * A rule that determines feature visibility. Rules are combined with AND logic
762
- * at the top level. Supports boolean combinators (and, or, not) for complex logic.
763
- *
764
- */
765
- VisibilityRule[];
766
- }
767
- }
768
- }
769
- declare namespace Paths {
770
- namespace DeleteSettingsValue {
771
- namespace Parameters {
772
- export type Key = string;
773
- export type OrgId = /**
774
- * Unique identifier for an organization (tenant) in the epilot platform
775
- * example:
776
- * 739224
777
- */
778
- Components.Schemas.OrganizationId;
779
- }
780
- export interface PathParameters {
781
- org_id: Parameters.OrgId;
782
- key: Parameters.Key;
783
- }
784
- namespace Responses {
785
- export interface $200 {
786
- }
787
- export interface $401 {
788
- }
789
- export interface $403 {
790
- }
791
- export interface $404 {
792
- }
793
- }
794
- }
795
- namespace GetCurrentOrganization {
796
- namespace Responses {
797
- export type $200 = /**
798
- * Represents an epilot organization (tenant).
799
- *
800
- * An organization contains all the configuration, branding, and contact information
801
- * for a tenant account on the epilot platform.
802
- *
803
- */
804
- Components.Schemas.Organization;
805
- export interface $401 {
806
- }
807
- export interface $403 {
808
- }
809
- }
810
- }
811
- namespace GetFeatureSettings {
812
- namespace Responses {
813
- export type $200 = /* Feature settings metadata served to frontend applications. */ Components.Schemas.FeatureSettings;
814
- export interface $401 {
815
- }
816
- }
817
- }
818
- namespace GetOrganization {
819
- namespace Parameters {
820
- export type OrgId = /**
821
- * Unique identifier for an organization (tenant) in the epilot platform
822
- * example:
823
- * 739224
824
- */
825
- Components.Schemas.OrganizationId;
826
- }
827
- export interface PathParameters {
828
- org_id: Parameters.OrgId;
829
- }
830
- namespace Responses {
831
- export type $200 = /**
832
- * Represents an epilot organization (tenant).
833
- *
834
- * An organization contains all the configuration, branding, and contact information
835
- * for a tenant account on the epilot platform.
836
- *
837
- */
838
- Components.Schemas.Organization;
839
- export interface $401 {
840
- }
841
- export interface $403 {
842
- }
843
- export interface $404 {
844
- }
845
- }
846
- }
847
- namespace GetOrganizationFeatureSettings {
848
- namespace Responses {
849
- export type $200 = /* Feature settings metadata served to frontend applications. */ Components.Schemas.FeatureSettings;
850
- export interface $401 {
851
- }
852
- }
853
- }
854
- namespace GetSettings {
855
- namespace Parameters {
856
- export type OrgId = /**
857
- * Unique identifier for an organization (tenant) in the epilot platform
858
- * example:
859
- * 739224
860
- */
861
- Components.Schemas.OrganizationId;
862
- }
863
- export interface PathParameters {
864
- org_id: Parameters.OrgId;
865
- }
866
- namespace Responses {
867
- export type $200 = /**
868
- * A key-value map of all organization settings.
869
- * Keys are setting identifiers and values can be any valid JSON type.
870
- *
871
- * example:
872
- * {
873
- * "double_opt_in": {
874
- * "enabled": true
875
- * },
876
- * "email_tracking": {
877
- * "enabled": true,
878
- * "track_opens": true
879
- * },
880
- * "default_language": "de"
881
- * }
882
- */
883
- Components.Schemas.Settings;
884
- export interface $401 {
885
- }
886
- export interface $403 {
887
- }
888
- export interface $404 {
889
- }
890
- }
891
- }
892
- namespace PutSettingsValue {
893
- namespace Parameters {
894
- export type Key = string;
895
- export type OrgId = /**
896
- * Unique identifier for an organization (tenant) in the epilot platform
897
- * example:
898
- * 739224
899
- */
900
- Components.Schemas.OrganizationId;
901
- }
902
- export interface PathParameters {
903
- org_id: Parameters.OrgId;
904
- key: Parameters.Key;
905
- }
906
- export type RequestBody = /**
907
- * The value of an organization setting.
908
- * Can be any valid JSON type: string, number, boolean, array, or object.
909
- *
910
- * example:
911
- * {
912
- * "enabled": true
913
- * }
914
- */
915
- Components.Schemas.SettingsValue;
916
- namespace Responses {
917
- export type $200 = /**
918
- * The value of an organization setting.
919
- * Can be any valid JSON type: string, number, boolean, array, or object.
920
- *
921
- * example:
922
- * {
923
- * "enabled": true
924
- * }
925
- */
926
- Components.Schemas.SettingsValue;
927
- export interface $400 {
928
- }
929
- export interface $401 {
930
- }
931
- export interface $403 {
932
- }
933
- export interface $404 {
934
- }
935
- }
936
- }
937
- namespace UpdateOrganization {
938
- namespace Parameters {
939
- export type OrgId = /**
940
- * Unique identifier for an organization (tenant) in the epilot platform
941
- * example:
942
- * 739224
943
- */
944
- Components.Schemas.OrganizationId;
945
- }
946
- export interface PathParameters {
947
- org_id: Parameters.OrgId;
948
- }
949
- export type RequestBody = /**
950
- * Represents an epilot organization (tenant).
951
- *
952
- * An organization contains all the configuration, branding, and contact information
953
- * for a tenant account on the epilot platform.
954
- *
955
- */
956
- Components.Schemas.Organization;
957
- namespace Responses {
958
- export type $200 = /**
959
- * Represents an epilot organization (tenant).
960
- *
961
- * An organization contains all the configuration, branding, and contact information
962
- * for a tenant account on the epilot platform.
963
- *
964
- */
965
- Components.Schemas.Organization;
966
- export interface $400 {
967
- }
968
- export interface $401 {
969
- }
970
- export interface $403 {
971
- }
972
- export interface $404 {
973
- }
974
- }
975
- }
976
- }
977
-
978
-
979
- interface OperationMethods {
980
- /**
981
- * getCurrentOrganization - getCurrentOrganization
982
- *
983
- * Retrieves the organization associated with the authenticated user's current session.
984
- *
985
- * This endpoint is useful for fetching organization details without knowing the organization ID,
986
- * as it automatically resolves the organization from the authentication token.
987
- *
988
- */
989
- 'getCurrentOrganization'(
990
- parameters?: Parameters<UnknownParamsObject> | null,
991
- data?: any,
992
- config?: AxiosRequestConfig
993
- ): OperationResponse<Paths.GetCurrentOrganization.Responses.$200>
994
- /**
995
- * getOrganization - getOrganization
996
- *
997
- * Retrieves detailed information about a specific organization by its unique identifier.
998
- *
999
- * Returns the organization's profile information including name, contact details,
1000
- * address, branding assets, and configuration.
1001
- *
1002
- */
1003
- 'getOrganization'(
1004
- parameters?: Parameters<Paths.GetOrganization.PathParameters> | null,
1005
- data?: any,
1006
- config?: AxiosRequestConfig
1007
- ): OperationResponse<Paths.GetOrganization.Responses.$200>
1008
- /**
1009
- * updateOrganization - updateOrganization
1010
- *
1011
- * Updates an organization's profile information.
1012
- *
1013
- * This endpoint supports partial updates - only the fields provided in the request body
1014
- * will be modified. Fields not included in the request will retain their current values.
1015
- *
1016
- * Common use cases:
1017
- * - Updating contact information (email, phone, website)
1018
- * - Changing the organization name
1019
- * - Updating the postal address
1020
- * - Setting or updating branding assets (logo_url, logo_thumbnail_url)
1021
- * - Configuring the default email signature
1022
- *
1023
- */
1024
- 'updateOrganization'(
1025
- parameters?: Parameters<Paths.UpdateOrganization.PathParameters> | null,
1026
- data?: Paths.UpdateOrganization.RequestBody,
1027
- config?: AxiosRequestConfig
1028
- ): OperationResponse<Paths.UpdateOrganization.Responses.$200>
1029
- /**
1030
- * getSettings - getSettings
1031
- *
1032
- * Retrieves all configuration settings for an organization.
1033
- *
1034
- * Returns a key-value map of all settings configured for the organization.
1035
- * Settings control various platform features and behaviors including:
1036
- * - Feature flags (e.g., double_opt_in, email_tracking)
1037
- * - Integration configurations
1038
- * - UI preferences
1039
- * - Workflow settings
1040
- *
1041
- */
1042
- 'getSettings'(
1043
- parameters?: Parameters<Paths.GetSettings.PathParameters> | null,
1044
- data?: any,
1045
- config?: AxiosRequestConfig
1046
- ): OperationResponse<Paths.GetSettings.Responses.$200>
1047
- /**
1048
- * putSettingsValue - putSettingsValue
1049
- *
1050
- * Creates or updates a specific organization setting identified by its key.
1051
- *
1052
- * The setting value can be any valid JSON type:
1053
- * - String (e.g., "en", "production")
1054
- * - Number (e.g., 100, 3.14)
1055
- * - Boolean (e.g., true, false)
1056
- * - Object (e.g., {"enabled": true, "threshold": 50})
1057
- * - Array (e.g., ["email", "sms", "push"])
1058
- *
1059
- * If the setting key does not exist, it will be created. If it exists, its value
1060
- * will be replaced with the new value.
1061
- *
1062
- */
1063
- 'putSettingsValue'(
1064
- parameters?: Parameters<Paths.PutSettingsValue.PathParameters> | null,
1065
- data?: Paths.PutSettingsValue.RequestBody,
1066
- config?: AxiosRequestConfig
1067
- ): OperationResponse<Paths.PutSettingsValue.Responses.$200>
1068
- /**
1069
- * deleteSettingsValue - deleteSettingsValue
1070
- *
1071
- * Removes a specific organization setting identified by its key.
1072
- *
1073
- * After deletion, the setting will no longer appear in the organization's settings
1074
- * and any features relying on this setting will use their default behavior.
1075
- *
1076
- */
1077
- 'deleteSettingsValue'(
1078
- parameters?: Parameters<Paths.DeleteSettingsValue.PathParameters> | null,
1079
- data?: any,
1080
- config?: AxiosRequestConfig
1081
- ): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
1082
- /**
1083
- * getOrganizationFeatureSettings - Get organization feature settings
1084
- *
1085
- * Returns feature flag metadata for the organization UI.
1086
- *
1087
- * This data is static (identical for all organizations) and changes infrequently.
1088
- * Clients should cache responses using the Cache-Control header.
1089
- *
1090
- */
1091
- 'getOrganizationFeatureSettings'(
1092
- parameters?: Parameters<UnknownParamsObject> | null,
1093
- data?: any,
1094
- config?: AxiosRequestConfig
1095
- ): OperationResponse<Paths.GetOrganizationFeatureSettings.Responses.$200>
1096
- /**
1097
- * getFeatureSettings - Get platform configuration metadata
1098
- *
1099
- * Deprecated: use /v2/organization/feature-settings instead.
1100
- */
1101
- 'getFeatureSettings'(
1102
- parameters?: Parameters<UnknownParamsObject> | null,
1103
- data?: any,
1104
- config?: AxiosRequestConfig
1105
- ): OperationResponse<Paths.GetFeatureSettings.Responses.$200>
1106
- }
1107
-
1108
- interface PathsDictionary {
1109
- ['/v2/organization/current']: {
1110
- /**
1111
- * getCurrentOrganization - getCurrentOrganization
1112
- *
1113
- * Retrieves the organization associated with the authenticated user's current session.
1114
- *
1115
- * This endpoint is useful for fetching organization details without knowing the organization ID,
1116
- * as it automatically resolves the organization from the authentication token.
1117
- *
1118
- */
1119
- 'get'(
1120
- parameters?: Parameters<UnknownParamsObject> | null,
1121
- data?: any,
1122
- config?: AxiosRequestConfig
1123
- ): OperationResponse<Paths.GetCurrentOrganization.Responses.$200>
1124
- }
1125
- ['/v2/organization/{org_id}']: {
1126
- /**
1127
- * getOrganization - getOrganization
1128
- *
1129
- * Retrieves detailed information about a specific organization by its unique identifier.
1130
- *
1131
- * Returns the organization's profile information including name, contact details,
1132
- * address, branding assets, and configuration.
1133
- *
1134
- */
1135
- 'get'(
1136
- parameters?: Parameters<Paths.GetOrganization.PathParameters> | null,
1137
- data?: any,
1138
- config?: AxiosRequestConfig
1139
- ): OperationResponse<Paths.GetOrganization.Responses.$200>
1140
- /**
1141
- * updateOrganization - updateOrganization
1142
- *
1143
- * Updates an organization's profile information.
1144
- *
1145
- * This endpoint supports partial updates - only the fields provided in the request body
1146
- * will be modified. Fields not included in the request will retain their current values.
1147
- *
1148
- * Common use cases:
1149
- * - Updating contact information (email, phone, website)
1150
- * - Changing the organization name
1151
- * - Updating the postal address
1152
- * - Setting or updating branding assets (logo_url, logo_thumbnail_url)
1153
- * - Configuring the default email signature
1154
- *
1155
- */
1156
- 'patch'(
1157
- parameters?: Parameters<Paths.UpdateOrganization.PathParameters> | null,
1158
- data?: Paths.UpdateOrganization.RequestBody,
1159
- config?: AxiosRequestConfig
1160
- ): OperationResponse<Paths.UpdateOrganization.Responses.$200>
1161
- }
1162
- ['/v2/organization/{org_id}/settings']: {
1163
- /**
1164
- * getSettings - getSettings
1165
- *
1166
- * Retrieves all configuration settings for an organization.
1167
- *
1168
- * Returns a key-value map of all settings configured for the organization.
1169
- * Settings control various platform features and behaviors including:
1170
- * - Feature flags (e.g., double_opt_in, email_tracking)
1171
- * - Integration configurations
1172
- * - UI preferences
1173
- * - Workflow settings
1174
- *
1175
- */
1176
- 'get'(
1177
- parameters?: Parameters<Paths.GetSettings.PathParameters> | null,
1178
- data?: any,
1179
- config?: AxiosRequestConfig
1180
- ): OperationResponse<Paths.GetSettings.Responses.$200>
1181
- }
1182
- ['/v2/organization/{org_id}/settings/{key}']: {
1183
- /**
1184
- * putSettingsValue - putSettingsValue
1185
- *
1186
- * Creates or updates a specific organization setting identified by its key.
1187
- *
1188
- * The setting value can be any valid JSON type:
1189
- * - String (e.g., "en", "production")
1190
- * - Number (e.g., 100, 3.14)
1191
- * - Boolean (e.g., true, false)
1192
- * - Object (e.g., {"enabled": true, "threshold": 50})
1193
- * - Array (e.g., ["email", "sms", "push"])
1194
- *
1195
- * If the setting key does not exist, it will be created. If it exists, its value
1196
- * will be replaced with the new value.
1197
- *
1198
- */
1199
- 'put'(
1200
- parameters?: Parameters<Paths.PutSettingsValue.PathParameters> | null,
1201
- data?: Paths.PutSettingsValue.RequestBody,
1202
- config?: AxiosRequestConfig
1203
- ): OperationResponse<Paths.PutSettingsValue.Responses.$200>
1204
- /**
1205
- * deleteSettingsValue - deleteSettingsValue
1206
- *
1207
- * Removes a specific organization setting identified by its key.
1208
- *
1209
- * After deletion, the setting will no longer appear in the organization's settings
1210
- * and any features relying on this setting will use their default behavior.
1211
- *
1212
- */
1213
- 'delete'(
1214
- parameters?: Parameters<Paths.DeleteSettingsValue.PathParameters> | null,
1215
- data?: any,
1216
- config?: AxiosRequestConfig
1217
- ): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
1218
- }
1219
- ['/v2/organization/feature-settings']: {
1220
- /**
1221
- * getOrganizationFeatureSettings - Get organization feature settings
1222
- *
1223
- * Returns feature flag metadata for the organization UI.
1224
- *
1225
- * This data is static (identical for all organizations) and changes infrequently.
1226
- * Clients should cache responses using the Cache-Control header.
1227
- *
1228
- */
1229
- 'get'(
1230
- parameters?: Parameters<UnknownParamsObject> | null,
1231
- data?: any,
1232
- config?: AxiosRequestConfig
1233
- ): OperationResponse<Paths.GetOrganizationFeatureSettings.Responses.$200>
1234
- }
1235
- ['/v2/feature-settings']: {
1236
- /**
1237
- * getFeatureSettings - Get platform configuration metadata
1238
- *
1239
- * Deprecated: use /v2/organization/feature-settings instead.
1240
- */
1241
- 'get'(
1242
- parameters?: Parameters<UnknownParamsObject> | null,
1243
- data?: any,
1244
- config?: AxiosRequestConfig
1245
- ): OperationResponse<Paths.GetFeatureSettings.Responses.$200>
1246
- }
1247
- }
1248
-
1249
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1250
-
1251
-
1252
- type CreateOrganizationRequest = Components.Schemas.CreateOrganizationRequest;
1253
- type DataPoint = Components.Schemas.DataPoint;
1254
- type DataPointsResponse = Components.Schemas.DataPointsResponse;
1255
- type FeatureFlagMetadata = Components.Schemas.FeatureFlagMetadata;
1256
- type FeatureSettings = Components.Schemas.FeatureSettings;
1257
- type HubspotCompaniesResponse = Components.Schemas.HubspotCompaniesResponse;
1258
- type HubspotCompany = Components.Schemas.HubspotCompany;
1259
- type HubspotOrganizationData = Components.Schemas.HubspotOrganizationData;
1260
- type I18nString = Components.Schemas.I18nString;
1261
- type InternalOrganization = Components.Schemas.InternalOrganization;
1262
- type Organization = Components.Schemas.Organization;
1263
- type OrganizationCleanupStatus = Components.Schemas.OrganizationCleanupStatus;
1264
- type OrganizationId = Components.Schemas.OrganizationId;
1265
- type OrganizationToCleanup = Components.Schemas.OrganizationToCleanup;
1266
- type SettingKey = Components.Schemas.SettingKey;
1267
- type Settings = Components.Schemas.Settings;
1268
- type SettingsValue = Components.Schemas.SettingsValue;
1269
- type VisibilityRule = Components.Schemas.VisibilityRule;
1270
-
1271
- export { type Client as C, type DataPoint as D, type FeatureFlagMetadata as F, type HubspotCompaniesResponse as H, type I18nString as I, type OperationMethods as O, Paths as P, type SettingKey as S, type VisibilityRule as V, Components as a, type PathsDictionary as b, type CreateOrganizationRequest as c, type DataPointsResponse as d, type FeatureSettings as e, type HubspotCompany as f, type HubspotOrganizationData as g, type InternalOrganization as h, type Organization as i, type OrganizationCleanupStatus as j, type OrganizationId as k, type OrganizationToCleanup as l, type Settings as m, type SettingsValue as n };