@dalmore/api-contracts 0.0.0-dev.ee0e6b6 → 0.0.0-dev.f317bb8

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 (713) 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 +140 -0
  18. package/common/types/account-setting.types.js +23 -0
  19. package/common/types/account-setting.types.js.map +1 -0
  20. package/common/types/account.types.d.ts +640 -0
  21. package/common/types/account.types.js +218 -0
  22. package/common/types/account.types.js.map +1 -0
  23. package/common/types/activity.types.d.ts +590 -0
  24. package/common/types/activity.types.js +258 -0
  25. package/common/types/activity.types.js.map +1 -0
  26. package/common/types/address.types.d.ts +89 -0
  27. package/common/types/address.types.js +36 -0
  28. package/common/types/address.types.js.map +1 -0
  29. package/common/types/aic.types.d.ts +434 -0
  30. package/common/types/aic.types.js +170 -0
  31. package/common/types/aic.types.js.map +1 -0
  32. package/common/types/aml.types.d.ts +41 -0
  33. package/common/types/aml.types.js +16 -0
  34. package/common/types/aml.types.js.map +1 -0
  35. package/common/types/api-key-logs.types.d.ts +204 -0
  36. package/common/types/api-key-logs.types.js +52 -0
  37. package/common/types/api-key-logs.types.js.map +1 -0
  38. package/common/types/api-keys.types.d.ts +192 -0
  39. package/common/types/api-keys.types.js +57 -0
  40. package/common/types/api-keys.types.js.map +1 -0
  41. package/common/types/asset.types.d.ts +1100 -0
  42. package/common/types/asset.types.js +353 -0
  43. package/common/types/asset.types.js.map +1 -0
  44. package/common/types/auth.types.d.ts +523 -0
  45. package/common/types/auth.types.js +280 -0
  46. package/common/types/auth.types.js.map +1 -0
  47. package/common/types/batch-jobs.types.d.ts +321 -0
  48. package/common/types/batch-jobs.types.js +111 -0
  49. package/common/types/batch-jobs.types.js.map +1 -0
  50. package/common/types/bonus-tier.types.d.ts +991 -0
  51. package/common/types/bonus-tier.types.js +166 -0
  52. package/common/types/bonus-tier.types.js.map +1 -0
  53. package/common/types/cap-table.types.d.ts +1248 -0
  54. package/common/types/cap-table.types.js +437 -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 +1851 -0
  66. package/common/types/common.types.js +1501 -0
  67. package/common/types/common.types.js.map +1 -0
  68. package/common/types/comply-advantage-api.types.d.ts +3626 -0
  69. package/common/types/comply-advantage-api.types.js +291 -0
  70. package/common/types/comply-advantage-api.types.js.map +1 -0
  71. package/common/types/comply-advantage.types.d.ts +48 -0
  72. package/common/types/comply-advantage.types.js +21 -0
  73. package/common/types/comply-advantage.types.js.map +1 -0
  74. package/common/types/contact-us.types.d.ts +126 -0
  75. package/common/types/contact-us.types.js +91 -0
  76. package/common/types/contact-us.types.js.map +1 -0
  77. package/common/types/countries.types.d.ts +77 -0
  78. package/common/types/countries.types.js +349 -0
  79. package/common/types/countries.types.js.map +1 -0
  80. package/common/types/covered-person.types.d.ts +204 -0
  81. package/common/types/covered-person.types.js +234 -0
  82. package/common/types/covered-person.types.js.map +1 -0
  83. package/common/types/csv.types.d.ts +1557 -0
  84. package/common/types/csv.types.js +154 -0
  85. package/common/types/csv.types.js.map +1 -0
  86. package/common/types/dashboard.types.d.ts +2086 -0
  87. package/common/types/dashboard.types.js +690 -0
  88. package/common/types/dashboard.types.js.map +1 -0
  89. package/common/types/data-record.types.d.ts +347 -0
  90. package/common/types/data-record.types.js +261 -0
  91. package/common/types/data-record.types.js.map +1 -0
  92. package/common/types/data-room.types.d.ts +1277 -0
  93. package/common/types/data-room.types.js +167 -0
  94. package/common/types/data-room.types.js.map +1 -0
  95. package/common/types/default-theme-config.types.d.ts +445 -0
  96. package/common/types/default-theme-config.types.js +63 -0
  97. package/common/types/default-theme-config.types.js.map +1 -0
  98. package/common/types/disbursement-adjustment.types.d.ts +21 -0
  99. package/common/types/disbursement-adjustment.types.js +25 -0
  100. package/common/types/disbursement-adjustment.types.js.map +1 -0
  101. package/common/types/disbursement-approval-user.types.d.ts +935 -0
  102. package/common/types/disbursement-approval-user.types.js +68 -0
  103. package/common/types/disbursement-approval-user.types.js.map +1 -0
  104. package/common/types/disbursement-review.types.d.ts +923 -0
  105. package/common/types/disbursement-review.types.js +76 -0
  106. package/common/types/disbursement-review.types.js.map +1 -0
  107. package/common/types/disbursement-transaction.types.d.ts +621 -0
  108. package/common/types/disbursement-transaction.types.js +51 -0
  109. package/common/types/disbursement-transaction.types.js.map +1 -0
  110. package/common/types/disbursements.types.d.ts +3496 -0
  111. package/common/types/disbursements.types.js +435 -0
  112. package/common/types/disbursements.types.js.map +1 -0
  113. package/common/types/domain-filter.types.d.ts +135 -0
  114. package/common/types/domain-filter.types.js +40 -0
  115. package/common/types/domain-filter.types.js.map +1 -0
  116. package/common/types/email-theme.types.d.ts +1359 -0
  117. package/common/types/email-theme.types.js +318 -0
  118. package/common/types/email-theme.types.js.map +1 -0
  119. package/common/types/entity.types.d.ts +21 -0
  120. package/common/types/entity.types.js +14 -0
  121. package/common/types/entity.types.js.map +1 -0
  122. package/common/types/error-responses.types.d.ts +144 -0
  123. package/common/types/error-responses.types.js +125 -0
  124. package/common/types/error-responses.types.js.map +1 -0
  125. package/common/types/escrow-account.types.d.ts +415 -0
  126. package/common/types/escrow-account.types.js +78 -0
  127. package/common/types/escrow-account.types.js.map +1 -0
  128. package/common/types/exchange-api-key.types.d.ts +1010 -0
  129. package/common/types/exchange-api-key.types.js +90 -0
  130. package/common/types/exchange-api-key.types.js.map +1 -0
  131. package/common/types/exchange-import.types.d.ts +23 -0
  132. package/common/types/exchange-import.types.js +23 -0
  133. package/common/types/exchange-import.types.js.map +1 -0
  134. package/common/types/exchange-provider.types.d.ts +1308 -0
  135. package/common/types/exchange-provider.types.js +268 -0
  136. package/common/types/exchange-provider.types.js.map +1 -0
  137. package/common/types/file.types.d.ts +428 -0
  138. package/common/types/file.types.js +392 -0
  139. package/common/types/file.types.js.map +1 -0
  140. package/common/types/health.types.d.ts +112 -0
  141. package/common/types/health.types.js +22 -0
  142. package/common/types/health.types.js.map +1 -0
  143. package/common/types/i-will-do-it-later.types.d.ts +51 -0
  144. package/common/types/i-will-do-it-later.types.js +30 -0
  145. package/common/types/i-will-do-it-later.types.js.map +1 -0
  146. package/common/types/{index.ts → index.d.ts} +7 -3
  147. package/common/types/index.js +56 -0
  148. package/common/types/index.js.map +1 -0
  149. package/common/types/individuals.types.d.ts +2101 -0
  150. package/common/types/individuals.types.js +500 -0
  151. package/common/types/individuals.types.js.map +1 -0
  152. package/common/types/investor-account.types.d.ts +2996 -0
  153. package/common/types/investor-account.types.js +929 -0
  154. package/common/types/investor-account.types.js.map +1 -0
  155. package/common/types/investorAccountIdSchema.type.js +1 -0
  156. package/common/types/investorAccountIdSchema.type.js.map +1 -0
  157. package/common/types/investors-offering.types.d.ts +391 -0
  158. package/common/types/investors-offering.types.js +49 -0
  159. package/common/types/investors-offering.types.js.map +1 -0
  160. package/common/types/invite.types.d.ts +641 -0
  161. package/common/types/invite.types.js +113 -0
  162. package/common/types/invite.types.js.map +1 -0
  163. package/common/types/issuer-bank-account.types.d.ts +113 -0
  164. package/common/types/issuer-bank-account.types.js +81 -0
  165. package/common/types/issuer-bank-account.types.js.map +1 -0
  166. package/common/types/issuer-offering.types.d.ts +2065 -0
  167. package/common/types/issuer-offering.types.js +616 -0
  168. package/common/types/issuer-offering.types.js.map +1 -0
  169. package/common/types/issuer-payment-method.types.d.ts +1100 -0
  170. package/common/types/issuer-payment-method.types.js +311 -0
  171. package/common/types/issuer-payment-method.types.js.map +1 -0
  172. package/common/types/issuer.types.d.ts +539 -0
  173. package/common/types/issuer.types.js +275 -0
  174. package/common/types/issuer.types.js.map +1 -0
  175. package/common/types/job-item.types.d.ts +230 -0
  176. package/common/types/job-item.types.js +89 -0
  177. package/common/types/job-item.types.js.map +1 -0
  178. package/common/types/jobs.types.d.ts +296 -0
  179. package/common/types/jobs.types.js +150 -0
  180. package/common/types/jobs.types.js.map +1 -0
  181. package/common/types/kyb.types.d.ts +167 -0
  182. package/common/types/kyb.types.js +45 -0
  183. package/common/types/kyb.types.js.map +1 -0
  184. package/common/types/kyc.types.d.ts +2197 -0
  185. package/common/types/kyc.types.js +301 -0
  186. package/common/types/kyc.types.js.map +1 -0
  187. package/common/types/legal-entity.types.d.ts +676 -0
  188. package/common/types/legal-entity.types.js +151 -0
  189. package/common/types/legal-entity.types.js.map +1 -0
  190. package/common/types/login-history.types.d.ts +160 -0
  191. package/common/types/login-history.types.js +39 -0
  192. package/common/types/login-history.types.js.map +1 -0
  193. package/common/types/mail-template.types.d.ts +595 -0
  194. package/common/types/mail-template.types.js +401 -0
  195. package/common/types/mail-template.types.js.map +1 -0
  196. package/common/types/north-cap-integration.types.d.ts +1303 -0
  197. package/common/types/north-cap-integration.types.js +145 -0
  198. package/common/types/north-cap-integration.types.js.map +1 -0
  199. package/common/types/note.types.d.ts +216 -0
  200. package/common/types/note.types.js +82 -0
  201. package/common/types/note.types.js.map +1 -0
  202. package/common/types/notification.types.d.ts +2689 -0
  203. package/common/types/notification.types.js +408 -0
  204. package/common/types/notification.types.js.map +1 -0
  205. package/common/types/notion-api.types.d.ts +3626 -0
  206. package/common/types/notion-api.types.js +271 -0
  207. package/common/types/notion-api.types.js.map +1 -0
  208. package/common/types/notion-database.types.d.ts +191 -0
  209. package/common/types/notion-database.types.js +95 -0
  210. package/common/types/notion-database.types.js.map +1 -0
  211. package/common/types/notion-page.types.d.ts +3482 -0
  212. package/common/types/notion-page.types.js +208 -0
  213. package/common/types/notion-page.types.js.map +1 -0
  214. package/common/types/offering-reports.types.d.ts +525 -0
  215. package/common/types/offering-reports.types.js +111 -0
  216. package/common/types/offering-reports.types.js.map +1 -0
  217. package/common/types/offering-submission.types.d.ts +785 -0
  218. package/common/types/offering-submission.types.js +291 -0
  219. package/common/types/offering-submission.types.js.map +1 -0
  220. package/common/types/offering.types.d.ts +2849 -0
  221. package/common/types/offering.types.js +803 -0
  222. package/common/types/offering.types.js.map +1 -0
  223. package/common/types/page-revision.types.d.ts +74 -0
  224. package/common/types/page-revision.types.js +68 -0
  225. package/common/types/page-revision.types.js.map +1 -0
  226. package/common/types/page.types.d.ts +540 -0
  227. package/common/types/page.types.js +361 -0
  228. package/common/types/page.types.js.map +1 -0
  229. package/common/types/password.type.d.ts +2 -0
  230. package/common/types/password.type.js +14 -0
  231. package/common/types/password.type.js.map +1 -0
  232. package/common/types/payment-methods.types.d.ts +800 -0
  233. package/common/types/payment-methods.types.js +260 -0
  234. package/common/types/payment-methods.types.js.map +1 -0
  235. package/common/types/phone.type.d.ts +12 -0
  236. package/common/types/phone.type.js +29 -0
  237. package/common/types/phone.type.js.map +1 -0
  238. package/common/types/portfolio.types.d.ts +185 -0
  239. package/common/types/portfolio.types.js +36 -0
  240. package/common/types/portfolio.types.js.map +1 -0
  241. package/common/types/privacy-policy-and-tos.types.d.ts +2 -0
  242. package/common/types/{privacy-policy-and-tos.types.ts → privacy-policy-and-tos.types.js} +1 -1
  243. package/common/types/privacy-policy-and-tos.types.js.map +1 -0
  244. package/common/types/queue.types.d.ts +22 -0
  245. package/common/types/queue.types.js +73 -0
  246. package/common/types/queue.types.js.map +1 -0
  247. package/common/types/registered-reps.types.d.ts +6 -0
  248. package/common/types/registered-reps.types.js +21 -0
  249. package/common/types/registered-reps.types.js.map +1 -0
  250. package/common/types/rejection-reasons.types.d.ts +35 -0
  251. package/common/types/rejection-reasons.types.js +49 -0
  252. package/common/types/rejection-reasons.types.js.map +1 -0
  253. package/common/types/reports.types.d.ts +345 -0
  254. package/common/types/reports.types.js +69 -0
  255. package/common/types/reports.types.js.map +1 -0
  256. package/common/types/review.types.d.ts +419 -0
  257. package/common/types/review.types.js +101 -0
  258. package/common/types/review.types.js.map +1 -0
  259. package/common/types/role.types.d.ts +30 -0
  260. package/common/types/role.types.js +21 -0
  261. package/common/types/role.types.js.map +1 -0
  262. package/common/types/secondary-customer.types.d.ts +586 -0
  263. package/common/types/secondary-customer.types.js +39 -0
  264. package/common/types/secondary-customer.types.js.map +1 -0
  265. package/common/types/secondary-issuer.types.d.ts +283 -0
  266. package/common/types/secondary-issuer.types.js +37 -0
  267. package/common/types/secondary-issuer.types.js.map +1 -0
  268. package/common/types/secondary-order.types.d.ts +508 -0
  269. package/common/types/secondary-order.types.js +40 -0
  270. package/common/types/secondary-order.types.js.map +1 -0
  271. package/common/types/secondary-security.types.d.ts +175 -0
  272. package/common/types/secondary-security.types.js +45 -0
  273. package/common/types/secondary-security.types.js.map +1 -0
  274. package/common/types/secondary-trade.entity.d.ts +16 -0
  275. package/common/types/secondary-trade.entity.js +12 -0
  276. package/common/types/secondary-trade.entity.js.map +1 -0
  277. package/common/types/secondary-trade.types.d.ts +465 -0
  278. package/common/types/secondary-trade.types.js +61 -0
  279. package/common/types/secondary-trade.types.js.map +1 -0
  280. package/common/types/secure-request.types.d.ts +171 -0
  281. package/common/types/secure-request.types.js +51 -0
  282. package/common/types/secure-request.types.js.map +1 -0
  283. package/common/types/signer.types.d.ts +3406 -0
  284. package/common/types/signer.types.js +532 -0
  285. package/common/types/signer.types.js.map +1 -0
  286. package/common/types/site-link.types.d.ts +875 -0
  287. package/common/types/site-link.types.js +126 -0
  288. package/common/types/site-link.types.js.map +1 -0
  289. package/common/types/site-settings.types.d.ts +1673 -0
  290. package/common/types/site-settings.types.js +500 -0
  291. package/common/types/site-settings.types.js.map +1 -0
  292. package/common/types/site.types.d.ts +1481 -0
  293. package/common/types/site.types.js +213 -0
  294. package/common/types/site.types.js.map +1 -0
  295. package/common/types/sms.types.d.ts +40 -0
  296. package/common/types/sms.types.js +27 -0
  297. package/common/types/sms.types.js.map +1 -0
  298. package/common/types/state-machine.types.d.ts +591 -0
  299. package/common/types/state-machine.types.js +144 -0
  300. package/common/types/state-machine.types.js.map +1 -0
  301. package/common/types/states.types.d.ts +77 -0
  302. package/common/types/states.types.js +137 -0
  303. package/common/types/states.types.js.map +1 -0
  304. package/common/types/subdoc-preview.types.d.ts +379 -0
  305. package/common/types/subdoc-preview.types.js +24 -0
  306. package/common/types/subdoc-preview.types.js.map +1 -0
  307. package/common/types/task.types.d.ts +537 -0
  308. package/common/types/task.types.js +211 -0
  309. package/common/types/task.types.js.map +1 -0
  310. package/common/types/trade-adjustment.type.d.ts +40 -0
  311. package/common/types/trade-adjustment.type.js +26 -0
  312. package/common/types/trade-adjustment.type.js.map +1 -0
  313. package/common/types/trade-line-item.types.d.ts +353 -0
  314. package/common/types/trade-line-item.types.js +103 -0
  315. package/common/types/trade-line-item.types.js.map +1 -0
  316. package/common/types/trade.types.d.ts +2015 -0
  317. package/common/types/trade.types.js +796 -0
  318. package/common/types/trade.types.js.map +1 -0
  319. package/common/types/transaction.types.d.ts +453 -0
  320. package/common/types/transaction.types.js +173 -0
  321. package/common/types/transaction.types.js.map +1 -0
  322. package/common/types/trusted-contact.types.d.ts +440 -0
  323. package/common/types/trusted-contact.types.js +95 -0
  324. package/common/types/trusted-contact.types.js.map +1 -0
  325. package/common/types/typography.types.d.ts +52 -0
  326. package/common/types/typography.types.js +67 -0
  327. package/common/types/typography.types.js.map +1 -0
  328. package/common/types/user-manual.types.d.ts +287 -0
  329. package/common/types/user-manual.types.js +192 -0
  330. package/common/types/user-manual.types.js.map +1 -0
  331. package/common/types/user-setting.types.d.ts +273 -0
  332. package/common/types/user-setting.types.js +85 -0
  333. package/common/types/user-setting.types.js.map +1 -0
  334. package/common/types/user.types.d.ts +2083 -0
  335. package/common/types/user.types.js +246 -0
  336. package/common/types/user.types.js.map +1 -0
  337. package/common/types/webhook.types.d.ts +10829 -0
  338. package/common/types/webhook.types.js +658 -0
  339. package/common/types/webhook.types.js.map +1 -0
  340. package/common/types/zip.type.d.ts +35 -0
  341. package/common/types/zip.type.js +28 -0
  342. package/common/types/zip.type.js.map +1 -0
  343. package/contracts/clients/accounts/index.d.ts +308 -0
  344. package/contracts/clients/accounts/index.js +43 -0
  345. package/contracts/clients/accounts/index.js.map +1 -0
  346. package/contracts/clients/aic/index.d.ts +280 -0
  347. package/contracts/clients/aic/index.js +47 -0
  348. package/contracts/clients/aic/index.js.map +1 -0
  349. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  350. package/contracts/clients/api-key-logs/index.js +37 -0
  351. package/contracts/clients/api-key-logs/index.js.map +1 -0
  352. package/contracts/clients/api-keys/index.d.ts +374 -0
  353. package/contracts/clients/api-keys/index.js +59 -0
  354. package/contracts/clients/api-keys/index.js.map +1 -0
  355. package/contracts/clients/assets/index.d.ts +1050 -0
  356. package/contracts/clients/assets/index.js +80 -0
  357. package/contracts/clients/assets/index.js.map +1 -0
  358. package/contracts/clients/auth/index.d.ts +236 -0
  359. package/contracts/clients/auth/index.js +38 -0
  360. package/contracts/clients/auth/index.js.map +1 -0
  361. package/contracts/clients/cart/index.d.ts +229 -0
  362. package/contracts/clients/cart/index.js +63 -0
  363. package/contracts/clients/cart/index.js.map +1 -0
  364. package/contracts/clients/csv/index.d.ts +1594 -0
  365. package/contracts/clients/csv/index.js +62 -0
  366. package/contracts/clients/csv/index.js.map +1 -0
  367. package/contracts/clients/files/index.d.ts +552 -0
  368. package/contracts/clients/files/index.js +142 -0
  369. package/contracts/clients/files/index.js.map +1 -0
  370. package/contracts/clients/files-public/index.d.ts +552 -0
  371. package/contracts/clients/files-public/index.js +142 -0
  372. package/contracts/clients/files-public/index.js.map +1 -0
  373. package/contracts/clients/index.d.ts +14483 -0
  374. package/contracts/clients/index.js +56 -0
  375. package/contracts/clients/index.js.map +1 -0
  376. package/contracts/clients/individuals/index.d.ts +3199 -0
  377. package/contracts/clients/individuals/index.js +74 -0
  378. package/contracts/clients/individuals/index.js.map +1 -0
  379. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  380. package/contracts/clients/investor-accounts/index.js +73 -0
  381. package/contracts/clients/investor-accounts/index.js.map +1 -0
  382. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  383. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  384. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  385. package/contracts/clients/issuers/index.d.ts +449 -0
  386. package/contracts/clients/issuers/index.js +75 -0
  387. package/contracts/clients/issuers/index.js.map +1 -0
  388. package/contracts/clients/kyc/index.d.ts +345 -0
  389. package/contracts/clients/kyc/index.js +49 -0
  390. package/contracts/clients/kyc/index.js.map +1 -0
  391. package/contracts/clients/legal-entities/index.d.ts +887 -0
  392. package/contracts/clients/legal-entities/index.js +74 -0
  393. package/contracts/clients/legal-entities/index.js.map +1 -0
  394. package/contracts/clients/offerings/index.d.ts +1068 -0
  395. package/contracts/clients/offerings/index.js +95 -0
  396. package/contracts/clients/offerings/index.js.map +1 -0
  397. package/contracts/clients/payment-methods/index.d.ts +456 -0
  398. package/contracts/clients/payment-methods/index.js +68 -0
  399. package/contracts/clients/payment-methods/index.js.map +1 -0
  400. package/contracts/clients/review/index.d.ts +85 -0
  401. package/contracts/clients/review/index.js +27 -0
  402. package/contracts/clients/review/index.js.map +1 -0
  403. package/contracts/clients/secure-requests/index.d.ts +100 -0
  404. package/contracts/clients/secure-requests/index.js +22 -0
  405. package/contracts/clients/secure-requests/index.js.map +1 -0
  406. package/contracts/clients/sites/index.d.ts +657 -0
  407. package/contracts/clients/sites/index.js +40 -0
  408. package/contracts/clients/sites/index.js.map +1 -0
  409. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  410. package/contracts/clients/trade-line-items/index.js +47 -0
  411. package/contracts/clients/trade-line-items/index.js.map +1 -0
  412. package/contracts/clients/trades/index.d.ts +871 -0
  413. package/contracts/clients/trades/index.js +156 -0
  414. package/contracts/clients/trades/index.js.map +1 -0
  415. package/contracts/clients/transactions/index.d.ts +88 -0
  416. package/contracts/clients/transactions/index.js +25 -0
  417. package/contracts/clients/transactions/index.js.map +1 -0
  418. package/package.json +27 -36
  419. package/common/helpers/index.ts +0 -59
  420. package/common/types/account-contact.types.ts +0 -98
  421. package/common/types/account-detail.types.ts +0 -27
  422. package/common/types/account-integration.types.ts +0 -143
  423. package/common/types/account-manager.types.ts +0 -124
  424. package/common/types/account-setting.types.ts +0 -31
  425. package/common/types/account.types.ts +0 -296
  426. package/common/types/activity.types.ts +0 -274
  427. package/common/types/address.types.ts +0 -41
  428. package/common/types/aic.types.ts +0 -246
  429. package/common/types/aml.types.ts +0 -18
  430. package/common/types/api-key-logs.types.ts +0 -66
  431. package/common/types/api-keys.types.ts +0 -69
  432. package/common/types/asset.types.ts +0 -338
  433. package/common/types/auth.types.ts +0 -370
  434. package/common/types/batch-jobs.types.ts +0 -151
  435. package/common/types/bonus-tier.types.ts +0 -171
  436. package/common/types/cart.types.ts +0 -21
  437. package/common/types/checklist-items.types.ts +0 -70
  438. package/common/types/checklist.types.ts +0 -97
  439. package/common/types/common.types.ts +0 -1530
  440. package/common/types/comply-advantage-api.types.ts +0 -316
  441. package/common/types/comply-advantage.types.ts +0 -25
  442. package/common/types/contact-us.types.ts +0 -107
  443. package/common/types/countries.types.ts +0 -375
  444. package/common/types/covered-person.types.ts +0 -274
  445. package/common/types/dashboard.types.ts +0 -792
  446. package/common/types/data-record.types.ts +0 -325
  447. package/common/types/data-room.types.ts +0 -242
  448. package/common/types/default-theme-config.types.ts +0 -87
  449. package/common/types/disbursement-adjustment.types.ts +0 -32
  450. package/common/types/disbursement-approval-user.types.ts +0 -100
  451. package/common/types/disbursement-review.types.ts +0 -110
  452. package/common/types/disbursement-transaction.types.ts +0 -72
  453. package/common/types/disbursements.types.ts +0 -426
  454. package/common/types/domain-filter.types.ts +0 -55
  455. package/common/types/email-theme.types.ts +0 -442
  456. package/common/types/entity.types.ts +0 -15
  457. package/common/types/error-responses.types.ts +0 -135
  458. package/common/types/escrow-account.types.ts +0 -104
  459. package/common/types/exchange-api-key.types.ts +0 -121
  460. package/common/types/exchange-import.types.ts +0 -36
  461. package/common/types/exchange-provider.types.ts +0 -329
  462. package/common/types/file.types.ts +0 -477
  463. package/common/types/health.types.ts +0 -29
  464. package/common/types/i-will-do-it-later.types.ts +0 -68
  465. package/common/types/individuals.types.ts +0 -541
  466. package/common/types/investor-account.types.ts +0 -1239
  467. package/common/types/investors-offering.types.ts +0 -65
  468. package/common/types/invite.types.ts +0 -133
  469. package/common/types/issuer-bank-account.types.ts +0 -107
  470. package/common/types/issuer-offering.types.ts +0 -389
  471. package/common/types/issuer-payment-method.types.ts +0 -382
  472. package/common/types/issuer.types.ts +0 -321
  473. package/common/types/job-item.types.ts +0 -119
  474. package/common/types/jobs.types.ts +0 -171
  475. package/common/types/kyb.types.ts +0 -53
  476. package/common/types/kyc.types.ts +0 -188
  477. package/common/types/legal-entity.types.ts +0 -185
  478. package/common/types/login-history.types.ts +0 -46
  479. package/common/types/mail-template.types.ts +0 -436
  480. package/common/types/north-cap-integration.types.ts +0 -190
  481. package/common/types/note.types.ts +0 -109
  482. package/common/types/notification.types.ts +0 -268
  483. package/common/types/notion-api.types.ts +0 -374
  484. package/common/types/notion-database.types.ts +0 -125
  485. package/common/types/notion-page.types.ts +0 -267
  486. package/common/types/offering-reports.types.ts +0 -153
  487. package/common/types/offering-submission.types.ts +0 -314
  488. package/common/types/offering.types.ts +0 -676
  489. package/common/types/page-revision.types.ts +0 -86
  490. package/common/types/page.types.ts +0 -436
  491. package/common/types/password.type.ts +0 -15
  492. package/common/types/payment-methods.types.ts +0 -298
  493. package/common/types/phone.type.ts +0 -27
  494. package/common/types/portfolio.types.ts +0 -50
  495. package/common/types/queue.types.ts +0 -112
  496. package/common/types/registered-reps.types.ts +0 -25
  497. package/common/types/rejection-reasons.types.ts +0 -56
  498. package/common/types/reminder-config.types.ts +0 -40
  499. package/common/types/review.types.ts +0 -133
  500. package/common/types/role.types.ts +0 -26
  501. package/common/types/secondary-customer.types.ts +0 -66
  502. package/common/types/secondary-issuer.types.ts +0 -50
  503. package/common/types/secondary-order.types.ts +0 -58
  504. package/common/types/secondary-security.types.ts +0 -60
  505. package/common/types/secondary-trade.entity.ts +0 -16
  506. package/common/types/secondary-trade.types.ts +0 -95
  507. package/common/types/secure-request.types.ts +0 -68
  508. package/common/types/signer.types.ts +0 -651
  509. package/common/types/site-link.types.ts +0 -166
  510. package/common/types/site-settings.types.ts +0 -726
  511. package/common/types/site.types.ts +0 -263
  512. package/common/types/sms.types.ts +0 -30
  513. package/common/types/state-machine.types.ts +0 -177
  514. package/common/types/states.types.ts +0 -163
  515. package/common/types/subdoc-preview.types.ts +0 -35
  516. package/common/types/task.types.ts +0 -258
  517. package/common/types/trade-adjustment.type.ts +0 -33
  518. package/common/types/trade-line-item.types.ts +0 -125
  519. package/common/types/trade.types.ts +0 -999
  520. package/common/types/transaction.types.ts +0 -209
  521. package/common/types/trusted-contact.types.ts +0 -122
  522. package/common/types/typography.types.ts +0 -75
  523. package/common/types/user-manual.types.ts +0 -290
  524. package/common/types/user-setting.types.ts +0 -133
  525. package/common/types/user.types.ts +0 -307
  526. package/common/types/webhook.types.ts +0 -588
  527. package/common/types/zip.type.ts +0 -36
  528. package/contracts/clients/accounts/index.ts +0 -61
  529. package/contracts/clients/aic/index.ts +0 -59
  530. package/contracts/clients/api-key-logs/index.ts +0 -53
  531. package/contracts/clients/api-keys/index.ts +0 -73
  532. package/contracts/clients/assets/index.ts +0 -102
  533. package/contracts/clients/auth/index.ts +0 -50
  534. package/contracts/clients/cart/index.ts +0 -80
  535. package/contracts/clients/files/index.ts +0 -166
  536. package/contracts/clients/files-public/index.ts +0 -166
  537. package/contracts/clients/index.ts +0 -54
  538. package/contracts/clients/individuals/index.ts +0 -93
  539. package/contracts/clients/investor-accounts/index.ts +0 -93
  540. package/contracts/clients/issuer-payment-methods/index.ts +0 -39
  541. package/contracts/clients/issuers/index.ts +0 -94
  542. package/contracts/clients/legal-entities/index.ts +0 -93
  543. package/contracts/clients/offerings/index.ts +0 -117
  544. package/contracts/clients/payment-methods/index.ts +0 -85
  545. package/contracts/clients/secure-requests/index.ts +0 -34
  546. package/contracts/clients/sites/index.ts +0 -56
  547. package/contracts/clients/trade-line-items/index.ts +0 -66
  548. package/contracts/clients/trades/index.ts +0 -186
  549. package/contracts/clients/transactions/index.ts +0 -37
  550. package/contracts/compliance/account-contacts/index.ts +0 -82
  551. package/contracts/compliance/account-managers/index.ts +0 -142
  552. package/contracts/compliance/accounts/index.ts +0 -187
  553. package/contracts/compliance/activities/index.ts +0 -55
  554. package/contracts/compliance/aic/index.ts +0 -60
  555. package/contracts/compliance/api-keys/index.ts +0 -91
  556. package/contracts/compliance/assets/index.ts +0 -122
  557. package/contracts/compliance/auth/index.ts +0 -134
  558. package/contracts/compliance/batch-jobs/index.ts +0 -62
  559. package/contracts/compliance/bonus-tiers/index.ts +0 -74
  560. package/contracts/compliance/checklist/index.ts +0 -87
  561. package/contracts/compliance/checklist-items/index.ts +0 -86
  562. package/contracts/compliance/covered-persons/index.ts +0 -97
  563. package/contracts/compliance/dashboard/index.ts +0 -111
  564. package/contracts/compliance/data-records/index.ts +0 -116
  565. package/contracts/compliance/data-rooms/index.ts +0 -113
  566. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  567. package/contracts/compliance/disbursement/index.ts +0 -165
  568. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  569. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  570. package/contracts/compliance/domain-filters/index.ts +0 -117
  571. package/contracts/compliance/email-themes/index.ts +0 -284
  572. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  573. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  574. package/contracts/compliance/exchange-imports/index.ts +0 -137
  575. package/contracts/compliance/files/index.ts +0 -267
  576. package/contracts/compliance/files-public/index.ts +0 -188
  577. package/contracts/compliance/health/index.ts +0 -26
  578. package/contracts/compliance/index.ts +0 -147
  579. package/contracts/compliance/individuals/index.ts +0 -57
  580. package/contracts/compliance/investor-accounts/index.ts +0 -141
  581. package/contracts/compliance/invites/index.ts +0 -137
  582. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  583. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  584. package/contracts/compliance/issuers/index.ts +0 -97
  585. package/contracts/compliance/job-items/index.ts +0 -58
  586. package/contracts/compliance/jobs/index.ts +0 -59
  587. package/contracts/compliance/kyb/index.ts +0 -54
  588. package/contracts/compliance/kyc/index.ts +0 -77
  589. package/contracts/compliance/legal-entities/index.ts +0 -57
  590. package/contracts/compliance/login-histories/index.ts +0 -37
  591. package/contracts/compliance/notes/index.ts +0 -69
  592. package/contracts/compliance/notion-databases/index.ts +0 -107
  593. package/contracts/compliance/notion-pages/index.ts +0 -105
  594. package/contracts/compliance/offering-reports/index.ts +0 -149
  595. package/contracts/compliance/offerings/index.ts +0 -233
  596. package/contracts/compliance/pages/index.ts +0 -178
  597. package/contracts/compliance/payment-methods/index.ts +0 -57
  598. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  599. package/contracts/compliance/review/index.ts +0 -169
  600. package/contracts/compliance/roles/index.ts +0 -34
  601. package/contracts/compliance/secondary-customers/index.ts +0 -77
  602. package/contracts/compliance/secondary-orders/index.ts +0 -60
  603. package/contracts/compliance/secondary-trades/index.ts +0 -100
  604. package/contracts/compliance/secure-requests/index.ts +0 -54
  605. package/contracts/compliance/signer/index.ts +0 -369
  606. package/contracts/compliance/site-links/index.ts +0 -128
  607. package/contracts/compliance/site-settings/index.ts +0 -669
  608. package/contracts/compliance/sites/index.ts +0 -56
  609. package/contracts/compliance/state-machine/index.ts +0 -94
  610. package/contracts/compliance/tasks/index.ts +0 -91
  611. package/contracts/compliance/third-parties/index.ts +0 -52
  612. package/contracts/compliance/trade-line-items/index.ts +0 -59
  613. package/contracts/compliance/trades/index.ts +0 -230
  614. package/contracts/compliance/transactions/index.ts +0 -161
  615. package/contracts/compliance/user-manuals/index.ts +0 -271
  616. package/contracts/compliance/user-settings/index.ts +0 -189
  617. package/contracts/compliance/users/index.ts +0 -221
  618. package/contracts/compliance/webhooks/index.ts +0 -41
  619. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  620. package/contracts/compliance-apikey/index.ts +0 -14
  621. package/contracts/index.ts +0 -6
  622. package/contracts/investors/account-contacts/index.ts +0 -58
  623. package/contracts/investors/aic/index.ts +0 -59
  624. package/contracts/investors/assets/index.ts +0 -61
  625. package/contracts/investors/auth/index.ts +0 -116
  626. package/contracts/investors/bonus-tiers/index.ts +0 -55
  627. package/contracts/investors/cart/index.ts +0 -75
  628. package/contracts/investors/contact-us/index.ts +0 -48
  629. package/contracts/investors/data-records/index.ts +0 -113
  630. package/contracts/investors/data-rooms/index.ts +0 -96
  631. package/contracts/investors/files/index.ts +0 -167
  632. package/contracts/investors/files-public/index.ts +0 -185
  633. package/contracts/investors/index.ts +0 -72
  634. package/contracts/investors/individuals/index.ts +0 -121
  635. package/contracts/investors/investor-accounts/index.ts +0 -110
  636. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  637. package/contracts/investors/issuers/index.ts +0 -30
  638. package/contracts/investors/legal-entities/index.ts +0 -93
  639. package/contracts/investors/notes/index.ts +0 -69
  640. package/contracts/investors/offerings/index.ts +0 -93
  641. package/contracts/investors/pages/index.ts +0 -88
  642. package/contracts/investors/payment-methods/index.ts +0 -149
  643. package/contracts/investors/portfolios/index.ts +0 -53
  644. package/contracts/investors/sites/index.ts +0 -96
  645. package/contracts/investors/tasks/index.ts +0 -111
  646. package/contracts/investors/trade-line-items/index.ts +0 -75
  647. package/contracts/investors/trades/index.ts +0 -114
  648. package/contracts/investors/transactions/index.ts +0 -37
  649. package/contracts/investors/trusted-contacts/index.ts +0 -93
  650. package/contracts/investors/user-manuals/index.ts +0 -62
  651. package/contracts/investors/user-settings/index.ts +0 -170
  652. package/contracts/investors/users/index.ts +0 -45
  653. package/contracts/investors/webhooks/index.ts +0 -30
  654. package/contracts/issuers/account-contacts/index.ts +0 -76
  655. package/contracts/issuers/account-integrations/index.ts +0 -97
  656. package/contracts/issuers/accounts/index.ts +0 -97
  657. package/contracts/issuers/activities/index.ts +0 -54
  658. package/contracts/issuers/aic/index.ts +0 -39
  659. package/contracts/issuers/api-key-logs/index.ts +0 -53
  660. package/contracts/issuers/api-keys/index.ts +0 -93
  661. package/contracts/issuers/assets/index.ts +0 -122
  662. package/contracts/issuers/auth/index.ts +0 -152
  663. package/contracts/issuers/bonus-tiers/index.ts +0 -73
  664. package/contracts/issuers/contact-us/index.ts +0 -48
  665. package/contracts/issuers/covered-persons/index.ts +0 -136
  666. package/contracts/issuers/dashboard/index.ts +0 -72
  667. package/contracts/issuers/data-records/index.ts +0 -257
  668. package/contracts/issuers/data-rooms/index.ts +0 -134
  669. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  670. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  671. package/contracts/issuers/disbursements/index.ts +0 -189
  672. package/contracts/issuers/email-themes/index.ts +0 -242
  673. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  674. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  675. package/contracts/issuers/files/index.ts +0 -166
  676. package/contracts/issuers/files-public/index.ts +0 -166
  677. package/contracts/issuers/health/index.ts +0 -24
  678. package/contracts/issuers/index.ts +0 -112
  679. package/contracts/issuers/investor-accounts/index.ts +0 -148
  680. package/contracts/issuers/invites/index.ts +0 -129
  681. package/contracts/issuers/issuer/index.ts +0 -94
  682. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  683. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  684. package/contracts/issuers/kyc/index.ts +0 -38
  685. package/contracts/issuers/login-histories/index.ts +0 -51
  686. package/contracts/issuers/notes/index.ts +0 -69
  687. package/contracts/issuers/offerings/index.ts +0 -206
  688. package/contracts/issuers/pages/index.ts +0 -138
  689. package/contracts/issuers/payment-methods/index.ts +0 -61
  690. package/contracts/issuers/portfolios/index.ts +0 -36
  691. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  692. package/contracts/issuers/review/index.ts +0 -63
  693. package/contracts/issuers/secondary-customers/index.ts +0 -55
  694. package/contracts/issuers/secondary-orders/index.ts +0 -57
  695. package/contracts/issuers/secondary-trades/index.ts +0 -57
  696. package/contracts/issuers/secure-requests/index.ts +0 -34
  697. package/contracts/issuers/site-links/index.ts +0 -116
  698. package/contracts/issuers/site-settings/index.ts +0 -585
  699. package/contracts/issuers/sites/index.ts +0 -32
  700. package/contracts/issuers/tasks/index.ts +0 -111
  701. package/contracts/issuers/trades/index.ts +0 -132
  702. package/contracts/issuers/transactions/index.ts +0 -158
  703. package/contracts/issuers/user-manuals/index.ts +0 -62
  704. package/contracts/issuers/user-settings/index.ts +0 -170
  705. package/contracts/issuers/users/index.ts +0 -126
  706. package/contracts/secondaries/accounts/index.ts +0 -58
  707. package/contracts/secondaries/index.ts +0 -23
  708. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  709. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  710. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  711. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  712. package/contracts/secondaries/secondary-trades/index.ts +0 -56
  713. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -1,100 +0,0 @@
1
- import { TypeID } from 'typeid-js';
2
- import { z } from 'zod';
3
- import { IBaseEntity } from './entity.types';
4
- import { accountIdSchema } from './account.types';
5
- import { AccountZod, IPaginationMeta } from './common.types';
6
- import { userIdSchema, UserZod } from './user.types';
7
-
8
- export const disbursementApprovalUserIdSchema = z.string().refine(
9
- (value) => {
10
- try {
11
- const tid = TypeID.fromString(value);
12
- return tid.getType() === 'disbursement_approval_user';
13
- } catch {
14
- return false;
15
- }
16
- },
17
- {
18
- message:
19
- 'Invalid disbursement approval user ID format. Must be a valid TypeID with "disbursement_approval_user" prefix.',
20
- },
21
- );
22
-
23
- export enum DisbursementApprovalUsersRole {
24
- CREATOR = 'CREATOR',
25
- APPROVER = 'APPROVER',
26
- }
27
-
28
- export const DisbursementApprovalUserZod = IBaseEntity.extend({
29
- role: z.nativeEnum(DisbursementApprovalUsersRole),
30
- accountId: accountIdSchema,
31
- account: z
32
- .lazy(() => AccountZod)
33
- .optional()
34
- .nullable(),
35
- userId: userIdSchema,
36
- user: UserZod.optional().nullable(),
37
- });
38
-
39
- export type DisbursementApprovalUserZod = z.infer<
40
- typeof DisbursementApprovalUserZod
41
- >;
42
-
43
- export const PostDisbursementApprovalUser = z.object({
44
- role: z.nativeEnum(DisbursementApprovalUsersRole),
45
- userId: userIdSchema,
46
- });
47
- export type PostDisbursementApprovalUser = z.infer<
48
- typeof PostDisbursementApprovalUser
49
- >;
50
-
51
- export const PostComplianceDisbursementApprovalUser =
52
- PostDisbursementApprovalUser.extend({
53
- accountId: accountIdSchema.optional().openapi({
54
- example: 'account_00041061050r3gg28a1c60t3gf',
55
- }),
56
- });
57
- export type PostComplianceDisbursementApprovalUser = z.infer<
58
- typeof PostComplianceDisbursementApprovalUser
59
- >;
60
-
61
- export const DisbursementApprovalUserFiltersZod = z.object({
62
- userId: userIdSchema.optional(),
63
- role: z.nativeEnum(DisbursementApprovalUsersRole).optional(),
64
- accountId: accountIdSchema.optional(),
65
- });
66
-
67
- export const IPaginatedDisbursementApprovalUser = z.object({
68
- items: z.array(DisbursementApprovalUserZod),
69
- meta: IPaginationMeta,
70
- });
71
- export type IPaginatedDisbursementApprovalUser = z.infer<
72
- typeof IPaginatedDisbursementApprovalUser
73
- >;
74
-
75
- const disbursementApprovalUsersInclude = z.enum(['user', 'account']);
76
-
77
- /**
78
- * @description Query parameters for including related entities
79
- * @xample in contract us as -> query: z.object({}).merge(DisbursementApprovalUsersIncludeQuery),
80
- */
81
- export const DisbursementApprovalUsersIncludeQuery = z.object({
82
- include: z
83
- .string()
84
- .optional()
85
- .transform((str) => (str ? str.split(',') : []))
86
- .refine(
87
- (includes) =>
88
- includes.every((include) =>
89
- disbursementApprovalUsersInclude.options.includes(include as any),
90
- ),
91
- {
92
- message: `Invalid include option provided. Valid options are: ${disbursementApprovalUsersInclude.options.join(',')}`,
93
- },
94
- )
95
- .openapi({
96
- example: `${disbursementApprovalUsersInclude.options.join(',')}`,
97
- }),
98
- });
99
- export interface DisbursementApprovalUsersIncludeQuery
100
- extends z.infer<typeof DisbursementApprovalUsersIncludeQuery> {}
@@ -1,110 +0,0 @@
1
- import { TypeID } from 'typeid-js';
2
- import { z } from 'zod';
3
- import { userIdSchema, UserZod } from './user.types';
4
- import {
5
- disbursementIdSchema,
6
- DisbursementStatus,
7
- } from './disbursements.types';
8
- import { IBaseEntity } from './entity.types';
9
- import { accountIdSchema } from './account.types';
10
- import { AccountZod, ComplianceReview, IPaginationMeta } from './common.types';
11
-
12
- export const disbursementReviewIdSchema = z.string().refine(
13
- (value) => {
14
- try {
15
- const tid = TypeID.fromString(value);
16
- return tid.getType() === 'disbursement_review';
17
- } catch {
18
- return false;
19
- }
20
- },
21
- {
22
- message:
23
- 'Invalid disbursement review ID format. Must be a valid TypeID with "disbursement_review" prefix.',
24
- },
25
- );
26
-
27
- export const PostDisbursementReviewZod = z.object({
28
- disbursementReview: z.enum(['APPROVED', 'REJECTED']),
29
- disbursements: z
30
- .array(disbursementIdSchema)
31
- .min(1, 'disbursement is required')
32
- .max(1, 'Maximum of 1 disbursement allowed')
33
- .openapi({
34
- example: ['disbursement_01jjsdrx1seqfse7z4z47sgdp5'],
35
- }),
36
- });
37
-
38
- export type PostDisbursementReviewZod = z.infer<
39
- typeof PostDisbursementReviewZod
40
- >;
41
-
42
- export const DisbursementReviewZod = IBaseEntity.extend({
43
- accountId: accountIdSchema,
44
- account: AccountZod.optional().nullable(),
45
- userId: userIdSchema,
46
- user: UserZod.optional().nullable(),
47
- status: z.nativeEnum(DisbursementStatus),
48
- });
49
-
50
- export type DisbursementReviewZod = z.infer<typeof DisbursementReviewZod>;
51
-
52
- export const IPaginatedDisbursementReviews = z.object({
53
- items: z.array(DisbursementReviewZod),
54
- meta: IPaginationMeta,
55
- });
56
- export type IPaginatedDisbursementReviews = z.infer<
57
- typeof IPaginatedDisbursementReviews
58
- >;
59
-
60
- const disbursementReviewsInclude = z.enum(['user', 'account', 'disbursement']);
61
-
62
- /**
63
- * @description Query parameters for including related entities
64
- * @xample in contract us as -> query: z.object({}).merge(DisbursementReviewsIncludeQuery),
65
- */
66
- export const DisbursementReviewsIncludeQuery = z.object({
67
- include: z
68
- .string()
69
- .optional()
70
- .transform((str) => (str ? str.split(',') : []))
71
- .refine(
72
- (includes) =>
73
- includes.every((include) =>
74
- disbursementReviewsInclude.options.includes(include as any),
75
- ),
76
- {
77
- message: `Invalid include option provided. Valid options are: ${disbursementReviewsInclude.options.join(',')}`,
78
- },
79
- )
80
- .openapi({
81
- example: `${disbursementReviewsInclude.options.join(',')}`,
82
- }),
83
- });
84
- export interface DisbursementReviewsIncludeQuery
85
- extends z.infer<typeof DisbursementReviewsIncludeQuery> {}
86
-
87
- export const DisbursementReviewFiltersZod = z.object({
88
- disbursementId: disbursementIdSchema,
89
- });
90
-
91
- export const PostComplianceReviewDisbursementZod = z.object({
92
- complianceReview: z.enum([
93
- ComplianceReview.APPROVED,
94
- ComplianceReview.REJECTED,
95
- ]),
96
- disbursements: z
97
- .array(disbursementIdSchema)
98
- .min(1, 'At least one disbursement is required')
99
- .max(50, 'Maximum of 50 disbursements allowed')
100
- .openapi({
101
- example: [
102
- 'disbursement_01jjsdrx1seqfse7z4z47sgdp5',
103
- 'disbursement_01jjsdrx27enkszq5cnc3hdhrf',
104
- ],
105
- }),
106
- });
107
-
108
- export type PostComplianceReviewDisbursementZod = z.infer<
109
- typeof PostComplianceReviewDisbursementZod
110
- >;
@@ -1,72 +0,0 @@
1
- import { TypeID } from 'typeid-js';
2
- import { z } from 'zod';
3
-
4
- import { accountIdSchema } from './account.types';
5
- import { IBaseEntity } from './entity.types';
6
- import { dateSchema } from './common.types';
7
- import { TransactionStatus, TransactionType } from './transaction.types';
8
- import { disbursementIdSchema, DisbursementZod } from './disbursements.types';
9
-
10
- export const disbursementTransactionIdSchema = z.string().refine(
11
- (value) => {
12
- try {
13
- const tid = TypeID.fromString(value);
14
- return tid.getType() === 'disbursement_transaction';
15
- } catch {
16
- return false;
17
- }
18
- },
19
- {
20
- message: `Invalid disbursement transaction ID format. Must be a valid TypeID with "disbursement_transaction" prefix.`,
21
- },
22
- );
23
-
24
- export const DisbursementTransactionZod = IBaseEntity.extend({
25
- id: disbursementTransactionIdSchema,
26
- accountId: accountIdSchema,
27
- type: z.nativeEnum(TransactionType),
28
- status: z.nativeEnum(TransactionStatus),
29
- tid: z.string().nullable(),
30
- amount: z.number(),
31
- currencyCode: z.string(),
32
- chargedAt: z.date().nullable(),
33
- cancelledAt: z.date().nullable(),
34
- disbursementId: z.lazy(() => disbursementIdSchema).nullable(),
35
- disbursement: z
36
- .lazy(() => DisbursementZod)
37
- .optional()
38
- .nullable(),
39
- });
40
- export type DisbursementTransactionZod = z.infer<
41
- typeof DisbursementTransactionZod
42
- >;
43
-
44
- export const PostDisbursementTransactionZod = z.object({
45
- tid: z.string().min(6).max(64).openapi({ example: 'TXN8A7B6C5' }),
46
- type: z
47
- .nativeEnum(TransactionType)
48
- .openapi({ example: TransactionType.CHARGE }),
49
- amount: z.number().min(0.01).max(10000000000).openapi({ example: 2000 }),
50
- disbursementId: z
51
- .lazy(() => disbursementIdSchema)
52
- .openapi({
53
- example: 'disbursement_01j5y5ghx5fg68d663j1fvy2x7',
54
- }),
55
- });
56
- export type PostDisbursementTransactionZod = z.infer<
57
- typeof PostDisbursementTransactionZod
58
- >;
59
-
60
- export const CompliancePostDisbursementTransactionZod =
61
- PostDisbursementTransactionZod.merge(
62
- z.object({
63
- chargedAt: dateSchema.refine(
64
- (date) => date instanceof Date && date <= new Date(),
65
- { message: 'date cannot be in the future' },
66
- ),
67
- accountId: accountIdSchema,
68
- }),
69
- );
70
- export type CompliancePostDisbursementTransactionZod = z.infer<
71
- typeof CompliancePostDisbursementTransactionZod
72
- >;
@@ -1,426 +0,0 @@
1
- import { z } from 'zod';
2
- import { IBaseEntity } from './entity.types';
3
- import { IOffering, offeringIdSchema } from './offering.types';
4
- import {
5
- AccountZod,
6
- BaseStatus,
7
- ComplianceReview,
8
- dateSchema,
9
- IPaginationMeta,
10
- } from './common.types';
11
- import { tradeIdSchema } from './trade.types';
12
- import { accountIdSchema } from './account.types';
13
- import { TypeID } from 'typeid-js';
14
- import { IIssuer, issuerIdSchema } from './issuer.types';
15
- import {
16
- IIssuerBankAccount,
17
- issuerBankAccountIdSchema,
18
- } from './issuer-bank-account.types';
19
- import { userIdSchema, UserZod } from './user.types';
20
- import {
21
- PostDisbursementAdjustmentZod,
22
- DisbursementAdjustmentType,
23
- } from './disbursement-adjustment.types';
24
- import { IEscrowAccount, escrowAccountIdSchema } from './escrow-account.types';
25
-
26
- export const disbursementIdSchema = z.string().refine(
27
- (value) => {
28
- try {
29
- const tid = TypeID.fromString(value);
30
- return tid.getType() === 'disbursement';
31
- } catch {
32
- return false;
33
- }
34
- },
35
- {
36
- message:
37
- 'Invalid disbursement ID format. Must be a valid TypeID with "disbursement" prefix.',
38
- },
39
- );
40
-
41
- export enum DisbursementStatus {
42
- PENDING = BaseStatus.PENDING,
43
- APPROVED = BaseStatus.APPROVED,
44
- REJECTED = BaseStatus.REJECTED,
45
- SETTLED = BaseStatus.SETTLED,
46
- COMPLETED = BaseStatus.COMPLETED,
47
- }
48
-
49
- export const DisbursementZod = IBaseEntity.extend({
50
- name: z.string().openapi({ example: 'Dalmore' }),
51
- status: z
52
- .nativeEnum(DisbursementStatus)
53
- .openapi({ example: DisbursementStatus.PENDING }),
54
- requestedAmount: z.number().openapi({ example: 100 }),
55
- netAmount: z.number().openapi({ example: 1000 }),
56
- complianceReview: z.nativeEnum(ComplianceReview),
57
- approversCount: z.number(),
58
- disbursedAt: z.date().nullable(),
59
- accountId: accountIdSchema,
60
- account: z
61
- .lazy(() => AccountZod)
62
- .optional()
63
- .nullable(),
64
- offeringId: offeringIdSchema,
65
- offering: z
66
- .lazy(() => IOffering)
67
- .optional()
68
- .nullable(),
69
- createdById: userIdSchema,
70
- createdBy: UserZod.optional().nullable(),
71
- reviewedById: z
72
- .string()
73
- .nullable()
74
- .openapi({ example: 'user_00041061050r3gg28a1c60t3gf' }),
75
- });
76
-
77
- export type DisbursementZod = z.infer<typeof DisbursementZod>;
78
-
79
- export const PostDisbursementTrades = z.object({
80
- accountId: accountIdSchema.openapi({
81
- example: 'account_00041061050r3gg28a1c60t3gf',
82
- }),
83
- name: z.string().openapi({ example: 'Dalmore' }),
84
- offeringId: z
85
- .lazy(() => offeringIdSchema)
86
- .openapi({
87
- example: 'offering_00041061050r3gg28a1c60t3gf',
88
- }),
89
- trades: z
90
- .array(tradeIdSchema)
91
- .min(1, 'At least one trade is required')
92
- .max(500, 'Maximum of 500 trades allowed')
93
- .openapi({
94
- example: [
95
- 'trade_00041061050r3gg28a1c60t3gf',
96
- 'trade_00041061050r3gg28a1c60t3g',
97
- ],
98
- }),
99
- });
100
- export type PostDisbursementTrades = z.infer<typeof PostDisbursementTrades>;
101
-
102
- export const PostDisbursementOfferings = z.object({
103
- accountId: accountIdSchema.openapi({
104
- example: 'account_00041061050r3gg28a1c60t3gf',
105
- }),
106
- name: z.string().openapi({ example: 'Dalmore' }),
107
- offeringId: z
108
- .lazy(() => offeringIdSchema)
109
- .openapi({
110
- example: 'offering_00041061050r3gg28a1c60t3gf',
111
- }),
112
- });
113
- export type PostDisbursementOfferings = z.infer<
114
- typeof PostDisbursementOfferings
115
- >;
116
-
117
- export const DisbursementFiltersZod = z.object({
118
- name: z.string().optional(),
119
- offeringId: z.lazy(() => offeringIdSchema).optional(),
120
- issuerId: z.lazy(() => issuerIdSchema).optional(),
121
- search: z.string().optional(),
122
- status: z
123
- .nativeEnum(DisbursementStatus)
124
- .optional()
125
- .openapi({ example: 'PENDING' }),
126
- from: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
127
- to: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
128
- accountId: accountIdSchema.optional(),
129
- });
130
-
131
- export const IPaginatedDisbursement = z.object({
132
- items: z.array(DisbursementZod),
133
- meta: IPaginationMeta,
134
- });
135
- export type IPaginatedDisbursement = z.infer<typeof IPaginatedDisbursement>;
136
-
137
- export const disbursementsInclude = z.enum([
138
- 'createdBy',
139
- 'reviewedBy',
140
- 'offering',
141
- 'account',
142
- 'issuerBankAccount',
143
- 'escrowAccount',
144
- 'disbursementAdjustments',
145
- 'tradeDisbursements',
146
- 'disbursementReviews',
147
- 'disbursementTransactions',
148
- 'issuer',
149
- ]);
150
-
151
- /**
152
- * @description Query parameters for including related entities
153
- * @xample in contract us as -> query: z.object({}).merge(DisbursementsIncludeQuery),
154
- */
155
- export const DisbursementsIncludeQuery = z.object({
156
- include: z
157
- .string()
158
- .optional()
159
- .transform((str) => (str ? str.split(',') : []))
160
- .refine(
161
- (includes) =>
162
- includes.every((include) =>
163
- disbursementsInclude.options.includes(include as any),
164
- ),
165
- {
166
- message: `Invalid include option provided. Valid options are: ${disbursementsInclude.options.join(',')}`,
167
- },
168
- )
169
- .openapi({
170
- example: `${disbursementsInclude.options.join(',')}`,
171
- }),
172
- });
173
- export interface DisbursementsIncludeQuery
174
- extends z.infer<typeof DisbursementsIncludeQuery> {}
175
-
176
- export const PostDisbursementZod = z.object({
177
- name: z.string().max(50).openapi({ example: 'Dalmore' }),
178
- offeringId: z
179
- .lazy(() => offeringIdSchema)
180
- .openapi({
181
- example: 'offering_00041061050r3gg28a1c60t3gf',
182
- }),
183
- issuerId: z
184
- .lazy(() => issuerIdSchema)
185
- .openapi({
186
- example: 'issuer_00041061050r3gg28a1c60t3gf',
187
- }),
188
- issuerBankAccountId: z
189
- .lazy(() => issuerBankAccountIdSchema)
190
- .openapi({
191
- example: 'issuer_bank_account_00041061050r3gg28a1c60t3gf',
192
- }),
193
- requestedAmount: z
194
- .number()
195
- .min(0.01)
196
- .max(10000000000)
197
- .openapi({ example: 2000 }),
198
- netAmount: z.number().min(0.01).max(10000000000).openapi({ example: 5000 }),
199
- disbursedAt: dateSchema.optional().nullable(),
200
- tradeIds: z.array(tradeIdSchema).min(1).max(100),
201
- disbursementAdjustments: z.array(PostDisbursementAdjustmentZod).refine(
202
- (adjustments) => {
203
- const adjustmentTypes = adjustments.map((adj) => adj.type);
204
- const requiredTypes = Object.values(DisbursementAdjustmentType);
205
- return requiredTypes.every((type) => adjustmentTypes.includes(type));
206
- },
207
- {
208
- message: `All disbursement adjustments are required: ${Object.values(DisbursementAdjustmentType).join(', ')}`,
209
- },
210
- ),
211
- escrowAccountId: z.lazy(() => escrowAccountIdSchema),
212
- });
213
- export type PostDisbursementZod = z.infer<typeof PostDisbursementZod>;
214
-
215
- export const CompliancePostDisbursementZod = PostDisbursementZod.extend({
216
- accountId: accountIdSchema,
217
- });
218
- export type CompliancePostDisbursementZod = z.infer<
219
- typeof CompliancePostDisbursementZod
220
- >;
221
-
222
- export const DisbursementsMissingConfigQuery = z.object({
223
- accountId: accountIdSchema.optional(),
224
- });
225
- export interface DisbursementsMissingConfigQuery
226
- extends z.infer<typeof DisbursementsMissingConfigQuery> {}
227
-
228
- export const DisbursementMissingConfigZod = z.object({
229
- missingConfigurations: z.array(z.string()),
230
- });
231
-
232
- export type DisbursementMissingConfigZod = z.infer<
233
- typeof DisbursementMissingConfigZod
234
- >;
235
-
236
- export const DisbursementSigningLinkZod = z.string().nullable();
237
-
238
- export type DisbursementSigningLinkZod = z.infer<
239
- typeof DisbursementSigningLinkZod
240
- >;
241
-
242
- export const ComplianceReviewDisbursements = z.object({
243
- complianceReview: z.enum([
244
- ComplianceReview.APPROVED,
245
- ComplianceReview.REJECTED,
246
- ]),
247
- disbursements: z
248
- .array(disbursementIdSchema)
249
- .min(1, 'At least one disbursement is required')
250
- .max(50, 'Maximum of 50 disbursements allowed')
251
- .openapi({
252
- example: [
253
- 'disbursement_01jjsdrx1seqfse7z4z47sgdp5',
254
- 'disbursement_01jjsdrx27enkszq5cnc3hdhrf',
255
- ],
256
- }),
257
- });
258
- export type ComplianceReviewDisbursements = z.infer<
259
- typeof ComplianceReviewDisbursements
260
- >;
261
-
262
- export const TradeDisbursementZod = z.object({
263
- id: z
264
- .lazy(() => disbursementIdSchema)
265
- .openapi({
266
- example: 'disbursement_00041061050r3gg28a1c60t3gf',
267
- }),
268
- name: z.string().openapi({ example: 'Disbursement Name' }),
269
- status: z
270
- .nativeEnum(DisbursementStatus)
271
- .openapi({ example: DisbursementStatus.PENDING }),
272
- date: z.date().nullable().openapi({ example: 'MM/DD/YYYY' }),
273
- });
274
- export type TradeDisbursementZod = z.infer<typeof TradeDisbursementZod>;
275
-
276
- export const TradeDisbursementsZod = z.array(TradeDisbursementZod);
277
- export type TradeDisbursementsZod = z.infer<typeof TradeDisbursementsZod>;
278
-
279
- export const PostDisbursementBalanceZod = z.object({
280
- offeringId: offeringIdSchema,
281
- });
282
- export type PostDisbursementBalanceZod = z.infer<
283
- typeof PostDisbursementBalanceZod
284
- >;
285
-
286
- export const PostDisbursementSummaryZod = z.object({
287
- offeringId: offeringIdSchema,
288
- tradeIds: z.array(tradeIdSchema).min(1).max(1000),
289
- });
290
- export type PostDisbursementSummaryZod = z.infer<
291
- typeof PostDisbursementSummaryZod
292
- >;
293
-
294
- export const DisbursementBalanceZod = z.object({
295
- contingencyAmount: z.number(),
296
- contingencyStatus: z.string(),
297
- totalRaised: z.number(),
298
- totalDisbursed: z.number(),
299
- totalPending: z.number(),
300
- totalFees: z.number(),
301
- refundPool: z.number(),
302
- availableForDisbursements: z.number(),
303
- });
304
- export type DisbursementBalanceZod = z.infer<typeof DisbursementBalanceZod>;
305
-
306
- export const DisbursementSummaryZod = z.object({
307
- amountRequested: z.number(),
308
- brokerageFee: z.number(),
309
- disbursementFee: z.number(),
310
- refundPool: z.number(),
311
- amountToBeTransferred: z.number(),
312
- });
313
- export type DisbursementSummaryZod = z.infer<typeof DisbursementSummaryZod>;
314
-
315
- // GET /disbursements/preview query parameters
316
- export const GetDisbursementPreviewQueryZod = z.object({
317
- offeringId: offeringIdSchema,
318
- selectedTrades: z
319
- .string()
320
- .optional()
321
- .transform((str) => (str ? str.split(',') : []))
322
- .refine(
323
- (ids) =>
324
- ids.every((id) => {
325
- try {
326
- const tid = TypeID.fromString(id);
327
- return tid.getType() === 'trade';
328
- } catch {
329
- return false;
330
- }
331
- }),
332
- {
333
- message: 'All selected trades must be valid trade IDs',
334
- },
335
- )
336
- .openapi({
337
- example: 'trade_01abc123,trade_01def456',
338
- }),
339
- });
340
- export type GetDisbursementPreviewQueryZod = z.infer<
341
- typeof GetDisbursementPreviewQueryZod
342
- >;
343
-
344
- // Context fields for disbursement preview
345
- export const DisbursementPreviewContextZod = z.object({
346
- issuer: z.lazy(() => IIssuer).nullable(),
347
- offering: z.lazy(() => IOffering).nullable(),
348
- escrowAccount: z.lazy(() => IEscrowAccount).nullable(),
349
- destinationBank: z.lazy(() => IIssuerBankAccount).nullable(),
350
- });
351
- export type DisbursementPreviewContextZod = z.infer<
352
- typeof DisbursementPreviewContextZod
353
- >;
354
-
355
- // Balance values for disbursement preview
356
- export const DisbursementPreviewBalanceZod = z.object({
357
- totalRaised: z.number(),
358
- totalDisbursed: z.number(),
359
- pending: z.number(),
360
- refundPool: z.number(),
361
- availableForDisbursement: z.number(),
362
- });
363
- export type DisbursementPreviewBalanceZod = z.infer<
364
- typeof DisbursementPreviewBalanceZod
365
- >;
366
-
367
- // Trade summary for disbursement preview
368
- export const DisbursementPreviewTradeSummaryZod = z.object({
369
- selectedTradesCount: z.number(),
370
- selectedTradesTotalAmount: z.number(),
371
- });
372
- export type DisbursementPreviewTradeSummaryZod = z.infer<
373
- typeof DisbursementPreviewTradeSummaryZod
374
- >;
375
-
376
- // Contingency validation result
377
- export const DisbursementPreviewContingencyZod = z.object({
378
- contingencyPassed: z.boolean(),
379
- contingencyMessage: z.string().nullable(),
380
- contingencyAmount: z.number(),
381
- });
382
- export type DisbursementPreviewContingencyZod = z.infer<
383
- typeof DisbursementPreviewContingencyZod
384
- >;
385
-
386
- // Amount defaults and constraints
387
- export const DisbursementPreviewAmountZod = z.object({
388
- defaultAmount: z.number(),
389
- minAmount: z.number(),
390
- maxAmount: z.number(),
391
- });
392
- export type DisbursementPreviewAmountZod = z.infer<
393
- typeof DisbursementPreviewAmountZod
394
- >;
395
-
396
- // Complete response for GET /disbursements/preview
397
- export const DisbursementPreviewZod = z.object({
398
- context: DisbursementPreviewContextZod,
399
- balance: DisbursementPreviewBalanceZod,
400
- tradeSummary: DisbursementPreviewTradeSummaryZod,
401
- contingency: DisbursementPreviewContingencyZod,
402
- amount: DisbursementPreviewAmountZod,
403
- });
404
- export type DisbursementPreviewZod = z.infer<typeof DisbursementPreviewZod>;
405
-
406
- export const EligibleOfferingZod = z.object({
407
- offeringId: offeringIdSchema,
408
- offeringName: z.string(),
409
- availableAmount: z.number(),
410
- });
411
- export type EligibleOfferingZod = z.infer<typeof EligibleOfferingZod>;
412
-
413
- export const IPaginatedEligibleOffering = z.object({
414
- items: z.array(EligibleOfferingZod),
415
- meta: IPaginationMeta,
416
- });
417
- export type IPaginatedEligibleOffering = z.infer<
418
- typeof IPaginatedEligibleOffering
419
- >;
420
-
421
- export const EligibleOfferingsFiltersZod = z.object({
422
- search: z.string().optional(),
423
- });
424
- export type EligibleOfferingsFiltersZod = z.infer<
425
- typeof EligibleOfferingsFiltersZod
426
- >;