@dalmore/api-contracts 0.0.0-dev.d8ef117 → 0.0.0-dev.ddf366c

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 (700) hide show
  1. package/README.md +23 -19
  2. package/common/helpers/index.d.ts +50 -0
  3. package/common/helpers/index.js +136 -0
  4. package/common/helpers/index.js.map +1 -0
  5. package/common/types/account-contact.types.d.ts +485 -0
  6. package/common/types/account-contact.types.js +75 -0
  7. package/common/types/account-contact.types.js.map +1 -0
  8. package/common/types/account-detail.types.d.ts +304 -0
  9. package/common/types/account-detail.types.js +20 -0
  10. package/common/types/account-detail.types.js.map +1 -0
  11. package/common/types/account-integration.types.d.ts +242 -0
  12. package/common/types/account-integration.types.js +121 -0
  13. package/common/types/account-integration.types.js.map +1 -0
  14. package/common/types/account-manager.types.d.ts +917 -0
  15. package/common/types/account-manager.types.js +89 -0
  16. package/common/types/account-manager.types.js.map +1 -0
  17. package/common/types/account-setting.types.d.ts +184 -0
  18. package/common/types/account-setting.types.js +52 -0
  19. package/common/types/account-setting.types.js.map +1 -0
  20. package/common/types/account.types.d.ts +631 -0
  21. package/common/types/account.types.js +217 -0
  22. package/common/types/account.types.js.map +1 -0
  23. package/common/types/activity.types.d.ts +581 -0
  24. package/common/types/activity.types.js +247 -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 +1186 -0
  42. package/common/types/asset.types.js +429 -0
  43. package/common/types/asset.types.js.map +1 -0
  44. package/common/types/auth.types.d.ts +487 -0
  45. package/common/types/auth.types.js +279 -0
  46. package/common/types/auth.types.js.map +1 -0
  47. package/common/types/batch-jobs.types.d.ts +321 -0
  48. package/common/types/batch-jobs.types.js +111 -0
  49. package/common/types/batch-jobs.types.js.map +1 -0
  50. package/common/types/bonus-tier.types.d.ts +1021 -0
  51. package/common/types/bonus-tier.types.js +167 -0
  52. package/common/types/bonus-tier.types.js.map +1 -0
  53. package/common/types/cap-table.types.d.ts +1124 -0
  54. package/common/types/cap-table.types.js +406 -0
  55. package/common/types/cap-table.types.js.map +1 -0
  56. package/common/types/cart.types.d.ts +28 -0
  57. package/common/types/cart.types.js +19 -0
  58. package/common/types/cart.types.js.map +1 -0
  59. package/common/types/checklist-items.types.d.ts +195 -0
  60. package/common/types/checklist-items.types.js +54 -0
  61. package/common/types/checklist-items.types.js.map +1 -0
  62. package/common/types/checklist.types.d.ts +140 -0
  63. package/common/types/checklist.types.js +71 -0
  64. package/common/types/checklist.types.js.map +1 -0
  65. package/common/types/common.types.d.ts +1512 -0
  66. package/common/types/common.types.js +1442 -0
  67. package/common/types/common.types.js.map +1 -0
  68. package/common/types/comply-advantage-api.types.d.ts +4532 -0
  69. package/common/types/comply-advantage-api.types.js +278 -0
  70. package/common/types/comply-advantage-api.types.js.map +1 -0
  71. package/common/types/comply-advantage.types.d.ts +48 -0
  72. package/common/types/comply-advantage.types.js +21 -0
  73. package/common/types/comply-advantage.types.js.map +1 -0
  74. package/common/types/contact-us.types.d.ts +126 -0
  75. package/common/types/contact-us.types.js +91 -0
  76. package/common/types/contact-us.types.js.map +1 -0
  77. package/common/types/countries.types.d.ts +77 -0
  78. package/common/types/countries.types.js +349 -0
  79. package/common/types/countries.types.js.map +1 -0
  80. package/common/types/covered-person.types.d.ts +204 -0
  81. package/common/types/covered-person.types.js +234 -0
  82. package/common/types/covered-person.types.js.map +1 -0
  83. package/common/types/dashboard.types.d.ts +2086 -0
  84. package/common/types/dashboard.types.js +690 -0
  85. package/common/types/dashboard.types.js.map +1 -0
  86. package/common/types/data-record.types.d.ts +347 -0
  87. package/common/types/data-record.types.js +261 -0
  88. package/common/types/data-record.types.js.map +1 -0
  89. package/common/types/data-room.types.d.ts +1277 -0
  90. package/common/types/data-room.types.js +167 -0
  91. package/common/types/data-room.types.js.map +1 -0
  92. package/common/types/default-theme-config.types.d.ts +445 -0
  93. package/common/types/default-theme-config.types.js +63 -0
  94. package/common/types/default-theme-config.types.js.map +1 -0
  95. package/common/types/disbursement-adjustment.types.d.ts +21 -0
  96. package/common/types/disbursement-adjustment.types.js +25 -0
  97. package/common/types/disbursement-adjustment.types.js.map +1 -0
  98. package/common/types/disbursement-approval-user.types.d.ts +935 -0
  99. package/common/types/disbursement-approval-user.types.js +68 -0
  100. package/common/types/disbursement-approval-user.types.js.map +1 -0
  101. package/common/types/disbursement-review.types.d.ts +923 -0
  102. package/common/types/disbursement-review.types.js +76 -0
  103. package/common/types/disbursement-review.types.js.map +1 -0
  104. package/common/types/disbursement-transaction.types.d.ts +621 -0
  105. package/common/types/disbursement-transaction.types.js +51 -0
  106. package/common/types/disbursement-transaction.types.js.map +1 -0
  107. package/common/types/disbursements.types.d.ts +3084 -0
  108. package/common/types/disbursements.types.js +342 -0
  109. package/common/types/disbursements.types.js.map +1 -0
  110. package/common/types/domain-filter.types.d.ts +135 -0
  111. package/common/types/domain-filter.types.js +40 -0
  112. package/common/types/domain-filter.types.js.map +1 -0
  113. package/common/types/email-theme.types.d.ts +1359 -0
  114. package/common/types/email-theme.types.js +318 -0
  115. package/common/types/email-theme.types.js.map +1 -0
  116. package/common/types/entity.types.d.ts +21 -0
  117. package/common/types/entity.types.js +14 -0
  118. package/common/types/entity.types.js.map +1 -0
  119. package/common/types/error-responses.types.d.ts +144 -0
  120. package/common/types/error-responses.types.js +125 -0
  121. package/common/types/error-responses.types.js.map +1 -0
  122. package/common/types/escrow-account.types.d.ts +398 -0
  123. package/common/types/escrow-account.types.js +75 -0
  124. package/common/types/escrow-account.types.js.map +1 -0
  125. package/common/types/exchange-api-key.types.d.ts +1010 -0
  126. package/common/types/exchange-api-key.types.js +90 -0
  127. package/common/types/exchange-api-key.types.js.map +1 -0
  128. package/common/types/exchange-import.types.d.ts +23 -0
  129. package/common/types/exchange-import.types.js +23 -0
  130. package/common/types/exchange-import.types.js.map +1 -0
  131. package/common/types/exchange-provider.types.d.ts +1308 -0
  132. package/common/types/exchange-provider.types.js +268 -0
  133. package/common/types/exchange-provider.types.js.map +1 -0
  134. package/common/types/file.types.d.ts +401 -0
  135. package/common/types/file.types.js +378 -0
  136. package/common/types/file.types.js.map +1 -0
  137. package/common/types/health.types.d.ts +112 -0
  138. package/common/types/health.types.js +22 -0
  139. package/common/types/health.types.js.map +1 -0
  140. package/common/types/i-will-do-it-later.types.d.ts +51 -0
  141. package/common/types/i-will-do-it-later.types.js +30 -0
  142. package/common/types/i-will-do-it-later.types.js.map +1 -0
  143. package/common/types/{index.ts → index.d.ts} +3 -3
  144. package/common/types/index.js +52 -0
  145. package/common/types/index.js.map +1 -0
  146. package/common/types/individuals.types.d.ts +1899 -0
  147. package/common/types/individuals.types.js +500 -0
  148. package/common/types/individuals.types.js.map +1 -0
  149. package/common/types/investor-account.types.d.ts +2996 -0
  150. package/common/types/investor-account.types.js +930 -0
  151. package/common/types/investor-account.types.js.map +1 -0
  152. package/common/types/investorAccountIdSchema.type.js +1 -0
  153. package/common/types/investorAccountIdSchema.type.js.map +1 -0
  154. package/common/types/investors-offering.types.d.ts +391 -0
  155. package/common/types/investors-offering.types.js +49 -0
  156. package/common/types/investors-offering.types.js.map +1 -0
  157. package/common/types/invite.types.d.ts +641 -0
  158. package/common/types/invite.types.js +113 -0
  159. package/common/types/invite.types.js.map +1 -0
  160. package/common/types/issuer-bank-account.types.d.ts +385 -0
  161. package/common/types/issuer-bank-account.types.js +81 -0
  162. package/common/types/issuer-bank-account.types.js.map +1 -0
  163. package/common/types/issuer-offering.types.d.ts +1509 -0
  164. package/common/types/issuer-offering.types.js +413 -0
  165. package/common/types/issuer-offering.types.js.map +1 -0
  166. package/common/types/issuer-payment-method.types.d.ts +1100 -0
  167. package/common/types/issuer-payment-method.types.js +311 -0
  168. package/common/types/issuer-payment-method.types.js.map +1 -0
  169. package/common/types/issuer.types.d.ts +539 -0
  170. package/common/types/issuer.types.js +275 -0
  171. package/common/types/issuer.types.js.map +1 -0
  172. package/common/types/job-item.types.d.ts +230 -0
  173. package/common/types/job-item.types.js +89 -0
  174. package/common/types/job-item.types.js.map +1 -0
  175. package/common/types/jobs.types.d.ts +296 -0
  176. package/common/types/jobs.types.js +150 -0
  177. package/common/types/jobs.types.js.map +1 -0
  178. package/common/types/kyb.types.d.ts +167 -0
  179. package/common/types/kyb.types.js +45 -0
  180. package/common/types/kyb.types.js.map +1 -0
  181. package/common/types/kyc.types.d.ts +2197 -0
  182. package/common/types/kyc.types.js +301 -0
  183. package/common/types/kyc.types.js.map +1 -0
  184. package/common/types/legal-entity.types.d.ts +638 -0
  185. package/common/types/legal-entity.types.js +148 -0
  186. package/common/types/legal-entity.types.js.map +1 -0
  187. package/common/types/login-history.types.d.ts +160 -0
  188. package/common/types/login-history.types.js +39 -0
  189. package/common/types/login-history.types.js.map +1 -0
  190. package/common/types/mail-template.types.d.ts +595 -0
  191. package/common/types/mail-template.types.js +401 -0
  192. package/common/types/mail-template.types.js.map +1 -0
  193. package/common/types/north-cap-integration.types.d.ts +1303 -0
  194. package/common/types/north-cap-integration.types.js +145 -0
  195. package/common/types/north-cap-integration.types.js.map +1 -0
  196. package/common/types/note.types.d.ts +216 -0
  197. package/common/types/note.types.js +82 -0
  198. package/common/types/note.types.js.map +1 -0
  199. package/common/types/notification.types.d.ts +2689 -0
  200. package/common/types/notification.types.js +408 -0
  201. package/common/types/notification.types.js.map +1 -0
  202. package/common/types/notion-api.types.d.ts +3626 -0
  203. package/common/types/notion-api.types.js +271 -0
  204. package/common/types/notion-api.types.js.map +1 -0
  205. package/common/types/notion-database.types.d.ts +191 -0
  206. package/common/types/notion-database.types.js +95 -0
  207. package/common/types/notion-database.types.js.map +1 -0
  208. package/common/types/notion-page.types.d.ts +3482 -0
  209. package/common/types/notion-page.types.js +208 -0
  210. package/common/types/notion-page.types.js.map +1 -0
  211. package/common/types/offering-reports.types.d.ts +525 -0
  212. package/common/types/offering-reports.types.js +111 -0
  213. package/common/types/offering-reports.types.js.map +1 -0
  214. package/common/types/offering-submission.types.d.ts +587 -0
  215. package/common/types/offering-submission.types.js +278 -0
  216. package/common/types/offering-submission.types.js.map +1 -0
  217. package/common/types/offering.types.d.ts +2555 -0
  218. package/common/types/offering.types.js +574 -0
  219. package/common/types/offering.types.js.map +1 -0
  220. package/common/types/page-revision.types.d.ts +74 -0
  221. package/common/types/page-revision.types.js +68 -0
  222. package/common/types/page-revision.types.js.map +1 -0
  223. package/common/types/page.types.d.ts +540 -0
  224. package/common/types/page.types.js +361 -0
  225. package/common/types/page.types.js.map +1 -0
  226. package/common/types/password.type.d.ts +2 -0
  227. package/common/types/password.type.js +14 -0
  228. package/common/types/password.type.js.map +1 -0
  229. package/common/types/payment-methods.types.d.ts +800 -0
  230. package/common/types/payment-methods.types.js +260 -0
  231. package/common/types/payment-methods.types.js.map +1 -0
  232. package/common/types/phone.type.d.ts +12 -0
  233. package/common/types/phone.type.js +29 -0
  234. package/common/types/phone.type.js.map +1 -0
  235. package/common/types/portfolio.types.d.ts +185 -0
  236. package/common/types/portfolio.types.js +36 -0
  237. package/common/types/portfolio.types.js.map +1 -0
  238. package/common/types/privacy-policy-and-tos.types.d.ts +2 -0
  239. package/common/types/{privacy-policy-and-tos.types.ts → privacy-policy-and-tos.types.js} +1 -1
  240. package/common/types/privacy-policy-and-tos.types.js.map +1 -0
  241. package/common/types/queue.types.d.ts +22 -0
  242. package/common/types/queue.types.js +73 -0
  243. package/common/types/queue.types.js.map +1 -0
  244. package/common/types/registered-reps.types.d.ts +6 -0
  245. package/common/types/registered-reps.types.js +21 -0
  246. package/common/types/registered-reps.types.js.map +1 -0
  247. package/common/types/rejection-reasons.types.d.ts +35 -0
  248. package/common/types/rejection-reasons.types.js +49 -0
  249. package/common/types/rejection-reasons.types.js.map +1 -0
  250. package/common/types/review.types.d.ts +419 -0
  251. package/common/types/review.types.js +101 -0
  252. package/common/types/review.types.js.map +1 -0
  253. package/common/types/role.types.d.ts +30 -0
  254. package/common/types/role.types.js +21 -0
  255. package/common/types/role.types.js.map +1 -0
  256. package/common/types/secondary-customer.types.d.ts +586 -0
  257. package/common/types/secondary-customer.types.js +39 -0
  258. package/common/types/secondary-customer.types.js.map +1 -0
  259. package/common/types/secondary-issuer.types.d.ts +283 -0
  260. package/common/types/secondary-issuer.types.js +37 -0
  261. package/common/types/secondary-issuer.types.js.map +1 -0
  262. package/common/types/secondary-order.types.d.ts +508 -0
  263. package/common/types/secondary-order.types.js +40 -0
  264. package/common/types/secondary-order.types.js.map +1 -0
  265. package/common/types/secondary-security.types.d.ts +175 -0
  266. package/common/types/secondary-security.types.js +45 -0
  267. package/common/types/secondary-security.types.js.map +1 -0
  268. package/common/types/secondary-trade.entity.d.ts +16 -0
  269. package/common/types/secondary-trade.entity.js +12 -0
  270. package/common/types/secondary-trade.entity.js.map +1 -0
  271. package/common/types/secondary-trade.types.d.ts +465 -0
  272. package/common/types/secondary-trade.types.js +61 -0
  273. package/common/types/secondary-trade.types.js.map +1 -0
  274. package/common/types/secure-request.types.d.ts +171 -0
  275. package/common/types/secure-request.types.js +51 -0
  276. package/common/types/secure-request.types.js.map +1 -0
  277. package/common/types/signer.types.d.ts +3406 -0
  278. package/common/types/signer.types.js +532 -0
  279. package/common/types/signer.types.js.map +1 -0
  280. package/common/types/site-link.types.d.ts +875 -0
  281. package/common/types/site-link.types.js +126 -0
  282. package/common/types/site-link.types.js.map +1 -0
  283. package/common/types/site-settings.types.d.ts +1673 -0
  284. package/common/types/site-settings.types.js +500 -0
  285. package/common/types/site-settings.types.js.map +1 -0
  286. package/common/types/site.types.d.ts +1496 -0
  287. package/common/types/site.types.js +213 -0
  288. package/common/types/site.types.js.map +1 -0
  289. package/common/types/sms.types.d.ts +40 -0
  290. package/common/types/sms.types.js +27 -0
  291. package/common/types/sms.types.js.map +1 -0
  292. package/common/types/state-machine.types.d.ts +591 -0
  293. package/common/types/state-machine.types.js +144 -0
  294. package/common/types/state-machine.types.js.map +1 -0
  295. package/common/types/states.types.d.ts +77 -0
  296. package/common/types/states.types.js +137 -0
  297. package/common/types/states.types.js.map +1 -0
  298. package/common/types/subdoc-preview.types.d.ts +379 -0
  299. package/common/types/subdoc-preview.types.js +24 -0
  300. package/common/types/subdoc-preview.types.js.map +1 -0
  301. package/common/types/task.types.d.ts +537 -0
  302. package/common/types/task.types.js +211 -0
  303. package/common/types/task.types.js.map +1 -0
  304. package/common/types/trade-adjustment.type.d.ts +40 -0
  305. package/common/types/trade-adjustment.type.js +26 -0
  306. package/common/types/trade-adjustment.type.js.map +1 -0
  307. package/common/types/trade-line-item.types.d.ts +329 -0
  308. package/common/types/trade-line-item.types.js +100 -0
  309. package/common/types/trade-line-item.types.js.map +1 -0
  310. package/common/types/trade.types.d.ts +2004 -0
  311. package/common/types/trade.types.js +787 -0
  312. package/common/types/trade.types.js.map +1 -0
  313. package/common/types/transaction.types.d.ts +454 -0
  314. package/common/types/transaction.types.js +174 -0
  315. package/common/types/transaction.types.js.map +1 -0
  316. package/common/types/trusted-contact.types.d.ts +440 -0
  317. package/common/types/trusted-contact.types.js +95 -0
  318. package/common/types/trusted-contact.types.js.map +1 -0
  319. package/common/types/typography.types.d.ts +52 -0
  320. package/common/types/typography.types.js +67 -0
  321. package/common/types/typography.types.js.map +1 -0
  322. package/common/types/user-manual.types.d.ts +287 -0
  323. package/common/types/user-manual.types.js +192 -0
  324. package/common/types/user-manual.types.js.map +1 -0
  325. package/common/types/user-setting.types.d.ts +273 -0
  326. package/common/types/user-setting.types.js +85 -0
  327. package/common/types/user-setting.types.js.map +1 -0
  328. package/common/types/user.types.d.ts +1951 -0
  329. package/common/types/user.types.js +238 -0
  330. package/common/types/user.types.js.map +1 -0
  331. package/common/types/webhook.types.d.ts +10829 -0
  332. package/common/types/webhook.types.js +658 -0
  333. package/common/types/webhook.types.js.map +1 -0
  334. package/common/types/zip.type.d.ts +35 -0
  335. package/common/types/zip.type.js +28 -0
  336. package/common/types/zip.type.js.map +1 -0
  337. package/contracts/clients/accounts/index.d.ts +308 -0
  338. package/contracts/clients/accounts/index.js +43 -0
  339. package/contracts/clients/accounts/index.js.map +1 -0
  340. package/contracts/clients/aic/index.d.ts +280 -0
  341. package/contracts/clients/aic/index.js +47 -0
  342. package/contracts/clients/aic/index.js.map +1 -0
  343. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  344. package/contracts/clients/api-key-logs/index.js +37 -0
  345. package/contracts/clients/api-key-logs/index.js.map +1 -0
  346. package/contracts/clients/api-keys/index.d.ts +374 -0
  347. package/contracts/clients/api-keys/index.js +59 -0
  348. package/contracts/clients/api-keys/index.js.map +1 -0
  349. package/contracts/clients/assets/index.d.ts +1116 -0
  350. package/contracts/clients/assets/index.js +80 -0
  351. package/contracts/clients/assets/index.js.map +1 -0
  352. package/contracts/clients/auth/index.d.ts +236 -0
  353. package/contracts/clients/auth/index.js +38 -0
  354. package/contracts/clients/auth/index.js.map +1 -0
  355. package/contracts/clients/cart/index.d.ts +229 -0
  356. package/contracts/clients/cart/index.js +63 -0
  357. package/contracts/clients/cart/index.js.map +1 -0
  358. package/contracts/clients/files/index.d.ts +552 -0
  359. package/contracts/clients/files/index.js +142 -0
  360. package/contracts/clients/files/index.js.map +1 -0
  361. package/contracts/clients/files-public/index.d.ts +552 -0
  362. package/contracts/clients/files-public/index.js +142 -0
  363. package/contracts/clients/files-public/index.js.map +1 -0
  364. package/contracts/clients/index.d.ts +12786 -0
  365. package/contracts/clients/index.js +52 -0
  366. package/contracts/clients/index.js.map +1 -0
  367. package/contracts/clients/individuals/index.d.ts +3199 -0
  368. package/contracts/clients/individuals/index.js +74 -0
  369. package/contracts/clients/individuals/index.js.map +1 -0
  370. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  371. package/contracts/clients/investor-accounts/index.js +73 -0
  372. package/contracts/clients/investor-accounts/index.js.map +1 -0
  373. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  374. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  375. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  376. package/contracts/clients/issuers/index.d.ts +449 -0
  377. package/contracts/clients/issuers/index.js +75 -0
  378. package/contracts/clients/issuers/index.js.map +1 -0
  379. package/contracts/clients/kyc/index.d.ts +345 -0
  380. package/contracts/clients/kyc/index.js +49 -0
  381. package/contracts/clients/kyc/index.js.map +1 -0
  382. package/contracts/clients/legal-entities/index.d.ts +887 -0
  383. package/contracts/clients/legal-entities/index.js +74 -0
  384. package/contracts/clients/legal-entities/index.js.map +1 -0
  385. package/contracts/clients/offerings/index.d.ts +983 -0
  386. package/contracts/clients/offerings/index.js +95 -0
  387. package/contracts/clients/offerings/index.js.map +1 -0
  388. package/contracts/clients/payment-methods/index.d.ts +456 -0
  389. package/contracts/clients/payment-methods/index.js +68 -0
  390. package/contracts/clients/payment-methods/index.js.map +1 -0
  391. package/contracts/clients/secure-requests/index.d.ts +100 -0
  392. package/contracts/clients/secure-requests/index.js +22 -0
  393. package/contracts/clients/secure-requests/index.js.map +1 -0
  394. package/contracts/clients/sites/index.d.ts +657 -0
  395. package/contracts/clients/sites/index.js +40 -0
  396. package/contracts/clients/sites/index.js.map +1 -0
  397. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  398. package/contracts/clients/trade-line-items/index.js +47 -0
  399. package/contracts/clients/trade-line-items/index.js.map +1 -0
  400. package/contracts/clients/trades/index.d.ts +871 -0
  401. package/contracts/clients/trades/index.js +156 -0
  402. package/contracts/clients/trades/index.js.map +1 -0
  403. package/contracts/clients/transactions/index.d.ts +88 -0
  404. package/contracts/clients/transactions/index.js +25 -0
  405. package/contracts/clients/transactions/index.js.map +1 -0
  406. package/package.json +27 -36
  407. package/common/helpers/index.ts +0 -59
  408. package/common/types/account-contact.types.ts +0 -98
  409. package/common/types/account-detail.types.ts +0 -27
  410. package/common/types/account-integration.types.ts +0 -143
  411. package/common/types/account-manager.types.ts +0 -124
  412. package/common/types/account.types.ts +0 -296
  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 -370
  421. package/common/types/batch-jobs.types.ts +0 -151
  422. package/common/types/bonus-tier.types.ts +0 -171
  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 -1520
  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 -107
  430. package/common/types/countries.types.ts +0 -375
  431. package/common/types/covered-person.types.ts +0 -274
  432. package/common/types/dashboard.types.ts +0 -799
  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 -541
  453. package/common/types/investor-account.types.ts +0 -1239
  454. package/common/types/investors-offering.types.ts +0 -65
  455. package/common/types/invite.types.ts +0 -133
  456. package/common/types/issuer-bank-account.types.ts +0 -107
  457. package/common/types/issuer-offering.types.ts +0 -395
  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 -185
  465. package/common/types/login-history.types.ts +0 -46
  466. package/common/types/mail-template.types.ts +0 -436
  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 -58
  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 -683
  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 -726
  498. package/common/types/site.types.ts +0 -270
  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.type.ts +0 -132
  506. package/common/types/trade.types.ts +0 -999
  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 -325
  513. package/common/types/webhook.types.ts +0 -588
  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/contracts/compliance/account-contacts/index.ts +0 -82
  538. package/contracts/compliance/account-managers/index.ts +0 -142
  539. package/contracts/compliance/accounts/index.ts +0 -187
  540. package/contracts/compliance/activities/index.ts +0 -55
  541. package/contracts/compliance/aic/index.ts +0 -60
  542. package/contracts/compliance/api-keys/index.ts +0 -91
  543. package/contracts/compliance/assets/index.ts +0 -122
  544. package/contracts/compliance/auth/index.ts +0 -134
  545. package/contracts/compliance/batch-jobs/index.ts +0 -62
  546. package/contracts/compliance/bonus-tiers/index.ts +0 -74
  547. package/contracts/compliance/checklist/index.ts +0 -87
  548. package/contracts/compliance/checklist-items/index.ts +0 -86
  549. package/contracts/compliance/covered-persons/index.ts +0 -97
  550. package/contracts/compliance/dashboard/index.ts +0 -111
  551. package/contracts/compliance/data-records/index.ts +0 -116
  552. package/contracts/compliance/data-rooms/index.ts +0 -113
  553. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  554. package/contracts/compliance/disbursement/index.ts +0 -165
  555. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  556. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  557. package/contracts/compliance/domain-filters/index.ts +0 -117
  558. package/contracts/compliance/email-themes/index.ts +0 -284
  559. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  560. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  561. package/contracts/compliance/exchange-imports/index.ts +0 -137
  562. package/contracts/compliance/files/index.ts +0 -267
  563. package/contracts/compliance/files-public/index.ts +0 -188
  564. package/contracts/compliance/health/index.ts +0 -26
  565. package/contracts/compliance/index.ts +0 -147
  566. package/contracts/compliance/individuals/index.ts +0 -57
  567. package/contracts/compliance/investor-accounts/index.ts +0 -141
  568. package/contracts/compliance/invites/index.ts +0 -137
  569. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  570. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  571. package/contracts/compliance/issuers/index.ts +0 -97
  572. package/contracts/compliance/job-items/index.ts +0 -58
  573. package/contracts/compliance/jobs/index.ts +0 -59
  574. package/contracts/compliance/kyb/index.ts +0 -54
  575. package/contracts/compliance/kyc/index.ts +0 -77
  576. package/contracts/compliance/legal-entities/index.ts +0 -57
  577. package/contracts/compliance/login-histories/index.ts +0 -37
  578. package/contracts/compliance/notes/index.ts +0 -69
  579. package/contracts/compliance/notion-databases/index.ts +0 -107
  580. package/contracts/compliance/notion-pages/index.ts +0 -105
  581. package/contracts/compliance/offering-reports/index.ts +0 -149
  582. package/contracts/compliance/offerings/index.ts +0 -233
  583. package/contracts/compliance/pages/index.ts +0 -178
  584. package/contracts/compliance/payment-methods/index.ts +0 -57
  585. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  586. package/contracts/compliance/review/index.ts +0 -169
  587. package/contracts/compliance/roles/index.ts +0 -34
  588. package/contracts/compliance/secondary-customers/index.ts +0 -77
  589. package/contracts/compliance/secondary-orders/index.ts +0 -60
  590. package/contracts/compliance/secondary-trades/index.ts +0 -100
  591. package/contracts/compliance/secure-requests/index.ts +0 -54
  592. package/contracts/compliance/signer/index.ts +0 -369
  593. package/contracts/compliance/site-links/index.ts +0 -128
  594. package/contracts/compliance/site-settings/index.ts +0 -669
  595. package/contracts/compliance/sites/index.ts +0 -56
  596. package/contracts/compliance/state-machine/index.ts +0 -94
  597. package/contracts/compliance/tasks/index.ts +0 -91
  598. package/contracts/compliance/third-parties/index.ts +0 -52
  599. package/contracts/compliance/trade-line-items/index.ts +0 -59
  600. package/contracts/compliance/trades/index.ts +0 -230
  601. package/contracts/compliance/transactions/index.ts +0 -161
  602. package/contracts/compliance/user-manuals/index.ts +0 -271
  603. package/contracts/compliance/user-settings/index.ts +0 -189
  604. package/contracts/compliance/users/index.ts +0 -221
  605. package/contracts/compliance/webhooks/index.ts +0 -41
  606. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  607. package/contracts/compliance-apikey/index.ts +0 -14
  608. package/contracts/index.ts +0 -6
  609. package/contracts/investors/account-contacts/index.ts +0 -58
  610. package/contracts/investors/aic/index.ts +0 -59
  611. package/contracts/investors/assets/index.ts +0 -61
  612. package/contracts/investors/auth/index.ts +0 -116
  613. package/contracts/investors/bonus-tiers/index.ts +0 -55
  614. package/contracts/investors/cart/index.ts +0 -75
  615. package/contracts/investors/contact-us/index.ts +0 -48
  616. package/contracts/investors/data-records/index.ts +0 -113
  617. package/contracts/investors/data-rooms/index.ts +0 -96
  618. package/contracts/investors/files/index.ts +0 -167
  619. package/contracts/investors/files-public/index.ts +0 -185
  620. package/contracts/investors/index.ts +0 -72
  621. package/contracts/investors/individuals/index.ts +0 -121
  622. package/contracts/investors/investor-accounts/index.ts +0 -110
  623. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  624. package/contracts/investors/issuers/index.ts +0 -30
  625. package/contracts/investors/legal-entities/index.ts +0 -93
  626. package/contracts/investors/notes/index.ts +0 -69
  627. package/contracts/investors/offerings/index.ts +0 -93
  628. package/contracts/investors/pages/index.ts +0 -88
  629. package/contracts/investors/payment-methods/index.ts +0 -149
  630. package/contracts/investors/portfolios/index.ts +0 -53
  631. package/contracts/investors/sites/index.ts +0 -96
  632. package/contracts/investors/tasks/index.ts +0 -111
  633. package/contracts/investors/trade-line-items/index.ts +0 -75
  634. package/contracts/investors/trades/index.ts +0 -114
  635. package/contracts/investors/transactions/index.ts +0 -37
  636. package/contracts/investors/trusted-contacts/index.ts +0 -93
  637. package/contracts/investors/user-manuals/index.ts +0 -62
  638. package/contracts/investors/user-settings/index.ts +0 -170
  639. package/contracts/investors/users/index.ts +0 -45
  640. package/contracts/investors/webhooks/index.ts +0 -30
  641. package/contracts/issuers/account-contacts/index.ts +0 -76
  642. package/contracts/issuers/account-integrations/index.ts +0 -97
  643. package/contracts/issuers/accounts/index.ts +0 -97
  644. package/contracts/issuers/activities/index.ts +0 -54
  645. package/contracts/issuers/aic/index.ts +0 -39
  646. package/contracts/issuers/api-key-logs/index.ts +0 -53
  647. package/contracts/issuers/api-keys/index.ts +0 -93
  648. package/contracts/issuers/assets/index.ts +0 -122
  649. package/contracts/issuers/auth/index.ts +0 -152
  650. package/contracts/issuers/bonus-tiers/index.ts +0 -73
  651. package/contracts/issuers/contact-us/index.ts +0 -48
  652. package/contracts/issuers/covered-persons/index.ts +0 -136
  653. package/contracts/issuers/dashboard/index.ts +0 -72
  654. package/contracts/issuers/data-records/index.ts +0 -257
  655. package/contracts/issuers/data-rooms/index.ts +0 -134
  656. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  657. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  658. package/contracts/issuers/disbursements/index.ts +0 -189
  659. package/contracts/issuers/email-themes/index.ts +0 -242
  660. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  661. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  662. package/contracts/issuers/files/index.ts +0 -166
  663. package/contracts/issuers/files-public/index.ts +0 -166
  664. package/contracts/issuers/health/index.ts +0 -24
  665. package/contracts/issuers/index.ts +0 -112
  666. package/contracts/issuers/investor-accounts/index.ts +0 -148
  667. package/contracts/issuers/invites/index.ts +0 -129
  668. package/contracts/issuers/issuer/index.ts +0 -94
  669. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  670. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  671. package/contracts/issuers/kyc/index.ts +0 -38
  672. package/contracts/issuers/login-histories/index.ts +0 -51
  673. package/contracts/issuers/notes/index.ts +0 -69
  674. package/contracts/issuers/offerings/index.ts +0 -206
  675. package/contracts/issuers/pages/index.ts +0 -138
  676. package/contracts/issuers/payment-methods/index.ts +0 -61
  677. package/contracts/issuers/portfolios/index.ts +0 -36
  678. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  679. package/contracts/issuers/review/index.ts +0 -63
  680. package/contracts/issuers/secondary-customers/index.ts +0 -55
  681. package/contracts/issuers/secondary-orders/index.ts +0 -57
  682. package/contracts/issuers/secondary-trades/index.ts +0 -57
  683. package/contracts/issuers/secure-requests/index.ts +0 -34
  684. package/contracts/issuers/site-links/index.ts +0 -116
  685. package/contracts/issuers/site-settings/index.ts +0 -585
  686. package/contracts/issuers/sites/index.ts +0 -32
  687. package/contracts/issuers/tasks/index.ts +0 -111
  688. package/contracts/issuers/trades/index.ts +0 -132
  689. package/contracts/issuers/transactions/index.ts +0 -158
  690. package/contracts/issuers/user-manuals/index.ts +0 -62
  691. package/contracts/issuers/user-settings/index.ts +0 -170
  692. package/contracts/issuers/users/index.ts +0 -126
  693. package/contracts/secondaries/accounts/index.ts +0 -58
  694. package/contracts/secondaries/index.ts +0 -23
  695. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  696. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  697. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  698. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  699. package/contracts/secondaries/secondary-trades/index.ts +0 -56
  700. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -0,0 +1,156 @@
1
+ import { initContract } from '@ts-rest/core';
2
+ import { BadRequestError, ForbiddenError, InternalError, NotFoundError, PaginationOptionsZod, UnauthorizedError, } from '../../../common/types/index.js';
3
+ import { InvestorsTradeResponse, IPaginatedTrade, IssuersTradeFiltersZod, PatchTradeStatus, PostTradeBody, tradeIdOrTidSchema, TradesIncludeQuery, TradeZod, PostAttachSubdocBody, PutAttachSubdocBody, PatchSubdocSignatureBody, AttachSubdocResponse, } from '../../../common/types/trade.types.js';
4
+ import { z } from 'zod';
5
+ import { PostTradeLineItem, TradeLineItemQuery, TradeLineItemResponse, } from '../../../common/types/trade-line-item.types.js';
6
+ const c = initContract();
7
+ export const tradesContract = c.router({
8
+ getTrade: {
9
+ summary: 'Get trade by id - id could be either the entity id or tid',
10
+ method: 'GET',
11
+ path: '/:id',
12
+ metadata: {
13
+ auth: true,
14
+ },
15
+ query: z
16
+ .object({})
17
+ .merge(IssuersTradeFiltersZod)
18
+ .merge(TradesIncludeQuery),
19
+ pathParams: z.object({
20
+ id: tradeIdOrTidSchema,
21
+ }),
22
+ responses: {
23
+ 200: TradeZod,
24
+ 401: UnauthorizedError,
25
+ 403: ForbiddenError,
26
+ 404: NotFoundError,
27
+ },
28
+ },
29
+ getTrades: {
30
+ summary: 'Get trades',
31
+ method: 'GET',
32
+ path: '',
33
+ metadata: {
34
+ auth: true,
35
+ },
36
+ query: PaginationOptionsZod.merge(IssuersTradeFiltersZod).merge(TradesIncludeQuery),
37
+ responses: {
38
+ 200: IPaginatedTrade,
39
+ 401: UnauthorizedError,
40
+ 403: ForbiddenError,
41
+ },
42
+ },
43
+ createTrades: {
44
+ summary: 'Create Trades',
45
+ method: 'POST',
46
+ path: '/',
47
+ metadata: {
48
+ auth: true,
49
+ },
50
+ body: PostTradeBody,
51
+ responses: {
52
+ 201: InvestorsTradeResponse,
53
+ 401: UnauthorizedError,
54
+ 403: ForbiddenError,
55
+ },
56
+ },
57
+ postLineItem: {
58
+ summary: 'Create a Line Item',
59
+ method: 'POST',
60
+ path: '/line-items',
61
+ metadata: {
62
+ auth: true,
63
+ },
64
+ query: TradeLineItemQuery,
65
+ body: PostTradeLineItem,
66
+ responses: {
67
+ 201: TradeLineItemResponse,
68
+ 401: UnauthorizedError,
69
+ 403: ForbiddenError,
70
+ 400: BadRequestError,
71
+ 500: InternalError,
72
+ },
73
+ },
74
+ patchTradeStatus: {
75
+ summary: 'Patch a trade status',
76
+ method: 'PATCH',
77
+ path: '/:id',
78
+ pathParams: z.object({
79
+ id: tradeIdOrTidSchema,
80
+ }),
81
+ metadata: {
82
+ auth: true,
83
+ },
84
+ body: PatchTradeStatus,
85
+ responses: {
86
+ 201: TradeZod,
87
+ 401: UnauthorizedError,
88
+ 403: ForbiddenError,
89
+ 400: BadRequestError,
90
+ 500: InternalError,
91
+ },
92
+ },
93
+ postAttachSubdoc: {
94
+ summary: 'Attach subdoc to trade',
95
+ method: 'POST',
96
+ path: '/:id/attach-subdoc',
97
+ pathParams: z.object({
98
+ id: tradeIdOrTidSchema,
99
+ }),
100
+ metadata: {
101
+ auth: true,
102
+ },
103
+ body: PostAttachSubdocBody,
104
+ responses: {
105
+ 200: AttachSubdocResponse,
106
+ 400: BadRequestError,
107
+ 401: UnauthorizedError,
108
+ 403: ForbiddenError,
109
+ 404: NotFoundError,
110
+ 500: InternalError,
111
+ },
112
+ },
113
+ putAttachSubdoc: {
114
+ summary: 'Update attached subdoc for trade',
115
+ method: 'PUT',
116
+ path: '/:id/attach-subdoc',
117
+ pathParams: z.object({
118
+ id: tradeIdOrTidSchema,
119
+ }),
120
+ metadata: {
121
+ auth: true,
122
+ },
123
+ body: PutAttachSubdocBody,
124
+ responses: {
125
+ 200: AttachSubdocResponse,
126
+ 400: BadRequestError,
127
+ 401: UnauthorizedError,
128
+ 403: ForbiddenError,
129
+ 404: NotFoundError,
130
+ 500: InternalError,
131
+ },
132
+ },
133
+ patchSubdocSign: {
134
+ summary: 'Update subdoc signature statuses for trade',
135
+ method: 'PATCH',
136
+ path: '/:id/sign',
137
+ pathParams: z.object({
138
+ id: tradeIdOrTidSchema,
139
+ }),
140
+ metadata: {
141
+ auth: true,
142
+ },
143
+ body: PatchSubdocSignatureBody,
144
+ responses: {
145
+ 200: AttachSubdocResponse,
146
+ 400: BadRequestError,
147
+ 401: UnauthorizedError,
148
+ 403: ForbiddenError,
149
+ 404: NotFoundError,
150
+ 500: InternalError,
151
+ },
152
+ },
153
+ }, {
154
+ pathPrefix: 'trades',
155
+ });
156
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,cAAc,EACd,aAAa,EACb,aAAa,EACb,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,GACtB,MAAM,6CAA6C,CAAC;AAErD,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CACpC;IACE,QAAQ,EAAE;QACR,OAAO,EAAE,2DAA2D;QACpE,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,CAAC;aACL,MAAM,CAAC,EAAE,CAAC;aACV,KAAK,CAAC,sBAAsB,CAAC;aAC7B,KAAK,CAAC,kBAAkB,CAAC;QAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,SAAS,EAAE;QACT,OAAO,EAAE,YAAY;QACrB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,KAAK,CAC7D,kBAAkB,CACnB;QACD,SAAS,EAAE;YACT,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,eAAe;QACxB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE;YACT,GAAG,EAAE,sBAAsB;YAC3B,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,oBAAoB;QAC7B,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,aAAa;QACnB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,iBAAiB;QACvB,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB;YAC1B,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,sBAAsB;QAC/B,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ;YACb,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,wBAAwB;QACjC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,oBAAoB;QAC1B,SAAS,EAAE;YACT,GAAG,EAAE,oBAAoB;YACzB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,eAAe,EAAE;QACf,OAAO,EAAE,kCAAkC;QAC3C,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE;YACT,GAAG,EAAE,oBAAoB;YACzB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,eAAe,EAAE;QACf,OAAO,EAAE,4CAA4C;QACrD,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,WAAW;QACjB,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,kBAAkB;SACvB,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,wBAAwB;QAC9B,SAAS,EAAE;YACT,GAAG,EAAE,oBAAoB;YACzB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,QAAQ;CACrB,CACF,CAAC"}
@@ -0,0 +1,88 @@
1
+ export declare const clientsTransactionsContract: {
2
+ postTransaction: {
3
+ method: "POST";
4
+ metadata: {
5
+ auth: boolean;
6
+ };
7
+ body: import("zod").ZodObject<{
8
+ tid: import("zod").ZodString;
9
+ tradeId: import("zod").ZodLazy<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
10
+ name: import("zod").ZodString;
11
+ chargedAt: import("zod").ZodEffects<import("zod").ZodEffects<import("zod").ZodNullable<import("zod").ZodString>, string | null, string | null>, Date | null, string | null>;
12
+ amount: import("zod").ZodEffects<import("zod").ZodNumber, number, number>;
13
+ } & {
14
+ userId: import("zod").ZodLazy<import("zod").ZodEffects<import("zod").ZodString, string, string>>;
15
+ }, "strip", import("zod").ZodTypeAny, {
16
+ name: string;
17
+ tid: string;
18
+ userId: string;
19
+ amount: number;
20
+ tradeId: string;
21
+ chargedAt: Date | null;
22
+ }, {
23
+ name: string;
24
+ tid: string;
25
+ userId: string;
26
+ amount: number;
27
+ tradeId: string;
28
+ chargedAt: string | null;
29
+ }>;
30
+ summary: "Create a transaction";
31
+ path: "transactions";
32
+ responses: {
33
+ 201: any;
34
+ 400: import("zod").ZodObject<{
35
+ status: import("zod").ZodNumber;
36
+ message: import("zod").ZodString;
37
+ errors: import("zod").ZodArray<import("zod").ZodString, "many">;
38
+ }, "strip", import("zod").ZodTypeAny, {
39
+ message: string;
40
+ status: number;
41
+ errors: string[];
42
+ }, {
43
+ message: string;
44
+ status: number;
45
+ errors: string[];
46
+ }>;
47
+ 401: import("zod").ZodObject<{
48
+ status: import("zod").ZodNumber;
49
+ message: import("zod").ZodString;
50
+ errors: import("zod").ZodArray<import("zod").ZodString, "many">;
51
+ }, "strip", import("zod").ZodTypeAny, {
52
+ message: string;
53
+ status: number;
54
+ errors: string[];
55
+ }, {
56
+ message: string;
57
+ status: number;
58
+ errors: string[];
59
+ }>;
60
+ 404: import("zod").ZodObject<{
61
+ status: import("zod").ZodNumber;
62
+ message: import("zod").ZodString;
63
+ errors: import("zod").ZodArray<import("zod").ZodString, "many">;
64
+ }, "strip", import("zod").ZodTypeAny, {
65
+ message: string;
66
+ status: number;
67
+ errors: string[];
68
+ }, {
69
+ message: string;
70
+ status: number;
71
+ errors: string[];
72
+ }>;
73
+ 500: import("zod").ZodObject<{
74
+ status: import("zod").ZodNumber;
75
+ message: import("zod").ZodString;
76
+ errors: import("zod").ZodArray<import("zod").ZodString, "many">;
77
+ }, "strip", import("zod").ZodTypeAny, {
78
+ message: string;
79
+ status: number;
80
+ errors: string[];
81
+ }, {
82
+ message: string;
83
+ status: number;
84
+ errors: string[];
85
+ }>;
86
+ };
87
+ };
88
+ };
@@ -0,0 +1,25 @@
1
+ import { initContract } from '@ts-rest/core';
2
+ import { BadRequestError, InternalError, NotFoundError, UnauthorizedError, } from '../../../common/types/index.js';
3
+ import { ClientPostTransactionZod, TransactionZod, } from '../../../common/types/transaction.types.js';
4
+ const c = initContract();
5
+ export const clientsTransactionsContract = c.router({
6
+ postTransaction: {
7
+ summary: 'Create a transaction',
8
+ method: 'POST',
9
+ path: '',
10
+ metadata: {
11
+ auth: true,
12
+ },
13
+ body: ClientPostTransactionZod,
14
+ responses: {
15
+ 201: TransactionZod,
16
+ 400: BadRequestError,
17
+ 401: UnauthorizedError,
18
+ 404: NotFoundError,
19
+ 500: InternalError,
20
+ },
21
+ },
22
+ }, {
23
+ pathPrefix: 'transactions',
24
+ });
25
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,eAAe,EACf,aAAa,EACb,aAAa,EACb,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,wBAAwB,EACxB,cAAc,GACf,MAAM,yCAAyC,CAAC;AAEjD,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CACjD;IACE,eAAe,EAAE;QACf,OAAO,EAAE,sBAAsB;QAC/B,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,IAAI,EAAE,wBAAwB;QAC9B,SAAS,EAAE;YACT,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,cAAc;CAC3B,CACF,CAAC"}
package/package.json CHANGED
@@ -1,48 +1,42 @@
1
1
  {
2
2
  "name": "@dalmore/api-contracts",
3
- "version": "0.0.0-dev.d8ef117",
3
+ "version": "0.0.0-dev.ddf366c",
4
4
  "description": "Type-safe API contracts for Dalmore Client Portal",
5
- "main": "./contracts/index.ts",
6
- "types": "./contracts/index.ts",
5
+ "type": "module",
6
+ "main": "./index.js",
7
+ "types": "./index.d.ts",
7
8
  "exports": {
8
9
  ".": {
9
- "types": "./contracts/index.ts",
10
- "default": "./contracts/index.ts"
11
- },
12
- "./compliance": {
13
- "types": "./contracts/compliance/index.ts",
14
- "default": "./contracts/compliance/index.ts"
15
- },
16
- "./investors": {
17
- "types": "./contracts/investors/index.ts",
18
- "default": "./contracts/investors/index.ts"
19
- },
20
- "./issuers": {
21
- "types": "./contracts/issuers/index.ts",
22
- "default": "./contracts/issuers/index.ts"
10
+ "types": "./index.d.ts",
11
+ "import": "./index.js",
12
+ "default": "./index.js"
23
13
  },
24
14
  "./clients": {
25
- "types": "./contracts/clients/index.ts",
26
- "default": "./contracts/clients/index.ts"
27
- },
28
- "./secondaries": {
29
- "types": "./contracts/secondaries/index.ts",
30
- "default": "./contracts/secondaries/index.ts"
31
- },
32
- "./compliance-apikey": {
33
- "types": "./contracts/compliance-apikey/index.ts",
34
- "default": "./contracts/compliance-apikey/index.ts"
15
+ "types": "./contracts/clients/index.d.ts",
16
+ "import": "./contracts/clients/index.js",
17
+ "default": "./contracts/clients/index.js"
35
18
  },
36
19
  "./types": {
37
- "types": "./common/types/index.ts",
38
- "default": "./common/types/index.ts"
39
- },
40
- "./types/*": {
41
- "types": "./common/types/*.ts",
42
- "default": "./common/types/*.ts"
20
+ "types": "./common/types/index.d.ts",
21
+ "import": "./common/types/index.js",
22
+ "default": "./common/types/index.js"
23
+ }
24
+ },
25
+ "typesVersions": {
26
+ "*": {
27
+ ".": [
28
+ "./index.d.ts"
29
+ ],
30
+ "clients": [
31
+ "./contracts/clients/index.d.ts"
32
+ ],
33
+ "types": [
34
+ "./common/types/index.d.ts"
35
+ ]
43
36
  }
44
37
  },
45
38
  "files": [
39
+ "index.ts",
46
40
  "contracts",
47
41
  "common"
48
42
  ],
@@ -68,9 +62,6 @@
68
62
  "typeid-js": "^1.2.0",
69
63
  "zod": "^3.24.4"
70
64
  },
71
- "devDependencies": {
72
- "typescript": "^5.8.3"
73
- },
74
65
  "engines": {
75
66
  "node": ">=24.0.0 <25.0.0"
76
67
  }
@@ -1,59 +0,0 @@
1
- /**
2
- * Contract helpers - minimal subset for API documentation generation
3
- */
4
-
5
- type CurlOptions = {
6
- query?: Record<string, string>;
7
- headers?: Record<string, string>;
8
- body?: Record<string, unknown>;
9
- formData?: Record<string, string>;
10
- };
11
-
12
- export const authHeader: CurlOptions['headers'] = {
13
- Authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
14
- };
15
-
16
- const generateCurlExample = (
17
- method: string,
18
- path: string,
19
- options: CurlOptions,
20
- ) => {
21
- const baseUrl = 'https://dalmore-client-portal-api-prod.onrender.com/api/v1';
22
- let curl = `curl -X ${method.toUpperCase()} '${baseUrl}${path}`;
23
- if (options.query) {
24
- const queryString = new URLSearchParams(options.query).toString();
25
- curl += `?${queryString}`;
26
- }
27
- curl += "'";
28
- if (options.headers) {
29
- Object.entries(options.headers).forEach(([key, value]) => {
30
- curl += ` \\\n --header '${key}: ${value}'`;
31
- });
32
- }
33
- if (options.body) {
34
- curl += ` \\\n --header 'Content-Type: application/json'`;
35
- curl += ` \\\n --data '${JSON.stringify(options.body)}'`;
36
- }
37
- if (options.formData) {
38
- Object.entries(options.formData).forEach(([key, value]) => {
39
- curl += ` \\\n --form '${key}=${value}'`;
40
- });
41
- }
42
- return curl;
43
- };
44
-
45
- export const generateApiDescription = (
46
- summary: string,
47
- method: string,
48
- path: string,
49
- options: CurlOptions,
50
- ) => {
51
- const curlExample = generateCurlExample(method, path, options);
52
- return `${summary}
53
-
54
- ### Example curl request
55
-
56
- \`\`\`bash
57
- ${curlExample}
58
- \`\`\``;
59
- };
@@ -1,98 +0,0 @@
1
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
- import { TypeID } from 'typeid-js';
3
- import { z } from 'zod';
4
- import { accountIdSchema } from './account.types';
5
- import { PhoneZodSchema } from './phone.type';
6
- import {
7
- AccountContactType,
8
- AccountZod,
9
- IPaginationMeta,
10
- } from './common.types';
11
- import { IBaseEntity } from './entity.types';
12
- import { PhoneNumberData } from './sms.types';
13
-
14
- extendZodWithOpenApi(z);
15
-
16
- export const accountContactIdSchema = z.string().refine(
17
- (value) => {
18
- try {
19
- const tid = TypeID.fromString(value);
20
- return tid.getType() === 'account_contact';
21
- } catch {
22
- return false;
23
- }
24
- },
25
- {
26
- message:
27
- 'Invalid account contact ID format. Must be a valid TypeID with "account_contact" prefix.',
28
- },
29
- );
30
-
31
- export const IAccountContact = IBaseEntity.extend({
32
- id: accountContactIdSchema,
33
- title: z.string().nullable().openapi({ example: 'Mr' }),
34
- firstName: z.string().nullable().openapi({ example: 'John' }),
35
- lastName: z.string().nullable().openapi({ example: 'Doe' }),
36
- email: z
37
- .string()
38
- .email()
39
- .nullable()
40
- .openapi({ example: 'john.doe@example.com' }),
41
- phone: PhoneNumberData.nullable().optional().openapi({ example: null }),
42
- type: z
43
- .nativeEnum(AccountContactType)
44
- .openapi({ example: AccountContactType.GENERAL }),
45
- accountId: accountIdSchema.openapi({
46
- example: 'account_01je6ht4b8fbmttkzh2hs82xqp',
47
- }),
48
- account: AccountZod.optional().nullable(),
49
- referenceLink: z.string().nullable().optional(),
50
- });
51
- export type IAccountContact = z.infer<typeof IAccountContact>;
52
-
53
- export const PatchAccountContactZod = z.object({
54
- title: z
55
- .string()
56
- .min(1)
57
- .max(50)
58
- .nullable()
59
- .optional()
60
- .openapi({ example: 'Mr' }),
61
- firstName: z.string().min(1).max(150).openapi({ example: 'John' }),
62
- lastName: z.string().min(1).max(150).openapi({ example: 'Doe' }),
63
- email: z.string().email().openapi({ example: 'john.doe@example.com' }),
64
- phone: PhoneZodSchema.nullable()
65
- .optional()
66
- .openapi({ example: '+12124567890' }),
67
- });
68
-
69
- export type PatchAccountContactZod = z.infer<typeof PatchAccountContactZod>;
70
-
71
- export const CompliancePatchAccountContactZod = PatchAccountContactZod.extend({
72
- accountId: accountIdSchema.openapi({
73
- example: 'account_01je6ht4b8fbmttkzh2hs82xqp',
74
- }),
75
- referenceLink: z
76
- .string()
77
- .url()
78
- .max(2048)
79
- .nullable()
80
- .optional()
81
- .openapi({ example: 'https://www.google.com' }),
82
- });
83
- export type CompliancePatchAccountContactZod = z.infer<
84
- typeof CompliancePatchAccountContactZod
85
- >;
86
-
87
- export const IPaginatedAccountContact = z.object({
88
- items: z.array(IAccountContact),
89
- meta: IPaginationMeta,
90
- });
91
- export type IPaginatedAccountContact = z.infer<typeof IPaginatedAccountContact>;
92
-
93
- export const AccountContactDeleteResponse = z.object({
94
- status: z.enum(['pass', 'fail']),
95
- });
96
- export type AccountContactDeleteResponse = z.infer<
97
- typeof AccountContactDeleteResponse
98
- >;
@@ -1,27 +0,0 @@
1
- import { z } from 'zod';
2
- import { IAsset } from './asset.types';
3
- import { IIssuer } from './issuer.types';
4
- import { IOffering } from './offering.types';
5
- import { IIssuerPaymentMethod } from './issuer-payment-method.types';
6
- import { SiteZod } from './site.types';
7
- import { IPage } from './page.types';
8
-
9
- export const AccountDetailSummaryZod = z.object({
10
- id: z.string(),
11
- name: z.string(),
12
- issuers: z.array(
13
- IIssuer.extend({
14
- offerings: z.lazy(() =>
15
- z.array(
16
- IOffering.extend({
17
- assets: z.lazy(() => z.array(IAsset)),
18
- }),
19
- ),
20
- ),
21
- paymentMethods: z.lazy(() => z.array(IIssuerPaymentMethod)),
22
- }),
23
- ),
24
- sites: z.lazy(() => z.array(SiteZod)),
25
- pages: z.lazy(() => z.array(IPage)),
26
- });
27
- export type AccountDetailSummaryZod = z.infer<typeof AccountDetailSummaryZod>;