@dalmore/api-contracts 0.0.0-dev.5e42638 → 0.0.0-dev.64aba85

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 (538) hide show
  1. package/common/helpers/index.d.ts +50 -0
  2. package/common/helpers/index.js +136 -0
  3. package/common/helpers/index.js.map +1 -0
  4. package/common/types/account-contact.types.d.ts +485 -0
  5. package/common/types/account-contact.types.js +75 -0
  6. package/common/types/account-contact.types.js.map +1 -0
  7. package/common/types/account-detail.types.d.ts +304 -0
  8. package/common/types/account-detail.types.js +20 -0
  9. package/common/types/account-detail.types.js.map +1 -0
  10. package/common/types/account-integration.types.d.ts +242 -0
  11. package/common/types/account-integration.types.js +121 -0
  12. package/common/types/account-integration.types.js.map +1 -0
  13. package/common/types/account-manager.types.d.ts +917 -0
  14. package/common/types/account-manager.types.js +89 -0
  15. package/common/types/account-manager.types.js.map +1 -0
  16. package/common/types/account-setting.types.d.ts +184 -0
  17. package/common/types/account-setting.types.js +52 -0
  18. package/common/types/account-setting.types.js.map +1 -0
  19. package/common/types/account.types.d.ts +631 -0
  20. package/common/types/account.types.js +217 -0
  21. package/common/types/account.types.js.map +1 -0
  22. package/common/types/activity.types.d.ts +581 -0
  23. package/common/types/activity.types.js +247 -0
  24. package/common/types/activity.types.js.map +1 -0
  25. package/common/types/address.types.d.ts +89 -0
  26. package/common/types/address.types.js +36 -0
  27. package/common/types/address.types.js.map +1 -0
  28. package/common/types/aic.types.d.ts +434 -0
  29. package/common/types/aic.types.js +170 -0
  30. package/common/types/aic.types.js.map +1 -0
  31. package/common/types/aml.types.d.ts +41 -0
  32. package/common/types/aml.types.js +16 -0
  33. package/common/types/aml.types.js.map +1 -0
  34. package/common/types/api-key-logs.types.d.ts +204 -0
  35. package/common/types/api-key-logs.types.js +52 -0
  36. package/common/types/api-key-logs.types.js.map +1 -0
  37. package/common/types/api-keys.types.d.ts +192 -0
  38. package/common/types/api-keys.types.js +57 -0
  39. package/common/types/api-keys.types.js.map +1 -0
  40. package/common/types/asset.types.d.ts +1186 -0
  41. package/common/types/asset.types.js +429 -0
  42. package/common/types/asset.types.js.map +1 -0
  43. package/common/types/auth.types.d.ts +487 -0
  44. package/common/types/auth.types.js +279 -0
  45. package/common/types/auth.types.js.map +1 -0
  46. package/common/types/batch-jobs.types.d.ts +321 -0
  47. package/common/types/batch-jobs.types.js +111 -0
  48. package/common/types/batch-jobs.types.js.map +1 -0
  49. package/common/types/bonus-tier.types.d.ts +1021 -0
  50. package/common/types/bonus-tier.types.js +167 -0
  51. package/common/types/bonus-tier.types.js.map +1 -0
  52. package/common/types/cap-table.types.d.ts +1124 -0
  53. package/common/types/cap-table.types.js +406 -0
  54. package/common/types/cap-table.types.js.map +1 -0
  55. package/common/types/cart.types.d.ts +28 -0
  56. package/common/types/cart.types.js +19 -0
  57. package/common/types/cart.types.js.map +1 -0
  58. package/common/types/checklist-items.types.d.ts +195 -0
  59. package/common/types/checklist-items.types.js +54 -0
  60. package/common/types/checklist-items.types.js.map +1 -0
  61. package/common/types/checklist.types.d.ts +140 -0
  62. package/common/types/checklist.types.js +71 -0
  63. package/common/types/checklist.types.js.map +1 -0
  64. package/common/types/common.types.d.ts +1512 -0
  65. package/common/types/common.types.js +1442 -0
  66. package/common/types/common.types.js.map +1 -0
  67. package/common/types/comply-advantage-api.types.d.ts +3626 -0
  68. package/common/types/comply-advantage-api.types.js +291 -0
  69. package/common/types/comply-advantage-api.types.js.map +1 -0
  70. package/common/types/comply-advantage.types.d.ts +48 -0
  71. package/common/types/comply-advantage.types.js +21 -0
  72. package/common/types/comply-advantage.types.js.map +1 -0
  73. package/common/types/contact-us.types.d.ts +126 -0
  74. package/common/types/contact-us.types.js +91 -0
  75. package/common/types/contact-us.types.js.map +1 -0
  76. package/common/types/countries.types.d.ts +77 -0
  77. package/common/types/countries.types.js +349 -0
  78. package/common/types/countries.types.js.map +1 -0
  79. package/common/types/covered-person.types.d.ts +204 -0
  80. package/common/types/covered-person.types.js +234 -0
  81. package/common/types/covered-person.types.js.map +1 -0
  82. package/common/types/dashboard.types.d.ts +2086 -0
  83. package/common/types/dashboard.types.js +690 -0
  84. package/common/types/dashboard.types.js.map +1 -0
  85. package/common/types/data-record.types.d.ts +347 -0
  86. package/common/types/data-record.types.js +261 -0
  87. package/common/types/data-record.types.js.map +1 -0
  88. package/common/types/data-room.types.d.ts +1277 -0
  89. package/common/types/data-room.types.js +167 -0
  90. package/common/types/data-room.types.js.map +1 -0
  91. package/common/types/default-theme-config.types.d.ts +445 -0
  92. package/common/types/default-theme-config.types.js +63 -0
  93. package/common/types/default-theme-config.types.js.map +1 -0
  94. package/common/types/disbursement-adjustment.types.d.ts +21 -0
  95. package/common/types/disbursement-adjustment.types.js +25 -0
  96. package/common/types/disbursement-adjustment.types.js.map +1 -0
  97. package/common/types/disbursement-approval-user.types.d.ts +935 -0
  98. package/common/types/disbursement-approval-user.types.js +68 -0
  99. package/common/types/disbursement-approval-user.types.js.map +1 -0
  100. package/common/types/disbursement-review.types.d.ts +923 -0
  101. package/common/types/disbursement-review.types.js +76 -0
  102. package/common/types/disbursement-review.types.js.map +1 -0
  103. package/common/types/disbursement-transaction.types.d.ts +621 -0
  104. package/common/types/disbursement-transaction.types.js +51 -0
  105. package/common/types/disbursement-transaction.types.js.map +1 -0
  106. package/common/types/disbursements.types.d.ts +3090 -0
  107. package/common/types/disbursements.types.js +345 -0
  108. package/common/types/disbursements.types.js.map +1 -0
  109. package/common/types/domain-filter.types.d.ts +135 -0
  110. package/common/types/domain-filter.types.js +40 -0
  111. package/common/types/domain-filter.types.js.map +1 -0
  112. package/common/types/email-theme.types.d.ts +1359 -0
  113. package/common/types/email-theme.types.js +318 -0
  114. package/common/types/email-theme.types.js.map +1 -0
  115. package/common/types/entity.types.d.ts +21 -0
  116. package/common/types/entity.types.js +14 -0
  117. package/common/types/entity.types.js.map +1 -0
  118. package/common/types/error-responses.types.d.ts +144 -0
  119. package/common/types/error-responses.types.js +125 -0
  120. package/common/types/error-responses.types.js.map +1 -0
  121. package/common/types/escrow-account.types.d.ts +398 -0
  122. package/common/types/escrow-account.types.js +75 -0
  123. package/common/types/escrow-account.types.js.map +1 -0
  124. package/common/types/exchange-api-key.types.d.ts +1010 -0
  125. package/common/types/exchange-api-key.types.js +90 -0
  126. package/common/types/exchange-api-key.types.js.map +1 -0
  127. package/common/types/exchange-import.types.d.ts +23 -0
  128. package/common/types/exchange-import.types.js +23 -0
  129. package/common/types/exchange-import.types.js.map +1 -0
  130. package/common/types/exchange-provider.types.d.ts +1308 -0
  131. package/common/types/exchange-provider.types.js +268 -0
  132. package/common/types/exchange-provider.types.js.map +1 -0
  133. package/common/types/file.types.d.ts +401 -0
  134. package/common/types/file.types.js +378 -0
  135. package/common/types/file.types.js.map +1 -0
  136. package/common/types/health.types.d.ts +112 -0
  137. package/common/types/health.types.js +22 -0
  138. package/common/types/health.types.js.map +1 -0
  139. package/common/types/i-will-do-it-later.types.d.ts +51 -0
  140. package/common/types/i-will-do-it-later.types.js +30 -0
  141. package/common/types/i-will-do-it-later.types.js.map +1 -0
  142. package/common/types/{index.ts → index.d.ts} +3 -3
  143. package/common/types/index.js +52 -0
  144. package/common/types/index.js.map +1 -0
  145. package/common/types/individuals.types.d.ts +1899 -0
  146. package/common/types/individuals.types.js +500 -0
  147. package/common/types/individuals.types.js.map +1 -0
  148. package/common/types/investor-account.types.d.ts +2996 -0
  149. package/common/types/investor-account.types.js +930 -0
  150. package/common/types/investor-account.types.js.map +1 -0
  151. package/common/types/investorAccountIdSchema.type.js +1 -0
  152. package/common/types/investorAccountIdSchema.type.js.map +1 -0
  153. package/common/types/investors-offering.types.d.ts +391 -0
  154. package/common/types/investors-offering.types.js +49 -0
  155. package/common/types/investors-offering.types.js.map +1 -0
  156. package/common/types/invite.types.d.ts +641 -0
  157. package/common/types/invite.types.js +113 -0
  158. package/common/types/invite.types.js.map +1 -0
  159. package/common/types/issuer-bank-account.types.d.ts +385 -0
  160. package/common/types/issuer-bank-account.types.js +81 -0
  161. package/common/types/issuer-bank-account.types.js.map +1 -0
  162. package/common/types/issuer-offering.types.d.ts +1509 -0
  163. package/common/types/issuer-offering.types.js +413 -0
  164. package/common/types/issuer-offering.types.js.map +1 -0
  165. package/common/types/issuer-payment-method.types.d.ts +1100 -0
  166. package/common/types/issuer-payment-method.types.js +311 -0
  167. package/common/types/issuer-payment-method.types.js.map +1 -0
  168. package/common/types/issuer.types.d.ts +539 -0
  169. package/common/types/issuer.types.js +275 -0
  170. package/common/types/issuer.types.js.map +1 -0
  171. package/common/types/job-item.types.d.ts +230 -0
  172. package/common/types/job-item.types.js +89 -0
  173. package/common/types/job-item.types.js.map +1 -0
  174. package/common/types/jobs.types.d.ts +296 -0
  175. package/common/types/jobs.types.js +150 -0
  176. package/common/types/jobs.types.js.map +1 -0
  177. package/common/types/kyb.types.d.ts +167 -0
  178. package/common/types/kyb.types.js +45 -0
  179. package/common/types/kyb.types.js.map +1 -0
  180. package/common/types/kyc.types.d.ts +2197 -0
  181. package/common/types/kyc.types.js +301 -0
  182. package/common/types/kyc.types.js.map +1 -0
  183. package/common/types/legal-entity.types.d.ts +638 -0
  184. package/common/types/legal-entity.types.js +148 -0
  185. package/common/types/legal-entity.types.js.map +1 -0
  186. package/common/types/login-history.types.d.ts +160 -0
  187. package/common/types/login-history.types.js +39 -0
  188. package/common/types/login-history.types.js.map +1 -0
  189. package/common/types/mail-template.types.d.ts +595 -0
  190. package/common/types/mail-template.types.js +401 -0
  191. package/common/types/mail-template.types.js.map +1 -0
  192. package/common/types/north-cap-integration.types.d.ts +1303 -0
  193. package/common/types/north-cap-integration.types.js +145 -0
  194. package/common/types/north-cap-integration.types.js.map +1 -0
  195. package/common/types/note.types.d.ts +216 -0
  196. package/common/types/note.types.js +82 -0
  197. package/common/types/note.types.js.map +1 -0
  198. package/common/types/notification.types.d.ts +2689 -0
  199. package/common/types/notification.types.js +408 -0
  200. package/common/types/notification.types.js.map +1 -0
  201. package/common/types/notion-api.types.d.ts +3626 -0
  202. package/common/types/notion-api.types.js +271 -0
  203. package/common/types/notion-api.types.js.map +1 -0
  204. package/common/types/notion-database.types.d.ts +191 -0
  205. package/common/types/notion-database.types.js +95 -0
  206. package/common/types/notion-database.types.js.map +1 -0
  207. package/common/types/notion-page.types.d.ts +3482 -0
  208. package/common/types/notion-page.types.js +208 -0
  209. package/common/types/notion-page.types.js.map +1 -0
  210. package/common/types/offering-reports.types.d.ts +525 -0
  211. package/common/types/offering-reports.types.js +111 -0
  212. package/common/types/offering-reports.types.js.map +1 -0
  213. package/common/types/offering-submission.types.d.ts +587 -0
  214. package/common/types/offering-submission.types.js +278 -0
  215. package/common/types/offering-submission.types.js.map +1 -0
  216. package/common/types/offering.types.d.ts +2555 -0
  217. package/common/types/offering.types.js +574 -0
  218. package/common/types/offering.types.js.map +1 -0
  219. package/common/types/page-revision.types.d.ts +74 -0
  220. package/common/types/page-revision.types.js +68 -0
  221. package/common/types/page-revision.types.js.map +1 -0
  222. package/common/types/page.types.d.ts +540 -0
  223. package/common/types/page.types.js +361 -0
  224. package/common/types/page.types.js.map +1 -0
  225. package/common/types/password.type.d.ts +2 -0
  226. package/common/types/password.type.js +14 -0
  227. package/common/types/password.type.js.map +1 -0
  228. package/common/types/payment-methods.types.d.ts +800 -0
  229. package/common/types/payment-methods.types.js +260 -0
  230. package/common/types/payment-methods.types.js.map +1 -0
  231. package/common/types/phone.type.d.ts +12 -0
  232. package/common/types/phone.type.js +29 -0
  233. package/common/types/phone.type.js.map +1 -0
  234. package/common/types/portfolio.types.d.ts +185 -0
  235. package/common/types/portfolio.types.js +36 -0
  236. package/common/types/portfolio.types.js.map +1 -0
  237. package/common/types/privacy-policy-and-tos.types.d.ts +2 -0
  238. package/common/types/{privacy-policy-and-tos.types.ts → privacy-policy-and-tos.types.js} +1 -1
  239. package/common/types/privacy-policy-and-tos.types.js.map +1 -0
  240. package/common/types/queue.types.d.ts +22 -0
  241. package/common/types/queue.types.js +73 -0
  242. package/common/types/queue.types.js.map +1 -0
  243. package/common/types/registered-reps.types.d.ts +6 -0
  244. package/common/types/registered-reps.types.js +21 -0
  245. package/common/types/registered-reps.types.js.map +1 -0
  246. package/common/types/rejection-reasons.types.d.ts +35 -0
  247. package/common/types/rejection-reasons.types.js +49 -0
  248. package/common/types/rejection-reasons.types.js.map +1 -0
  249. package/common/types/review.types.d.ts +419 -0
  250. package/common/types/review.types.js +101 -0
  251. package/common/types/review.types.js.map +1 -0
  252. package/common/types/role.types.d.ts +30 -0
  253. package/common/types/role.types.js +21 -0
  254. package/common/types/role.types.js.map +1 -0
  255. package/common/types/secondary-customer.types.d.ts +586 -0
  256. package/common/types/secondary-customer.types.js +39 -0
  257. package/common/types/secondary-customer.types.js.map +1 -0
  258. package/common/types/secondary-issuer.types.d.ts +283 -0
  259. package/common/types/secondary-issuer.types.js +37 -0
  260. package/common/types/secondary-issuer.types.js.map +1 -0
  261. package/common/types/secondary-order.types.d.ts +508 -0
  262. package/common/types/secondary-order.types.js +40 -0
  263. package/common/types/secondary-order.types.js.map +1 -0
  264. package/common/types/secondary-security.types.d.ts +175 -0
  265. package/common/types/secondary-security.types.js +45 -0
  266. package/common/types/secondary-security.types.js.map +1 -0
  267. package/common/types/secondary-trade.entity.d.ts +16 -0
  268. package/common/types/secondary-trade.entity.js +12 -0
  269. package/common/types/secondary-trade.entity.js.map +1 -0
  270. package/common/types/secondary-trade.types.d.ts +465 -0
  271. package/common/types/secondary-trade.types.js +61 -0
  272. package/common/types/secondary-trade.types.js.map +1 -0
  273. package/common/types/secure-request.types.d.ts +171 -0
  274. package/common/types/secure-request.types.js +51 -0
  275. package/common/types/secure-request.types.js.map +1 -0
  276. package/common/types/signer.types.d.ts +3406 -0
  277. package/common/types/signer.types.js +532 -0
  278. package/common/types/signer.types.js.map +1 -0
  279. package/common/types/site-link.types.d.ts +875 -0
  280. package/common/types/site-link.types.js +126 -0
  281. package/common/types/site-link.types.js.map +1 -0
  282. package/common/types/site-settings.types.d.ts +1673 -0
  283. package/common/types/site-settings.types.js +500 -0
  284. package/common/types/site-settings.types.js.map +1 -0
  285. package/common/types/site.types.d.ts +1496 -0
  286. package/common/types/site.types.js +213 -0
  287. package/common/types/site.types.js.map +1 -0
  288. package/common/types/sms.types.d.ts +40 -0
  289. package/common/types/sms.types.js +27 -0
  290. package/common/types/sms.types.js.map +1 -0
  291. package/common/types/state-machine.types.d.ts +591 -0
  292. package/common/types/state-machine.types.js +144 -0
  293. package/common/types/state-machine.types.js.map +1 -0
  294. package/common/types/states.types.d.ts +77 -0
  295. package/common/types/states.types.js +137 -0
  296. package/common/types/states.types.js.map +1 -0
  297. package/common/types/subdoc-preview.types.d.ts +379 -0
  298. package/common/types/subdoc-preview.types.js +24 -0
  299. package/common/types/subdoc-preview.types.js.map +1 -0
  300. package/common/types/task.types.d.ts +537 -0
  301. package/common/types/task.types.js +211 -0
  302. package/common/types/task.types.js.map +1 -0
  303. package/common/types/trade-adjustment.type.d.ts +40 -0
  304. package/common/types/trade-adjustment.type.js +26 -0
  305. package/common/types/trade-adjustment.type.js.map +1 -0
  306. package/common/types/trade-line-item.types.d.ts +329 -0
  307. package/common/types/trade-line-item.types.js +100 -0
  308. package/common/types/trade-line-item.types.js.map +1 -0
  309. package/common/types/trade.types.d.ts +2004 -0
  310. package/common/types/trade.types.js +787 -0
  311. package/common/types/trade.types.js.map +1 -0
  312. package/common/types/transaction.types.d.ts +454 -0
  313. package/common/types/transaction.types.js +174 -0
  314. package/common/types/transaction.types.js.map +1 -0
  315. package/common/types/trusted-contact.types.d.ts +440 -0
  316. package/common/types/trusted-contact.types.js +95 -0
  317. package/common/types/trusted-contact.types.js.map +1 -0
  318. package/common/types/typography.types.d.ts +52 -0
  319. package/common/types/typography.types.js +67 -0
  320. package/common/types/typography.types.js.map +1 -0
  321. package/common/types/user-manual.types.d.ts +287 -0
  322. package/common/types/user-manual.types.js +192 -0
  323. package/common/types/user-manual.types.js.map +1 -0
  324. package/common/types/user-setting.types.d.ts +273 -0
  325. package/common/types/user-setting.types.js +85 -0
  326. package/common/types/user-setting.types.js.map +1 -0
  327. package/common/types/user.types.d.ts +1951 -0
  328. package/common/types/user.types.js +238 -0
  329. package/common/types/user.types.js.map +1 -0
  330. package/common/types/webhook.types.d.ts +10829 -0
  331. package/common/types/webhook.types.js +658 -0
  332. package/common/types/webhook.types.js.map +1 -0
  333. package/common/types/zip.type.d.ts +35 -0
  334. package/common/types/zip.type.js +28 -0
  335. package/common/types/zip.type.js.map +1 -0
  336. package/contracts/clients/accounts/index.d.ts +308 -0
  337. package/contracts/clients/accounts/index.js +43 -0
  338. package/contracts/clients/accounts/index.js.map +1 -0
  339. package/contracts/clients/aic/index.d.ts +280 -0
  340. package/contracts/clients/aic/index.js +47 -0
  341. package/contracts/clients/aic/index.js.map +1 -0
  342. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  343. package/contracts/clients/api-key-logs/index.js +37 -0
  344. package/contracts/clients/api-key-logs/index.js.map +1 -0
  345. package/contracts/clients/api-keys/index.d.ts +374 -0
  346. package/contracts/clients/api-keys/index.js +59 -0
  347. package/contracts/clients/api-keys/index.js.map +1 -0
  348. package/contracts/clients/assets/index.d.ts +1116 -0
  349. package/contracts/clients/assets/index.js +80 -0
  350. package/contracts/clients/assets/index.js.map +1 -0
  351. package/contracts/clients/auth/index.d.ts +236 -0
  352. package/contracts/clients/auth/index.js +38 -0
  353. package/contracts/clients/auth/index.js.map +1 -0
  354. package/contracts/clients/cart/index.d.ts +229 -0
  355. package/contracts/clients/cart/index.js +63 -0
  356. package/contracts/clients/cart/index.js.map +1 -0
  357. package/contracts/clients/files/index.d.ts +552 -0
  358. package/contracts/clients/files/index.js +142 -0
  359. package/contracts/clients/files/index.js.map +1 -0
  360. package/contracts/clients/files-public/index.d.ts +552 -0
  361. package/contracts/clients/files-public/index.js +142 -0
  362. package/contracts/clients/files-public/index.js.map +1 -0
  363. package/contracts/clients/index.d.ts +12786 -0
  364. package/contracts/clients/index.js +52 -0
  365. package/contracts/clients/index.js.map +1 -0
  366. package/contracts/clients/individuals/index.d.ts +3199 -0
  367. package/contracts/clients/individuals/index.js +74 -0
  368. package/contracts/clients/individuals/index.js.map +1 -0
  369. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  370. package/contracts/clients/investor-accounts/index.js +73 -0
  371. package/contracts/clients/investor-accounts/index.js.map +1 -0
  372. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  373. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  374. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  375. package/contracts/clients/issuers/index.d.ts +449 -0
  376. package/contracts/clients/issuers/index.js +75 -0
  377. package/contracts/clients/issuers/index.js.map +1 -0
  378. package/contracts/clients/kyc/index.d.ts +345 -0
  379. package/contracts/clients/kyc/index.js +49 -0
  380. package/contracts/clients/kyc/index.js.map +1 -0
  381. package/contracts/clients/legal-entities/index.d.ts +887 -0
  382. package/contracts/clients/legal-entities/index.js +74 -0
  383. package/contracts/clients/legal-entities/index.js.map +1 -0
  384. package/contracts/clients/offerings/index.d.ts +983 -0
  385. package/contracts/clients/offerings/index.js +95 -0
  386. package/contracts/clients/offerings/index.js.map +1 -0
  387. package/contracts/clients/payment-methods/index.d.ts +456 -0
  388. package/contracts/clients/payment-methods/index.js +68 -0
  389. package/contracts/clients/payment-methods/index.js.map +1 -0
  390. package/contracts/clients/secure-requests/index.d.ts +100 -0
  391. package/contracts/clients/secure-requests/index.js +22 -0
  392. package/contracts/clients/secure-requests/index.js.map +1 -0
  393. package/contracts/clients/sites/index.d.ts +657 -0
  394. package/contracts/clients/sites/index.js +40 -0
  395. package/contracts/clients/sites/index.js.map +1 -0
  396. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  397. package/contracts/clients/trade-line-items/index.js +47 -0
  398. package/contracts/clients/trade-line-items/index.js.map +1 -0
  399. package/contracts/clients/trades/index.d.ts +871 -0
  400. package/contracts/clients/trades/index.js +156 -0
  401. package/contracts/clients/trades/index.js.map +1 -0
  402. package/contracts/clients/transactions/index.d.ts +88 -0
  403. package/contracts/clients/transactions/index.js +25 -0
  404. package/contracts/clients/transactions/index.js.map +1 -0
  405. package/package.json +15 -15
  406. package/common/helpers/index.ts +0 -59
  407. package/common/types/account-contact.types.ts +0 -99
  408. package/common/types/account-detail.types.ts +0 -27
  409. package/common/types/account-integration.types.ts +0 -143
  410. package/common/types/account-manager.types.ts +0 -120
  411. package/common/types/account-setting.types.ts +0 -65
  412. package/common/types/account.types.ts +0 -297
  413. package/common/types/activity.types.ts +0 -274
  414. package/common/types/address.types.ts +0 -41
  415. package/common/types/aic.types.ts +0 -246
  416. package/common/types/aml.types.ts +0 -18
  417. package/common/types/api-key-logs.types.ts +0 -66
  418. package/common/types/api-keys.types.ts +0 -69
  419. package/common/types/asset.types.ts +0 -338
  420. package/common/types/auth.types.ts +0 -359
  421. package/common/types/batch-jobs.types.ts +0 -151
  422. package/common/types/bonus-tier.types.ts +0 -180
  423. package/common/types/cart.types.ts +0 -21
  424. package/common/types/checklist-items.types.ts +0 -70
  425. package/common/types/checklist.types.ts +0 -97
  426. package/common/types/common.types.ts +0 -1552
  427. package/common/types/comply-advantage-api.types.ts +0 -316
  428. package/common/types/comply-advantage.types.ts +0 -25
  429. package/common/types/contact-us.types.ts +0 -111
  430. package/common/types/countries.types.ts +0 -375
  431. package/common/types/covered-person.types.ts +0 -275
  432. package/common/types/dashboard.types.ts +0 -792
  433. package/common/types/data-record.types.ts +0 -325
  434. package/common/types/data-room.types.ts +0 -242
  435. package/common/types/default-theme-config.types.ts +0 -87
  436. package/common/types/disbursement-adjustment.types.ts +0 -32
  437. package/common/types/disbursement-approval-user.types.ts +0 -100
  438. package/common/types/disbursement-review.types.ts +0 -110
  439. package/common/types/disbursement-transaction.types.ts +0 -72
  440. package/common/types/disbursements.types.ts +0 -426
  441. package/common/types/domain-filter.types.ts +0 -55
  442. package/common/types/email-theme.types.ts +0 -442
  443. package/common/types/entity.types.ts +0 -15
  444. package/common/types/error-responses.types.ts +0 -135
  445. package/common/types/escrow-account.types.ts +0 -104
  446. package/common/types/exchange-api-key.types.ts +0 -121
  447. package/common/types/exchange-import.types.ts +0 -36
  448. package/common/types/exchange-provider.types.ts +0 -329
  449. package/common/types/file.types.ts +0 -477
  450. package/common/types/health.types.ts +0 -29
  451. package/common/types/i-will-do-it-later.types.ts +0 -68
  452. package/common/types/individuals.types.ts +0 -542
  453. package/common/types/investor-account.types.ts +0 -1240
  454. package/common/types/investors-offering.types.ts +0 -65
  455. package/common/types/invite.types.ts +0 -159
  456. package/common/types/issuer-bank-account.types.ts +0 -107
  457. package/common/types/issuer-offering.types.ts +0 -389
  458. package/common/types/issuer-payment-method.types.ts +0 -382
  459. package/common/types/issuer.types.ts +0 -321
  460. package/common/types/job-item.types.ts +0 -119
  461. package/common/types/jobs.types.ts +0 -171
  462. package/common/types/kyb.types.ts +0 -53
  463. package/common/types/kyc.types.ts +0 -188
  464. package/common/types/legal-entity.types.ts +0 -186
  465. package/common/types/login-history.types.ts +0 -46
  466. package/common/types/mail-template.types.ts +0 -470
  467. package/common/types/north-cap-integration.types.ts +0 -190
  468. package/common/types/note.types.ts +0 -109
  469. package/common/types/notification.types.ts +0 -554
  470. package/common/types/notion-api.types.ts +0 -374
  471. package/common/types/notion-database.types.ts +0 -125
  472. package/common/types/notion-page.types.ts +0 -267
  473. package/common/types/offering-reports.types.ts +0 -153
  474. package/common/types/offering-submission.types.ts +0 -314
  475. package/common/types/offering.types.ts +0 -676
  476. package/common/types/page-revision.types.ts +0 -86
  477. package/common/types/page.types.ts +0 -436
  478. package/common/types/password.type.ts +0 -15
  479. package/common/types/payment-methods.types.ts +0 -298
  480. package/common/types/phone.type.ts +0 -27
  481. package/common/types/portfolio.types.ts +0 -50
  482. package/common/types/queue.types.ts +0 -112
  483. package/common/types/registered-reps.types.ts +0 -25
  484. package/common/types/rejection-reasons.types.ts +0 -56
  485. package/common/types/reminder-config.types.ts +0 -40
  486. package/common/types/review.types.ts +0 -133
  487. package/common/types/role.types.ts +0 -26
  488. package/common/types/secondary-customer.types.ts +0 -66
  489. package/common/types/secondary-issuer.types.ts +0 -50
  490. package/common/types/secondary-order.types.ts +0 -58
  491. package/common/types/secondary-security.types.ts +0 -60
  492. package/common/types/secondary-trade.entity.ts +0 -16
  493. package/common/types/secondary-trade.types.ts +0 -95
  494. package/common/types/secure-request.types.ts +0 -68
  495. package/common/types/signer.types.ts +0 -651
  496. package/common/types/site-link.types.ts +0 -166
  497. package/common/types/site-settings.types.ts +0 -727
  498. package/common/types/site.types.ts +0 -263
  499. package/common/types/sms.types.ts +0 -30
  500. package/common/types/state-machine.types.ts +0 -177
  501. package/common/types/states.types.ts +0 -163
  502. package/common/types/subdoc-preview.types.ts +0 -35
  503. package/common/types/task.types.ts +0 -258
  504. package/common/types/trade-adjustment.type.ts +0 -33
  505. package/common/types/trade-line-item.types.ts +0 -125
  506. package/common/types/trade.types.ts +0 -1045
  507. package/common/types/transaction.types.ts +0 -209
  508. package/common/types/trusted-contact.types.ts +0 -122
  509. package/common/types/typography.types.ts +0 -75
  510. package/common/types/user-manual.types.ts +0 -290
  511. package/common/types/user-setting.types.ts +0 -133
  512. package/common/types/user.types.ts +0 -304
  513. package/common/types/webhook.types.ts +0 -730
  514. package/common/types/zip.type.ts +0 -36
  515. package/contracts/clients/accounts/index.ts +0 -61
  516. package/contracts/clients/aic/index.ts +0 -59
  517. package/contracts/clients/api-key-logs/index.ts +0 -53
  518. package/contracts/clients/api-keys/index.ts +0 -73
  519. package/contracts/clients/assets/index.ts +0 -102
  520. package/contracts/clients/auth/index.ts +0 -50
  521. package/contracts/clients/cart/index.ts +0 -80
  522. package/contracts/clients/files/index.ts +0 -166
  523. package/contracts/clients/files-public/index.ts +0 -166
  524. package/contracts/clients/index.ts +0 -54
  525. package/contracts/clients/individuals/index.ts +0 -93
  526. package/contracts/clients/investor-accounts/index.ts +0 -93
  527. package/contracts/clients/issuer-payment-methods/index.ts +0 -39
  528. package/contracts/clients/issuers/index.ts +0 -94
  529. package/contracts/clients/legal-entities/index.ts +0 -93
  530. package/contracts/clients/offerings/index.ts +0 -117
  531. package/contracts/clients/payment-methods/index.ts +0 -85
  532. package/contracts/clients/secure-requests/index.ts +0 -34
  533. package/contracts/clients/sites/index.ts +0 -56
  534. package/contracts/clients/trade-line-items/index.ts +0 -66
  535. package/contracts/clients/trades/index.ts +0 -186
  536. package/contracts/clients/transactions/index.ts +0 -37
  537. package/index.ts +0 -10
  538. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -1,186 +0,0 @@
1
- import { z } from 'zod';
2
- import { IBaseEntity } from './entity.types';
3
- import {
4
- dateSchema,
5
- EmailSchema,
6
- IPaginationMeta,
7
- KYBStatus,
8
- SanctionsStatus,
9
- SetupStatusType,
10
- } from './common.types';
11
- import { KybZod } from './kyb.types';
12
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
13
- import { TypeID } from 'typeid-js';
14
- import { AddressSchema } from './address.types';
15
- import { PhoneZodSchema } from './phone.type';
16
- extendZodWithOpenApi(z);
17
-
18
- // importing investorAccountIdSchema directly from './investor-account.types' causes 500 server errors due to circular import
19
- const investorAccountIdSchema = z.string().refine(
20
- (value) => {
21
- try {
22
- const tid = TypeID.fromString(value);
23
- return tid.getType() === 'investor_account';
24
- } catch {
25
- return false;
26
- }
27
- },
28
- {
29
- message:
30
- 'Invalid investor_account ID format. Must be a valid TypeID with "investor_account" prefix.',
31
- },
32
- );
33
-
34
- export const legalEntityIdSchema = z.string().refine(
35
- (value) => {
36
- try {
37
- const tid = TypeID.fromString(value);
38
- return tid.getType() === 'legal_entity';
39
- } catch {
40
- return false;
41
- }
42
- },
43
- {
44
- message:
45
- 'Invalid legal_entity ID format. Must be a valid TypeID with "legal_entity" prefix.',
46
- },
47
- );
48
- export const LegalEntityZod = IBaseEntity.extend({
49
- thirdPartyId: z
50
- .string()
51
- .openapi({ example: 'third_party_legal_entity_123' })
52
- .nullable(),
53
- accountId: z
54
- .string()
55
- .openapi({ example: 'account_01j1xgme5qeqq97gpdztd7e4a6' }),
56
- investorAccountId: z
57
- .string()
58
- .openapi({ example: 'investor_account_01j1xgme5qeqq97gpdztd7e4a7' }),
59
- kybStatus: z
60
- .lazy(() => z.nativeEnum(KYBStatus))
61
- .openapi({ example: 'PENDING' }),
62
- sanctionsStatus: z
63
- .lazy(() => z.nativeEnum(SanctionsStatus))
64
- .openapi({ example: 'PENDING' }),
65
- kybs: z.array(KybZod).optional(),
66
- name: z.string().openapi({ example: 'Acme Corporation' }),
67
- ein: z.string().openapi({ example: '12-3456789' }).nullish(),
68
- companyType: z.string().openapi({ example: 'LLC' }).nullish(),
69
- streetAddress: z.string().openapi({ example: '123 Main St' }).nullish(),
70
- city: z.string().openapi({ example: 'Anytown' }).nullish(),
71
- state: z.string().openapi({ example: 'CA' }).nullable(),
72
- zip: z.string().openapi({ example: '12345' }).nullish(),
73
- country: z.string().openapi({ example: 'USA' }).nullish(),
74
- phone: z.string().openapi({ example: '+12124567890' }).nullish(),
75
- setupStatus: z.nativeEnum(SetupStatusType),
76
- });
77
- export type LegalEntityZod = z.infer<typeof LegalEntityZod>;
78
-
79
- export const IPaginatedLegalEntity = z.object({
80
- items: z.array(LegalEntityZod),
81
- meta: IPaginationMeta,
82
- });
83
- export type IPaginatedLegalEntity = z.infer<typeof IPaginatedLegalEntity>;
84
-
85
- const legalEntitiesInclude = z.enum(['kybs']);
86
-
87
- export const LegalEntityFiltersZod = z.object({
88
- kybStatus: z.nativeEnum(KYBStatus).optional(),
89
- sanctionsStatus: z.nativeEnum(SanctionsStatus).optional(),
90
- });
91
-
92
- /**
93
- * @description Query parameters for including related entities
94
- * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
95
- */
96
- export const LegalEntitiesIncludeQuery = z.object({
97
- include: z
98
- .string()
99
- .optional()
100
- .transform((str) => (str ? str.split(',') : []))
101
- .refine(
102
- (includes) =>
103
- includes.every((include) =>
104
- legalEntitiesInclude.options.includes(include as any),
105
- ),
106
- {
107
- message: `Invalid include option provided. Valid options are: ${legalEntitiesInclude.options.join(',')}`,
108
- },
109
- )
110
- .openapi({
111
- example: `${legalEntitiesInclude.options.join(',')}`,
112
- }),
113
- });
114
- export interface LegalEntitiesIncludeQuery
115
- extends z.infer<typeof LegalEntitiesIncludeQuery> {}
116
- export const EINSchema = z
117
- .string()
118
- .openapi({ example: '123456789' })
119
- .length(9, 'Ein shall be of 9 characters')
120
- .refine((v) => !isNaN(Number(v)), {
121
- message: `Ein can only consist of numbers`,
122
- })
123
- .optional();
124
-
125
- export const CompanyNameSchema = z
126
- .string()
127
- .openapi({ example: 'Acme Corporation' })
128
- .min(2, 'Name is less than 2 characters ')
129
- .max(50, 'Name is more than 50 characters ');
130
-
131
- export const CompanyTypeSchema = z
132
- .string()
133
- .openapi({ example: 'LLC' })
134
- .min(2, 'companyType is less than 2 characters ')
135
- .max(50, 'companyType is more than 50 characters ');
136
-
137
- export const PostLegalEntitySchema = z
138
- .object({
139
- investorAccountId: investorAccountIdSchema,
140
- name: CompanyNameSchema,
141
- ein: EINSchema,
142
- email: EmailSchema.optional(),
143
- companyType: CompanyTypeSchema.optional(),
144
- phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
145
- dateOfIncorporation: z.lazy(() => dateSchema).optional(),
146
- stateOfIncorporation: z.string().optional(),
147
- })
148
- .and(AddressSchema);
149
-
150
- export type PostLegalEntityType = z.infer<typeof PostLegalEntitySchema>;
151
-
152
- export const UpdateLegalEntitySchema = z
153
- .object({
154
- id: legalEntityIdSchema.optional(),
155
- name: CompanyNameSchema.optional(),
156
- ein: EINSchema,
157
- email: EmailSchema.optional(),
158
- companyType: CompanyTypeSchema.optional(),
159
- phone: PhoneZodSchema.openapi({ example: '+12124567890' }).optional(),
160
- dateOfIncorporation: z.lazy(() => dateSchema).optional(),
161
- stateOfIncorporation: z.string().optional(),
162
- })
163
- .and(AddressSchema);
164
-
165
- export type UpdateLegalEntityType = z.infer<typeof UpdateLegalEntitySchema>;
166
-
167
- export const ResponseLegalEntitySchema = z.object({
168
- id: legalEntityIdSchema,
169
- accountId: z.string(),
170
- investorAccountId: z.string(),
171
- name: CompanyNameSchema,
172
- ein: EINSchema.nullish(),
173
- email: z.string().email().nullable(),
174
- companyType: z.string().nullable(),
175
- address: z.string().nullable(),
176
- address2: z.string().nullable(),
177
- city: z.string().nullable(),
178
- state: z.string().nullable(),
179
- zip: z.string().nullable(),
180
- country: z.string().nullable(),
181
- phone: z.string().nullable(),
182
- dateOfIncorporation: z.coerce.date().nullable(),
183
- stateOfIncorporation: z.string().nullable(),
184
- setupStatus: z.nativeEnum(SetupStatusType),
185
- });
186
- export type ResponseLegalEntityType = z.infer<typeof ResponseLegalEntitySchema>;
@@ -1,46 +0,0 @@
1
- import { TypeID } from 'typeid-js';
2
- import { z } from 'zod';
3
- import { IBaseEntity } from './entity.types';
4
- export const loginHistoryIdSchema = z.string().refine(
5
- (value) => {
6
- try {
7
- const tid = TypeID.fromString(value);
8
- return tid.getType() === 'login_history';
9
- } catch {
10
- return false;
11
- }
12
- },
13
- {
14
- message:
15
- 'Invalid login history ID format. Must be a valid TypeID with "login_history" prefix.',
16
- },
17
- );
18
- export const ILoginHistory = IBaseEntity.extend({
19
- id: loginHistoryIdSchema,
20
- ipAddress: z.string().ip().nullable(),
21
- location: z.string().nullable(),
22
- browser: z.string().nullable(),
23
- deviceString: z.string().nullable(),
24
- osVersion: z.string().nullable(),
25
- browserVersion: z.string().nullable(),
26
- os: z.string().nullable(),
27
- userId: z.string().nullable(),
28
- user: z.any().nullable(),
29
- });
30
- export type ILoginHistory = z.infer<typeof ILoginHistory>;
31
-
32
- export const PostLoginHistoryZod = z.object({
33
- ipAddress: z.string().ip().nullable(),
34
- location: z.string().nullable(),
35
- browser: z.string().nullable(),
36
- deviceString: z.string().nullable(),
37
- osVersion: z.string().nullable(),
38
- browserVersion: z.string().nullable(),
39
- os: z.string().nullable(),
40
- });
41
- export type PostLoginHistoryZod = z.infer<typeof PostLoginHistoryZod>;
42
-
43
- export const IListLoginHistories = z.object({
44
- items: z.array(ILoginHistory),
45
- });
46
- export type IListLoginHistories = z.infer<typeof IListLoginHistories>;
@@ -1,470 +0,0 @@
1
- import { z } from 'zod';
2
- import { InvestorAccountType } from './common.types';
3
-
4
- export const IssuerWelcomeEmailTemplateZod = z.object({
5
- issuerName: z.string(),
6
- });
7
- export type IssuerWelcomeEmailTemplateZod = z.infer<
8
- typeof IssuerWelcomeEmailTemplateZod
9
- >;
10
-
11
- export const ResetPasswordEmailTemplateZod = z.object({
12
- name: z.string(),
13
- resetPasswordLink: z.string(),
14
- resetPasswordCode: z.string(),
15
- });
16
- export type ResetPasswordEmailTemplateZod = z.infer<
17
- typeof ResetPasswordEmailTemplateZod
18
- >;
19
-
20
- export const InvitationEmailTemplateZod = z.object({
21
- issuerName: z.string(),
22
- role: z.string(),
23
- invitationLink: z.string(),
24
- });
25
- export type InvitationEmailTemplateZod = z.infer<
26
- typeof InvitationEmailTemplateZod
27
- >;
28
-
29
- export const InvestorWelcomeEmailTemplateZod = z.object({
30
- investorName: z.string(),
31
- issuerName: z.string(),
32
- loginLink: z.string(),
33
- });
34
- export type InvestorWelcomeEmailTemplateZod = z.infer<
35
- typeof InvestorWelcomeEmailTemplateZod
36
- >;
37
-
38
- export const PlacedOrderLineItemsZod = z.object({
39
- name: z.string(),
40
- pricePerShare: z.number(),
41
- numberOfSharesPurchased: z.number(),
42
- totalInvestment: z.number(),
43
- });
44
- export type PlacedOrderLineItemsZod = z.infer<typeof PlacedOrderLineItemsZod>;
45
-
46
- export const OrderPlacedEmailTemplateZod = z.object({
47
- issuerName: z.string(),
48
- investorName: z.string(),
49
- investorAccountType: z.nativeEnum(InvestorAccountType),
50
- lineItems: z.array(PlacedOrderLineItemsZod),
51
- tradeDetailsEndpoint: z.string(),
52
- isWirePayment: z.boolean(),
53
- usAccountHolderName: z.string(),
54
- usBankName: z.string(),
55
- usRoutingNumber: z.string(),
56
- usAccountNumber: z.string(),
57
- reference: z.string(),
58
- swiftId: z.string(),
59
- });
60
- export type OrderPlacedEmailTemplateZod = z.infer<
61
- typeof OrderPlacedEmailTemplateZod
62
- >;
63
-
64
- export const OrderApprovedEmailTemplateZod = OrderPlacedEmailTemplateZod.omit({
65
- lineItems: true,
66
- }).extend({
67
- pricePerShare: z.number(),
68
- numberOfAssetsPurchased: z.number(),
69
- name: z.string(),
70
- totalAmount: z.number(),
71
- isWirePayment: z.boolean(),
72
- usAccountHolderName: z.string(),
73
- usBankName: z.string(),
74
- usRoutingNumber: z.string(),
75
- usAccountNumber: z.string(),
76
- reference: z.string(),
77
- swiftId: z.string(),
78
- });
79
- export type OrderApprovedEmailTemplateZod = z.infer<
80
- typeof OrderApprovedEmailTemplateZod
81
- >;
82
-
83
- export const TaskAssignedEmailTemplateZod = z.object({
84
- userName: z.string(),
85
- taskName: z.string(),
86
- assignedBy: z.string(),
87
- dueDate: z.string(),
88
- taskType: z.string(),
89
- priority: z.string(),
90
- description: z.string(),
91
- completeTaskEndpoint: z.string(),
92
- });
93
- export type TaskAssignedEmailTemplateZod = z.infer<
94
- typeof TaskAssignedEmailTemplateZod
95
- >;
96
- export const ResetPasswordSuccessEmailTemplateZod = z.object({
97
- name: z.string(),
98
- loginLink: z.string(),
99
- });
100
- export type ResetPasswordSuccessEmailTemplateZod = z.infer<
101
- typeof ResetPasswordSuccessEmailTemplateZod
102
- >;
103
-
104
- export const PaymentFailedEmailTemplateZod = z.object({
105
- firstName: z.string(),
106
- tradeDetailsEndpoint: z.string(),
107
- });
108
- export type PaymentFailedEmailTemplateZod = z.infer<
109
- typeof PaymentFailedEmailTemplateZod
110
- >;
111
- export const RetirementInstructionEmailTemplateZod = z.object({
112
- name: z.string(),
113
- instruction: z.string(),
114
- });
115
- export type RetirementInstructionEmailTemplateZod = z.infer<
116
- typeof RetirementInstructionEmailTemplateZod
117
- >;
118
-
119
- export const ContactUsEmailTemplateZod = z.object({
120
- firstName: z.string(),
121
- lastName: z.string(),
122
- email: z.string(),
123
- subject: z.string(),
124
- message: z.string(),
125
- timestamp: z.string(),
126
- });
127
- export type ContactUsEmailTemplateZod = z.infer<
128
- typeof ContactUsEmailTemplateZod
129
- >;
130
-
131
- export const SignatureRequestEmailTemplateZod = z.object({
132
- investorName: z.string(),
133
- requestedBy: z.string(),
134
- requestedByEmail: z.string(),
135
- documentName: z.string(),
136
- expirationDate: z.string(),
137
- signersList: z.array(
138
- z.object({
139
- name: z.string(),
140
- email: z.string(),
141
- }),
142
- ),
143
- });
144
- export type SignatureRequestEmailTemplateZod = z.infer<
145
- typeof SignatureRequestEmailTemplateZod
146
- >;
147
- // TODO: Add EMAIL_VERIFICATION
148
- export const EMAIL_TEMPLATES = {
149
- WELCOME_ISSUER: {
150
- subject: 'Welcome to Dalmore',
151
- path: 'welcome-issuer.mjml',
152
- body: `<html>
153
- <body>
154
- <p>Hello {{issuerName}},</p>
155
-
156
- <p>Welcome to Dalmore! We're thrilled to have you here as you take the next step in raising investments.</p>
157
-
158
- <p>Getting started is simple. Complete setting up your issuer account, submit your offering for review, and once approved, you'll be ready to connect with investors.</p>
159
-
160
- <p>For more details on how Dalmore can support your fundraising efforts, we've attached a brief info guide.</p>
161
-
162
- <p>If you have any questions, feel free to reach out.</p>
163
-
164
- <p>Best,<br>
165
- The Dalmore Team</p>
166
- </body>
167
- </html>`,
168
- },
169
-
170
- WELCOME_INVESTOR: {
171
- subject: 'Start Investing with {{issuerName}} on Dalmore',
172
- path: 'welcome-investor.mjml',
173
- body: `<html>
174
- <body>
175
- <p>Hello {{investorName}},</p>
176
-
177
- <p>{{issuerName}} is now accepting investments on Dalmore. Explore the offering and invest today.</p>
178
-
179
- <p>You can view the offering here:</p>
180
-
181
- <p><a href="{{heroAssetLink}}">View Offering</a></p>
182
-
183
- <p>If you have any questions, we're here to help.</p>
184
-
185
- <p>Best,<br>
186
- The Dalmore Team</p>
187
- </body>
188
- </html>`,
189
- },
190
-
191
- RESET_PASSWORD: {
192
- subject: 'Reset your password',
193
- path: 'reset-password.mjml',
194
- body: `<html>
195
- <body>
196
- <p>Hello {{name}},</p>
197
-
198
- <p>We received a request to reset your password. Click below to set a new one:</p>
199
-
200
- <p>Code: {{resetPasswordCode}}</p>
201
-
202
- <p><a href="{{resetPasswordLink}}">Reset Password</a></p>
203
-
204
- <p>If you didn't request this, please ignore this email.</p>
205
-
206
- <p>Best,<br>
207
- The Dalmore Team</p>
208
- </body>
209
- </html>`,
210
- },
211
-
212
- ISSUER_INVITATION: {
213
- subject: "You've Been Invited to Join an Issuer Account",
214
- path: 'invitation.mjml',
215
- body: `<html>
216
- <body>
217
- <p>Hello,</p>
218
-
219
- <p>You've been invited to join the {{issuerName}}'s account on Dalmore with the role of {{role}}.</p>
220
-
221
- <p>Click below to accept the invitation and access the account:</p>
222
-
223
- <p>{{invitationLink}}</p>
224
-
225
- <p>If you have any questions, feel free to reach out.</p>
226
-
227
- <p>Best,<br>
228
- The Dalmore Team</p>
229
- </body>
230
- </html>`,
231
- },
232
-
233
- COMPLIANCE_INVITATION: {
234
- subject: "You've Been Invited to Join an Compliance Account",
235
- path: 'compliance-invitation.mjml',
236
- body: `<html>
237
- <body>
238
- <p>Hello,</p>
239
-
240
- <p>You've been invited to join the Dalmore Group Compliance Portal with the role of {{role}}.</p>
241
-
242
- <p>Click below to accept the invitation and access the account:</p>
243
-
244
- <p>{{invitationLink}}</p>
245
-
246
- <p>If you have any questions, feel free to reach out.</p>
247
-
248
- <p>Best,<br>
249
- The Dalmore Team</p>
250
- </body>
251
- </html>`,
252
- },
253
-
254
- ORDER_PLACED: {
255
- subject: 'Your Trade Has Been Placed',
256
- path: 'order-placed.mjml',
257
- body: `<html>
258
- <body>
259
- <p>Hello {{investorName}},</p>
260
-
261
- <p>Your trade has been successfully placed with {{issuerName}}. Here are the details:</p>
262
-
263
- <p><b>Investor Account Type:</b> {{investorAccountType}}<br>
264
- <b>Offering Name:</b> {{offeringName}}<br>
265
- <b>Number of Assets Purchased:</b> {{numberOfAssetsPurchased}}<br>
266
- <b>Total Investment Value:</b> {{totalInvestmentAmount}}</p>
267
-
268
- <p>You will receive a confirmation once the order is reviewed.</p>
269
-
270
- <p><a href="{{tradeDetailsEndpoint}}">View Trade Details</a></p>
271
-
272
- <p>Best,<br>
273
- The Dalmore Team</p>
274
- </body>
275
- </html>`,
276
- },
277
-
278
- ORDER_APPROVED: {
279
- subject: 'Your Trade Has Been Approved',
280
- path: 'order-approved.mjml',
281
- body: `<html>
282
- <body>
283
- <p>Hello {{investorName}},</p>
284
-
285
- <p>Your trade with {{issuerName}} has been reviewed and approved. Here are the details:</p>
286
-
287
- <p><b>Investor Account Type:</b> {{investorAccountType}}<br>
288
- <b>Offering Name:</b> {{offeringName}}<br>
289
- <b>Number of Assets Purchased:</b> {{numberOfAssetsPurchased}}<br>
290
- <b>Total Investment Value:</b> {{totalInvestmentAmount}}</p>
291
-
292
- <p>You can view your trade details in your account.</p>
293
-
294
- <p>Best,<br>
295
- The Dalmore Team</p>
296
- </body>
297
- </html>`,
298
- },
299
- TASK_ASSIGNED: {
300
- subject: 'New Task Assigned',
301
- path: 'task-assigned.mjml',
302
- body: `<html>
303
- <body>
304
- <p>Hi, {{userName}}!</p>
305
-
306
- <p>You have a new task assigned to you. Please review the details below:</p>
307
-
308
- <p>Task Name: {{taskName}}<br>
309
- Assigned By: {{assignedBy}}<br>
310
- Due Date: {{dueDate}}<br>
311
- Task Type: {{taskType}}<br>
312
- Priority: {{priority}}<br>
313
- Description: {{description}}</p>
314
-
315
- <p><a href="{{completeTaskEndpoint}}">Complete Task</a></p>
316
- </body>
317
- </html>
318
- `,
319
- },
320
- AML_PENDING: {
321
- subject: 'AML Pending',
322
- path: 'aml-pending.mjml',
323
- body: `<html>
324
- <body>
325
- <p>Hi, {{userName}}!</p>
326
-
327
- <p>Your AML status is pending. Please complete your AML.</p>
328
-
329
- <p>Click below to visit your AML record:</p>
330
-
331
- <p><a href="{{completeAmlEndpoint}}">Visit AML</a></p>
332
- </body>
333
- </html>
334
- `,
335
- },
336
- PAYMENT_FAILED: {
337
- subject: 'Payment Failed',
338
- path: 'payment-failed.mjml',
339
- body: ``,
340
- },
341
- RESET_PASSWORD_SUCCESS: {
342
- subject: 'Password Changed Successfully',
343
- path: 'reset-password-successful.mjml',
344
- body: ``,
345
- },
346
- RETIREMENT_INSTRUCTION: {
347
- subject: 'Retirement Instruction',
348
- path: 'retirement-instruction.mjml',
349
- body: ``,
350
- },
351
- EMAIL_NOTIFICATION: {
352
- subject: '{{subject}}',
353
- path: 'email-notification.mjml',
354
- body: ``,
355
- },
356
- CONTACT_US: {
357
- subject: 'New Contact Message',
358
- path: 'contact-us.mjml',
359
- body: ``,
360
- },
361
- SUBMIT_PAYMENT: {
362
- subject: 'New Task Assigned – Submit Payment',
363
- path: 'submit-payment.mjml',
364
- body: ``,
365
- },
366
- SIGNATURE_REQUEST: {
367
- subject: 'Document Signature Request',
368
- path: 'signature-request.mjml',
369
- body: ``,
370
- },
371
- };
372
- // TODO: Add EMAIL_VERIFICATION
373
- export enum EmailTemplatesType {
374
- WELCOME_ISSUER = 'WELCOME_ISSUER',
375
- WELCOME_INVESTOR = 'WELCOME_INVESTOR',
376
- RESET_PASSWORD = 'RESET_PASSWORD',
377
- RESET_PASSWORD_SUCCESS = 'RESET_PASSWORD_SUCCESS',
378
- ISSUER_INVITATION = 'ISSUER_INVITATION',
379
- COMPLIANCE_INVITATION = 'COMPLIANCE_INVITATION',
380
- EMAIL_NOTIFICATION = 'EMAIL_NOTIFICATION',
381
- ORDER_PLACED = 'ORDER_PLACED',
382
- ORDER_APPROVED = 'ORDER_APPROVED',
383
- TASK_ASSIGNED = 'TASK_ASSIGNED',
384
- PAYMENT_FAILED = 'PAYMENT_FAILED',
385
- UPDATE_PAYMENT = 'UPDATE_PAYMENT',
386
- KYC_VERIFICATION_REQUIRED = 'KYC_VERIFICATION_REQUIRED',
387
- DOCUMENT_SIGNATURE_PENDING = 'DOCUMENT_SIGNATURE_PENDING',
388
- VERIFY_ACCOUNT = 'VERIFY_ACCOUNT',
389
- SIGNATURE_REQUEST = 'SIGNATURE_REQUEST',
390
- SUBMIT_PAYMENT = 'SUBMIT_PAYMENT',
391
- RETIREMENT_INSTRUCTION = 'RETIREMENT_INSTRUCTION',
392
- AML_PENDING = 'AML_PENDING',
393
- CONTACT_US = 'CONTACT_US',
394
- NONE = 'NONE',
395
- }
396
-
397
- export enum EmailAttachmentsType {
398
- USER_MANUAL = 'USER_MANUAL',
399
- BROKER_DEALER = 'BROKER_DEALER',
400
- STREAM = 'STREAM',
401
- STREAMS = 'STREAMS',
402
- OTHER = 'OTHER',
403
- NONE = 'NONE',
404
- }
405
-
406
- export const FooterZod = z.object({
407
- linkedinUrl: z.string().url().nullable(),
408
- twitterUrl: z.string().url().nullable(),
409
- facebookUrl: z.string().url().nullable(),
410
- instagramUrl: z.string().url().nullable(),
411
- mailSupporter: z.string().email().nullable(),
412
- websiteUrl: z.string().url().nullable(),
413
- otherUrls: z.array(z.string().url().nullable()).nullable(),
414
- poweredByImageUrl: z.string().url().nullable(),
415
- contactUsUrl: z.string().url().nullable(),
416
- });
417
- export type FooterZod = z.infer<typeof FooterZod>;
418
-
419
- export const HeaderZod = z.object({
420
- companyName: z.string(),
421
- logoUrl: z.string().nullable(),
422
- });
423
-
424
- export type HeaderZod = z.infer<typeof HeaderZod>;
425
-
426
- export const HeaderAndFooterZod = z.object({
427
- header: HeaderZod,
428
- footer: FooterZod,
429
- });
430
- export type HeaderAndFooterZod = z.infer<typeof HeaderAndFooterZod>;
431
-
432
- export const EmailThemeSettingZod = z.record(z.string(), z.string().nullable());
433
- export type EmailThemeSetting = z.infer<typeof EmailThemeSettingZod>;
434
-
435
- export const EmailThemeSettingsZod = z.array(EmailThemeSettingZod);
436
- export type EmailThemeSettingsZod = z.infer<typeof EmailThemeSettingsZod>;
437
-
438
- /**
439
- * Response from a successful email send operation.
440
- * Based on SendGrid SDK's ClientResponse structure.
441
- */
442
- export const EmailSendResponseSchema = z.object({
443
- /** HTTP status code from SendGrid (e.g., 202 for accepted) */
444
- statusCode: z.number(),
445
- /** SendGrid's x-message-id header for tracking emails in their dashboard */
446
- messageId: z.string().optional(),
447
- /** Full response headers, available for debugging if needed */
448
- headers: z.record(z.string(), z.unknown()).optional(),
449
- });
450
- export type EmailSendResponse = z.infer<typeof EmailSendResponseSchema>;
451
-
452
- /**
453
- * Error from a failed email send operation.
454
- * Fields are optional because error shapes vary depending on failure type
455
- * (network errors vs SendGrid API errors).
456
- */
457
- export const EmailSendErrorSchema = z.object({
458
- /** Human-readable error message */
459
- message: z.string(),
460
- /** Network-level error code (e.g., 'ECONNREFUSED', 'ETIMEDOUT') */
461
- code: z.string().optional(),
462
- /** HTTP status code if request reached SendGrid (e.g., 400, 401, 403, 413, 500) */
463
- statusCode: z.number().optional(),
464
- /**
465
- * SendGrid's error response body. Structure: { errors: [{ message, field, help, id }] }
466
- * @see https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send#responses
467
- */
468
- response: z.unknown().optional(),
469
- });
470
- export type EmailSendError = z.infer<typeof EmailSendErrorSchema>;