@dalmore/api-contracts 0.0.0-dev.4ec8ae0 → 0.0.0-dev.535835b

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 (704) hide show
  1. package/README.md +23 -19
  2. package/common/helpers/index.d.ts +50 -0
  3. package/common/helpers/index.js +136 -0
  4. package/common/helpers/index.js.map +1 -0
  5. package/common/types/account-contact.types.d.ts +485 -0
  6. package/common/types/account-contact.types.js +75 -0
  7. package/common/types/account-contact.types.js.map +1 -0
  8. package/common/types/account-detail.types.d.ts +304 -0
  9. package/common/types/account-detail.types.js +20 -0
  10. package/common/types/account-detail.types.js.map +1 -0
  11. package/common/types/account-integration.types.d.ts +242 -0
  12. package/common/types/account-integration.types.js +121 -0
  13. package/common/types/account-integration.types.js.map +1 -0
  14. package/common/types/account-manager.types.d.ts +917 -0
  15. package/common/types/account-manager.types.js +89 -0
  16. package/common/types/account-manager.types.js.map +1 -0
  17. package/common/types/account-setting.types.d.ts +135 -0
  18. package/common/types/account-setting.types.js +23 -0
  19. package/common/types/account-setting.types.js.map +1 -0
  20. package/common/types/account.types.d.ts +640 -0
  21. package/common/types/account.types.js +218 -0
  22. package/common/types/account.types.js.map +1 -0
  23. package/common/types/activity.types.d.ts +590 -0
  24. package/common/types/activity.types.js +258 -0
  25. package/common/types/activity.types.js.map +1 -0
  26. package/common/types/address.types.d.ts +89 -0
  27. package/common/types/address.types.js +36 -0
  28. package/common/types/address.types.js.map +1 -0
  29. package/common/types/aic.types.d.ts +434 -0
  30. package/common/types/aic.types.js +170 -0
  31. package/common/types/aic.types.js.map +1 -0
  32. package/common/types/aml.types.d.ts +41 -0
  33. package/common/types/aml.types.js +16 -0
  34. package/common/types/aml.types.js.map +1 -0
  35. package/common/types/api-key-logs.types.d.ts +204 -0
  36. package/common/types/api-key-logs.types.js +52 -0
  37. package/common/types/api-key-logs.types.js.map +1 -0
  38. package/common/types/api-keys.types.d.ts +192 -0
  39. package/common/types/api-keys.types.js +57 -0
  40. package/common/types/api-keys.types.js.map +1 -0
  41. package/common/types/asset.types.d.ts +1100 -0
  42. package/common/types/asset.types.js +353 -0
  43. package/common/types/asset.types.js.map +1 -0
  44. package/common/types/auth.types.d.ts +487 -0
  45. package/common/types/auth.types.js +279 -0
  46. package/common/types/auth.types.js.map +1 -0
  47. package/common/types/batch-jobs.types.d.ts +321 -0
  48. package/common/types/batch-jobs.types.js +111 -0
  49. package/common/types/batch-jobs.types.js.map +1 -0
  50. package/common/types/bonus-tier.types.d.ts +991 -0
  51. package/common/types/bonus-tier.types.js +166 -0
  52. package/common/types/bonus-tier.types.js.map +1 -0
  53. package/common/types/cap-table.types.d.ts +1139 -0
  54. package/common/types/cap-table.types.js +423 -0
  55. package/common/types/cap-table.types.js.map +1 -0
  56. package/common/types/cart.types.d.ts +28 -0
  57. package/common/types/cart.types.js +19 -0
  58. package/common/types/cart.types.js.map +1 -0
  59. package/common/types/checklist-items.types.d.ts +195 -0
  60. package/common/types/checklist-items.types.js +54 -0
  61. package/common/types/checklist-items.types.js.map +1 -0
  62. package/common/types/checklist.types.d.ts +140 -0
  63. package/common/types/checklist.types.js +71 -0
  64. package/common/types/checklist.types.js.map +1 -0
  65. package/common/types/common.types.d.ts +1833 -0
  66. package/common/types/common.types.js +1500 -0
  67. package/common/types/common.types.js.map +1 -0
  68. package/common/types/comply-advantage-api.types.d.ts +3626 -0
  69. package/common/types/comply-advantage-api.types.js +291 -0
  70. package/common/types/comply-advantage-api.types.js.map +1 -0
  71. package/common/types/comply-advantage.types.d.ts +48 -0
  72. package/common/types/comply-advantage.types.js +21 -0
  73. package/common/types/comply-advantage.types.js.map +1 -0
  74. package/common/types/contact-us.types.d.ts +126 -0
  75. package/common/types/contact-us.types.js +91 -0
  76. package/common/types/contact-us.types.js.map +1 -0
  77. package/common/types/countries.types.d.ts +77 -0
  78. package/common/types/countries.types.js +349 -0
  79. package/common/types/countries.types.js.map +1 -0
  80. package/common/types/covered-person.types.d.ts +204 -0
  81. package/common/types/covered-person.types.js +234 -0
  82. package/common/types/covered-person.types.js.map +1 -0
  83. package/common/types/dashboard.types.d.ts +2086 -0
  84. package/common/types/dashboard.types.js +690 -0
  85. package/common/types/dashboard.types.js.map +1 -0
  86. package/common/types/data-record.types.d.ts +347 -0
  87. package/common/types/data-record.types.js +261 -0
  88. package/common/types/data-record.types.js.map +1 -0
  89. package/common/types/data-room.types.d.ts +1277 -0
  90. package/common/types/data-room.types.js +167 -0
  91. package/common/types/data-room.types.js.map +1 -0
  92. package/common/types/default-theme-config.types.d.ts +445 -0
  93. package/common/types/default-theme-config.types.js +63 -0
  94. package/common/types/default-theme-config.types.js.map +1 -0
  95. package/common/types/disbursement-adjustment.types.d.ts +21 -0
  96. package/common/types/disbursement-adjustment.types.js +25 -0
  97. package/common/types/disbursement-adjustment.types.js.map +1 -0
  98. package/common/types/disbursement-approval-user.types.d.ts +935 -0
  99. package/common/types/disbursement-approval-user.types.js +68 -0
  100. package/common/types/disbursement-approval-user.types.js.map +1 -0
  101. package/common/types/disbursement-review.types.d.ts +923 -0
  102. package/common/types/disbursement-review.types.js +76 -0
  103. package/common/types/disbursement-review.types.js.map +1 -0
  104. package/common/types/disbursement-transaction.types.d.ts +621 -0
  105. package/common/types/disbursement-transaction.types.js +51 -0
  106. package/common/types/disbursement-transaction.types.js.map +1 -0
  107. package/common/types/disbursements.types.d.ts +3381 -0
  108. package/common/types/disbursements.types.js +408 -0
  109. package/common/types/disbursements.types.js.map +1 -0
  110. package/common/types/domain-filter.types.d.ts +135 -0
  111. package/common/types/domain-filter.types.js +40 -0
  112. package/common/types/domain-filter.types.js.map +1 -0
  113. package/common/types/email-theme.types.d.ts +1359 -0
  114. package/common/types/email-theme.types.js +318 -0
  115. package/common/types/email-theme.types.js.map +1 -0
  116. package/common/types/entity.types.d.ts +21 -0
  117. package/common/types/entity.types.js +14 -0
  118. package/common/types/entity.types.js.map +1 -0
  119. package/common/types/error-responses.types.d.ts +144 -0
  120. package/common/types/error-responses.types.js +125 -0
  121. package/common/types/error-responses.types.js.map +1 -0
  122. package/common/types/escrow-account.types.d.ts +415 -0
  123. package/common/types/escrow-account.types.js +78 -0
  124. package/common/types/escrow-account.types.js.map +1 -0
  125. package/common/types/exchange-api-key.types.d.ts +1010 -0
  126. package/common/types/exchange-api-key.types.js +90 -0
  127. package/common/types/exchange-api-key.types.js.map +1 -0
  128. package/common/types/exchange-import.types.d.ts +23 -0
  129. package/common/types/exchange-import.types.js +23 -0
  130. package/common/types/exchange-import.types.js.map +1 -0
  131. package/common/types/exchange-provider.types.d.ts +1308 -0
  132. package/common/types/exchange-provider.types.js +268 -0
  133. package/common/types/exchange-provider.types.js.map +1 -0
  134. package/common/types/file.types.d.ts +425 -0
  135. package/common/types/file.types.js +389 -0
  136. package/common/types/file.types.js.map +1 -0
  137. package/common/types/health.types.d.ts +112 -0
  138. package/common/types/health.types.js +22 -0
  139. package/common/types/health.types.js.map +1 -0
  140. package/common/types/i-will-do-it-later.types.d.ts +51 -0
  141. package/common/types/i-will-do-it-later.types.js +30 -0
  142. package/common/types/i-will-do-it-later.types.js.map +1 -0
  143. package/common/types/{index.ts → index.d.ts} +6 -3
  144. package/common/types/index.js +55 -0
  145. package/common/types/index.js.map +1 -0
  146. package/common/types/individuals.types.d.ts +1899 -0
  147. package/common/types/individuals.types.js +503 -0
  148. package/common/types/individuals.types.js.map +1 -0
  149. package/common/types/investor-account.types.d.ts +2996 -0
  150. package/common/types/investor-account.types.js +929 -0
  151. package/common/types/investor-account.types.js.map +1 -0
  152. package/common/types/investorAccountIdSchema.type.js +1 -0
  153. package/common/types/investorAccountIdSchema.type.js.map +1 -0
  154. package/common/types/investors-offering.types.d.ts +391 -0
  155. package/common/types/investors-offering.types.js +49 -0
  156. package/common/types/investors-offering.types.js.map +1 -0
  157. package/common/types/invite.types.d.ts +641 -0
  158. package/common/types/invite.types.js +113 -0
  159. package/common/types/invite.types.js.map +1 -0
  160. package/common/types/issuer-bank-account.types.d.ts +113 -0
  161. package/common/types/issuer-bank-account.types.js +81 -0
  162. package/common/types/issuer-bank-account.types.js.map +1 -0
  163. package/common/types/issuer-offering.types.d.ts +2060 -0
  164. package/common/types/issuer-offering.types.js +597 -0
  165. package/common/types/issuer-offering.types.js.map +1 -0
  166. package/common/types/issuer-payment-method.types.d.ts +1100 -0
  167. package/common/types/issuer-payment-method.types.js +311 -0
  168. package/common/types/issuer-payment-method.types.js.map +1 -0
  169. package/common/types/issuer.types.d.ts +539 -0
  170. package/common/types/issuer.types.js +275 -0
  171. package/common/types/issuer.types.js.map +1 -0
  172. package/common/types/job-item.types.d.ts +230 -0
  173. package/common/types/job-item.types.js +89 -0
  174. package/common/types/job-item.types.js.map +1 -0
  175. package/common/types/jobs.types.d.ts +296 -0
  176. package/common/types/jobs.types.js +150 -0
  177. package/common/types/jobs.types.js.map +1 -0
  178. package/common/types/kyb.types.d.ts +167 -0
  179. package/common/types/kyb.types.js +45 -0
  180. package/common/types/kyb.types.js.map +1 -0
  181. package/common/types/kyc.types.d.ts +2197 -0
  182. package/common/types/kyc.types.js +301 -0
  183. package/common/types/kyc.types.js.map +1 -0
  184. package/common/types/legal-entity.types.d.ts +638 -0
  185. package/common/types/legal-entity.types.js +148 -0
  186. package/common/types/legal-entity.types.js.map +1 -0
  187. package/common/types/login-history.types.d.ts +160 -0
  188. package/common/types/login-history.types.js +39 -0
  189. package/common/types/login-history.types.js.map +1 -0
  190. package/common/types/mail-template.types.d.ts +595 -0
  191. package/common/types/mail-template.types.js +401 -0
  192. package/common/types/mail-template.types.js.map +1 -0
  193. package/common/types/north-cap-integration.types.d.ts +1303 -0
  194. package/common/types/north-cap-integration.types.js +145 -0
  195. package/common/types/north-cap-integration.types.js.map +1 -0
  196. package/common/types/note.types.d.ts +216 -0
  197. package/common/types/note.types.js +82 -0
  198. package/common/types/note.types.js.map +1 -0
  199. package/common/types/notification.types.d.ts +2689 -0
  200. package/common/types/notification.types.js +408 -0
  201. package/common/types/notification.types.js.map +1 -0
  202. package/common/types/notion-api.types.d.ts +3626 -0
  203. package/common/types/notion-api.types.js +271 -0
  204. package/common/types/notion-api.types.js.map +1 -0
  205. package/common/types/notion-database.types.d.ts +191 -0
  206. package/common/types/notion-database.types.js +95 -0
  207. package/common/types/notion-database.types.js.map +1 -0
  208. package/common/types/notion-page.types.d.ts +3482 -0
  209. package/common/types/notion-page.types.js +208 -0
  210. package/common/types/notion-page.types.js.map +1 -0
  211. package/common/types/offering-reports.types.d.ts +525 -0
  212. package/common/types/offering-reports.types.js +111 -0
  213. package/common/types/offering-reports.types.js.map +1 -0
  214. package/common/types/offering-submission.types.d.ts +785 -0
  215. package/common/types/offering-submission.types.js +291 -0
  216. package/common/types/offering-submission.types.js.map +1 -0
  217. package/common/types/offering.types.d.ts +2849 -0
  218. package/common/types/offering.types.js +788 -0
  219. package/common/types/offering.types.js.map +1 -0
  220. package/common/types/page-revision.types.d.ts +74 -0
  221. package/common/types/page-revision.types.js +68 -0
  222. package/common/types/page-revision.types.js.map +1 -0
  223. package/common/types/page.types.d.ts +540 -0
  224. package/common/types/page.types.js +361 -0
  225. package/common/types/page.types.js.map +1 -0
  226. package/common/types/password.type.d.ts +2 -0
  227. package/common/types/password.type.js +14 -0
  228. package/common/types/password.type.js.map +1 -0
  229. package/common/types/payment-methods.types.d.ts +800 -0
  230. package/common/types/payment-methods.types.js +260 -0
  231. package/common/types/payment-methods.types.js.map +1 -0
  232. package/common/types/phone.type.d.ts +12 -0
  233. package/common/types/phone.type.js +29 -0
  234. package/common/types/phone.type.js.map +1 -0
  235. package/common/types/portfolio.types.d.ts +185 -0
  236. package/common/types/portfolio.types.js +36 -0
  237. package/common/types/portfolio.types.js.map +1 -0
  238. package/common/types/privacy-policy-and-tos.types.d.ts +2 -0
  239. package/common/types/{privacy-policy-and-tos.types.ts → privacy-policy-and-tos.types.js} +1 -1
  240. package/common/types/privacy-policy-and-tos.types.js.map +1 -0
  241. package/common/types/queue.types.d.ts +22 -0
  242. package/common/types/queue.types.js +73 -0
  243. package/common/types/queue.types.js.map +1 -0
  244. package/common/types/registered-reps.types.d.ts +6 -0
  245. package/common/types/registered-reps.types.js +21 -0
  246. package/common/types/registered-reps.types.js.map +1 -0
  247. package/common/types/rejection-reasons.types.d.ts +35 -0
  248. package/common/types/rejection-reasons.types.js +49 -0
  249. package/common/types/rejection-reasons.types.js.map +1 -0
  250. package/common/types/reports.types.d.ts +345 -0
  251. package/common/types/reports.types.js +69 -0
  252. package/common/types/reports.types.js.map +1 -0
  253. package/common/types/review.types.d.ts +419 -0
  254. package/common/types/review.types.js +101 -0
  255. package/common/types/review.types.js.map +1 -0
  256. package/common/types/role.types.d.ts +30 -0
  257. package/common/types/role.types.js +21 -0
  258. package/common/types/role.types.js.map +1 -0
  259. package/common/types/secondary-customer.types.d.ts +586 -0
  260. package/common/types/secondary-customer.types.js +39 -0
  261. package/common/types/secondary-customer.types.js.map +1 -0
  262. package/common/types/secondary-issuer.types.d.ts +283 -0
  263. package/common/types/secondary-issuer.types.js +37 -0
  264. package/common/types/secondary-issuer.types.js.map +1 -0
  265. package/common/types/secondary-order.types.d.ts +508 -0
  266. package/common/types/secondary-order.types.js +40 -0
  267. package/common/types/secondary-order.types.js.map +1 -0
  268. package/common/types/secondary-security.types.d.ts +175 -0
  269. package/common/types/secondary-security.types.js +45 -0
  270. package/common/types/secondary-security.types.js.map +1 -0
  271. package/common/types/secondary-trade.entity.d.ts +16 -0
  272. package/common/types/secondary-trade.entity.js +12 -0
  273. package/common/types/secondary-trade.entity.js.map +1 -0
  274. package/common/types/secondary-trade.types.d.ts +465 -0
  275. package/common/types/secondary-trade.types.js +61 -0
  276. package/common/types/secondary-trade.types.js.map +1 -0
  277. package/common/types/secure-request.types.d.ts +171 -0
  278. package/common/types/secure-request.types.js +51 -0
  279. package/common/types/secure-request.types.js.map +1 -0
  280. package/common/types/signer.types.d.ts +3406 -0
  281. package/common/types/signer.types.js +532 -0
  282. package/common/types/signer.types.js.map +1 -0
  283. package/common/types/site-link.types.d.ts +875 -0
  284. package/common/types/site-link.types.js +126 -0
  285. package/common/types/site-link.types.js.map +1 -0
  286. package/common/types/site-settings.types.d.ts +1673 -0
  287. package/common/types/site-settings.types.js +500 -0
  288. package/common/types/site-settings.types.js.map +1 -0
  289. package/common/types/site.types.d.ts +1481 -0
  290. package/common/types/site.types.js +213 -0
  291. package/common/types/site.types.js.map +1 -0
  292. package/common/types/sms.types.d.ts +40 -0
  293. package/common/types/sms.types.js +27 -0
  294. package/common/types/sms.types.js.map +1 -0
  295. package/common/types/state-machine.types.d.ts +591 -0
  296. package/common/types/state-machine.types.js +144 -0
  297. package/common/types/state-machine.types.js.map +1 -0
  298. package/common/types/states.types.d.ts +77 -0
  299. package/common/types/states.types.js +137 -0
  300. package/common/types/states.types.js.map +1 -0
  301. package/common/types/subdoc-preview.types.d.ts +379 -0
  302. package/common/types/subdoc-preview.types.js +24 -0
  303. package/common/types/subdoc-preview.types.js.map +1 -0
  304. package/common/types/task.types.d.ts +537 -0
  305. package/common/types/task.types.js +211 -0
  306. package/common/types/task.types.js.map +1 -0
  307. package/common/types/trade-adjustment.type.d.ts +40 -0
  308. package/common/types/trade-adjustment.type.js +26 -0
  309. package/common/types/trade-adjustment.type.js.map +1 -0
  310. package/common/types/trade-line-item.types.d.ts +329 -0
  311. package/common/types/trade-line-item.types.js +100 -0
  312. package/common/types/trade-line-item.types.js.map +1 -0
  313. package/common/types/trade.types.d.ts +2006 -0
  314. package/common/types/trade.types.js +790 -0
  315. package/common/types/trade.types.js.map +1 -0
  316. package/common/types/transaction.types.d.ts +453 -0
  317. package/common/types/transaction.types.js +173 -0
  318. package/common/types/transaction.types.js.map +1 -0
  319. package/common/types/trusted-contact.types.d.ts +440 -0
  320. package/common/types/trusted-contact.types.js +95 -0
  321. package/common/types/trusted-contact.types.js.map +1 -0
  322. package/common/types/typography.types.d.ts +52 -0
  323. package/common/types/typography.types.js +67 -0
  324. package/common/types/typography.types.js.map +1 -0
  325. package/common/types/user-manual.types.d.ts +287 -0
  326. package/common/types/user-manual.types.js +192 -0
  327. package/common/types/user-manual.types.js.map +1 -0
  328. package/common/types/user-setting.types.d.ts +273 -0
  329. package/common/types/user-setting.types.js +85 -0
  330. package/common/types/user-setting.types.js.map +1 -0
  331. package/common/types/user.types.d.ts +1999 -0
  332. package/common/types/user.types.js +244 -0
  333. package/common/types/user.types.js.map +1 -0
  334. package/common/types/webhook.types.d.ts +10829 -0
  335. package/common/types/webhook.types.js +658 -0
  336. package/common/types/webhook.types.js.map +1 -0
  337. package/common/types/zip.type.d.ts +35 -0
  338. package/common/types/zip.type.js +28 -0
  339. package/common/types/zip.type.js.map +1 -0
  340. package/contracts/clients/accounts/index.d.ts +308 -0
  341. package/contracts/clients/accounts/index.js +43 -0
  342. package/contracts/clients/accounts/index.js.map +1 -0
  343. package/contracts/clients/aic/index.d.ts +280 -0
  344. package/contracts/clients/aic/index.js +47 -0
  345. package/contracts/clients/aic/index.js.map +1 -0
  346. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  347. package/contracts/clients/api-key-logs/index.js +37 -0
  348. package/contracts/clients/api-key-logs/index.js.map +1 -0
  349. package/contracts/clients/api-keys/index.d.ts +374 -0
  350. package/contracts/clients/api-keys/index.js +59 -0
  351. package/contracts/clients/api-keys/index.js.map +1 -0
  352. package/contracts/clients/assets/index.d.ts +1050 -0
  353. package/contracts/clients/assets/index.js +80 -0
  354. package/contracts/clients/assets/index.js.map +1 -0
  355. package/contracts/clients/auth/index.d.ts +236 -0
  356. package/contracts/clients/auth/index.js +38 -0
  357. package/contracts/clients/auth/index.js.map +1 -0
  358. package/contracts/clients/cart/index.d.ts +229 -0
  359. package/contracts/clients/cart/index.js +63 -0
  360. package/contracts/clients/cart/index.js.map +1 -0
  361. package/contracts/clients/files/index.d.ts +552 -0
  362. package/contracts/clients/files/index.js +142 -0
  363. package/contracts/clients/files/index.js.map +1 -0
  364. package/contracts/clients/files-public/index.d.ts +552 -0
  365. package/contracts/clients/files-public/index.js +142 -0
  366. package/contracts/clients/files-public/index.js.map +1 -0
  367. package/contracts/clients/index.d.ts +12800 -0
  368. package/contracts/clients/index.js +52 -0
  369. package/contracts/clients/index.js.map +1 -0
  370. package/contracts/clients/individuals/index.d.ts +3199 -0
  371. package/contracts/clients/individuals/index.js +74 -0
  372. package/contracts/clients/individuals/index.js.map +1 -0
  373. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  374. package/contracts/clients/investor-accounts/index.js +73 -0
  375. package/contracts/clients/investor-accounts/index.js.map +1 -0
  376. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  377. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  378. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  379. package/contracts/clients/issuers/index.d.ts +449 -0
  380. package/contracts/clients/issuers/index.js +75 -0
  381. package/contracts/clients/issuers/index.js.map +1 -0
  382. package/contracts/clients/kyc/index.d.ts +345 -0
  383. package/contracts/clients/kyc/index.js +49 -0
  384. package/contracts/clients/kyc/index.js.map +1 -0
  385. package/contracts/clients/legal-entities/index.d.ts +887 -0
  386. package/contracts/clients/legal-entities/index.js +74 -0
  387. package/contracts/clients/legal-entities/index.js.map +1 -0
  388. package/contracts/clients/offerings/index.d.ts +1063 -0
  389. package/contracts/clients/offerings/index.js +95 -0
  390. package/contracts/clients/offerings/index.js.map +1 -0
  391. package/contracts/clients/payment-methods/index.d.ts +456 -0
  392. package/contracts/clients/payment-methods/index.js +68 -0
  393. package/contracts/clients/payment-methods/index.js.map +1 -0
  394. package/contracts/clients/secure-requests/index.d.ts +100 -0
  395. package/contracts/clients/secure-requests/index.js +22 -0
  396. package/contracts/clients/secure-requests/index.js.map +1 -0
  397. package/contracts/clients/sites/index.d.ts +657 -0
  398. package/contracts/clients/sites/index.js +40 -0
  399. package/contracts/clients/sites/index.js.map +1 -0
  400. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  401. package/contracts/clients/trade-line-items/index.js +47 -0
  402. package/contracts/clients/trade-line-items/index.js.map +1 -0
  403. package/contracts/clients/trades/index.d.ts +871 -0
  404. package/contracts/clients/trades/index.js +156 -0
  405. package/contracts/clients/trades/index.js.map +1 -0
  406. package/contracts/clients/transactions/index.d.ts +88 -0
  407. package/contracts/clients/transactions/index.js +25 -0
  408. package/contracts/clients/transactions/index.js.map +1 -0
  409. package/package.json +27 -36
  410. package/common/helpers/index.ts +0 -59
  411. package/common/types/account-contact.types.ts +0 -98
  412. package/common/types/account-detail.types.ts +0 -27
  413. package/common/types/account-integration.types.ts +0 -143
  414. package/common/types/account-manager.types.ts +0 -124
  415. package/common/types/account-setting.types.ts +0 -31
  416. package/common/types/account.types.ts +0 -296
  417. package/common/types/activity.types.ts +0 -274
  418. package/common/types/address.types.ts +0 -41
  419. package/common/types/aic.types.ts +0 -246
  420. package/common/types/aml.types.ts +0 -18
  421. package/common/types/api-key-logs.types.ts +0 -66
  422. package/common/types/api-keys.types.ts +0 -69
  423. package/common/types/asset.types.ts +0 -338
  424. package/common/types/auth.types.ts +0 -370
  425. package/common/types/batch-jobs.types.ts +0 -151
  426. package/common/types/bonus-tier.types.ts +0 -171
  427. package/common/types/cart.types.ts +0 -21
  428. package/common/types/checklist-items.types.ts +0 -70
  429. package/common/types/checklist.types.ts +0 -97
  430. package/common/types/common.types.ts +0 -1530
  431. package/common/types/comply-advantage-api.types.ts +0 -316
  432. package/common/types/comply-advantage.types.ts +0 -25
  433. package/common/types/contact-us.types.ts +0 -107
  434. package/common/types/countries.types.ts +0 -375
  435. package/common/types/covered-person.types.ts +0 -274
  436. package/common/types/dashboard.types.ts +0 -792
  437. package/common/types/data-record.types.ts +0 -325
  438. package/common/types/data-room.types.ts +0 -242
  439. package/common/types/default-theme-config.types.ts +0 -87
  440. package/common/types/disbursement-adjustment.types.ts +0 -32
  441. package/common/types/disbursement-approval-user.types.ts +0 -100
  442. package/common/types/disbursement-review.types.ts +0 -110
  443. package/common/types/disbursement-transaction.types.ts +0 -72
  444. package/common/types/disbursements.types.ts +0 -426
  445. package/common/types/domain-filter.types.ts +0 -55
  446. package/common/types/email-theme.types.ts +0 -442
  447. package/common/types/entity.types.ts +0 -15
  448. package/common/types/error-responses.types.ts +0 -135
  449. package/common/types/escrow-account.types.ts +0 -104
  450. package/common/types/exchange-api-key.types.ts +0 -121
  451. package/common/types/exchange-import.types.ts +0 -36
  452. package/common/types/exchange-provider.types.ts +0 -329
  453. package/common/types/file.types.ts +0 -477
  454. package/common/types/health.types.ts +0 -29
  455. package/common/types/i-will-do-it-later.types.ts +0 -68
  456. package/common/types/individuals.types.ts +0 -541
  457. package/common/types/investor-account.types.ts +0 -1239
  458. package/common/types/investors-offering.types.ts +0 -65
  459. package/common/types/invite.types.ts +0 -133
  460. package/common/types/issuer-bank-account.types.ts +0 -107
  461. package/common/types/issuer-offering.types.ts +0 -392
  462. package/common/types/issuer-payment-method.types.ts +0 -382
  463. package/common/types/issuer.types.ts +0 -321
  464. package/common/types/job-item.types.ts +0 -119
  465. package/common/types/jobs.types.ts +0 -171
  466. package/common/types/kyb.types.ts +0 -53
  467. package/common/types/kyc.types.ts +0 -188
  468. package/common/types/legal-entity.types.ts +0 -185
  469. package/common/types/login-history.types.ts +0 -46
  470. package/common/types/mail-template.types.ts +0 -436
  471. package/common/types/north-cap-integration.types.ts +0 -190
  472. package/common/types/note.types.ts +0 -109
  473. package/common/types/notification.types.ts +0 -268
  474. package/common/types/notion-api.types.ts +0 -374
  475. package/common/types/notion-database.types.ts +0 -125
  476. package/common/types/notion-page.types.ts +0 -267
  477. package/common/types/offering-reports.types.ts +0 -153
  478. package/common/types/offering-submission.types.ts +0 -314
  479. package/common/types/offering.types.ts +0 -676
  480. package/common/types/page-revision.types.ts +0 -86
  481. package/common/types/page.types.ts +0 -436
  482. package/common/types/password.type.ts +0 -15
  483. package/common/types/payment-methods.types.ts +0 -298
  484. package/common/types/phone.type.ts +0 -27
  485. package/common/types/portfolio.types.ts +0 -50
  486. package/common/types/queue.types.ts +0 -112
  487. package/common/types/registered-reps.types.ts +0 -25
  488. package/common/types/rejection-reasons.types.ts +0 -56
  489. package/common/types/reminder-config.types.ts +0 -40
  490. package/common/types/review.types.ts +0 -133
  491. package/common/types/role.types.ts +0 -26
  492. package/common/types/secondary-customer.types.ts +0 -66
  493. package/common/types/secondary-issuer.types.ts +0 -50
  494. package/common/types/secondary-order.types.ts +0 -58
  495. package/common/types/secondary-security.types.ts +0 -60
  496. package/common/types/secondary-trade.entity.ts +0 -16
  497. package/common/types/secondary-trade.types.ts +0 -95
  498. package/common/types/secure-request.types.ts +0 -68
  499. package/common/types/signer.types.ts +0 -651
  500. package/common/types/site-link.types.ts +0 -166
  501. package/common/types/site-settings.types.ts +0 -726
  502. package/common/types/site.types.ts +0 -263
  503. package/common/types/sms.types.ts +0 -30
  504. package/common/types/state-machine.types.ts +0 -177
  505. package/common/types/states.types.ts +0 -163
  506. package/common/types/subdoc-preview.types.ts +0 -35
  507. package/common/types/task.types.ts +0 -258
  508. package/common/types/trade-adjustment.type.ts +0 -33
  509. package/common/types/trade-line-item.types.ts +0 -125
  510. package/common/types/trade.types.ts +0 -999
  511. package/common/types/transaction.types.ts +0 -209
  512. package/common/types/trusted-contact.types.ts +0 -122
  513. package/common/types/typography.types.ts +0 -75
  514. package/common/types/user-manual.types.ts +0 -290
  515. package/common/types/user-setting.types.ts +0 -133
  516. package/common/types/user.types.ts +0 -307
  517. package/common/types/webhook.types.ts +0 -588
  518. package/common/types/zip.type.ts +0 -36
  519. package/contracts/clients/accounts/index.ts +0 -61
  520. package/contracts/clients/aic/index.ts +0 -59
  521. package/contracts/clients/api-key-logs/index.ts +0 -53
  522. package/contracts/clients/api-keys/index.ts +0 -73
  523. package/contracts/clients/assets/index.ts +0 -102
  524. package/contracts/clients/auth/index.ts +0 -50
  525. package/contracts/clients/cart/index.ts +0 -80
  526. package/contracts/clients/files/index.ts +0 -166
  527. package/contracts/clients/files-public/index.ts +0 -166
  528. package/contracts/clients/index.ts +0 -54
  529. package/contracts/clients/individuals/index.ts +0 -93
  530. package/contracts/clients/investor-accounts/index.ts +0 -93
  531. package/contracts/clients/issuer-payment-methods/index.ts +0 -39
  532. package/contracts/clients/issuers/index.ts +0 -94
  533. package/contracts/clients/legal-entities/index.ts +0 -93
  534. package/contracts/clients/offerings/index.ts +0 -117
  535. package/contracts/clients/payment-methods/index.ts +0 -85
  536. package/contracts/clients/secure-requests/index.ts +0 -34
  537. package/contracts/clients/sites/index.ts +0 -56
  538. package/contracts/clients/trade-line-items/index.ts +0 -66
  539. package/contracts/clients/trades/index.ts +0 -186
  540. package/contracts/clients/transactions/index.ts +0 -37
  541. package/contracts/compliance/account-contacts/index.ts +0 -82
  542. package/contracts/compliance/account-managers/index.ts +0 -142
  543. package/contracts/compliance/accounts/index.ts +0 -187
  544. package/contracts/compliance/activities/index.ts +0 -55
  545. package/contracts/compliance/aic/index.ts +0 -60
  546. package/contracts/compliance/api-keys/index.ts +0 -91
  547. package/contracts/compliance/assets/index.ts +0 -122
  548. package/contracts/compliance/auth/index.ts +0 -134
  549. package/contracts/compliance/batch-jobs/index.ts +0 -62
  550. package/contracts/compliance/bonus-tiers/index.ts +0 -74
  551. package/contracts/compliance/checklist/index.ts +0 -87
  552. package/contracts/compliance/checklist-items/index.ts +0 -86
  553. package/contracts/compliance/covered-persons/index.ts +0 -97
  554. package/contracts/compliance/dashboard/index.ts +0 -111
  555. package/contracts/compliance/data-records/index.ts +0 -116
  556. package/contracts/compliance/data-rooms/index.ts +0 -113
  557. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  558. package/contracts/compliance/disbursement/index.ts +0 -165
  559. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  560. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  561. package/contracts/compliance/domain-filters/index.ts +0 -117
  562. package/contracts/compliance/email-themes/index.ts +0 -284
  563. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  564. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  565. package/contracts/compliance/exchange-imports/index.ts +0 -137
  566. package/contracts/compliance/files/index.ts +0 -267
  567. package/contracts/compliance/files-public/index.ts +0 -188
  568. package/contracts/compliance/health/index.ts +0 -26
  569. package/contracts/compliance/index.ts +0 -147
  570. package/contracts/compliance/individuals/index.ts +0 -57
  571. package/contracts/compliance/investor-accounts/index.ts +0 -141
  572. package/contracts/compliance/invites/index.ts +0 -137
  573. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  574. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  575. package/contracts/compliance/issuers/index.ts +0 -97
  576. package/contracts/compliance/job-items/index.ts +0 -58
  577. package/contracts/compliance/jobs/index.ts +0 -59
  578. package/contracts/compliance/kyb/index.ts +0 -54
  579. package/contracts/compliance/kyc/index.ts +0 -77
  580. package/contracts/compliance/legal-entities/index.ts +0 -57
  581. package/contracts/compliance/login-histories/index.ts +0 -37
  582. package/contracts/compliance/notes/index.ts +0 -69
  583. package/contracts/compliance/notion-databases/index.ts +0 -107
  584. package/contracts/compliance/notion-pages/index.ts +0 -105
  585. package/contracts/compliance/offering-reports/index.ts +0 -149
  586. package/contracts/compliance/offerings/index.ts +0 -233
  587. package/contracts/compliance/pages/index.ts +0 -178
  588. package/contracts/compliance/payment-methods/index.ts +0 -57
  589. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  590. package/contracts/compliance/review/index.ts +0 -169
  591. package/contracts/compliance/roles/index.ts +0 -34
  592. package/contracts/compliance/secondary-customers/index.ts +0 -77
  593. package/contracts/compliance/secondary-orders/index.ts +0 -60
  594. package/contracts/compliance/secondary-trades/index.ts +0 -100
  595. package/contracts/compliance/secure-requests/index.ts +0 -54
  596. package/contracts/compliance/signer/index.ts +0 -369
  597. package/contracts/compliance/site-links/index.ts +0 -128
  598. package/contracts/compliance/site-settings/index.ts +0 -669
  599. package/contracts/compliance/sites/index.ts +0 -56
  600. package/contracts/compliance/state-machine/index.ts +0 -94
  601. package/contracts/compliance/tasks/index.ts +0 -91
  602. package/contracts/compliance/third-parties/index.ts +0 -52
  603. package/contracts/compliance/trade-line-items/index.ts +0 -59
  604. package/contracts/compliance/trades/index.ts +0 -230
  605. package/contracts/compliance/transactions/index.ts +0 -161
  606. package/contracts/compliance/user-manuals/index.ts +0 -271
  607. package/contracts/compliance/user-settings/index.ts +0 -189
  608. package/contracts/compliance/users/index.ts +0 -221
  609. package/contracts/compliance/webhooks/index.ts +0 -41
  610. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  611. package/contracts/compliance-apikey/index.ts +0 -14
  612. package/contracts/index.ts +0 -6
  613. package/contracts/investors/account-contacts/index.ts +0 -58
  614. package/contracts/investors/aic/index.ts +0 -59
  615. package/contracts/investors/assets/index.ts +0 -61
  616. package/contracts/investors/auth/index.ts +0 -116
  617. package/contracts/investors/bonus-tiers/index.ts +0 -55
  618. package/contracts/investors/cart/index.ts +0 -75
  619. package/contracts/investors/contact-us/index.ts +0 -48
  620. package/contracts/investors/data-records/index.ts +0 -113
  621. package/contracts/investors/data-rooms/index.ts +0 -96
  622. package/contracts/investors/files/index.ts +0 -167
  623. package/contracts/investors/files-public/index.ts +0 -185
  624. package/contracts/investors/index.ts +0 -72
  625. package/contracts/investors/individuals/index.ts +0 -121
  626. package/contracts/investors/investor-accounts/index.ts +0 -110
  627. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  628. package/contracts/investors/issuers/index.ts +0 -30
  629. package/contracts/investors/legal-entities/index.ts +0 -93
  630. package/contracts/investors/notes/index.ts +0 -69
  631. package/contracts/investors/offerings/index.ts +0 -93
  632. package/contracts/investors/pages/index.ts +0 -88
  633. package/contracts/investors/payment-methods/index.ts +0 -149
  634. package/contracts/investors/portfolios/index.ts +0 -53
  635. package/contracts/investors/sites/index.ts +0 -96
  636. package/contracts/investors/tasks/index.ts +0 -111
  637. package/contracts/investors/trade-line-items/index.ts +0 -75
  638. package/contracts/investors/trades/index.ts +0 -114
  639. package/contracts/investors/transactions/index.ts +0 -37
  640. package/contracts/investors/trusted-contacts/index.ts +0 -93
  641. package/contracts/investors/user-manuals/index.ts +0 -62
  642. package/contracts/investors/user-settings/index.ts +0 -170
  643. package/contracts/investors/users/index.ts +0 -45
  644. package/contracts/investors/webhooks/index.ts +0 -30
  645. package/contracts/issuers/account-contacts/index.ts +0 -76
  646. package/contracts/issuers/account-integrations/index.ts +0 -97
  647. package/contracts/issuers/accounts/index.ts +0 -97
  648. package/contracts/issuers/activities/index.ts +0 -54
  649. package/contracts/issuers/aic/index.ts +0 -39
  650. package/contracts/issuers/api-key-logs/index.ts +0 -53
  651. package/contracts/issuers/api-keys/index.ts +0 -93
  652. package/contracts/issuers/assets/index.ts +0 -122
  653. package/contracts/issuers/auth/index.ts +0 -152
  654. package/contracts/issuers/bonus-tiers/index.ts +0 -73
  655. package/contracts/issuers/contact-us/index.ts +0 -48
  656. package/contracts/issuers/covered-persons/index.ts +0 -136
  657. package/contracts/issuers/dashboard/index.ts +0 -72
  658. package/contracts/issuers/data-records/index.ts +0 -257
  659. package/contracts/issuers/data-rooms/index.ts +0 -134
  660. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  661. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  662. package/contracts/issuers/disbursements/index.ts +0 -189
  663. package/contracts/issuers/email-themes/index.ts +0 -242
  664. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  665. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  666. package/contracts/issuers/files/index.ts +0 -166
  667. package/contracts/issuers/files-public/index.ts +0 -166
  668. package/contracts/issuers/health/index.ts +0 -24
  669. package/contracts/issuers/index.ts +0 -112
  670. package/contracts/issuers/investor-accounts/index.ts +0 -148
  671. package/contracts/issuers/invites/index.ts +0 -129
  672. package/contracts/issuers/issuer/index.ts +0 -94
  673. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  674. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  675. package/contracts/issuers/kyc/index.ts +0 -38
  676. package/contracts/issuers/login-histories/index.ts +0 -51
  677. package/contracts/issuers/notes/index.ts +0 -69
  678. package/contracts/issuers/offerings/index.ts +0 -206
  679. package/contracts/issuers/pages/index.ts +0 -138
  680. package/contracts/issuers/payment-methods/index.ts +0 -61
  681. package/contracts/issuers/portfolios/index.ts +0 -36
  682. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  683. package/contracts/issuers/review/index.ts +0 -63
  684. package/contracts/issuers/secondary-customers/index.ts +0 -55
  685. package/contracts/issuers/secondary-orders/index.ts +0 -57
  686. package/contracts/issuers/secondary-trades/index.ts +0 -57
  687. package/contracts/issuers/secure-requests/index.ts +0 -34
  688. package/contracts/issuers/site-links/index.ts +0 -116
  689. package/contracts/issuers/site-settings/index.ts +0 -585
  690. package/contracts/issuers/sites/index.ts +0 -32
  691. package/contracts/issuers/tasks/index.ts +0 -111
  692. package/contracts/issuers/trades/index.ts +0 -132
  693. package/contracts/issuers/transactions/index.ts +0 -158
  694. package/contracts/issuers/user-manuals/index.ts +0 -62
  695. package/contracts/issuers/user-settings/index.ts +0 -170
  696. package/contracts/issuers/users/index.ts +0 -126
  697. package/contracts/secondaries/accounts/index.ts +0 -58
  698. package/contracts/secondaries/index.ts +0 -23
  699. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  700. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  701. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  702. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  703. package/contracts/secondaries/secondary-trades/index.ts +0 -56
  704. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -0,0 +1,788 @@
1
+ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
+ import { TypeID } from 'typeid-js';
3
+ import { z } from 'zod';
4
+ import { accountIdSchema } from './account.types.js';
5
+ import { capShareClassIdSchema } from './cap-table.types.js';
6
+ import { AccountZod, ComplianceReview, dateSchema, IPaginationMeta, OfferingType, ManagedByType, PaginationOptionsZod, UrlSchema, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType, StringToBooleanSchema, HttpMethod, numberPrecisionSchema, WarrantSharesCalculationMethod, } from './common.types.js';
7
+ import { IBaseEntity } from './entity.types.js';
8
+ import { fileIdSchema, FileZod } from './file.types.js';
9
+ import { IIssuer, issuerIdSchema } from './issuer.types.js';
10
+ import { InvestorsOfferingFiltersZod, InvestorsOfferingsIncludeQuery, } from './investors-offering.types.js';
11
+ import { escrowValidationRefinement, postOfferingRefinement, warrantsValidationRefinement, } from './issuer-offering.types.js';
12
+ import { postAssetRefinement, AssetTemplateType } from './asset.types.js';
13
+ import { IIssuerBankAccount, issuerBankAccountIdSchema, } from './issuer-bank-account.types.js';
14
+ import { escrowAccountIdSchema, IEscrowAccount } from './escrow-account.types.js';
15
+ import { BonusTierListZod, postBonusTierRefinement } from './bonus-tier.types.js';
16
+ export var OfferingFeeType;
17
+ (function (OfferingFeeType) {
18
+ OfferingFeeType["FIXED"] = "FIXED";
19
+ OfferingFeeType["PERCENTAGE"] = "PERCENTAGE";
20
+ })(OfferingFeeType || (OfferingFeeType = {}));
21
+ extendZodWithOpenApi(z);
22
+ export const offeringIdSchema = z.string().refine((value) => {
23
+ try {
24
+ const tid = TypeID.fromString(value);
25
+ return tid.getType() === 'offering';
26
+ }
27
+ catch {
28
+ return false;
29
+ }
30
+ }, {
31
+ message: `Invalid offering ID format. Must be a valid TypeID with "offering" prefix. Example: offering_01j5y5ghx5fg68d663j1fvy2x7`,
32
+ });
33
+ export const offeringRevisionIdSchema = z.string().refine((value) => {
34
+ try {
35
+ const tid = TypeID.fromString(value);
36
+ return tid.getType() === 'offering_revision';
37
+ }
38
+ catch {
39
+ return false;
40
+ }
41
+ }, {
42
+ message: `Invalid offering revision ID format. Must be a valid TypeID with "offering_revision" prefix. Example: offering_revision_01j5y5ghx5fg68d663j1fvy2x7`,
43
+ });
44
+ export const OfferingPlatformSettings = z.object({
45
+ backOfficePortal: z.string(),
46
+ username: z.string().nullable(),
47
+ password: z.string().nullable(),
48
+ apiKey: z.string().nullable(),
49
+ });
50
+ export const IOffering = IBaseEntity.extend({
51
+ name: z.string(),
52
+ tid: z.string().nullable(),
53
+ type: z.nativeEnum(OfferingType).nullable(),
54
+ description: z.string().nullable(),
55
+ raiseAmount: z.number().nullable(),
56
+ targetAmount: z.number().nullable(),
57
+ minInvestment: z.number().nullable(),
58
+ maxInvestment: z.number().nullable(),
59
+ contingencyAmount: z.number().nullable(),
60
+ startAt: z.date().nullable(),
61
+ endAt: z.date().nullable(),
62
+ platform: z.string(),
63
+ platformSettings: z.string().nullable(),
64
+ enabled: z.boolean(),
65
+ accountId: z.string().nullable(),
66
+ account: AccountZod.optional().nullable(),
67
+ issuer: z
68
+ .lazy(() => IIssuer)
69
+ .optional()
70
+ .nullable(), // Use z.lazy here
71
+ issuerId: z.string().nullable(),
72
+ coverArtId: z
73
+ .lazy(() => fileIdSchema)
74
+ .nullable()
75
+ .optional(),
76
+ coverArt: z.lazy(() => FileZod).nullable(),
77
+ cancellationPeriod: z.number().nullable(),
78
+ memorandumId: z
79
+ .lazy(() => fileIdSchema)
80
+ .nullable()
81
+ .optional(),
82
+ subscriptionAgreementId: z
83
+ .lazy(() => fileIdSchema)
84
+ .nullable()
85
+ .optional(),
86
+ managedBy: z.nativeEnum(ManagedByType).nullable(),
87
+ valuationCap: z.number().nullable(),
88
+ showTotalRaised: z.boolean().optional(),
89
+ hasEscrow: z.boolean().optional(),
90
+ escrowAgreementFileId: z.string().nullable().optional(),
91
+ bankAccountId: z.string().nullable().optional(),
92
+ bankAccount: z
93
+ .lazy(() => IIssuerBankAccount)
94
+ .nullable()
95
+ .optional(),
96
+ escrowAccountId: z.string().nullable().optional(),
97
+ escrowAccount: z
98
+ .lazy(() => IEscrowAccount)
99
+ .nullable()
100
+ .optional(),
101
+ warrantsEnabled: z.boolean().optional(),
102
+ totalShares: z.number().nullable().optional(),
103
+ warrantTermYears: z.number().nullable().optional(),
104
+ exercisePrice: z.number().nullable().optional(),
105
+ warrantPercentage: z.number().nullable().optional(),
106
+ calculationMethod: z
107
+ .nativeEnum(WarrantSharesCalculationMethod)
108
+ .nullable()
109
+ .optional(),
110
+ incrementThreshold: z.number().nullable().optional(),
111
+ fullyDilutedShares: z.number().nullable().optional(),
112
+ shareClassId: z.string().nullable().optional(),
113
+ });
114
+ export const IPaginatedOffering = z.object({
115
+ items: z.array(IOffering),
116
+ meta: IPaginationMeta,
117
+ });
118
+ export const PatchOfferingBase = z.object({
119
+ name: z.string().optional(),
120
+ description: z.string().nullable().optional(),
121
+ tid: z.string().optional(),
122
+ type: z.nativeEnum(OfferingType).optional(),
123
+ targetAmount: z.number().min(0.01).max(10000000000).optional(),
124
+ raiseAmount: z
125
+ .number()
126
+ .min(0.01)
127
+ .max(10000000000)
128
+ .openapi({ example: 5000 })
129
+ .optional(),
130
+ minInvestment: z
131
+ .number()
132
+ .min(0.01)
133
+ .max(10000000000)
134
+ .openapi({ example: 5000 })
135
+ .optional()
136
+ .nullable(),
137
+ maxInvestment: z
138
+ .number()
139
+ .min(0.01)
140
+ .max(10000000000)
141
+ .openapi({ example: 5000 })
142
+ .optional()
143
+ .nullable(),
144
+ contingencyAmount: z
145
+ .number()
146
+ .min(0.0)
147
+ .max(10000000000)
148
+ .openapi({ example: 5000 })
149
+ .optional()
150
+ .nullable(),
151
+ startAt: dateSchema.optional().openapi({ example: '10/20/2024' }),
152
+ endAt: dateSchema.optional().openapi({ example: '10/27/2024' }),
153
+ platform: z.string().optional(),
154
+ coverArtId: z
155
+ .lazy(() => fileIdSchema)
156
+ .nullable()
157
+ .optional(),
158
+ platformSettings: OfferingPlatformSettings.optional().transform((val) => val ? JSON.stringify(val) : null),
159
+ enabled: z.boolean().optional(),
160
+ entitySubscriptionAgreementTemplateId: z.string().optional().nullable(),
161
+ managedBy: z.nativeEnum(ManagedByType).optional(),
162
+ subscriptionAgreementTemplateId: z.string().optional().nullable(),
163
+ memorandumId: z
164
+ .lazy(() => fileIdSchema)
165
+ .nullable()
166
+ .optional(),
167
+ subscriptionAgreementId: z
168
+ .lazy(() => fileIdSchema)
169
+ .nullable()
170
+ .optional(),
171
+ jointSubscriptionAgreementTemplateId: z.string().optional().nullable(),
172
+ cancellationPeriod: z.number().min(1).max(30).optional().nullable(),
173
+ showTotalRaised: z.boolean().optional(),
174
+ issuerId: issuerIdSchema.optional(),
175
+ shareClassId: z
176
+ .lazy(() => capShareClassIdSchema)
177
+ .nullable()
178
+ .optional(),
179
+ });
180
+ export const PatchOffering = PatchOfferingBase.merge(z.object({
181
+ assetName: z
182
+ .string()
183
+ .min(2)
184
+ .max(50)
185
+ .optional()
186
+ .openapi({ example: 'Asset name' }),
187
+ assetType: z
188
+ .nativeEnum(AssetType)
189
+ .optional()
190
+ .openapi({ example: AssetType.STOCK }),
191
+ pricePerUnit: z
192
+ .number()
193
+ .min(0.01)
194
+ .max(10000000000)
195
+ .nullable()
196
+ .optional()
197
+ .openapi({ example: 2000 }),
198
+ totalUnits: z
199
+ .number()
200
+ .min(1)
201
+ .max(10000000000)
202
+ .nullable()
203
+ .optional()
204
+ .openapi({ example: 5200 }),
205
+ yield: z
206
+ .number()
207
+ .min(0.01)
208
+ .max(10000000000)
209
+ .nullable()
210
+ .optional()
211
+ .openapi({ example: 1200 }),
212
+ duration: z
213
+ .number()
214
+ .min(1)
215
+ .max(1000)
216
+ .nullable()
217
+ .optional()
218
+ .openapi({ example: 1 }),
219
+ durationType: z
220
+ .nativeEnum(DurationType)
221
+ .nullable()
222
+ .optional()
223
+ .openapi({ example: DurationType.DAY }),
224
+ template: z
225
+ .nativeEnum(AssetTemplateType)
226
+ .default(AssetTemplateType.STANDARD)
227
+ .openapi({ example: AssetTemplateType.STANDARD })
228
+ .nullable()
229
+ .optional(),
230
+ tiers: z.array(z.number().positive()).nullable().optional(),
231
+ enableBonus: z.boolean().optional(),
232
+ interestRate: z
233
+ .number()
234
+ .min(0.01)
235
+ .max(100)
236
+ .nullable()
237
+ .optional()
238
+ .openapi({ example: 10 }),
239
+ bonusTiers: BonusTierListZod.optional(),
240
+ hasEscrow: z.boolean().optional(),
241
+ bankAccountId: z
242
+ .lazy(() => issuerBankAccountIdSchema)
243
+ .nullable()
244
+ .optional(),
245
+ escrowAccountId: z
246
+ .lazy(() => escrowAccountIdSchema)
247
+ .nullable()
248
+ .optional(),
249
+ escrowAgreementFileId: z
250
+ .lazy(() => fileIdSchema)
251
+ .nullable()
252
+ .optional(),
253
+ warrantsEnabled: z.boolean().optional().openapi({ example: false }),
254
+ totalShares: z
255
+ .number()
256
+ .int()
257
+ .positive()
258
+ .max(10000000000)
259
+ .nullable()
260
+ .optional()
261
+ .openapi({ example: 1000 }),
262
+ warrantTermYears: z
263
+ .number()
264
+ .int()
265
+ .positive()
266
+ .max(10000000000)
267
+ .nullable()
268
+ .optional()
269
+ .openapi({ example: 10 }),
270
+ exercisePrice: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
271
+ .nullable()
272
+ .optional()
273
+ .openapi({ example: 100 }),
274
+ warrantPercentage: numberPrecisionSchema(2, z.number().positive().max(100))
275
+ .nullable()
276
+ .optional()
277
+ .openapi({ example: 10 }),
278
+ calculationMethod: z
279
+ .nativeEnum(WarrantSharesCalculationMethod)
280
+ .nullable()
281
+ .optional()
282
+ .openapi({ example: WarrantSharesCalculationMethod.NONE }),
283
+ incrementThreshold: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
284
+ .nullable()
285
+ .optional()
286
+ .openapi({ example: 10 }),
287
+ }));
288
+ /**
289
+ * Optional params for resolveAndValidateOfferingUpdateFields.
290
+ * All fields are optional and nullable; resolution merges with offering/asset values.
291
+ */
292
+ export const ResolveOfferingUpdateFieldsParamsZod = z.object({
293
+ minInvestment: z.number().nullable().optional(),
294
+ maxInvestment: z.number().nullable().optional(),
295
+ targetAmount: z.number().nullable().optional(),
296
+ pricePerUnit: z.number().nullable().optional(),
297
+ });
298
+ /**
299
+ * Resolved, validated offering update fields (price per unit, target amount, min/max investment).
300
+ * Returned by resolveAndValidateOfferingUpdateFields and passed into validateBonusTiersForUpdate.
301
+ */
302
+ export const ResolvedOfferingUpdateFieldsZod = z.object({
303
+ pricePerUnit: z.number(),
304
+ targetAmount: z.number(),
305
+ minInvestment: z.number().nullable(),
306
+ maxInvestment: z.number().nullable(),
307
+ });
308
+ export const PostComplianceOffering = PatchOfferingBase.merge(z.object({
309
+ accountId: z.lazy(() => accountIdSchema),
310
+ managedBy: z.nativeEnum(ManagedByType).optional(),
311
+ shareClassId: z
312
+ .lazy(() => capShareClassIdSchema)
313
+ .nullable()
314
+ .optional()
315
+ .openapi({ example: 'cap_table_share_class_01j1xgme...' }),
316
+ assetName: z.string().min(2).max(50).openapi({ example: 'Asset name' }),
317
+ assetType: z.nativeEnum(AssetType).openapi({ example: AssetType.STOCK }),
318
+ pricePerUnit: z
319
+ .number()
320
+ .min(0.01)
321
+ .max(10000000000)
322
+ .nullable()
323
+ .openapi({ example: 2000 }),
324
+ totalUnits: z
325
+ .number()
326
+ .min(1)
327
+ .max(10000000000)
328
+ .nullable()
329
+ .openapi({ example: 5200 }),
330
+ yield: z
331
+ .number()
332
+ .min(0.01)
333
+ .max(10000000000)
334
+ .nullable()
335
+ .optional()
336
+ .openapi({ example: 1200 }),
337
+ duration: z
338
+ .number()
339
+ .min(1)
340
+ .max(1000)
341
+ .nullable()
342
+ .optional()
343
+ .openapi({ example: 1 }),
344
+ durationType: z
345
+ .nativeEnum(DurationType)
346
+ .nullable()
347
+ .optional()
348
+ .openapi({ example: DurationType.DAY }),
349
+ template: z
350
+ .nativeEnum(AssetTemplateType)
351
+ .default(AssetTemplateType.STANDARD)
352
+ .openapi({ example: AssetTemplateType.STANDARD }),
353
+ tiers: z.array(z.number().positive()).nullable().optional(),
354
+ enableBonus: z.boolean().default(false).optional(),
355
+ hasEscrow: z.boolean().optional(),
356
+ bankAccountId: z
357
+ .lazy(() => issuerBankAccountIdSchema)
358
+ .nullable()
359
+ .optional(),
360
+ escrowAccountId: z
361
+ .lazy(() => escrowAccountIdSchema)
362
+ .nullable()
363
+ .optional(),
364
+ interestRate: z
365
+ .number()
366
+ .min(0.01)
367
+ .max(100)
368
+ .nullable()
369
+ .optional()
370
+ .openapi({ example: 10 }),
371
+ bonusTiers: BonusTierListZod.optional(),
372
+ warrantsEnabled: z
373
+ .boolean()
374
+ .optional()
375
+ .default(false)
376
+ .openapi({ example: false }),
377
+ totalShares: z
378
+ .number()
379
+ .int()
380
+ .positive()
381
+ .max(10000000000)
382
+ .nullable()
383
+ .optional()
384
+ .openapi({ example: 1000 }),
385
+ warrantTermYears: z
386
+ .number()
387
+ .int()
388
+ .positive()
389
+ .max(10000000000)
390
+ .nullable()
391
+ .optional()
392
+ .openapi({ example: 10 }),
393
+ exercisePrice: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
394
+ .nullable()
395
+ .optional()
396
+ .openapi({ example: 100 }),
397
+ warrantPercentage: numberPrecisionSchema(2, z.number().positive().max(100))
398
+ .nullable()
399
+ .optional()
400
+ .openapi({ example: 10 }),
401
+ calculationMethod: z
402
+ .nativeEnum(WarrantSharesCalculationMethod)
403
+ .nullable()
404
+ .optional()
405
+ .openapi({ example: WarrantSharesCalculationMethod.NONE }),
406
+ incrementThreshold: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
407
+ .nullable()
408
+ .optional()
409
+ .openapi({ example: 10 }),
410
+ })).superRefine((data, ctx) => {
411
+ postOfferingRefinement(data, ctx);
412
+ postAssetRefinement(data, ctx);
413
+ escrowValidationRefinement(data, ctx, HttpMethod.POST);
414
+ postBonusTierRefinement(data, ctx);
415
+ warrantsValidationRefinement(data, ctx);
416
+ });
417
+ export const offeringsInclude = z.enum([
418
+ 'account',
419
+ 'issuer',
420
+ 'trades',
421
+ 'assets',
422
+ 'disbursements',
423
+ 'draftVersion',
424
+ 'publishedVersion',
425
+ 'revisions',
426
+ 'onboardingReviewedBy',
427
+ 'bankAccount',
428
+ 'escrowAccount',
429
+ 'shareClass',
430
+ ]);
431
+ /**
432
+ * @description Query parameters for including related entities
433
+ * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
434
+ */
435
+ export const OfferingsIncludeQuery = z.object({
436
+ include: z
437
+ .string()
438
+ .optional()
439
+ .transform((str) => (str ? str.split(',') : []))
440
+ .refine((includes) => includes.every((include) => offeringsInclude.options.includes(include)), {
441
+ message: `Invalid include option provided. Valid options are: ${offeringsInclude.options.join(',')}`,
442
+ })
443
+ .openapi({
444
+ example: `${offeringsInclude.options.join(',')}`,
445
+ }),
446
+ });
447
+ /**
448
+ * Filters supported for querying offerings.
449
+ *
450
+ * Available fields:
451
+ * - `issuerName`: (string, optional) Filter by name of the issuer.
452
+ * - `name`: (string, optional) Filter by offering name.
453
+ * - `accountId`: (AccountId, optional) Filter by tenant/account ID.
454
+ * - `issuerId`: (IssuerId, optional) Filter by issuer ID.
455
+ * - `type`: (OfferingType, optional) Filter by offering type.
456
+ * - `status`: (ComplianceReview, optional) Filter by compliance review status.
457
+ * - `enabled`: (boolean, optional) Filter for enabled/active offerings.
458
+ * - `managedBy`: (ManagedByType, optional) Filter by which system or user manages the offering.
459
+ * - `versioningType`: (OfferingVersioningType, optional) Filter by versioning strategy.
460
+ * - `onboardingStatus`: (OfferingOnboardingStatus, optional) Filter by issuer onboarding status.
461
+ *
462
+ * @remarks
463
+ * These filters can be combined to query offerings across multiple dimensions.
464
+ *
465
+ * Example use:
466
+ * ```ts
467
+ * { issuerName: "ABC Capital", type: OfferingType.REG_A }
468
+ * ```
469
+ */
470
+ export const OfferingFiltersZod = z.object({
471
+ issuerName: z.string().optional(),
472
+ name: z.string().optional(),
473
+ accountId: accountIdSchema.optional(),
474
+ issuerId: z.lazy(() => issuerIdSchema).optional(),
475
+ type: z.nativeEnum(OfferingType).optional(),
476
+ status: z.nativeEnum(ComplianceReview).optional(),
477
+ enabled: StringToBooleanSchema.optional(),
478
+ managedBy: z.nativeEnum(ManagedByType).optional(),
479
+ versioningType: z.nativeEnum(OfferingVersioningType).optional(),
480
+ onboardingStatus: z.nativeEnum(OfferingOnboardingStatus).optional(),
481
+ complianceReview: z.nativeEnum(ComplianceReview).optional(),
482
+ });
483
+ export const OfferingSortZod = z.object({
484
+ sort: z.enum([SortBy.NAME, SortBy.CREATED_AT, SortBy.UPDATED_AT]).optional(),
485
+ dir: z.nativeEnum(SortOrder).optional(),
486
+ });
487
+ export const OfferingSummaryFiltersZod = z.object({
488
+ accountId: accountIdSchema.optional(),
489
+ hasPendingTrades: z.coerce.boolean().optional(),
490
+ });
491
+ export const OfferingSummaryResponseZod = z.object({
492
+ id: z.lazy(() => offeringIdSchema),
493
+ name: z.string(),
494
+ account: z.object({ id: z.lazy(() => accountIdSchema), name: z.string() }),
495
+ trades: z.object({
496
+ total: z.number(),
497
+ tradeReview: z.number(),
498
+ readyForDisbursement: z.number(),
499
+ }),
500
+ });
501
+ export const PaginatedOfferingSummaryResponseZod = z.object({
502
+ items: z.array(OfferingSummaryResponseZod),
503
+ meta: IPaginationMeta,
504
+ });
505
+ const BaseOfferingSettings = z.object({
506
+ settingsBrokerageFeeValue: z.number().nonnegative().nullable().optional(),
507
+ settingsBrokerageFeeType: z.nativeEnum(OfferingFeeType).nullable().optional(),
508
+ settingsCardFeeValue: z.number().nonnegative().nullable().optional(),
509
+ settingsCardFeeType: z.nativeEnum(OfferingFeeType).nullable().optional(),
510
+ settingsDisbursementFeeValue: z.number().nonnegative().nullable().optional(),
511
+ settingsDisbursementFeeType: z
512
+ .nativeEnum(OfferingFeeType)
513
+ .nullable()
514
+ .optional(),
515
+ settingsRefundPoolFeeValue: z.number().nonnegative().nullable().optional(),
516
+ settingsRefundPoolFeeType: z
517
+ .nativeEnum(OfferingFeeType)
518
+ .nullable()
519
+ .optional(),
520
+ serviceChargesType: z.nativeEnum(OfferingFeeType).nullable().optional(),
521
+ serviceCharges: z.number().nonnegative().nullable().optional(),
522
+ });
523
+ export const OfferingSettings = BaseOfferingSettings.refine((data) => (data.settingsBrokerageFeeType === null &&
524
+ data.settingsBrokerageFeeValue === null) ||
525
+ (data.settingsBrokerageFeeType !== null &&
526
+ data.settingsBrokerageFeeValue !== null), {
527
+ message: 'settingsBrokerageFeeType and settingsBrokerageFeeValue must both be either null or not-null',
528
+ })
529
+ .refine((data) => (data.serviceChargesType === null && data.serviceCharges === null) ||
530
+ (data.serviceChargesType !== null && data.serviceCharges !== null), {
531
+ message: 'serviceChargesType and serviceCharges must both be either null or not-null',
532
+ })
533
+ .refine((data) => (data.settingsCardFeeType === null &&
534
+ data.settingsCardFeeValue === null) ||
535
+ (data.settingsCardFeeType !== null && data.settingsCardFeeValue !== null), {
536
+ message: 'settingsCardFeeType and settingsCardFeeValue must both be either null or not-null',
537
+ })
538
+ .refine((data) => (data.settingsDisbursementFeeType === null &&
539
+ data.settingsDisbursementFeeValue === null) ||
540
+ (data.settingsDisbursementFeeType !== null &&
541
+ data.settingsDisbursementFeeValue !== null), {
542
+ message: 'settingsDisbursementFeeType and settingsDisbursementFeeValue must both be either null or not-null',
543
+ })
544
+ .refine((data) => (data.settingsRefundPoolFeeType === null &&
545
+ data.settingsRefundPoolFeeValue === null) ||
546
+ (data.settingsRefundPoolFeeType !== null &&
547
+ data.settingsRefundPoolFeeValue !== null), {
548
+ message: 'settingsRefundPoolFeeType and settingsRefundPoolFeeValue must both be either null or not-null',
549
+ })
550
+ .refine((data) => data.settingsBrokerageFeeType !== OfferingFeeType.PERCENTAGE ||
551
+ (data.settingsBrokerageFeeValue !== null &&
552
+ data.settingsBrokerageFeeValue <= 100), {
553
+ message: 'settingsBrokerageFeeValue must be less than or equal to 100',
554
+ })
555
+ .refine((data) => data.settingsRefundPoolFeeType !== OfferingFeeType.PERCENTAGE ||
556
+ (data.settingsRefundPoolFeeValue !== null &&
557
+ data.settingsRefundPoolFeeValue <= 100), {
558
+ message: 'settingsRefundPoolFeeValue must be less than or equal to 100',
559
+ })
560
+ .refine((data) => data.settingsCardFeeType !== OfferingFeeType.PERCENTAGE ||
561
+ (data.settingsCardFeeValue !== null && data.settingsCardFeeValue <= 100), {
562
+ message: 'settingsCardFeeValue must be less than or equal to 100',
563
+ })
564
+ .refine((data) => data.settingsDisbursementFeeType !== OfferingFeeType.PERCENTAGE ||
565
+ (data.settingsDisbursementFeeValue !== null &&
566
+ data.settingsDisbursementFeeValue <= 100), {
567
+ message: 'settingsDisbursementFeeValue must be less than 100',
568
+ });
569
+ export const PatchComplianceOffering = z
570
+ .intersection(PatchOffering, OfferingSettings)
571
+ .superRefine((data, ctx) => {
572
+ // Check if both values are present, and if so, ensure minInvestment is less than maxInvestment
573
+ if (typeof data.minInvestment === 'number' &&
574
+ typeof data.maxInvestment === 'number') {
575
+ if (data.minInvestment >= data.maxInvestment) {
576
+ ctx.addIssue({
577
+ code: z.ZodIssueCode.custom,
578
+ message: 'Minimum investment must be less than maximum investment.',
579
+ path: ['minInvestment'],
580
+ });
581
+ }
582
+ }
583
+ // Apply escrow-specific refinements
584
+ escrowValidationRefinement(data, ctx, HttpMethod.PATCH);
585
+ // Apply bonus-tier-specific refinements
586
+ postBonusTierRefinement(data, ctx);
587
+ });
588
+ export const IComplianceOffering = z.intersection(IOffering, OfferingSettings);
589
+ export const IPaginatedComplianceOffering = z.object({
590
+ items: z.array(IComplianceOffering),
591
+ meta: IPaginationMeta,
592
+ });
593
+ export const ReviewOfferings = z.object({
594
+ complianceReview: z.enum([
595
+ ComplianceReview.APPROVED,
596
+ ComplianceReview.REJECTED,
597
+ ]),
598
+ offerings: z
599
+ .array(offeringIdSchema)
600
+ .min(1, 'At least one offering is required')
601
+ .max(50, 'Maximum of 50 offerings allowed')
602
+ .openapi({
603
+ example: [
604
+ 'offering_01jjsdrx1seqfse7z4z47sgdp5',
605
+ 'offering_01jjsdrx27enkszq5cnc3hdhrf',
606
+ ],
607
+ }),
608
+ });
609
+ export const OfferingDetailsResponseZod = z.object({
610
+ raisedAmount: z.number(),
611
+ investors: z.number().int(),
612
+ minInvestment: z.number(),
613
+ maxInvestment: z.number(),
614
+ valuationCap: z.number(),
615
+ targetAmount: z.number(),
616
+ });
617
+ export const OfferingsArrayQueryZod = z.object({
618
+ offerings: z
619
+ .string()
620
+ .optional()
621
+ .transform((val) => {
622
+ if (!val)
623
+ return undefined;
624
+ return val.split(',').map((id) => id.trim());
625
+ })
626
+ .pipe(z
627
+ .array(z.string())
628
+ .optional()
629
+ .refine((val) => {
630
+ if (!val)
631
+ return true;
632
+ return val.every((id) => {
633
+ try {
634
+ const tid = TypeID.fromString(id);
635
+ return tid.getType() === 'offering';
636
+ }
637
+ catch {
638
+ return false;
639
+ }
640
+ });
641
+ }, {
642
+ message: 'Invalid offering IDs format. Must be a valid TypeID with "offering" prefix.',
643
+ })),
644
+ });
645
+ export const OfferingRaiseAmountResponseZod = z.object({
646
+ offeringId: z.lazy(() => offeringIdSchema),
647
+ totalRaisedAmount: z.number(),
648
+ });
649
+ export const PublicOfferingFiltersZod = PaginationOptionsZod.merge(InvestorsOfferingsIncludeQuery)
650
+ .merge(InvestorsOfferingFiltersZod)
651
+ .extend({
652
+ url: UrlSchema,
653
+ });
654
+ export const PendingOfferingSummaryResponseZod = z.object({
655
+ id: z.lazy(() => offeringIdSchema),
656
+ name: z.string(),
657
+ assets: z.number(),
658
+ issuerName: z.string(),
659
+ issuerId: z.string(),
660
+ accountName: z.string(),
661
+ accountId: z.string(),
662
+ targetAmount: z.number().nullable(),
663
+ startAt: z.date().nullable(),
664
+ offeringType: z.nativeEnum(OfferingType),
665
+ });
666
+ export const PaginatedPendingOfferingSummaryResponseZod = z.object({
667
+ items: z.array(PendingOfferingSummaryResponseZod),
668
+ meta: IPaginationMeta,
669
+ });
670
+ export const ReviewOfferingOnboarding = z.object({
671
+ onboardingStatus: z.nativeEnum(OfferingOnboardingStatus),
672
+ });
673
+ export const OnboardingOfferingSummaryZod = z.object({
674
+ accountId: z.lazy(() => accountIdSchema),
675
+ accountName: z.string(),
676
+ offeringName: z.string(),
677
+ offeringId: z.string(),
678
+ memorandumId: z.string().nullable(),
679
+ subscriptionAgreementId: z.string().nullable(),
680
+ subscriptionAgreementTemplateId: z.string().nullable(),
681
+ jointSubscriptionAgreementTemplateId: z.string().nullable(),
682
+ entitySubscriptionAgreementTemplateId: z.string().nullable(),
683
+ });
684
+ export const OnboardingOfferingSummaryFilterZod = z.object({
685
+ search: z.string().optional(),
686
+ offeringId: offeringIdSchema.optional(),
687
+ });
688
+ export const IPaginatedOnboardingOfferingSummaryResponse = z.object({
689
+ items: z.array(OnboardingOfferingSummaryZod),
690
+ meta: IPaginationMeta,
691
+ });
692
+ /**
693
+ * Maps asset types to fields that should be reset (nullified) when converting
694
+ * from one asset type to another. This ensures incompatible fields from the
695
+ * previous type are cleared when the asset type changes.
696
+ */
697
+ export const ESCROW_ENABLED_OFFERING_FIELD_RESETS = {
698
+ bankAccountId: null,
699
+ escrowAccountId: null,
700
+ escrowAgreementFileId: null,
701
+ };
702
+ /**
703
+ * Schema for escrow validation data input
704
+ */
705
+ export const EscrowValidationDataZod = z.object({
706
+ hasEscrow: z.boolean().optional(),
707
+ bankAccountId: z.string().nullable().optional(),
708
+ escrowAccountId: z.string().nullable().optional(),
709
+ escrowAgreementFileId: z.string().nullable().optional(),
710
+ });
711
+ /**
712
+ * Schema for escrow validation context
713
+ */
714
+ export const EscrowValidationContextZod = z.object({
715
+ accountId: z.string(),
716
+ issuerId: z.string(),
717
+ offeringId: z.string(),
718
+ currentBankAccountId: z.string().nullable(),
719
+ currentEscrowAccountId: z.string().nullable(),
720
+ currentEscrowAgreementFileId: z.string().nullable(),
721
+ });
722
+ /**
723
+ * Shape of warrant fields shared by Offering and OfferingRevision for validation.
724
+ */
725
+ export const WarrantSharesBaseZod = z.object({
726
+ warrantsEnabled: z.boolean(),
727
+ totalShares: z.number().nullable(),
728
+ warrantTermYears: z.number().nullable(),
729
+ exercisePrice: z.number().nullable(),
730
+ warrantPercentage: z.number().nullable(),
731
+ calculationMethod: z.nativeEnum(WarrantSharesCalculationMethod).nullable(),
732
+ incrementThreshold: z.number().nullable(),
733
+ fullyDilutedShares: z.number().nullable(),
734
+ });
735
+ /**
736
+ * All warrant field keys used when picking warrant data from base or patch.
737
+ */
738
+ export const WARRANT_FIELD_KEYS = [
739
+ 'warrantsEnabled',
740
+ 'totalShares',
741
+ 'warrantTermYears',
742
+ 'exercisePrice',
743
+ 'warrantPercentage',
744
+ 'calculationMethod',
745
+ 'incrementThreshold',
746
+ 'fullyDilutedShares',
747
+ ];
748
+ /**
749
+ * Warrant field keys required when enabling warrants (turning warrants on).
750
+ */
751
+ export const WARRANT_REQUIRED_WHEN_ENABLED_KEYS = [
752
+ 'totalShares',
753
+ 'warrantTermYears',
754
+ 'exercisePrice',
755
+ 'warrantPercentage',
756
+ 'calculationMethod',
757
+ ];
758
+ /**
759
+ * Patch input for warrant validation (optional warrant fields from PATCH body).
760
+ */
761
+ export const WarrantValidationDataZod = z.object({
762
+ warrantsEnabled: z.boolean().optional(),
763
+ totalShares: z.number().nullable().optional(),
764
+ warrantTermYears: z.number().nullable().optional(),
765
+ exercisePrice: z.number().nullable().optional(),
766
+ warrantPercentage: z.number().nullable().optional(),
767
+ calculationMethod: z
768
+ .nativeEnum(WarrantSharesCalculationMethod)
769
+ .nullable()
770
+ .optional(),
771
+ incrementThreshold: z.number().nullable().optional(),
772
+ fullyDilutedShares: z.number().nullable().optional(),
773
+ });
774
+ /**
775
+ * Warrant-related fields to reset (nullify) when warrants are disabled.
776
+ * Used when warrantsEnabled is set to false so revision and offering stay in sync.
777
+ */
778
+ export const WARRANT_DISABLED_FIELD_RESETS = {
779
+ warrantsEnabled: false,
780
+ totalShares: null,
781
+ warrantTermYears: null,
782
+ exercisePrice: null,
783
+ warrantPercentage: null,
784
+ calculationMethod: null,
785
+ incrementThreshold: null,
786
+ fullyDilutedShares: null,
787
+ };
788
+ //# sourceMappingURL=offering.types.js.map