@dalmore/api-contracts 0.0.0-dev.15e31bc → 0.0.0-dev.1945443

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 (705) 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 +184 -0
  18. package/common/types/account-setting.types.js +52 -0
  19. package/common/types/account-setting.types.js.map +1 -0
  20. package/common/types/account.types.d.ts +631 -0
  21. package/common/types/account.types.js +216 -0
  22. package/common/types/account.types.js.map +1 -0
  23. package/common/types/activity.types.d.ts +580 -0
  24. package/common/types/activity.types.js +245 -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 +888 -0
  42. package/common/types/asset.types.js +280 -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 +980 -0
  51. package/common/types/bonus-tier.types.js +159 -0
  52. package/common/types/bonus-tier.types.js.map +1 -0
  53. package/common/types/cap-table.types.d.ts +1124 -0
  54. package/common/types/cap-table.types.js +406 -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 +1495 -0
  66. package/common/types/common.types.js +1430 -0
  67. package/common/types/common.types.js.map +1 -0
  68. package/common/types/comply-advantage-api.types.d.ts +3959 -0
  69. package/common/types/comply-advantage-api.types.js +270 -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 +2343 -0
  108. package/common/types/disbursements.types.js +308 -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 +398 -0
  123. package/common/types/escrow-account.types.js +75 -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 +401 -0
  135. package/common/types/file.types.js +378 -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} +3 -3
  144. package/common/types/index.js +52 -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 +500 -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 +930 -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 +385 -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 +1245 -0
  164. package/common/types/issuer-offering.types.js +344 -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 +587 -0
  215. package/common/types/offering-submission.types.js +278 -0
  216. package/common/types/offering-submission.types.js.map +1 -0
  217. package/common/types/offering.types.d.ts +2335 -0
  218. package/common/types/offering.types.js +505 -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/review.types.d.ts +419 -0
  251. package/common/types/review.types.js +101 -0
  252. package/common/types/review.types.js.map +1 -0
  253. package/common/types/role.types.d.ts +30 -0
  254. package/common/types/role.types.js +21 -0
  255. package/common/types/role.types.js.map +1 -0
  256. package/common/types/secondary-customer.types.d.ts +586 -0
  257. package/common/types/secondary-customer.types.js +39 -0
  258. package/common/types/secondary-customer.types.js.map +1 -0
  259. package/common/types/secondary-issuer.types.d.ts +283 -0
  260. package/common/types/secondary-issuer.types.js +37 -0
  261. package/common/types/secondary-issuer.types.js.map +1 -0
  262. package/common/types/secondary-order.types.d.ts +508 -0
  263. package/common/types/secondary-order.types.js +40 -0
  264. package/common/types/secondary-order.types.js.map +1 -0
  265. package/common/types/secondary-security.types.d.ts +175 -0
  266. package/common/types/secondary-security.types.js +45 -0
  267. package/common/types/secondary-security.types.js.map +1 -0
  268. package/common/types/secondary-trade.entity.d.ts +16 -0
  269. package/common/types/secondary-trade.entity.js +12 -0
  270. package/common/types/secondary-trade.entity.js.map +1 -0
  271. package/common/types/secondary-trade.types.d.ts +465 -0
  272. package/common/types/secondary-trade.types.js +61 -0
  273. package/common/types/secondary-trade.types.js.map +1 -0
  274. package/common/types/secure-request.types.d.ts +171 -0
  275. package/common/types/secure-request.types.js +51 -0
  276. package/common/types/secure-request.types.js.map +1 -0
  277. package/common/types/signer.types.d.ts +3394 -0
  278. package/common/types/signer.types.js +517 -0
  279. package/common/types/signer.types.js.map +1 -0
  280. package/common/types/site-link.types.d.ts +875 -0
  281. package/common/types/site-link.types.js +126 -0
  282. package/common/types/site-link.types.js.map +1 -0
  283. package/common/types/site-settings.types.d.ts +1673 -0
  284. package/common/types/site-settings.types.js +500 -0
  285. package/common/types/site-settings.types.js.map +1 -0
  286. package/common/types/site.types.d.ts +1476 -0
  287. package/common/types/site.types.js +213 -0
  288. package/common/types/site.types.js.map +1 -0
  289. package/common/types/sms.types.d.ts +40 -0
  290. package/common/types/sms.types.js +27 -0
  291. package/common/types/sms.types.js.map +1 -0
  292. package/common/types/state-machine.types.d.ts +591 -0
  293. package/common/types/state-machine.types.js +144 -0
  294. package/common/types/state-machine.types.js.map +1 -0
  295. package/common/types/states.types.d.ts +77 -0
  296. package/common/types/states.types.js +137 -0
  297. package/common/types/states.types.js.map +1 -0
  298. package/common/types/subdoc-preview.types.d.ts +379 -0
  299. package/common/types/subdoc-preview.types.js +24 -0
  300. package/common/types/subdoc-preview.types.js.map +1 -0
  301. package/common/types/task.types.d.ts +537 -0
  302. package/common/types/task.types.js +211 -0
  303. package/common/types/task.types.js.map +1 -0
  304. package/common/types/trade-adjustment.type.d.ts +40 -0
  305. package/common/types/trade-adjustment.type.js +26 -0
  306. package/common/types/trade-adjustment.type.js.map +1 -0
  307. package/common/types/trade-line-item.types.d.ts +312 -0
  308. package/common/types/trade-line-item.types.js +89 -0
  309. package/common/types/trade-line-item.types.js.map +1 -0
  310. package/common/types/trade.types.d.ts +1987 -0
  311. package/common/types/trade.types.js +780 -0
  312. package/common/types/trade.types.js.map +1 -0
  313. package/common/types/transaction.types.d.ts +375 -0
  314. package/common/types/transaction.types.js +154 -0
  315. package/common/types/transaction.types.js.map +1 -0
  316. package/common/types/trusted-contact.types.d.ts +440 -0
  317. package/common/types/trusted-contact.types.js +95 -0
  318. package/common/types/trusted-contact.types.js.map +1 -0
  319. package/common/types/typography.types.d.ts +52 -0
  320. package/common/types/typography.types.js +67 -0
  321. package/common/types/typography.types.js.map +1 -0
  322. package/common/types/user-manual.types.d.ts +287 -0
  323. package/common/types/user-manual.types.js +192 -0
  324. package/common/types/user-manual.types.js.map +1 -0
  325. package/common/types/user-setting.types.d.ts +273 -0
  326. package/common/types/user-setting.types.js +85 -0
  327. package/common/types/user-setting.types.js.map +1 -0
  328. package/common/types/user.types.d.ts +1951 -0
  329. package/common/types/user.types.js +238 -0
  330. package/common/types/user.types.js.map +1 -0
  331. package/common/types/webhook.types.d.ts +10829 -0
  332. package/common/types/webhook.types.js +658 -0
  333. package/common/types/webhook.types.js.map +1 -0
  334. package/common/types/zip.type.d.ts +35 -0
  335. package/common/types/zip.type.js +28 -0
  336. package/common/types/zip.type.js.map +1 -0
  337. package/contracts/clients/accounts/index.d.ts +308 -0
  338. package/contracts/clients/accounts/index.js +43 -0
  339. package/contracts/clients/accounts/index.js.map +1 -0
  340. package/contracts/clients/aic/index.d.ts +280 -0
  341. package/contracts/clients/aic/index.js +47 -0
  342. package/contracts/clients/aic/index.js.map +1 -0
  343. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  344. package/contracts/clients/api-key-logs/index.js +37 -0
  345. package/contracts/clients/api-key-logs/index.js.map +1 -0
  346. package/contracts/clients/api-keys/index.d.ts +374 -0
  347. package/contracts/clients/api-keys/index.js +59 -0
  348. package/contracts/clients/api-keys/index.js.map +1 -0
  349. package/contracts/clients/assets/index.d.ts +1028 -0
  350. package/contracts/clients/assets/index.js +80 -0
  351. package/contracts/clients/assets/index.js.map +1 -0
  352. package/contracts/clients/auth/index.d.ts +236 -0
  353. package/contracts/clients/auth/index.js +38 -0
  354. package/contracts/clients/auth/index.js.map +1 -0
  355. package/contracts/clients/cart/index.d.ts +229 -0
  356. package/contracts/clients/cart/index.js +63 -0
  357. package/contracts/clients/cart/index.js.map +1 -0
  358. package/contracts/clients/files/index.d.ts +552 -0
  359. package/contracts/clients/files/index.js +142 -0
  360. package/contracts/clients/files/index.js.map +1 -0
  361. package/contracts/clients/files-public/index.d.ts +552 -0
  362. package/contracts/clients/files-public/index.js +142 -0
  363. package/contracts/clients/files-public/index.js.map +1 -0
  364. package/contracts/clients/index.d.ts +12476 -0
  365. package/contracts/clients/index.js +52 -0
  366. package/contracts/clients/index.js.map +1 -0
  367. package/contracts/clients/individuals/index.d.ts +3199 -0
  368. package/contracts/clients/individuals/index.js +74 -0
  369. package/contracts/clients/individuals/index.js.map +1 -0
  370. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  371. package/contracts/clients/investor-accounts/index.js +73 -0
  372. package/contracts/clients/investor-accounts/index.js.map +1 -0
  373. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  374. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  375. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  376. package/contracts/clients/issuers/index.d.ts +449 -0
  377. package/contracts/clients/issuers/index.js +75 -0
  378. package/contracts/clients/issuers/index.js.map +1 -0
  379. package/contracts/clients/kyc/index.d.ts +345 -0
  380. package/contracts/clients/kyc/index.js +49 -0
  381. package/contracts/clients/kyc/index.js.map +1 -0
  382. package/contracts/clients/legal-entities/index.d.ts +887 -0
  383. package/contracts/clients/legal-entities/index.js +74 -0
  384. package/contracts/clients/legal-entities/index.js.map +1 -0
  385. package/contracts/clients/offerings/index.d.ts +767 -0
  386. package/contracts/clients/offerings/index.js +95 -0
  387. package/contracts/clients/offerings/index.js.map +1 -0
  388. package/contracts/clients/payment-methods/index.d.ts +456 -0
  389. package/contracts/clients/payment-methods/index.js +68 -0
  390. package/contracts/clients/payment-methods/index.js.map +1 -0
  391. package/contracts/clients/secure-requests/index.d.ts +100 -0
  392. package/contracts/clients/secure-requests/index.js +22 -0
  393. package/contracts/clients/secure-requests/index.js.map +1 -0
  394. package/contracts/clients/sites/index.d.ts +657 -0
  395. package/contracts/clients/sites/index.js +40 -0
  396. package/contracts/clients/sites/index.js.map +1 -0
  397. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  398. package/contracts/clients/trade-line-items/index.js +47 -0
  399. package/contracts/clients/trade-line-items/index.js.map +1 -0
  400. package/contracts/clients/trades/index.d.ts +865 -0
  401. package/contracts/clients/trades/index.js +156 -0
  402. package/contracts/clients/trades/index.js.map +1 -0
  403. package/contracts/clients/transactions/index.d.ts +88 -0
  404. package/contracts/clients/transactions/index.js +25 -0
  405. package/contracts/clients/transactions/index.js.map +1 -0
  406. package/package.json +27 -36
  407. package/common/helpers/index.ts +0 -59
  408. package/common/types/account-contact.types.ts +0 -99
  409. package/common/types/account-detail.types.ts +0 -27
  410. package/common/types/account-integration.types.ts +0 -143
  411. package/common/types/account-manager.types.ts +0 -120
  412. package/common/types/account-setting.types.ts +0 -65
  413. package/common/types/account.types.ts +0 -297
  414. package/common/types/activity.types.ts +0 -274
  415. package/common/types/address.types.ts +0 -41
  416. package/common/types/aic.types.ts +0 -246
  417. package/common/types/aml.types.ts +0 -18
  418. package/common/types/api-key-logs.types.ts +0 -66
  419. package/common/types/api-keys.types.ts +0 -69
  420. package/common/types/asset.types.ts +0 -338
  421. package/common/types/auth.types.ts +0 -359
  422. package/common/types/batch-jobs.types.ts +0 -151
  423. package/common/types/bonus-tier.types.ts +0 -180
  424. package/common/types/cart.types.ts +0 -21
  425. package/common/types/checklist-items.types.ts +0 -70
  426. package/common/types/checklist.types.ts +0 -97
  427. package/common/types/common.types.ts +0 -1546
  428. package/common/types/comply-advantage-api.types.ts +0 -316
  429. package/common/types/comply-advantage.types.ts +0 -25
  430. package/common/types/contact-us.types.ts +0 -111
  431. package/common/types/countries.types.ts +0 -375
  432. package/common/types/covered-person.types.ts +0 -275
  433. package/common/types/dashboard.types.ts +0 -792
  434. package/common/types/data-record.types.ts +0 -325
  435. package/common/types/data-room.types.ts +0 -242
  436. package/common/types/default-theme-config.types.ts +0 -87
  437. package/common/types/disbursement-adjustment.types.ts +0 -32
  438. package/common/types/disbursement-approval-user.types.ts +0 -100
  439. package/common/types/disbursement-review.types.ts +0 -110
  440. package/common/types/disbursement-transaction.types.ts +0 -72
  441. package/common/types/disbursements.types.ts +0 -426
  442. package/common/types/domain-filter.types.ts +0 -55
  443. package/common/types/email-theme.types.ts +0 -442
  444. package/common/types/entity.types.ts +0 -15
  445. package/common/types/error-responses.types.ts +0 -135
  446. package/common/types/escrow-account.types.ts +0 -104
  447. package/common/types/exchange-api-key.types.ts +0 -121
  448. package/common/types/exchange-import.types.ts +0 -36
  449. package/common/types/exchange-provider.types.ts +0 -329
  450. package/common/types/file.types.ts +0 -477
  451. package/common/types/health.types.ts +0 -29
  452. package/common/types/i-will-do-it-later.types.ts +0 -68
  453. package/common/types/individuals.types.ts +0 -542
  454. package/common/types/investor-account.types.ts +0 -1240
  455. package/common/types/investors-offering.types.ts +0 -65
  456. package/common/types/invite.types.ts +0 -159
  457. package/common/types/issuer-bank-account.types.ts +0 -107
  458. package/common/types/issuer-offering.types.ts +0 -389
  459. package/common/types/issuer-payment-method.types.ts +0 -382
  460. package/common/types/issuer.types.ts +0 -321
  461. package/common/types/job-item.types.ts +0 -119
  462. package/common/types/jobs.types.ts +0 -171
  463. package/common/types/kyb.types.ts +0 -53
  464. package/common/types/kyc.types.ts +0 -188
  465. package/common/types/legal-entity.types.ts +0 -186
  466. package/common/types/login-history.types.ts +0 -46
  467. package/common/types/mail-template.types.ts +0 -436
  468. package/common/types/north-cap-integration.types.ts +0 -190
  469. package/common/types/note.types.ts +0 -109
  470. package/common/types/notification.types.ts +0 -544
  471. package/common/types/notion-api.types.ts +0 -374
  472. package/common/types/notion-database.types.ts +0 -125
  473. package/common/types/notion-page.types.ts +0 -267
  474. package/common/types/offering-reports.types.ts +0 -153
  475. package/common/types/offering-submission.types.ts +0 -314
  476. package/common/types/offering.types.ts +0 -676
  477. package/common/types/page-revision.types.ts +0 -86
  478. package/common/types/page.types.ts +0 -436
  479. package/common/types/password.type.ts +0 -15
  480. package/common/types/payment-methods.types.ts +0 -298
  481. package/common/types/phone.type.ts +0 -27
  482. package/common/types/portfolio.types.ts +0 -50
  483. package/common/types/queue.types.ts +0 -112
  484. package/common/types/registered-reps.types.ts +0 -25
  485. package/common/types/rejection-reasons.types.ts +0 -56
  486. package/common/types/reminder-config.types.ts +0 -40
  487. package/common/types/review.types.ts +0 -133
  488. package/common/types/role.types.ts +0 -26
  489. package/common/types/secondary-customer.types.ts +0 -66
  490. package/common/types/secondary-issuer.types.ts +0 -50
  491. package/common/types/secondary-order.types.ts +0 -58
  492. package/common/types/secondary-security.types.ts +0 -60
  493. package/common/types/secondary-trade.entity.ts +0 -16
  494. package/common/types/secondary-trade.types.ts +0 -95
  495. package/common/types/secure-request.types.ts +0 -68
  496. package/common/types/signer.types.ts +0 -651
  497. package/common/types/site-link.types.ts +0 -166
  498. package/common/types/site-settings.types.ts +0 -727
  499. package/common/types/site.types.ts +0 -263
  500. package/common/types/sms.types.ts +0 -30
  501. package/common/types/state-machine.types.ts +0 -177
  502. package/common/types/states.types.ts +0 -163
  503. package/common/types/subdoc-preview.types.ts +0 -35
  504. package/common/types/task.types.ts +0 -258
  505. package/common/types/trade-adjustment.type.ts +0 -33
  506. package/common/types/trade-line-item.types.ts +0 -125
  507. package/common/types/trade.types.ts +0 -1045
  508. package/common/types/transaction.types.ts +0 -209
  509. package/common/types/trusted-contact.types.ts +0 -122
  510. package/common/types/typography.types.ts +0 -75
  511. package/common/types/user-manual.types.ts +0 -290
  512. package/common/types/user-setting.types.ts +0 -133
  513. package/common/types/user.types.ts +0 -304
  514. package/common/types/webhook.types.ts +0 -588
  515. package/common/types/zip.type.ts +0 -36
  516. package/contracts/clients/accounts/index.ts +0 -61
  517. package/contracts/clients/aic/index.ts +0 -59
  518. package/contracts/clients/api-key-logs/index.ts +0 -53
  519. package/contracts/clients/api-keys/index.ts +0 -73
  520. package/contracts/clients/assets/index.ts +0 -102
  521. package/contracts/clients/auth/index.ts +0 -50
  522. package/contracts/clients/cart/index.ts +0 -80
  523. package/contracts/clients/files/index.ts +0 -166
  524. package/contracts/clients/files-public/index.ts +0 -166
  525. package/contracts/clients/index.ts +0 -54
  526. package/contracts/clients/individuals/index.ts +0 -93
  527. package/contracts/clients/investor-accounts/index.ts +0 -93
  528. package/contracts/clients/issuer-payment-methods/index.ts +0 -39
  529. package/contracts/clients/issuers/index.ts +0 -94
  530. package/contracts/clients/legal-entities/index.ts +0 -93
  531. package/contracts/clients/offerings/index.ts +0 -117
  532. package/contracts/clients/payment-methods/index.ts +0 -85
  533. package/contracts/clients/secure-requests/index.ts +0 -34
  534. package/contracts/clients/sites/index.ts +0 -56
  535. package/contracts/clients/trade-line-items/index.ts +0 -66
  536. package/contracts/clients/trades/index.ts +0 -186
  537. package/contracts/clients/transactions/index.ts +0 -37
  538. package/contracts/compliance/account-contacts/index.ts +0 -82
  539. package/contracts/compliance/account-managers/index.ts +0 -142
  540. package/contracts/compliance/account-settings/index.ts +0 -59
  541. package/contracts/compliance/accounts/index.ts +0 -187
  542. package/contracts/compliance/activities/index.ts +0 -55
  543. package/contracts/compliance/aic/index.ts +0 -60
  544. package/contracts/compliance/api-keys/index.ts +0 -91
  545. package/contracts/compliance/assets/index.ts +0 -122
  546. package/contracts/compliance/auth/index.ts +0 -135
  547. package/contracts/compliance/batch-jobs/index.ts +0 -62
  548. package/contracts/compliance/bonus-tiers/index.ts +0 -74
  549. package/contracts/compliance/checklist/index.ts +0 -87
  550. package/contracts/compliance/checklist-items/index.ts +0 -86
  551. package/contracts/compliance/covered-persons/index.ts +0 -97
  552. package/contracts/compliance/dashboard/index.ts +0 -111
  553. package/contracts/compliance/data-records/index.ts +0 -116
  554. package/contracts/compliance/data-rooms/index.ts +0 -113
  555. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  556. package/contracts/compliance/disbursement/index.ts +0 -165
  557. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  558. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  559. package/contracts/compliance/domain-filters/index.ts +0 -117
  560. package/contracts/compliance/email-themes/index.ts +0 -284
  561. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  562. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  563. package/contracts/compliance/exchange-imports/index.ts +0 -137
  564. package/contracts/compliance/files/index.ts +0 -267
  565. package/contracts/compliance/files-public/index.ts +0 -188
  566. package/contracts/compliance/health/index.ts +0 -26
  567. package/contracts/compliance/index.ts +0 -151
  568. package/contracts/compliance/individuals/index.ts +0 -57
  569. package/contracts/compliance/investor-accounts/index.ts +0 -141
  570. package/contracts/compliance/invites/index.ts +0 -129
  571. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  572. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  573. package/contracts/compliance/issuers/index.ts +0 -97
  574. package/contracts/compliance/job-items/index.ts +0 -58
  575. package/contracts/compliance/jobs/index.ts +0 -59
  576. package/contracts/compliance/kyb/index.ts +0 -54
  577. package/contracts/compliance/kyc/index.ts +0 -77
  578. package/contracts/compliance/legal-entities/index.ts +0 -57
  579. package/contracts/compliance/login-histories/index.ts +0 -37
  580. package/contracts/compliance/notes/index.ts +0 -69
  581. package/contracts/compliance/notification-channels/index.ts +0 -251
  582. package/contracts/compliance/notion-databases/index.ts +0 -107
  583. package/contracts/compliance/notion-pages/index.ts +0 -105
  584. package/contracts/compliance/offering-reports/index.ts +0 -149
  585. package/contracts/compliance/offerings/index.ts +0 -233
  586. package/contracts/compliance/pages/index.ts +0 -178
  587. package/contracts/compliance/payment-methods/index.ts +0 -57
  588. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  589. package/contracts/compliance/review/index.ts +0 -169
  590. package/contracts/compliance/roles/index.ts +0 -34
  591. package/contracts/compliance/secondary-customers/index.ts +0 -77
  592. package/contracts/compliance/secondary-orders/index.ts +0 -60
  593. package/contracts/compliance/secondary-trades/index.ts +0 -100
  594. package/contracts/compliance/secure-requests/index.ts +0 -54
  595. package/contracts/compliance/signer/index.ts +0 -369
  596. package/contracts/compliance/site-links/index.ts +0 -128
  597. package/contracts/compliance/site-settings/index.ts +0 -669
  598. package/contracts/compliance/sites/index.ts +0 -56
  599. package/contracts/compliance/state-machine/index.ts +0 -94
  600. package/contracts/compliance/tasks/index.ts +0 -91
  601. package/contracts/compliance/third-parties/index.ts +0 -52
  602. package/contracts/compliance/trade-line-items/index.ts +0 -59
  603. package/contracts/compliance/trades/index.ts +0 -249
  604. package/contracts/compliance/transactions/index.ts +0 -161
  605. package/contracts/compliance/user-manuals/index.ts +0 -271
  606. package/contracts/compliance/user-settings/index.ts +0 -189
  607. package/contracts/compliance/users/index.ts +0 -221
  608. package/contracts/compliance/webhooks/index.ts +0 -41
  609. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  610. package/contracts/compliance-apikey/index.ts +0 -14
  611. package/contracts/index.ts +0 -6
  612. package/contracts/investors/account-contacts/index.ts +0 -58
  613. package/contracts/investors/aic/index.ts +0 -59
  614. package/contracts/investors/assets/index.ts +0 -61
  615. package/contracts/investors/auth/index.ts +0 -116
  616. package/contracts/investors/bonus-tiers/index.ts +0 -55
  617. package/contracts/investors/cart/index.ts +0 -75
  618. package/contracts/investors/contact-us/index.ts +0 -48
  619. package/contracts/investors/data-records/index.ts +0 -113
  620. package/contracts/investors/data-rooms/index.ts +0 -96
  621. package/contracts/investors/files/index.ts +0 -167
  622. package/contracts/investors/files-public/index.ts +0 -185
  623. package/contracts/investors/index.ts +0 -72
  624. package/contracts/investors/individuals/index.ts +0 -121
  625. package/contracts/investors/investor-accounts/index.ts +0 -110
  626. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  627. package/contracts/investors/issuers/index.ts +0 -30
  628. package/contracts/investors/legal-entities/index.ts +0 -93
  629. package/contracts/investors/notes/index.ts +0 -69
  630. package/contracts/investors/offerings/index.ts +0 -93
  631. package/contracts/investors/pages/index.ts +0 -88
  632. package/contracts/investors/payment-methods/index.ts +0 -149
  633. package/contracts/investors/portfolios/index.ts +0 -53
  634. package/contracts/investors/sites/index.ts +0 -96
  635. package/contracts/investors/tasks/index.ts +0 -111
  636. package/contracts/investors/trade-line-items/index.ts +0 -75
  637. package/contracts/investors/trades/index.ts +0 -114
  638. package/contracts/investors/transactions/index.ts +0 -37
  639. package/contracts/investors/trusted-contacts/index.ts +0 -93
  640. package/contracts/investors/user-manuals/index.ts +0 -62
  641. package/contracts/investors/user-settings/index.ts +0 -170
  642. package/contracts/investors/users/index.ts +0 -45
  643. package/contracts/investors/webhooks/index.ts +0 -30
  644. package/contracts/issuers/account-contacts/index.ts +0 -76
  645. package/contracts/issuers/account-integrations/index.ts +0 -97
  646. package/contracts/issuers/account-settings/index.ts +0 -36
  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 -153
  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 -116
  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/notification-channels/index.ts +0 -251
  679. package/contracts/issuers/offerings/index.ts +0 -206
  680. package/contracts/issuers/pages/index.ts +0 -138
  681. package/contracts/issuers/payment-methods/index.ts +0 -61
  682. package/contracts/issuers/portfolios/index.ts +0 -36
  683. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  684. package/contracts/issuers/review/index.ts +0 -63
  685. package/contracts/issuers/secondary-customers/index.ts +0 -55
  686. package/contracts/issuers/secondary-orders/index.ts +0 -57
  687. package/contracts/issuers/secondary-trades/index.ts +0 -57
  688. package/contracts/issuers/secure-requests/index.ts +0 -34
  689. package/contracts/issuers/site-links/index.ts +0 -116
  690. package/contracts/issuers/site-settings/index.ts +0 -585
  691. package/contracts/issuers/sites/index.ts +0 -32
  692. package/contracts/issuers/tasks/index.ts +0 -111
  693. package/contracts/issuers/trades/index.ts +0 -132
  694. package/contracts/issuers/transactions/index.ts +0 -158
  695. package/contracts/issuers/user-manuals/index.ts +0 -62
  696. package/contracts/issuers/user-settings/index.ts +0 -170
  697. package/contracts/issuers/users/index.ts +0 -126
  698. package/contracts/secondaries/accounts/index.ts +0 -58
  699. package/contracts/secondaries/index.ts +0 -23
  700. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  701. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  702. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  703. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  704. package/contracts/secondaries/secondary-trades/index.ts +0 -56
  705. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -1,1045 +0,0 @@
1
- import { z } from 'zod';
2
- import {
3
- InvestmentType,
4
- IPaginationMeta,
5
- FundingStatus,
6
- TxnCheck,
7
- PaginationOptionsZod,
8
- dateSchema,
9
- BaseStatus,
10
- ComplianceReview,
11
- OfferingType,
12
- ManagedByType,
13
- SignatureStatus,
14
- TradeType,
15
- TradeStatus,
16
- SortOrder,
17
- SortBy,
18
- AicStatus,
19
- AMLStatus,
20
- KYCStatus,
21
- createDateSchema,
22
- AccountStatus,
23
- SavedQuery,
24
- } from './common.types';
25
- import { IOffering, offeringIdSchema } from './offering.types';
26
- import { IBaseEntity } from './entity.types';
27
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
28
- import { TypeID } from 'typeid-js';
29
- import {
30
- paymentMethodIdSchema,
31
- PaymentMethodResponse,
32
- PaymentMethodType,
33
- } from './payment-methods.types';
34
- import {
35
- investorAccountIdSchema,
36
- InvestorAccountExportFilters,
37
- ComplianceInvestorAccountExportFilters,
38
- RegisteredInvestorUserRawZod,
39
- IInvestorAccount,
40
- } from './investor-account.types';
41
- import {
42
- tradeLineItemIdSchema,
43
- TradeLineItemZod,
44
- } from './trade-line-item.types';
45
- import { TradeAdjustmentZod } from './trade-adjustment.type';
46
- import { TransactionZod } from './transaction.types';
47
- import { accountIdSchema } from './account.types';
48
- import { userIdSchema } from './user.types';
49
- import { issuerIdSchema } from './issuer.types';
50
- import {
51
- GetSecondaryCustomerFiltersZod,
52
- SecondaryCustomer,
53
- } from './secondary-customer.types';
54
- import {
55
- SecondaryTrade,
56
- SecondaryTradeFiltersZod,
57
- } from './secondary-trade.types';
58
- import { InvestorAccount } from '../../investor-accounts/entities/investor-account.entity';
59
- import { Trade } from '../../trades/entities/trade.entity';
60
- import { fileIdSchema } from './file.types';
61
-
62
- extendZodWithOpenApi(z);
63
-
64
- // Zod schemas for attach subdoc endpoints
65
- export const PostAttachSubdocBody = z.object({
66
- lineItemId: tradeLineItemIdSchema.openapi({
67
- example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja',
68
- }),
69
- fileId: z
70
- .lazy(() => fileIdSchema)
71
- .openapi({ example: 'file_01je6ht4b8fbmttkzh2hs82xqp' }),
72
- primarySignatureStatus: z
73
- .nativeEnum(SignatureStatus)
74
- .openapi({ example: 'SIGNED' }),
75
- secondarySignatureStatus: z
76
- .nativeEnum(SignatureStatus)
77
- .optional()
78
- .openapi({ example: 'SIGNED' }),
79
- });
80
- export type PostAttachSubdocBody = z.infer<typeof PostAttachSubdocBody>;
81
-
82
- export const PutAttachSubdocBody = z.object({
83
- lineItemId: tradeLineItemIdSchema
84
- .optional()
85
- .openapi({ example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja' }),
86
- fileId: z
87
- .lazy(() => fileIdSchema)
88
- .optional()
89
- .openapi({ example: 'file_01je6ht4b8fbmttkzh2hs82xqp' }),
90
- primarySignatureStatus: z
91
- .nativeEnum(SignatureStatus)
92
- .optional()
93
- .openapi({ example: 'SIGNED' }),
94
- secondarySignatureStatus: z
95
- .nativeEnum(SignatureStatus)
96
- .optional()
97
- .openapi({ example: 'SIGNED' }),
98
- });
99
- export type PutAttachSubdocBody = z.infer<typeof PutAttachSubdocBody>;
100
-
101
- export const PatchSubdocSignatureBody = z.object({
102
- lineItemId: tradeLineItemIdSchema.optional().openapi({
103
- example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja',
104
- description:
105
- 'Optional. If not provided, updates the first line item with an attached subdoc. Required for trades with multiple line items.',
106
- }),
107
- primarySignatureStatus: z.nativeEnum(SignatureStatus).optional().openapi({
108
- example: 'SIGNED',
109
- description: 'Primary signer signature status',
110
- }),
111
- secondarySignatureStatus: z.nativeEnum(SignatureStatus).optional().openapi({
112
- example: 'SIGNED',
113
- description:
114
- 'Secondary signer signature status. Only applicable for JOINT investor accounts.',
115
- }),
116
- });
117
- export type PatchSubdocSignatureBody = z.infer<typeof PatchSubdocSignatureBody>;
118
-
119
- export const AttachSubdocResponse = z.object({
120
- success: z.boolean(),
121
- message: z.string(),
122
- });
123
- export type AttachSubdocResponse = z.infer<typeof AttachSubdocResponse>;
124
-
125
- export const CheckResultsSchema = z.object({
126
- fundingStatus: z.boolean(),
127
- agreementStatus: z.boolean(),
128
- subscriptionAgreementCheck: z.boolean(),
129
- kycStatus: z.boolean(),
130
- sanctionsStatus: z.boolean(),
131
- accreditationStatus: z.boolean(),
132
- kybStatus: z.boolean(),
133
- });
134
- export type CheckResults = z.infer<typeof CheckResultsSchema>;
135
-
136
- export const TradeIdPrefix = 'trade';
137
- export const TradeSnapshotIdPrefix = 'trade_snapshot';
138
-
139
- export const tradeIdSchema = z.string().refine(
140
- (value) => {
141
- try {
142
- const tid = TypeID.fromString(value);
143
- return tid.getType() === TradeIdPrefix;
144
- } catch {
145
- return false;
146
- }
147
- },
148
- {
149
- message:
150
- 'Invalid trade ID format. Must be a valid TypeID with "trade" prefix. ex: trade_00041061050r3gg28a1c60t3gf',
151
- },
152
- );
153
-
154
- export const tradeIdOrTidSchema = z.union([
155
- z.string().refine(
156
- (value) => {
157
- try {
158
- const tid = TypeID.fromString(value);
159
- return tid.getType() === TradeIdPrefix;
160
- } catch {
161
- return false;
162
- }
163
- },
164
- {
165
- message:
166
- 'Invalid trade ID format. Must be a valid TypeID with "trade" prefix. ex: trade_00041061050r3gg28a1c60t3gf',
167
- },
168
- ),
169
- z
170
- .string()
171
- .min(1)
172
- .max(50)
173
- .openapi({ example: 'tid_00041061050r3gg28a1c60t3gf' }),
174
- ]);
175
-
176
- export const tradeSnapshotIdSchema = z.string().refine(
177
- (value) => {
178
- try {
179
- const tid = TypeID.fromString(value);
180
- return tid.getType() === TradeSnapshotIdPrefix;
181
- } catch {
182
- return false;
183
- }
184
- },
185
- {
186
- message:
187
- 'Invalid trade snapshot ID format. Must be a valid TypeID with "trade_snapshot" prefix. ex: trade_snapshot_00041061050r3gg28a1c60t3gf',
188
- },
189
- );
190
-
191
- export enum SaStatus {
192
- PENDING = BaseStatus.PENDING,
193
- SIGNED = BaseStatus.SIGNED,
194
- DECLINED = BaseStatus.DECLINED,
195
- NEEDS_REVIEW = BaseStatus.NEEDS_REVIEW,
196
- }
197
-
198
- export enum TradeSystemLogType {
199
- SUB_DOC_CHECK = 'Subscription Agreement Check',
200
- ADDRESS_CHECK = 'Address Check',
201
- COUNTRY_CHECK = 'Country Check',
202
- CONCENTRATION_CHECK = 'Concentration Check',
203
- KYC_CHECK = 'KYC Check',
204
- AML_CHECK = 'AML Check',
205
- AIC_CHECK = 'AIC Check',
206
- USER_AGE_CHECK = 'User Age Check',
207
- KYC_NAME_CHECK = 'KYC Name Check',
208
- AML_NAME_CHECK = 'AML Name Check',
209
- AIC_NAME_CHECK = 'AIC Name Check',
210
- KYC_DOB_CHECK = 'KYC DOB Check',
211
- AIC_SSN_CHECK = 'AIC SSN Check',
212
- // Data Integrity Checks For Imported Trades
213
- SHARES_CHECK = 'Shares Check',
214
- PRICE_PER_UNIT_CHECK = 'Price Per Unit Check',
215
- ISSUER_CHECK = 'Issuer Check',
216
- INVESTOR_CHECK = 'Investor Check',
217
- OFFERING_CHECK = 'Offering Check',
218
- ASSETS_CHECK = 'Assets Check',
219
- INDIVIDUALS_CHECK = 'Individuals Check',
220
- }
221
-
222
- export enum SaCheck {
223
- PENDING = BaseStatus.PENDING,
224
- NEEDS_REVIEW = BaseStatus.NEEDS_REVIEW,
225
- APPROVED = BaseStatus.APPROVED,
226
- REJECTED = BaseStatus.REJECTED,
227
- }
228
-
229
- // cart NEEDS_INFO PLACED IN_REVIEW AWAITING_FUNDING CANCELLED SETTLED
230
-
231
- export enum SystemReviewCheck {
232
- PENDING = BaseStatus.PENDING,
233
- APPROVED = BaseStatus.APPROVED,
234
- REJECTED = BaseStatus.REJECTED,
235
- NEEDS_REVIEW = BaseStatus.NEEDS_REVIEW,
236
- WARNING = BaseStatus.WARNING,
237
- INCOMPLETE = BaseStatus.INCOMPLETE,
238
- }
239
-
240
- export enum Platforms {
241
- DALMORE = 'DALMORE',
242
- IMPORT = 'IMPORT',
243
- }
244
-
245
- export enum MatchResultStatus {
246
- MATCHED = 'MATCHED',
247
- UNMATCHED = 'UNMATCHED',
248
- }
249
-
250
- export enum TradeSystemReviewLogStatus {
251
- PASSED = 'PASSED',
252
- WARNING = 'WARNING',
253
- }
254
-
255
- export const matchResultSchema = z.object({
256
- actual: z.string().min(1).max(200),
257
- status: z.nativeEnum(MatchResultStatus),
258
- extracted: z.string().min(1).max(200),
259
- corrected: z.string().min(1).max(200).optional().nullable(),
260
- });
261
- export type matchResultSchema = z.infer<typeof matchResultSchema>;
262
-
263
- const saLogItemSchema = z.object({
264
- tradeLineItemId: tradeLineItemIdSchema,
265
- signerName: matchResultSchema.optional(),
266
- totalAmount: matchResultSchema.optional(),
267
- investorName: matchResultSchema.optional(),
268
- numberOfShares: matchResultSchema.optional(),
269
- });
270
-
271
- export type saLogItemSchema = z.infer<typeof saLogItemSchema>;
272
-
273
- export const SaLogSchema = z.object({
274
- finalStatus: z.nativeEnum(SaStatus),
275
- matchResults: z.array(saLogItemSchema),
276
- });
277
-
278
- export type saLogSchema = z.infer<typeof SaLogSchema>;
279
-
280
- export const PatchSaLogSchema = z.object({
281
- matchResults: z.array(saLogItemSchema),
282
- });
283
-
284
- export type PatchSaLogSchema = z.infer<typeof PatchSaLogSchema>;
285
-
286
- export const TradeBalanceResultZod = z.object({
287
- tradeAdjustments: z.number().multipleOf(0.01),
288
- chargedAmount: z.number().multipleOf(0.01),
289
- balance: z.number().multipleOf(0.01),
290
- });
291
- export type TradeBalanceResultZod = z.infer<typeof TradeBalanceResultZod>;
292
-
293
- export const TradeZod = IBaseEntity.extend({
294
- investorAccountId: z.lazy(() => investorAccountIdSchema.nullable()),
295
- investorAccount: z
296
- .lazy(() => IInvestorAccount)
297
- .optional()
298
- .nullable(),
299
- offering: z
300
- .lazy(() => IOffering)
301
- .optional()
302
- .nullable(),
303
- accountId: accountIdSchema.nullable(),
304
- offeringId: z.lazy(() => offeringIdSchema.nullable()),
305
- paymentMethodId: z.lazy(() => paymentMethodIdSchema).nullable(),
306
- paymentMethod: z
307
- .lazy(() => PaymentMethodResponse)
308
- .optional()
309
- .nullable(),
310
- userId: z.lazy(() => userIdSchema.nullable()),
311
- tradeNumber: z.string(),
312
- ip: z.string().nullable(),
313
- tid: z.string().nullable(),
314
- investmentType: z.nativeEnum(InvestmentType),
315
- numberOfShares: z.number().int(),
316
- pricePerShare: z.number().multipleOf(0.01),
317
- lineItems: z.array(z.lazy(() => TradeLineItemZod)),
318
- adjustments: z.array(z.lazy(() => TradeAdjustmentZod)),
319
- transactions: z.array(z.lazy(() => TransactionZod)),
320
- totalAmount: z.number().multipleOf(0.01).nullable(),
321
- tradeStatus: z.nativeEnum(TradeStatus),
322
- tradeStatusUnmapped: z.string().nullable(),
323
- tradeDate: z.date().nullable(),
324
- saStatus: z.nativeEnum(SaStatus),
325
- saStatusUnmapped: z.string().nullable(),
326
- saUrl: z.string().nullable(),
327
- saSignedAt: z.date().nullable(),
328
- saExtractedNumberOfShares: z.string().nullable(),
329
- saExtractedTotalAmount: z.string().nullable(),
330
- saExtractedPricePerShare: z.string().nullable(),
331
- saExtractedInvestorType: z.string().nullable(),
332
- saExtractedSigner: z.string().nullable(),
333
- saExtractedSignatureDate: z.date().nullable(),
334
- saExtractedSigner2: z.string().nullable(),
335
- saExtractedSignatureDate2: z.date().nullable(),
336
- saCheck: z.nativeEnum(SaCheck),
337
- saCheckedAt: z.date().nullable(),
338
- saLog: SaLogSchema.nullable(),
339
- txnTid: z.string().nullable(),
340
- txnResponse: z.string().nullable(),
341
- txnPaymentMethod: z.nativeEnum(PaymentMethodType).nullable(),
342
- txnCurrencyCode: z.string().length(3).nullable(),
343
- txnChargedAmount: z.number().multipleOf(0.01).nullable(),
344
- txnDate: z.date().nullable(),
345
- txnSettledDate: z.date().nullable(),
346
- fundingStatus: z.nativeEnum(FundingStatus).nullable(),
347
- fundingStatusUnmapped: z.string().nullable(),
348
- txnCheck: z.nativeEnum(TxnCheck).nullable(),
349
- txnCheckedAt: z.date().nullable(),
350
- txnLog: z.string().nullable(),
351
- systemReviewCheck: z.nativeEnum(SystemReviewCheck).nullable(),
352
- systemReviewCheckedAt: z.date().nullable(),
353
- systemReviewLog: z.string().nullable(),
354
- complianceReview: z.nativeEnum(ComplianceReview).nullable(),
355
- complianceReviewNotes: z.string().nullable(),
356
- complianceReviewerId: z.string().nullable(),
357
- issuerId: z.lazy(() => issuerIdSchema.nullable()),
358
- complianceReviewName: z.string().nullable(),
359
- complianceReviewAt: z.date().nullable(),
360
- tradeType: z.nativeEnum(TradeType).nullable(),
361
- placedAt: z.date().nullable(),
362
- platform: z.string(),
363
- cancelledAt: z.date().nullable(),
364
- cancelledById: z.string().nullable(),
365
- cancelledReason: z.string().nullable(),
366
- cancellationPeriod: z.number().nullable(),
367
- disbursed: z.boolean().optional(),
368
- tradeAdjustments: z.number().nullable().optional(),
369
- chargedAmount: z.number().nullable().optional(),
370
- balance: z.number().nullable().optional(),
371
- isUncleared24h: z.boolean(),
372
- });
373
- export type TradeZod = z.infer<typeof TradeZod>;
374
-
375
- export enum SnapshotEvent {
376
- COMPLIANCE_APPROVED = 'COMPLIANCE_APPROVED',
377
- COMPLIANCE_REJECTED = 'COMPLIANCE_REJECTED',
378
- CANCELLED = 'CANCELLED',
379
- PLACED = 'PLACED',
380
- SETTLED = 'SETTLED',
381
- }
382
-
383
- export const GetTradeSnapshotEventsResponse = z.object({
384
- events: z.array(z.nativeEnum(SnapshotEvent)),
385
- });
386
- export type GetTradeSnapshotEventsResponse = z.infer<
387
- typeof GetTradeSnapshotEventsResponse
388
- >;
389
-
390
- export const IPaginatedTrade = z.object({
391
- items: z.array(TradeZod),
392
- meta: IPaginationMeta,
393
- });
394
- export type IPaginatedTrade = z.infer<typeof IPaginatedTrade>;
395
-
396
- export const IPaginatedReviewTrade = z.object({
397
- totalCount: z.number().int(),
398
- currentPosition: z.number().int(),
399
- tradeIds: z.array(tradeIdSchema),
400
- });
401
- export type IPaginatedReviewTrade = z.infer<typeof IPaginatedReviewTrade>;
402
-
403
- export const TradeSummaryZod = z.object({
404
- accountId: accountIdSchema,
405
- accountName: z.string(),
406
- regACount: z.number().int(),
407
- regCfCount: z.number().int(),
408
- regDCount: z.number().int(),
409
- totalCount: z.number().int(),
410
- totalReadyToApproveCount: z.number().int(),
411
- regAReadyToApproveCount: z.number().int(),
412
- regCfReadyToApproveCount: z.number().int(),
413
- regDReadyToApproveCount: z.number().int(),
414
- });
415
- export type TradeSummaryZod = z.infer<typeof TradeSummaryZod>;
416
-
417
- export const IPaginatedTradeSummaryResponse = z.object({
418
- items: z.array(TradeSummaryZod),
419
- meta: IPaginationMeta,
420
- });
421
- export type IPaginatedTradeSummaryResponse = z.infer<
422
- typeof IPaginatedTradeSummaryResponse
423
- >;
424
-
425
- export const TradeSummaryFilterZod = z.object({
426
- reviewStatus: z.nativeEnum(ComplianceReview).optional(),
427
- managedBy: z.nativeEnum(ManagedByType).optional(),
428
- });
429
-
430
- const tradeStatusValues = Object.values(TradeStatus) as string[];
431
-
432
- export const TradeFiltersZod = z.object({
433
- investmentType: z.nativeEnum(InvestmentType).optional(),
434
- tradeStatus: z
435
- .string()
436
- .optional()
437
- .transform((str) => (str ? str.split(',') : []))
438
- .refine(
439
- (statuses) =>
440
- statuses.every((status) => tradeStatusValues.includes(status as any)),
441
- {
442
- message: `Invalid trade status option provided. Valid options are: ${tradeStatusValues.join(',')}`,
443
- },
444
- )
445
- .openapi({
446
- example: `${tradeStatusValues.join(',')}`,
447
- }),
448
- from: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
449
- to: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
450
- saStatus: z.nativeEnum(SaStatus).optional(),
451
- saCheck: z.nativeEnum(SaCheck).optional(),
452
- txnPaymentMethod: z.nativeEnum(PaymentMethodType).optional(),
453
- fundingStatus: z.nativeEnum(FundingStatus).optional(),
454
- txnCheck: z.nativeEnum(TxnCheck).optional(),
455
- systemReviewCheck: z.nativeEnum(SystemReviewCheck).optional(),
456
- complianceReview: z.nativeEnum(ComplianceReview).optional(),
457
- beenDisbursed: z.enum(['true', 'false']).optional(),
458
- search: z.string().max(50).optional(),
459
- offeringId: z
460
- .lazy(() => offeringIdSchema)
461
- .optional()
462
- .openapi({
463
- example: 'offering_00041061050r3gg28a1c60t3gf',
464
- }),
465
- accountId: accountIdSchema.optional(),
466
- issuerId: z
467
- .lazy(() => issuerIdSchema)
468
- .optional()
469
- .openapi({
470
- example: 'issuer_01jfw4q6qef30s6fpqtsxw94ya',
471
- }),
472
- snapshotEvent: z.nativeEnum(SnapshotEvent).optional(),
473
- offeringType: z.nativeEnum(OfferingType).optional(),
474
- managedBy: z.nativeEnum(ManagedByType).optional(),
475
- platform: z.nativeEnum(Platforms).optional(),
476
- investorAccountId: z.lazy(() => investorAccountIdSchema).optional(),
477
- });
478
-
479
- export const ComplianceTradesFiltersZod = z.object({
480
- kycStatus: z.nativeEnum(KYCStatus).optional(),
481
- aicStatus: z.nativeEnum(AicStatus).optional(),
482
- amlStatus: z.nativeEnum(AMLStatus).optional(),
483
- accountStatus: z.nativeEnum(AccountStatus).optional(),
484
- savedQuery: z.nativeEnum(SavedQuery).optional(),
485
- });
486
-
487
- export type ComplianceTradesFiltersZod = z.infer<
488
- typeof ComplianceTradesFiltersZod
489
- >;
490
-
491
- export const TradeSortZod = z.object({
492
- sort: z
493
- .enum([SortBy.PLACEDAT, SortBy.CREATED_AT, SortBy.UPDATED_AT])
494
- .optional(),
495
- dir: z.nativeEnum(SortOrder).optional(),
496
- });
497
- export type TradeSortZod = z.infer<typeof TradeSortZod>;
498
-
499
- export const reviewTrades = z.object({
500
- complianceReview: z.nativeEnum(ComplianceReview),
501
- force: z.boolean().optional(),
502
- forceApprovals: z
503
- .array(z.enum(['kyc', 'aic', 'aml', 'subdoc']))
504
- .optional()
505
- .openapi({
506
- example: ['kyc', 'aml'],
507
- }), // items we are trying to force approve along with the trade
508
- trades: z
509
- .array(tradeIdSchema)
510
- .min(1, 'At least one trade is required')
511
- .max(1000, 'Maximum of 1000 trades allowed')
512
- .openapi({
513
- example: [
514
- 'trade_00041061050r3gg28a1c60t3gf',
515
- 'trade_00041061050r3gg28a1c60t3g',
516
- ],
517
- }),
518
- rejectionReason: z.string().min(1).max(1000).optional().nullable(),
519
- });
520
- export type reviewTrades = z.infer<typeof reviewTrades>;
521
-
522
- export const reviewAllTrades = z.object({
523
- complianceReview: z.enum([
524
- ComplianceReview.APPROVED,
525
- ]) /* only approved is supported for now */,
526
- });
527
- export type reviewAllTrades = z.infer<typeof reviewAllTrades>;
528
-
529
- export const PatchTradeStatus = z.object({
530
- tradeStatus: z.nativeEnum(TradeStatus),
531
- });
532
- export type PatchTradeStatus = z.infer<typeof PatchTradeStatus>;
533
-
534
- export const tradesInclude = z.enum([
535
- 'tradeDisbursements',
536
- 'adjustments',
537
- 'account',
538
- 'issuer',
539
- 'lineItems',
540
- 'transactions',
541
- 'investorAccount',
542
- 'offering',
543
- 'paymentMethod',
544
- ]);
545
-
546
- /**
547
- * @description Query parameters for including related entities
548
- * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
549
- */
550
- export const TradesIncludeQuery = z.object({
551
- include: z
552
- .string()
553
- .optional()
554
- .transform((str) => (str ? str.split(',') : []))
555
- .refine(
556
- (includes) =>
557
- includes.every((include) =>
558
- tradesInclude.options.includes(include as any),
559
- ),
560
- {
561
- message: `Invalid include option provided. Valid options are: ${tradesInclude.options.join(',')}`,
562
- },
563
- )
564
- .openapi({
565
- example: `${tradesInclude.options.join(',')}`,
566
- }),
567
- });
568
-
569
- export interface TradesIncludeQuery
570
- extends z.infer<typeof TradesIncludeQuery> {}
571
-
572
- export enum TradeExportType {
573
- PAGE = 'PAGE',
574
- ALL = 'ALL',
575
- }
576
-
577
- export const ExportTradesQuery = PaginationOptionsZod.merge(TradeFiltersZod)
578
- .merge(ComplianceTradesFiltersZod)
579
- .merge(TradesIncludeQuery)
580
- .merge(TradeSortZod)
581
- .extend({
582
- exportType: z
583
- .nativeEnum(TradeExportType)
584
- .optional()
585
- .default(TradeExportType.PAGE),
586
- });
587
- export type ExportTradesQuery = z.infer<typeof ExportTradesQuery>;
588
-
589
- const tradesColumn = z.enum([
590
- 'id',
591
- 'investorAccountId',
592
- 'investorAccount',
593
- 'accountId',
594
- 'account',
595
- 'offeringId',
596
- 'offering',
597
- 'paymentMethodId',
598
- 'paymentMethod',
599
- 'userId',
600
- 'user',
601
- 'disbursementId',
602
- 'disbursement',
603
- 'tradeNumber',
604
- 'ip',
605
- 'tid',
606
- 'platform',
607
- 'investmentType',
608
- 'numberOfShares',
609
- 'pricePerShare',
610
- 'lineItems',
611
- 'transactions',
612
- 'totalAmount',
613
- 'tradeStatus',
614
- 'tradeStatusUnmapped',
615
- 'tradeDate',
616
- 'saStatus',
617
- 'saStatusUnmapped',
618
- 'saUrl',
619
- 'saSignedAt',
620
- 'saExtractedNumberOfShares',
621
- 'saExtractedTotalAmount',
622
- 'saExtractedPricePerShare',
623
- 'saExtractedInvestorType',
624
- 'saExtractedSigner',
625
- 'saExtractedSignatureDate',
626
- 'saExtractedSigner2',
627
- 'saExtractedSignatureDate2',
628
- 'saCheck',
629
- 'saCheckedAt',
630
- 'saLog',
631
- 'txnTid',
632
- 'txnResponse',
633
- 'txnPaymentMethod',
634
- 'txnCurrencyCode',
635
- 'txnChargedAmount',
636
- 'txnDate',
637
- 'txnSettledDate',
638
- 'fundingStatus',
639
- 'fundingStatusUnmapped',
640
- 'txnCheck',
641
- 'txnCheckedAt',
642
- 'txnLog',
643
- 'systemReviewCheck',
644
- 'systemReviewLog',
645
- 'complianceReview',
646
- 'complianceReviewNotes',
647
- 'complianceReviewerId',
648
- 'managedBy',
649
- 'complianceReviewer',
650
- 'issuer',
651
- 'issuerId',
652
- 'complianceReviewName',
653
- 'complianceReviewAt',
654
- 'tradeType',
655
- 'placedAt',
656
- 'cancelledAt',
657
- 'cancelledById',
658
- 'cancelledReason',
659
- 'cancellationPeriod',
660
- ]);
661
-
662
- /**
663
- * @description Query parameters for including related entities
664
- * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
665
- */
666
- export const TradesColumnQuery = z.object({
667
- column: z
668
- .string()
669
- .optional()
670
- .transform((str) => (str ? str.split(',') : []))
671
- .refine(
672
- (columns) =>
673
- columns.every((col) => tradesColumn.options.includes(col as any)),
674
- {
675
- message: `Invalid column option provided. Valid options are: ${tradesColumn.options.join(',')}`,
676
- },
677
- )
678
- .openapi({
679
- example: `${tradesColumn.options.join(',')}`,
680
- }),
681
- });
682
-
683
- export const InvestorsTradeFiltersZod = z.object({
684
- investorAccountId: z.lazy(() => investorAccountIdSchema).optional(),
685
- tradeStatus: z.nativeEnum(TradeStatus).optional(),
686
- search: z.string().min(1).max(50).optional(),
687
- });
688
-
689
- const investorsTradesInclude = z.enum([
690
- 'lineItems',
691
- 'investorAccount',
692
- 'issuer',
693
- 'offering',
694
- ]);
695
-
696
- /**
697
- * @description Query parameters for including related entities
698
- * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
699
- */
700
- export const InvestorsTradesIncludeQuery = z.object({
701
- include: z
702
- .string()
703
- .optional()
704
- .transform((str) => (str ? str.split(',') : []))
705
- .refine(
706
- (includes) =>
707
- includes.every((include) =>
708
- investorsTradesInclude.options.includes(include as any),
709
- ),
710
- {
711
- message: `Invalid include option provided. Valid options are: ${investorsTradesInclude.options.join(',')}`,
712
- },
713
- )
714
- .openapi({
715
- example: `${investorsTradesInclude.options.join(',')}`,
716
- }),
717
- });
718
- export interface InvestorsTradesIncludeQuery
719
- extends z.infer<typeof InvestorsTradesIncludeQuery> {}
720
-
721
- export const InvestorsGetTradesQuery = PaginationOptionsZod.merge(
722
- InvestorsTradeFiltersZod,
723
- ).merge(InvestorsTradesIncludeQuery);
724
-
725
- export const UpdateTradeBody = z.object({
726
- paymentMethodId: z.lazy(() => paymentMethodIdSchema),
727
- });
728
-
729
- export type UpdateTradeBodyType = z.infer<typeof UpdateTradeBody>;
730
-
731
- export const PostTradeBody = z.object({
732
- investorAccountId: z.lazy(() => investorAccountIdSchema).optional(),
733
- investmentType: z.nativeEnum(InvestmentType).optional(),
734
- });
735
-
736
- export type PostTradeBodyType = z.infer<typeof PostTradeBody>;
737
-
738
- export const InvestorsTradeResponse = IBaseEntity.extend({
739
- investorAccountId: z.lazy(() => investorAccountIdSchema).nullable(),
740
- accountId: z.string(),
741
- offeringId: z.string().nullable(),
742
- tid: z.string().nullable(),
743
- investmentType: z.nativeEnum(InvestmentType),
744
- numberOfShares: z.number().int(),
745
- pricePerShare: z.number().multipleOf(0.01),
746
- totalAmount: z.number().multipleOf(0.01).nullable(),
747
- tradeStatus: z.nativeEnum(TradeStatus),
748
- tradeStatusUnmapped: z.string().nullable(),
749
- tradeDate: z.date().nullable(),
750
- paymentMethodId: z.lazy(() => paymentMethodIdSchema).nullable(),
751
- });
752
-
753
- export const InvestorsPaginatedTrade = z.object({
754
- items: z.array(InvestorsTradeResponse),
755
- meta: IPaginationMeta,
756
- });
757
- export const IssuersTradeFiltersZod = z.object({
758
- investmentType: z.nativeEnum(InvestmentType).optional(),
759
- tradeStatus: z.nativeEnum(TradeStatus).optional(),
760
- saStatus: z.nativeEnum(SaStatus).optional(),
761
- saCheck: z.nativeEnum(SaCheck).optional(),
762
- txnPaymentMethod: z.nativeEnum(PaymentMethodType).optional(),
763
- fundingStatus: z.nativeEnum(FundingStatus).optional(),
764
- txnCheck: z.nativeEnum(TxnCheck).optional(),
765
- systemReviewCheck: z.nativeEnum(SystemReviewCheck).optional(),
766
- complianceReview: z.nativeEnum(ComplianceReview).optional(),
767
- beenDisbursed: z.enum(['true', 'false']).optional(),
768
- search: z.string().optional().openapi({ example: 'Mike' }),
769
- offeringId: z
770
- .lazy(() => offeringIdSchema)
771
- .optional()
772
- .openapi({
773
- example: 'offering_00041061050r3gg28a1c60t3gf',
774
- }),
775
- from: createDateSchema('START').optional().openapi({ example: 'MM/DD/YYYY' }),
776
- to: createDateSchema('END').optional().openapi({ example: 'MM/DD/YYYY' }),
777
- minAmount: z
778
- .string()
779
- .transform((num) => Number(num))
780
- .pipe(z.number().multipleOf(0.01).min(0.01).max(10000000000))
781
- .optional()
782
- .openapi({ example: '2500.00' }),
783
- maxAmount: z
784
- .string()
785
- .transform((num) => Number(num))
786
- .pipe(z.number().multipleOf(0.01).min(0.01).max(10000000000))
787
- .optional()
788
- .openapi({ example: '15000000.50' }),
789
- managedBy: z.nativeEnum(ManagedByType).optional(),
790
- investorAccountId: z.lazy(() => investorAccountIdSchema).optional(),
791
- });
792
- export type IssuersTradeFiltersZod = z.infer<typeof IssuersTradeFiltersZod>;
793
-
794
- /**
795
- * Zod schema representing a union of all possible filter types based on portal type.
796
- * This schema can be used for runtime validation of filter parameters.
797
- */
798
- export const GetTradeFiltersSchema = z.union([
799
- TradeFiltersZod,
800
- IssuersTradeFiltersZod,
801
- InvestorsTradeFiltersZod,
802
- ]);
803
-
804
- /**
805
- * Type representing the filters parameter for getTradeWithCalculatedFields.
806
- * This is a union of all possible filter types based on portal type:
807
- * - TradeFiltersZod (Compliance portal)
808
- * - IssuersTradeFiltersZod (Issuer portal)
809
- * - InvestorsTradeFiltersZod (Investor portal)
810
- */
811
- export type GetTradeFiltersType = z.infer<typeof GetTradeFiltersSchema>;
812
-
813
- export const CancelTradeResponse = z.object({
814
- message: z.string(),
815
- });
816
- export type CancelTradeResponse = z.infer<typeof CancelTradeResponse>;
817
-
818
- export const FailedTradeZod = z.object({
819
- id: tradeIdSchema,
820
- tradeNo: z.string(),
821
- errors: z.string().array(),
822
- });
823
-
824
- export type FailedTradeZod = z.infer<typeof FailedTradeZod>;
825
-
826
- export const ReviewTradeZod = z.object({
827
- success: z.boolean(),
828
- message: z.string(),
829
- failedTrades: z.array(FailedTradeZod),
830
- });
831
-
832
- export type ReviewTradeZod = z.infer<typeof ReviewTradeZod>;
833
-
834
- export const CancelTradeZod = z.object({
835
- reason: z
836
- .string()
837
- .min(2)
838
- .max(1000)
839
- .openapi({ example: 'cancellation reason' }),
840
- });
841
-
842
- export type CancelTradeZod = z.infer<typeof CancelTradeZod>;
843
-
844
- export const ComplianceCancelTradeZod = z.object({
845
- reason: z
846
- .string()
847
- .min(2)
848
- .max(1000)
849
- .openapi({ example: 'cancellation reason' }),
850
- accountId: accountIdSchema.openapi({
851
- example: 'account_00041061050r3gg28a1c60t3gf',
852
- }),
853
- });
854
- export type ComplianceCancelTradeZod = z.infer<typeof ComplianceCancelTradeZod>;
855
-
856
- export const ProcessPaymentZod = z.object({
857
- tradeId: tradeIdSchema,
858
- amount: z.number().min(0.01).max(10000000000),
859
- });
860
-
861
- export type ProcessPaymentZod = z.infer<typeof ProcessPaymentZod>;
862
-
863
- export const ProcessPaymentResponse = z.object({
864
- success: z.boolean(),
865
- });
866
-
867
- export type ProcessPaymentResponse = z.infer<typeof ProcessPaymentResponse>;
868
-
869
- const TradeLineItemDataZod = z.object({
870
- signaturePlatform: z.string(),
871
- signatureDocumentId: z.string(),
872
- signatureUrl: z.string(),
873
- signatureStatus: z.nativeEnum(SignatureStatus),
874
- });
875
-
876
- export type TradeLineItemDataZod = z.infer<typeof TradeLineItemDataZod>;
877
-
878
- export const TradeSystemReviewLogZod = z.object({
879
- type: z.nativeEnum(TradeSystemLogType),
880
- data: z.record(z.string(), z.any()),
881
- error: z.string().nullable(),
882
- message: z.string().nullable(),
883
- status: z.nativeEnum(TradeSystemReviewLogStatus),
884
- });
885
- export type TradeSystemReviewLogZod = z.infer<typeof TradeSystemReviewLogZod>;
886
-
887
- export enum BoldsignTemplateType {
888
- INDIVIDUAL = 'INDIVIDUAL',
889
- JOINT = 'JOINT',
890
- ENTITY = 'ENTITY',
891
- }
892
-
893
- export const GetTemplateVariablesForTradeZod = z.object({
894
- templateType: z.nativeEnum(BoldsignTemplateType),
895
- templateId: z.string(),
896
- mergeVars: z.array(
897
- z.object({
898
- field: z.string(),
899
- value: z.string(),
900
- }),
901
- ),
902
- });
903
-
904
- export type GetTemplateVariablesForTradeZod = z.infer<
905
- typeof GetTemplateVariablesForTradeZod
906
- >;
907
-
908
- /**
909
- * Zod schema for CSV export data with all formatted fields ready for export
910
- * All extraction and formatting logic is handled in trades.service.ts
911
- */
912
- export const TradeForCsvExportZod = z.object({
913
- tradeNumber: z.string(),
914
- investorName: z.string(),
915
- signerName: z.string(),
916
- offeringName: z.string(),
917
- tradeType: z.string(),
918
- numberOfShares: z.number(),
919
- pricePerShare: z.string(), // Formatted with $ prefix
920
- totalAmount: z.string(), // Formatted with $ prefix
921
- tradeStatus: z.string(),
922
- fundingStatus: z.string(),
923
- kycStatus: z.boolean(),
924
- amlStatus: z.boolean(),
925
- aicStatus: z.boolean(),
926
- saStatus: z.string(),
927
- placedAt: z.string(), // Formatted date string
928
- closedAt: z.string(), // Formatted date string
929
- txnPaymentMethod: z.string(),
930
- txnChargedAmount: z.string(), // Formatted with $ prefix
931
- registeredRepId: z.string(),
932
- managedBy: z.string(),
933
- platform: z.string(),
934
- // Entity fields (for LEGAL_ENTITY type)
935
- entityName: z.string(),
936
- entityEin: z.string(),
937
- entityAddress: z.string(),
938
- entityAddress2: z.string(),
939
- entityCity: z.string(),
940
- entityCountry: z.string(),
941
- entityState: z.string(),
942
- entityZip: z.string(),
943
- entityEmail: z.string(),
944
- entityPhone: z.string(),
945
- entityCompanyType: z.string(),
946
- // Primary individual fields
947
- primaryFirstName: z.string(),
948
- primaryLastName: z.string(),
949
- primaryDob: z.string(), // Formatted date string
950
- primarySsn: z.string(), // Formatted SSN
951
- primaryAddress: z.string(),
952
- primaryAddress2: z.string(),
953
- primaryCity: z.string(),
954
- primaryCountry: z.string(),
955
- primaryState: z.string(),
956
- primaryZip: z.string(),
957
- primaryEmail: z.string(),
958
- primaryPhone: z.string(),
959
- // Secondary individual fields (for JOINT and LEGAL_ENTITY types)
960
- secondaryFirstName: z.string(),
961
- secondaryLastName: z.string(),
962
- secondaryDob: z.string(), // Formatted date string
963
- secondarySsn: z.string(), // Formatted SSN
964
- secondaryAddress: z.string(),
965
- secondaryAddress2: z.string(),
966
- secondaryCity: z.string(),
967
- secondaryCountry: z.string(),
968
- secondaryState: z.string(),
969
- secondaryZip: z.string(),
970
- secondaryEmail: z.string(),
971
- secondaryPhone: z.string(),
972
- });
973
-
974
- export type TradeForCsvExport = z.infer<typeof TradeForCsvExportZod>;
975
-
976
- export const CANCELLABLE_TRADE_STATUSES = [
977
- TradeStatus.PLACED,
978
- TradeStatus.IN_REVIEW,
979
- TradeStatus.NEEDS_INFO,
980
- TradeStatus.FUNDING,
981
- ];
982
-
983
- export const NON_CANCELABLE_COMPLIANCE_REVIEW_STATUSES = [
984
- ComplianceReview.APPROVED,
985
- ComplianceReview.REJECTED,
986
- ComplianceReview.CANCELLED,
987
- ];
988
-
989
- /**
990
- * Filter type for Investor Account exports in workers
991
- * Extends the base InvestorAccountExportFilters with additional optional fields needed for bulk exports
992
- */
993
- export type WorkerInvestorAccountExportFilters = Partial<
994
- (InvestorAccountExportFilters | ComplianceInvestorAccountExportFilters) & {
995
- isRegisteredUsersExport: boolean | null;
996
- search: string | null;
997
- startDate: Date | null;
998
- endDate: Date | null;
999
- userType: string | null;
1000
- accountId: string | null;
1001
- }
1002
- >;
1003
- /**
1004
- * Filter type for Trade exports
1005
- * Extends IssuersTradeFiltersZod with accountId
1006
- */
1007
- export type TradeExportFilters = Partial<
1008
- IssuersTradeFiltersZod & {
1009
- accountId: string | null;
1010
- }
1011
- >;
1012
-
1013
- /**
1014
- * Filter type for Compliance Trade exports
1015
- */
1016
- export type ComplianceTradeExportFilters = Partial<ExportTradesQuery>;
1017
-
1018
- /**
1019
- * Filter type for Secondary Customer exports
1020
- */
1021
- export type SecondaryCustomerExportFilters =
1022
- Partial<GetSecondaryCustomerFiltersZod>;
1023
-
1024
- /**
1025
- * Filter type for Secondary Trade exports
1026
- */
1027
- export type SecondaryTradeExportFilters = Partial<SecondaryTradeFiltersZod>;
1028
-
1029
- /**
1030
- * Combined filter type for all bulk export types
1031
- * Used in the ExportBulkDataDto
1032
- */
1033
- export type BulkExportFilters =
1034
- | WorkerInvestorAccountExportFilters
1035
- | TradeExportFilters
1036
- | ComplianceTradeExportFilters
1037
- | SecondaryCustomerExportFilters
1038
- | SecondaryTradeExportFilters;
1039
-
1040
- export type BulkExportResponse =
1041
- | InvestorAccount[]
1042
- | RegisteredInvestorUserRawZod[]
1043
- | Trade[]
1044
- | SecondaryCustomer[]
1045
- | SecondaryTrade[];