@dalmore/api-contracts 0.0.0-dev.988f3c3 → 0.0.0-dev.a0bb940

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 +217 -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 +1498 -0
  66. package/common/types/common.types.js +1431 -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 +329 -0
  308. package/common/types/trade-line-item.types.js +100 -0
  309. package/common/types/trade-line-item.types.js.map +1 -0
  310. package/common/types/trade.types.d.ts +2004 -0
  311. package/common/types/trade.types.js +783 -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 +12482 -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 +871 -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 -98
  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 -124
  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 -370
  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 -1530
  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 -107
  431. package/common/types/countries.types.ts +0 -375
  432. package/common/types/covered-person.types.ts +0 -274
  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 -541
  454. package/common/types/investor-account.types.ts +0 -1239
  455. package/common/types/investors-offering.types.ts +0 -65
  456. package/common/types/invite.types.ts +0 -133
  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 -185
  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 -726
  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 -999
  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 -307
  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 -134
  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 -137
  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 -230
  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 -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 -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,325 +0,0 @@
1
- import { z } from 'zod';
2
- import { TypeID } from 'typeid-js';
3
- import { IBaseEntity } from './entity.types';
4
- import { dataRoomIdSchema } from './data-room.types';
5
- import { fileIdSchema } from './file.types';
6
- import { BaseStatus, IPaginationMeta } from './common.types';
7
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
8
- extendZodWithOpenApi(z);
9
-
10
- export const dataRecordIdSchema = z.string().refine(
11
- (value) => {
12
- try {
13
- const tid = TypeID.fromString(value);
14
- return tid.getType() === 'data_record';
15
- } catch {
16
- return false;
17
- }
18
- },
19
- {
20
- message:
21
- 'Invalid data_record ID format. Must be a valid TypeID with "data_record" prefix.',
22
- },
23
- );
24
-
25
- export const dataRecordFileIdSchema = z.string().refine(
26
- (value) => {
27
- try {
28
- const tid = TypeID.fromString(value);
29
- return tid.getType() === 'data_record_file';
30
- } catch {
31
- return false;
32
- }
33
- },
34
- {
35
- message:
36
- 'Invalid data_record_file ID format. Must be a valid TypeID with "data_record" prefix.',
37
- },
38
- );
39
-
40
- const dataRecordsInclude = z.enum(['dataRecordFiles', 'children']);
41
-
42
- /**
43
- * @description Query parameters for including related entities
44
- * @example in contract us as -> query: z.object({}).merge(DataRecordsIncludeQuery),
45
- */
46
- export const DataRecordsIncludeQuery = z.object({
47
- include: z
48
- .string()
49
- .optional()
50
- .transform((str) => (str ? str.split(',') : []))
51
- .refine(
52
- (includes) =>
53
- includes.every((include) =>
54
- dataRecordsInclude.options.includes(include as any),
55
- ),
56
- {
57
- message: `Invalid include option provided. Valid options are: ${dataRecordsInclude.options.join(',')}`,
58
- },
59
- )
60
- .openapi({
61
- example: `${dataRecordsInclude.options.join(',')}`,
62
- }),
63
- });
64
- export interface DataRecordsIncludeQuery
65
- extends z.infer<typeof DataRecordsIncludeQuery> {}
66
-
67
- export const DataRecordFileZod = IBaseEntity.extend({
68
- dataRecordId: z.lazy(() => dataRecordIdSchema),
69
- fileId: fileIdSchema.nullable(),
70
- });
71
- export type DataRecordFileZod = z.infer<typeof DataRecordFileZod>;
72
-
73
- export enum DataRecordType {
74
- FOLDER = 'FOLDER',
75
- }
76
-
77
- export const DataRecordZod = IBaseEntity.extend({
78
- name: z.string(),
79
- type: z.nativeEnum(DataRecordType),
80
- parentId: z.string().nullable(),
81
- children: z.array(z.lazy(() => DataRecordZod)).openapi({
82
- example: [
83
- {
84
- id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
85
- name: 'Record 1',
86
- type: 'FOLDER',
87
- parentId: 'data_record_01jghnncbmfkpre0ybqv0n8017',
88
- children: [],
89
- dataRecordFiles: [],
90
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
91
- },
92
- ],
93
- }),
94
- dataRecordFiles: z.array(DataRecordFileZod),
95
- dataRoomId: z.lazy(() => dataRoomIdSchema),
96
- });
97
- export type DataRecordZod = z.infer<typeof DataRecordZod>;
98
-
99
- export const IPaginatedDataRecords = z.object({
100
- items: z.array(DataRecordZod),
101
- meta: IPaginationMeta,
102
- });
103
- export type IPaginatedDataRecords = z.infer<typeof IPaginatedDataRecords>;
104
-
105
- export const RecordPathResponse = z.object({
106
- records: z.array(DataRecordZod),
107
- path: z.string().openapi({ example: '/folder_1/folder_2/target_record' }),
108
- });
109
- export type RecordPathResponse = z.infer<typeof RecordPathResponse>;
110
-
111
- export const PostDataRecordFolder = z.object({
112
- name: z.string().min(1).max(255),
113
- dataRoomId: z.lazy(() => dataRoomIdSchema),
114
- parentId: dataRecordIdSchema,
115
- });
116
- export type PostDataRecordFolder = z.infer<typeof PostDataRecordFolder>;
117
-
118
- export const DeleteDataRecordFolder = z.object({
119
- folderId: dataRecordIdSchema,
120
- force: z.boolean().default(false),
121
- });
122
- export type DeleteDataRecordFolder = z.infer<typeof DeleteDataRecordFolder>;
123
-
124
- export const MoveDataRecordFolder = z.object({
125
- folderId: dataRecordIdSchema,
126
- targetFolderId: dataRecordIdSchema,
127
- });
128
- export type MoveDataRecordFolder = z.infer<typeof MoveDataRecordFolder>;
129
-
130
- export const PostDataRecordFile = z.object({
131
- dataRecordId: dataRecordIdSchema,
132
- });
133
- export type PostDataRecordFile = z.infer<typeof PostDataRecordFile>;
134
-
135
- export const PatchDataRecordFile = z.object({
136
- fileId: fileIdSchema,
137
- });
138
- export type PatchDataRecordFile = z.infer<typeof PatchDataRecordFile>;
139
-
140
- export const DeleteDataRecordFile = z.object({
141
- dataRecordId: dataRecordIdSchema,
142
- fileId: fileIdSchema,
143
- });
144
- export type DeleteDataRecordFile = z.infer<typeof DeleteDataRecordFile>;
145
-
146
- export const MoveDataRecordFile = z.object({
147
- sourceFolderId: dataRecordIdSchema,
148
- targetFolderId: dataRecordIdSchema,
149
- fileId: fileIdSchema,
150
- });
151
- export type MoveDataRecordFile = z.infer<typeof MoveDataRecordFile>;
152
-
153
- export const PatchDataRecordFolder = z.object({
154
- name: z.string().min(1).max(255),
155
- });
156
- export type PatchDataRecordFolder = z.infer<typeof PatchDataRecordFolder>;
157
-
158
- type IBaseEntityType = z.infer<typeof IBaseEntity>;
159
-
160
- export interface BaseDataRecordStructure extends IBaseEntityType {
161
- name: string;
162
- type: DataRecordType;
163
- parentId: string | null;
164
- dataRoomId: string;
165
- dataRecordFiles?: DataRecordFileZod[] | undefined;
166
- data?: BaseDataRecordStructure[] | undefined;
167
- }
168
-
169
- export const DataRecordStructureZod: z.ZodType<BaseDataRecordStructure> = z
170
- .lazy(() =>
171
- IBaseEntity.extend({
172
- name: z.string().min(1).max(255),
173
- type: z.nativeEnum(DataRecordType),
174
- parentId: z.string().nullable(),
175
- dataRoomId: z.string(),
176
- dataRecordFiles: z.array(DataRecordFileZod).optional(),
177
- data: z.array(z.lazy(() => DataRecordStructureZod)).optional(),
178
- isPasswordProtected: z.boolean(),
179
- }),
180
- )
181
- .openapi({
182
- example: {
183
- createdAt: '2025-01-01T19:31:04.725Z',
184
- updatedAt: '2025-01-01T19:50:28.979Z',
185
- deletedAt: null,
186
- id: 'data_record_01jghnk8wxeb6sc3aqphtdjk9e',
187
- name: 'Folder 1 Updated',
188
- type: 'FOLDER',
189
- parentId: null,
190
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
191
- dataRecordFiles: [
192
- {
193
- createdAt: '2025-01-01T21:55:45.048Z',
194
- updatedAt: '2025-01-01T21:55:45.048Z',
195
- deletedAt: null,
196
- id: 'data_record_file_01jghxw5ryfrev868psy5m2kkd',
197
- dataRecordId: 'data_record_01jghnk8wxeb6sc3aqphtdjk9e',
198
- fileId: 'file_01jghxv0eae8rttq5rw2arry34',
199
- file: {
200
- createdAt: '2025-01-01T21:55:06.528Z',
201
- updatedAt: '2025-01-01T21:55:06.528Z',
202
- deletedAt: null,
203
- id: 'file_01jghxv0eae8rttq5rw2arry34',
204
- tid: null,
205
- url: 'https://dalmoredatafactory.blob.core.windows.net/api-files-public-dev/1735768506533.trade_01jghn5866f3ev3xe7a82ykqbn.test.pdf',
206
- fileType: 'application/pdf',
207
- fileName: 'test.pdf',
208
- name: 'test',
209
- category: 'test',
210
- label: 'label',
211
- extractedData: null,
212
- targetTable: 'TRADES',
213
- targetId: 'trade_01jghn5866f3ev3xe7a82ykqbn',
214
- linkedFrom: null,
215
- accountId: 'account_01jghn57a5e0wvz5q4t9a9fzj5',
216
- userId: 'user_01jghn57pgfpsvqczcvz6pmv50',
217
- __entity: 'File',
218
- },
219
- __entity: 'DataRecordFile',
220
- },
221
- ],
222
- __entity: 'DataRecord',
223
- data: [
224
- {
225
- createdAt: '2025-01-01T19:32:13.779Z',
226
- updatedAt: '2025-01-01T19:32:13.779Z',
227
- deletedAt: null,
228
- id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
229
- name: 'Folder 1.1',
230
- type: 'FOLDER',
231
- parentId: 'data_record_01jghnk8wxeb6sc3aqphtdjk9e',
232
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
233
- dataRecordFiles: [],
234
- __entity: 'DataRecord',
235
- data: [
236
- {
237
- createdAt: '2025-01-01T20:42:54.458Z',
238
- updatedAt: '2025-01-01T20:42:54.458Z',
239
- deletedAt: null,
240
- id: 'data_record_01jghspsmgff8a6sjc7b78s1dx',
241
- name: 'Folder 1.2',
242
- type: 'FOLDER',
243
- parentId: 'data_record_01jghnncbmfkpre0ybqv0n8017',
244
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
245
- dataRecordFiles: [],
246
- __entity: 'DataRecord',
247
- data: [],
248
- },
249
- ],
250
- },
251
- ],
252
- },
253
- });
254
- export type DataRecordStructureZod = z.infer<typeof DataRecordStructureZod>;
255
-
256
- export const DataRecordsFilters = z.object({
257
- search: z.string().max(50).optional(),
258
- parentId: dataRecordIdSchema.optional(),
259
- dataRoomId: z.lazy(() => dataRoomIdSchema).optional(),
260
- status: z.nativeEnum(BaseStatus).optional(),
261
- });
262
- export type DataRecordsFilters = z.infer<typeof DataRecordsFilters>;
263
-
264
- export const FolderSummaryZod = DataRecordZod.extend({
265
- childCount: z.number(),
266
- fileCount: z.number(),
267
- descendantCount: z.number(),
268
- });
269
- export type FolderSummaryZod = z.infer<typeof FolderSummaryZod>;
270
-
271
- export const NavigationContextZod = z.object({
272
- isRoot: z.boolean(),
273
- depth: z.number(),
274
- hasChildren: z.boolean(),
275
- currentPath: z.string(),
276
- parentPath: z.string(),
277
- context: z.object({
278
- dataRoomName: z.string(),
279
- currentFolderName: z.string(),
280
- parentFolderName: z.string().nullable(),
281
- }),
282
- });
283
- export type NavigationContextZod = z.infer<typeof NavigationContextZod>;
284
-
285
- export const NavigationSummaryZod = z
286
- .object({
287
- currentFolder: FolderSummaryZod,
288
- parentFolder: FolderSummaryZod.nullable(),
289
- siblings: z.array(FolderSummaryZod),
290
- children: z.array(FolderSummaryZod),
291
- totalDescendants: z.number(),
292
- navigation: NavigationContextZod,
293
- })
294
- .openapi({
295
- example: {
296
- currentFolder: {
297
- id: 'data_record_01jgjdkne6fbf9bwerypvkd2b5',
298
- name: 'Folder 1',
299
- type: 'FOLDER',
300
- parentId: null,
301
- dataRoomId: 'data_room_01jgjdk1zse759qsb8ma5w9q42',
302
- childCount: 2,
303
- fileCount: 0,
304
- descendantCount: 3,
305
- dataRecordFiles: [],
306
- },
307
- parentFolder: null,
308
- siblings: [],
309
- children: [],
310
- totalDescendants: 3,
311
- navigation: {
312
- isRoot: true,
313
- depth: 0,
314
- hasChildren: true,
315
- currentPath: 'Folder 1',
316
- parentPath: '',
317
- context: {
318
- dataRoomName: 'Test Data Room',
319
- currentFolderName: 'Folder 1',
320
- parentFolderName: null,
321
- },
322
- },
323
- },
324
- });
325
- export type NavigationSummaryZod = z.infer<typeof NavigationSummaryZod>;
@@ -1,242 +0,0 @@
1
- import { z } from 'zod';
2
- import {
3
- AccountZod,
4
- ComplianceReview,
5
- IPaginationMeta,
6
- PaginationOptionsZod,
7
- UrlSchema,
8
- } from './common.types';
9
- import { TypeID } from 'typeid-js';
10
- import { accountIdSchema } from './account.types';
11
- import { IBaseEntity } from './entity.types';
12
- import { DataRecordStructureZod, DataRecordZod } from './data-record.types';
13
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
14
- import { PasswordSchema } from './password.type';
15
- extendZodWithOpenApi(z);
16
-
17
- export const dataRoomIdSchema = z.string().refine(
18
- (value) => {
19
- try {
20
- const tid = TypeID.fromString(value);
21
- return tid.getType() === 'data_room';
22
- } catch {
23
- return false;
24
- }
25
- },
26
- {
27
- message:
28
- 'Invalid data_room ID format. Must be a valid TypeID with "data_room" prefix.',
29
- },
30
- );
31
-
32
- const dataRoomsInclude = z.enum(['dataRecords', 'account']);
33
-
34
- /**
35
- * @description Query parameters for including related entities
36
- * @example in contract us as -> query: z.object({}).merge(DataRoomsIncludeQuery),
37
- */
38
- export const DataRoomsIncludeQuery = z.object({
39
- include: z
40
- .string()
41
- .optional()
42
- .transform((str) => (str ? str.split(',') : []))
43
- .refine(
44
- (includes) =>
45
- includes.every((include) =>
46
- dataRoomsInclude.options.includes(include as any),
47
- ),
48
- {
49
- message: `Invalid include option provided. Valid options are: ${dataRoomsInclude.options.join(',')}`,
50
- },
51
- )
52
- .openapi({
53
- example: `${dataRoomsInclude.options.join(',')}`,
54
- }),
55
- });
56
- export interface DataRoomsIncludeQuery
57
- extends z.infer<typeof DataRoomsIncludeQuery> {}
58
-
59
- export const DataRoomZod = IBaseEntity.extend({
60
- name: z.string(),
61
- accountId: accountIdSchema,
62
- account: AccountZod.optional().nullable(),
63
- dataRecords: z.array(z.lazy(() => DataRecordZod)).openapi({
64
- example: [
65
- {
66
- id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
67
- name: 'Record 1',
68
- type: 'FOLDER',
69
- parentId: null,
70
- children: [],
71
- dataRecordFiles: [],
72
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
73
- },
74
- ],
75
- }),
76
- });
77
- export type DataRoomZod = z.infer<typeof DataRoomZod>;
78
-
79
- export const IPaginatedDataRooms = z.object({
80
- items: z.array(DataRoomZod),
81
- meta: IPaginationMeta,
82
- });
83
- export type IPaginatedDataRooms = z.infer<typeof IPaginatedDataRooms>;
84
-
85
- export const DataRoomApprovalsZod = z.object({
86
- accountName: z.string(),
87
- accountId: accountIdSchema,
88
- pendingFilesCount: z.number(),
89
- });
90
- export type DataRoomApprovalsZod = z.infer<typeof DataRoomApprovalsZod>;
91
-
92
- export const PostDataRoom = z.object({
93
- name: z.string().min(2).max(50),
94
- });
95
- export type PostDataRoom = z.infer<typeof PostDataRoom>;
96
-
97
- export const DeleteDataRoom = z.object({
98
- dataRoomId: dataRoomIdSchema,
99
- force: z.boolean().default(false),
100
- });
101
- export type DeleteDataRoom = z.infer<typeof DeleteDataRoom>;
102
-
103
- export const DataRoomsFilters = z.object({
104
- search: z.string().max(50).optional(),
105
- accountId: accountIdSchema.optional(),
106
- });
107
- export type DataRoomsFilters = z.infer<typeof DataRoomsFilters>;
108
-
109
- export const InvestorDataRoomsFilters = DataRoomsFilters.omit({
110
- accountId: true,
111
- });
112
- export type InvestorDataRoomsFilters = z.infer<typeof InvestorDataRoomsFilters>;
113
-
114
- export const DataRoomStructureZod = IBaseEntity.extend({
115
- name: z.string().min(1).max(255),
116
- accountId: accountIdSchema,
117
- dataRecords: z.array(DataRecordStructureZod).openapi({
118
- example: [
119
- {
120
- id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
121
- name: 'Record 1',
122
- type: 'FOLDER',
123
- parentId: null,
124
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
125
- data: [
126
- {
127
- id: 'data_record_01jghnncbmfkpre0ybqv0n53322',
128
- name: 'Record 2',
129
- type: 'FOLDER',
130
- parentId: 'data_record_01jghnncbmfkpre0ybqv0n8017',
131
- dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
132
- data: [],
133
- },
134
- ],
135
- },
136
- ],
137
- }),
138
- isPasswordProtected: z.boolean(),
139
- });
140
- export type DataRoomStructureZod = z.infer<typeof DataRoomStructureZod>;
141
-
142
- export const DataRoomFilesSummaryFilterZod = z.object({
143
- accountId: accountIdSchema.optional(),
144
- status: z.nativeEnum(ComplianceReview),
145
- });
146
-
147
- export type DataRoomFilesSummaryFilterZod = z.infer<
148
- typeof DataRoomFilesSummaryFilterZod
149
- >;
150
-
151
- export const DataRoomFileSummary = z.object({
152
- fileId: z.string(),
153
- fileName: z.string(),
154
- fileType: z.string(),
155
- complianceReview: z.nativeEnum(ComplianceReview),
156
- account: z.object({
157
- id: z.string(),
158
- name: z.string(),
159
- }),
160
- dataRoom: z.object({
161
- id: z.string(),
162
- name: z.string(),
163
- }),
164
- structure: z.object({
165
- path: z.string(),
166
- }),
167
- createdAt: z.date(),
168
- updatedAt: z.date(),
169
- });
170
-
171
- export type DataRoomFileSummary = z.infer<typeof DataRoomFileSummary>;
172
-
173
- export const IPaginatedDataRoomFilesSummaryZod = z.object({
174
- items: z.array(DataRoomFileSummary),
175
- meta: IPaginationMeta,
176
- });
177
- export type IPaginatedDataRoomFilesSummaryZod = z.infer<
178
- typeof IPaginatedDataRoomFilesSummaryZod
179
- >;
180
-
181
- export const DataRoomsQueryZod = PaginationOptionsZod.and(DataRoomsFilters).and(
182
- DataRoomsIncludeQuery,
183
- );
184
-
185
- export type DataRoomsQueryZod = z.infer<typeof DataRoomsQueryZod>;
186
-
187
- export const PublicDataRoomFiltersZod = PaginationOptionsZod.merge(
188
- DataRoomsFilters,
189
- )
190
- .merge(DataRoomsIncludeQuery)
191
- .extend({
192
- url: UrlSchema,
193
- });
194
-
195
- export type PublicDataRoomFiltersZod = z.infer<typeof PublicDataRoomFiltersZod>;
196
-
197
- export const PatchDataRoomZod = PostDataRoom.extend({
198
- isPasswordProtected: z.boolean().optional(),
199
- password: PasswordSchema.optional(),
200
- }).refine(
201
- (data) => {
202
- if (data.isPasswordProtected) {
203
- return data.password !== undefined;
204
- }
205
- return true;
206
- },
207
- {
208
- message: 'Password is required when password protection is enabled',
209
- path: ['password'],
210
- },
211
- );
212
- export type PatchDataRoomZod = z.infer<typeof PatchDataRoomZod>;
213
-
214
- export const DataRoomPasswordQueryZod = z.object({
215
- password: z.string().min(6).optional().openapi({
216
- example: 'Secretpassword6#',
217
- }),
218
- });
219
- export type DataRoomPasswordQueryZod = z.infer<typeof DataRoomPasswordQueryZod>;
220
-
221
- export const GetDataRoomQueryZod = DataRoomsIncludeQuery.merge(
222
- DataRoomPasswordQueryZod,
223
- );
224
- export type GetDataRoomQueryZod = z.infer<typeof GetDataRoomQueryZod>;
225
-
226
- export const DataRoomZodWithoutPassword = IBaseEntity.extend({
227
- name: z.string(),
228
- accountId: accountIdSchema,
229
- account: AccountZod.optional().nullable(),
230
- dataRecords: z.array(z.any()).optional().nullable(),
231
- isPasswordProtected: z.boolean(),
232
- });
233
- export type DataRoomZodWithoutPassword = z.infer<
234
- typeof DataRoomZodWithoutPassword
235
- >;
236
- export const IPaginatedDataRoomsWithoutPassword = z.object({
237
- items: z.array(DataRoomZodWithoutPassword),
238
- meta: IPaginationMeta,
239
- });
240
- export type IPaginatedDataRoomsWithoutPassword = z.infer<
241
- typeof IPaginatedDataRoomsWithoutPassword
242
- >;
@@ -1,87 +0,0 @@
1
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
- import { TypeID } from 'typeid-js';
3
- import { z } from 'zod';
4
- import { IPaginationMeta } from './common.types';
5
- import { ITheme, themeIdSchema } from './site-settings.types';
6
- import { emailThemeIdSchema, IEmailTheme } from './email-theme.types';
7
- import { IBaseEntity } from './entity.types';
8
-
9
- extendZodWithOpenApi(z);
10
-
11
- export const defaultThemeConfigIdSchema = z.string().refine(
12
- (value) => {
13
- try {
14
- const tid = TypeID.fromString(value);
15
- return tid.getType() === 'default_theme_config';
16
- } catch {
17
- return false;
18
- }
19
- },
20
- {
21
- message: `Invalid default theme config ID format. Must be a valid TypeID with "default_theme_config" prefix. Example: default_theme_config_01j5y5ghx5fg68d663j1fvy2x7`,
22
- },
23
- );
24
-
25
- export const IDefaultThemeConfig = IBaseEntity.extend({
26
- id: defaultThemeConfigIdSchema,
27
- name: z.string().nullable(),
28
- themeId: z.lazy(() => themeIdSchema),
29
- theme: z
30
- .lazy(() => ITheme)
31
- .nullable()
32
- .optional(),
33
- emailThemeId: z.lazy(() => emailThemeIdSchema),
34
- emailTheme: z
35
- .lazy(() => IEmailTheme)
36
- .nullable()
37
- .optional(),
38
- enabled: z.boolean(),
39
- });
40
-
41
- export type IDefaultThemeConfig = z.infer<typeof IDefaultThemeConfig>;
42
-
43
- export const GetDefaultThemeConfig = z.object({
44
- id: defaultThemeConfigIdSchema,
45
- name: z.string().nullable(),
46
- siteThemeName: z.string().nullable(),
47
- siteThemeId: z.string(),
48
- emailThemeName: z.string().nullable(),
49
- emailThemeId: z.string(),
50
- enabled: z.boolean(),
51
- primaryColor: z.string().nullable(),
52
- primaryTextColor: z.string().nullable(),
53
- secondaryColor: z.string().nullable(),
54
- secondaryTextColor: z.string().nullable(),
55
- });
56
-
57
- export type GetDefaultThemeConfig = z.infer<typeof GetDefaultThemeConfig>;
58
-
59
- export const IPaginatedDefaultThemeConfigsZod = z.object({
60
- items: z.array(GetDefaultThemeConfig),
61
- meta: IPaginationMeta,
62
- });
63
-
64
- export type IPaginatedDefaultThemeConfigsZod = z.infer<
65
- typeof IPaginatedDefaultThemeConfigsZod
66
- >;
67
-
68
- export const PostDefaultThemeConfigZod = z.object({
69
- name: z.string().min(1).max(60),
70
- siteThemeId: z.lazy(() => themeIdSchema),
71
- emailThemeId: z.lazy(() => emailThemeIdSchema),
72
- });
73
-
74
- export type PostDefaultThemeConfigZod = z.infer<
75
- typeof PostDefaultThemeConfigZod
76
- >;
77
-
78
- export const PatchDefaultThemeConfigZod = z.object({
79
- name: z.string().min(1).max(60).optional(),
80
- themeId: z.lazy(() => themeIdSchema).optional(),
81
- emailThemeId: z.lazy(() => emailThemeIdSchema).optional(),
82
- enabled: z.boolean().optional(),
83
- });
84
-
85
- export type PatchDefaultThemeConfigZod = z.infer<
86
- typeof PatchDefaultThemeConfigZod
87
- >;
@@ -1,32 +0,0 @@
1
- import { TypeID } from 'typeid-js';
2
- import { z } from 'zod';
3
-
4
- export const disbursementAdjustmentIdSchema = z.string().refine(
5
- (value) => {
6
- try {
7
- const tid = TypeID.fromString(value);
8
- return tid.getType() === 'disbursement_adjustment';
9
- } catch {
10
- return false;
11
- }
12
- },
13
- {
14
- message:
15
- 'Invalid disbursement adjustment ID format. Must be a valid TypeID with "disbursement_adjustment" prefix.',
16
- },
17
- );
18
-
19
- export enum DisbursementAdjustmentType {
20
- COMISSION = 'COMISSION',
21
- DISBURSEMENT_FEE = 'DISBURSEMENT_FEE',
22
- REFUND_POOL = 'REFUND_POOL',
23
- }
24
-
25
- export const PostDisbursementAdjustmentZod = z.object({
26
- type: z.nativeEnum(DisbursementAdjustmentType),
27
- value: z.number().max(10000000000),
28
- description: z.string().max(50),
29
- });
30
- export type PostDisbursementAdjustmentZod = z.infer<
31
- typeof PostDisbursementAdjustmentZod
32
- >;