@dalmore/api-contracts 0.0.0-dev.56068a6 → 0.0.0-dev.56f7e68

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 (541) 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 +135 -0
  17. package/common/types/account-setting.types.js +23 -0
  18. package/common/types/account-setting.types.js.map +1 -0
  19. package/common/types/account.types.d.ts +640 -0
  20. package/common/types/account.types.js +218 -0
  21. package/common/types/account.types.js.map +1 -0
  22. package/common/types/activity.types.d.ts +590 -0
  23. package/common/types/activity.types.js +258 -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 +1100 -0
  41. package/common/types/asset.types.js +353 -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 +991 -0
  50. package/common/types/bonus-tier.types.js +166 -0
  51. package/common/types/bonus-tier.types.js.map +1 -0
  52. package/common/types/cap-table.types.d.ts +1139 -0
  53. package/common/types/cap-table.types.js +423 -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 +1819 -0
  65. package/common/types/common.types.js +1484 -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 +2564 -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 +415 -0
  122. package/common/types/escrow-account.types.js +78 -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 +425 -0
  134. package/common/types/file.types.js +389 -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} +5 -3
  143. package/common/types/index.js +54 -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 +503 -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 +113 -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 +1904 -0
  163. package/common/types/issuer-offering.types.js +455 -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 +785 -0
  214. package/common/types/offering-submission.types.js +291 -0
  215. package/common/types/offering-submission.types.js.map +1 -0
  216. package/common/types/offering.types.d.ts +2615 -0
  217. package/common/types/offering.types.js +602 -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/reports.types.d.ts +345 -0
  250. package/common/types/reports.types.js +69 -0
  251. package/common/types/reports.types.js.map +1 -0
  252. package/common/types/review.types.d.ts +419 -0
  253. package/common/types/review.types.js +101 -0
  254. package/common/types/review.types.js.map +1 -0
  255. package/common/types/role.types.d.ts +30 -0
  256. package/common/types/role.types.js +21 -0
  257. package/common/types/role.types.js.map +1 -0
  258. package/common/types/secondary-customer.types.d.ts +586 -0
  259. package/common/types/secondary-customer.types.js +39 -0
  260. package/common/types/secondary-customer.types.js.map +1 -0
  261. package/common/types/secondary-issuer.types.d.ts +283 -0
  262. package/common/types/secondary-issuer.types.js +37 -0
  263. package/common/types/secondary-issuer.types.js.map +1 -0
  264. package/common/types/secondary-order.types.d.ts +508 -0
  265. package/common/types/secondary-order.types.js +40 -0
  266. package/common/types/secondary-order.types.js.map +1 -0
  267. package/common/types/secondary-security.types.d.ts +175 -0
  268. package/common/types/secondary-security.types.js +45 -0
  269. package/common/types/secondary-security.types.js.map +1 -0
  270. package/common/types/secondary-trade.entity.d.ts +16 -0
  271. package/common/types/secondary-trade.entity.js +12 -0
  272. package/common/types/secondary-trade.entity.js.map +1 -0
  273. package/common/types/secondary-trade.types.d.ts +465 -0
  274. package/common/types/secondary-trade.types.js +61 -0
  275. package/common/types/secondary-trade.types.js.map +1 -0
  276. package/common/types/secure-request.types.d.ts +171 -0
  277. package/common/types/secure-request.types.js +51 -0
  278. package/common/types/secure-request.types.js.map +1 -0
  279. package/common/types/signer.types.d.ts +3406 -0
  280. package/common/types/signer.types.js +532 -0
  281. package/common/types/signer.types.js.map +1 -0
  282. package/common/types/site-link.types.d.ts +875 -0
  283. package/common/types/site-link.types.js +126 -0
  284. package/common/types/site-link.types.js.map +1 -0
  285. package/common/types/site-settings.types.d.ts +1673 -0
  286. package/common/types/site-settings.types.js +500 -0
  287. package/common/types/site-settings.types.js.map +1 -0
  288. package/common/types/site.types.d.ts +1481 -0
  289. package/common/types/site.types.js +213 -0
  290. package/common/types/site.types.js.map +1 -0
  291. package/common/types/sms.types.d.ts +40 -0
  292. package/common/types/sms.types.js +27 -0
  293. package/common/types/sms.types.js.map +1 -0
  294. package/common/types/state-machine.types.d.ts +591 -0
  295. package/common/types/state-machine.types.js +144 -0
  296. package/common/types/state-machine.types.js.map +1 -0
  297. package/common/types/states.types.d.ts +77 -0
  298. package/common/types/states.types.js +137 -0
  299. package/common/types/states.types.js.map +1 -0
  300. package/common/types/subdoc-preview.types.d.ts +379 -0
  301. package/common/types/subdoc-preview.types.js +24 -0
  302. package/common/types/subdoc-preview.types.js.map +1 -0
  303. package/common/types/task.types.d.ts +537 -0
  304. package/common/types/task.types.js +211 -0
  305. package/common/types/task.types.js.map +1 -0
  306. package/common/types/trade-adjustment.type.d.ts +40 -0
  307. package/common/types/trade-adjustment.type.js +26 -0
  308. package/common/types/trade-adjustment.type.js.map +1 -0
  309. package/common/types/trade-line-item.types.d.ts +329 -0
  310. package/common/types/trade-line-item.types.js +100 -0
  311. package/common/types/trade-line-item.types.js.map +1 -0
  312. package/common/types/trade.types.d.ts +2006 -0
  313. package/common/types/trade.types.js +789 -0
  314. package/common/types/trade.types.js.map +1 -0
  315. package/common/types/transaction.types.d.ts +454 -0
  316. package/common/types/transaction.types.js +174 -0
  317. package/common/types/transaction.types.js.map +1 -0
  318. package/common/types/trusted-contact.types.d.ts +440 -0
  319. package/common/types/trusted-contact.types.js +95 -0
  320. package/common/types/trusted-contact.types.js.map +1 -0
  321. package/common/types/typography.types.d.ts +52 -0
  322. package/common/types/typography.types.js +67 -0
  323. package/common/types/typography.types.js.map +1 -0
  324. package/common/types/user-manual.types.d.ts +287 -0
  325. package/common/types/user-manual.types.js +192 -0
  326. package/common/types/user-manual.types.js.map +1 -0
  327. package/common/types/user-setting.types.d.ts +273 -0
  328. package/common/types/user-setting.types.js +85 -0
  329. package/common/types/user-setting.types.js.map +1 -0
  330. package/common/types/user.types.d.ts +1980 -0
  331. package/common/types/user.types.js +241 -0
  332. package/common/types/user.types.js.map +1 -0
  333. package/common/types/webhook.types.d.ts +10829 -0
  334. package/common/types/webhook.types.js +658 -0
  335. package/common/types/webhook.types.js.map +1 -0
  336. package/common/types/zip.type.d.ts +35 -0
  337. package/common/types/zip.type.js +28 -0
  338. package/common/types/zip.type.js.map +1 -0
  339. package/contracts/clients/accounts/index.d.ts +308 -0
  340. package/contracts/clients/accounts/index.js +43 -0
  341. package/contracts/clients/accounts/index.js.map +1 -0
  342. package/contracts/clients/aic/index.d.ts +280 -0
  343. package/contracts/clients/aic/index.js +47 -0
  344. package/contracts/clients/aic/index.js.map +1 -0
  345. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  346. package/contracts/clients/api-key-logs/index.js +37 -0
  347. package/contracts/clients/api-key-logs/index.js.map +1 -0
  348. package/contracts/clients/api-keys/index.d.ts +374 -0
  349. package/contracts/clients/api-keys/index.js +59 -0
  350. package/contracts/clients/api-keys/index.js.map +1 -0
  351. package/contracts/clients/assets/index.d.ts +1050 -0
  352. package/contracts/clients/assets/index.js +80 -0
  353. package/contracts/clients/assets/index.js.map +1 -0
  354. package/contracts/clients/auth/index.d.ts +236 -0
  355. package/contracts/clients/auth/index.js +38 -0
  356. package/contracts/clients/auth/index.js.map +1 -0
  357. package/contracts/clients/cart/index.d.ts +229 -0
  358. package/contracts/clients/cart/index.js +63 -0
  359. package/contracts/clients/cart/index.js.map +1 -0
  360. package/contracts/clients/files/index.d.ts +552 -0
  361. package/contracts/clients/files/index.js +142 -0
  362. package/contracts/clients/files/index.js.map +1 -0
  363. package/contracts/clients/files-public/index.d.ts +552 -0
  364. package/contracts/clients/files-public/index.js +142 -0
  365. package/contracts/clients/files-public/index.js.map +1 -0
  366. package/contracts/clients/index.d.ts +12720 -0
  367. package/contracts/clients/index.js +52 -0
  368. package/contracts/clients/index.js.map +1 -0
  369. package/contracts/clients/individuals/index.d.ts +3199 -0
  370. package/contracts/clients/individuals/index.js +74 -0
  371. package/contracts/clients/individuals/index.js.map +1 -0
  372. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  373. package/contracts/clients/investor-accounts/index.js +73 -0
  374. package/contracts/clients/investor-accounts/index.js.map +1 -0
  375. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  376. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  377. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  378. package/contracts/clients/issuers/index.d.ts +449 -0
  379. package/contracts/clients/issuers/index.js +75 -0
  380. package/contracts/clients/issuers/index.js.map +1 -0
  381. package/contracts/clients/kyc/index.d.ts +345 -0
  382. package/contracts/clients/kyc/index.js +49 -0
  383. package/contracts/clients/kyc/index.js.map +1 -0
  384. package/contracts/clients/legal-entities/index.d.ts +887 -0
  385. package/contracts/clients/legal-entities/index.js +74 -0
  386. package/contracts/clients/legal-entities/index.js.map +1 -0
  387. package/contracts/clients/offerings/index.d.ts +983 -0
  388. package/contracts/clients/offerings/index.js +95 -0
  389. package/contracts/clients/offerings/index.js.map +1 -0
  390. package/contracts/clients/payment-methods/index.d.ts +456 -0
  391. package/contracts/clients/payment-methods/index.js +68 -0
  392. package/contracts/clients/payment-methods/index.js.map +1 -0
  393. package/contracts/clients/secure-requests/index.d.ts +100 -0
  394. package/contracts/clients/secure-requests/index.js +22 -0
  395. package/contracts/clients/secure-requests/index.js.map +1 -0
  396. package/contracts/clients/sites/index.d.ts +657 -0
  397. package/contracts/clients/sites/index.js +40 -0
  398. package/contracts/clients/sites/index.js.map +1 -0
  399. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  400. package/contracts/clients/trade-line-items/index.js +47 -0
  401. package/contracts/clients/trade-line-items/index.js.map +1 -0
  402. package/contracts/clients/trades/index.d.ts +871 -0
  403. package/contracts/clients/trades/index.js +156 -0
  404. package/contracts/clients/trades/index.js.map +1 -0
  405. package/contracts/clients/transactions/index.d.ts +88 -0
  406. package/contracts/clients/transactions/index.js +25 -0
  407. package/contracts/clients/transactions/index.js.map +1 -0
  408. package/package.json +15 -15
  409. package/common/helpers/index.ts +0 -59
  410. package/common/types/account-contact.types.ts +0 -99
  411. package/common/types/account-detail.types.ts +0 -27
  412. package/common/types/account-integration.types.ts +0 -143
  413. package/common/types/account-manager.types.ts +0 -120
  414. package/common/types/account-setting.types.ts +0 -65
  415. package/common/types/account.types.ts +0 -297
  416. package/common/types/activity.types.ts +0 -274
  417. package/common/types/address.types.ts +0 -41
  418. package/common/types/aic.types.ts +0 -246
  419. package/common/types/aml.types.ts +0 -18
  420. package/common/types/api-key-logs.types.ts +0 -66
  421. package/common/types/api-keys.types.ts +0 -69
  422. package/common/types/asset.types.ts +0 -338
  423. package/common/types/auth.types.ts +0 -359
  424. package/common/types/batch-jobs.types.ts +0 -151
  425. package/common/types/bonus-tier.types.ts +0 -180
  426. package/common/types/cart.types.ts +0 -21
  427. package/common/types/checklist-items.types.ts +0 -70
  428. package/common/types/checklist.types.ts +0 -97
  429. package/common/types/common.types.ts +0 -1552
  430. package/common/types/comply-advantage-api.types.ts +0 -316
  431. package/common/types/comply-advantage.types.ts +0 -25
  432. package/common/types/contact-us.types.ts +0 -111
  433. package/common/types/countries.types.ts +0 -375
  434. package/common/types/covered-person.types.ts +0 -275
  435. package/common/types/dashboard.types.ts +0 -792
  436. package/common/types/data-record.types.ts +0 -325
  437. package/common/types/data-room.types.ts +0 -242
  438. package/common/types/default-theme-config.types.ts +0 -87
  439. package/common/types/disbursement-adjustment.types.ts +0 -32
  440. package/common/types/disbursement-approval-user.types.ts +0 -100
  441. package/common/types/disbursement-review.types.ts +0 -110
  442. package/common/types/disbursement-transaction.types.ts +0 -72
  443. package/common/types/disbursements.types.ts +0 -426
  444. package/common/types/domain-filter.types.ts +0 -55
  445. package/common/types/email-theme.types.ts +0 -442
  446. package/common/types/entity.types.ts +0 -15
  447. package/common/types/error-responses.types.ts +0 -135
  448. package/common/types/escrow-account.types.ts +0 -104
  449. package/common/types/exchange-api-key.types.ts +0 -121
  450. package/common/types/exchange-import.types.ts +0 -36
  451. package/common/types/exchange-provider.types.ts +0 -329
  452. package/common/types/file.types.ts +0 -477
  453. package/common/types/health.types.ts +0 -29
  454. package/common/types/i-will-do-it-later.types.ts +0 -68
  455. package/common/types/individuals.types.ts +0 -542
  456. package/common/types/investor-account.types.ts +0 -1240
  457. package/common/types/investors-offering.types.ts +0 -65
  458. package/common/types/invite.types.ts +0 -159
  459. package/common/types/issuer-bank-account.types.ts +0 -107
  460. package/common/types/issuer-offering.types.ts +0 -389
  461. package/common/types/issuer-payment-method.types.ts +0 -382
  462. package/common/types/issuer.types.ts +0 -321
  463. package/common/types/job-item.types.ts +0 -119
  464. package/common/types/jobs.types.ts +0 -171
  465. package/common/types/kyb.types.ts +0 -53
  466. package/common/types/kyc.types.ts +0 -188
  467. package/common/types/legal-entity.types.ts +0 -186
  468. package/common/types/login-history.types.ts +0 -46
  469. package/common/types/mail-template.types.ts +0 -470
  470. package/common/types/north-cap-integration.types.ts +0 -190
  471. package/common/types/note.types.ts +0 -109
  472. package/common/types/notification.types.ts +0 -554
  473. package/common/types/notion-api.types.ts +0 -374
  474. package/common/types/notion-database.types.ts +0 -125
  475. package/common/types/notion-page.types.ts +0 -267
  476. package/common/types/offering-reports.types.ts +0 -153
  477. package/common/types/offering-submission.types.ts +0 -314
  478. package/common/types/offering.types.ts +0 -676
  479. package/common/types/page-revision.types.ts +0 -86
  480. package/common/types/page.types.ts +0 -436
  481. package/common/types/password.type.ts +0 -15
  482. package/common/types/payment-methods.types.ts +0 -298
  483. package/common/types/phone.type.ts +0 -27
  484. package/common/types/portfolio.types.ts +0 -50
  485. package/common/types/queue.types.ts +0 -112
  486. package/common/types/registered-reps.types.ts +0 -25
  487. package/common/types/rejection-reasons.types.ts +0 -56
  488. package/common/types/reminder-config.types.ts +0 -40
  489. package/common/types/review.types.ts +0 -133
  490. package/common/types/role.types.ts +0 -26
  491. package/common/types/secondary-customer.types.ts +0 -66
  492. package/common/types/secondary-issuer.types.ts +0 -50
  493. package/common/types/secondary-order.types.ts +0 -58
  494. package/common/types/secondary-security.types.ts +0 -60
  495. package/common/types/secondary-trade.entity.ts +0 -16
  496. package/common/types/secondary-trade.types.ts +0 -95
  497. package/common/types/secure-request.types.ts +0 -68
  498. package/common/types/signer.types.ts +0 -651
  499. package/common/types/site-link.types.ts +0 -166
  500. package/common/types/site-settings.types.ts +0 -727
  501. package/common/types/site.types.ts +0 -263
  502. package/common/types/sms.types.ts +0 -30
  503. package/common/types/state-machine.types.ts +0 -177
  504. package/common/types/states.types.ts +0 -163
  505. package/common/types/subdoc-preview.types.ts +0 -35
  506. package/common/types/task.types.ts +0 -258
  507. package/common/types/trade-adjustment.type.ts +0 -33
  508. package/common/types/trade-line-item.types.ts +0 -125
  509. package/common/types/trade.types.ts +0 -1045
  510. package/common/types/transaction.types.ts +0 -209
  511. package/common/types/trusted-contact.types.ts +0 -122
  512. package/common/types/typography.types.ts +0 -75
  513. package/common/types/user-manual.types.ts +0 -290
  514. package/common/types/user-setting.types.ts +0 -133
  515. package/common/types/user.types.ts +0 -304
  516. package/common/types/webhook.types.ts +0 -730
  517. package/common/types/zip.type.ts +0 -36
  518. package/contracts/clients/accounts/index.ts +0 -61
  519. package/contracts/clients/aic/index.ts +0 -59
  520. package/contracts/clients/api-key-logs/index.ts +0 -53
  521. package/contracts/clients/api-keys/index.ts +0 -73
  522. package/contracts/clients/assets/index.ts +0 -102
  523. package/contracts/clients/auth/index.ts +0 -50
  524. package/contracts/clients/cart/index.ts +0 -80
  525. package/contracts/clients/files/index.ts +0 -166
  526. package/contracts/clients/files-public/index.ts +0 -166
  527. package/contracts/clients/index.ts +0 -54
  528. package/contracts/clients/individuals/index.ts +0 -93
  529. package/contracts/clients/investor-accounts/index.ts +0 -93
  530. package/contracts/clients/issuer-payment-methods/index.ts +0 -39
  531. package/contracts/clients/issuers/index.ts +0 -94
  532. package/contracts/clients/legal-entities/index.ts +0 -93
  533. package/contracts/clients/offerings/index.ts +0 -117
  534. package/contracts/clients/payment-methods/index.ts +0 -85
  535. package/contracts/clients/secure-requests/index.ts +0 -34
  536. package/contracts/clients/sites/index.ts +0 -56
  537. package/contracts/clients/trade-line-items/index.ts +0 -66
  538. package/contracts/clients/trades/index.ts +0 -186
  539. package/contracts/clients/transactions/index.ts +0 -37
  540. package/index.ts +0 -10
  541. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -1,375 +0,0 @@
1
- import { z } from 'zod';
2
-
3
- const CountrySchema = z.object({
4
- code: z.string().length(2),
5
- name: z.string(),
6
- });
7
- type Country = z.infer<typeof CountrySchema>;
8
-
9
- const CountriesSchema = z.array(CountrySchema);
10
-
11
- const countries: Country[] = [
12
- { code: 'AD', name: 'Andorra' },
13
- { code: 'AE', name: 'United Arab Emirates' },
14
- { code: 'AF', name: 'Afghanistan' },
15
- { code: 'AG', name: 'Antigua and Barbuda' },
16
- { code: 'AI', name: 'Anguilla' },
17
- { code: 'AL', name: 'Albania' },
18
- { code: 'AM', name: 'Armenia' },
19
- { code: 'AO', name: 'Angola' },
20
- { code: 'AQ', name: 'Antarctica' },
21
- { code: 'AR', name: 'Argentina' },
22
- { code: 'AS', name: 'American Samoa' },
23
- { code: 'AT', name: 'Austria' },
24
- { code: 'AU', name: 'Australia' },
25
- { code: 'AW', name: 'Aruba' },
26
- { code: 'AX', name: 'Åland Islands' },
27
- { code: 'AZ', name: 'Azerbaijan' },
28
- { code: 'BA', name: 'Bosnia and Herzegovina' },
29
- { code: 'BB', name: 'Barbados' },
30
- { code: 'BD', name: 'Bangladesh' },
31
- { code: 'BE', name: 'Belgium' },
32
- { code: 'BF', name: 'Burkina Faso' },
33
- { code: 'BG', name: 'Bulgaria' },
34
- { code: 'BH', name: 'Bahrain' },
35
- { code: 'BI', name: 'Burundi' },
36
- { code: 'BJ', name: 'Benin' },
37
- { code: 'BL', name: 'Saint Barthélemy' },
38
- { code: 'BM', name: 'Bermuda' },
39
- { code: 'BN', name: 'Brunei Darussalam' },
40
- { code: 'BO', name: 'Bolivia, Plurinational State of' },
41
- { code: 'BQ', name: 'Bonaire, Sint Eustatius and Saba' },
42
- { code: 'BR', name: 'Brazil' },
43
- { code: 'BS', name: 'Bahamas' },
44
- { code: 'BT', name: 'Bhutan' },
45
- { code: 'BV', name: 'Bouvet Island' },
46
- { code: 'BW', name: 'Botswana' },
47
- { code: 'BY', name: 'Belarus' },
48
- { code: 'BZ', name: 'Belize' },
49
- { code: 'CA', name: 'Canada' },
50
- { code: 'CC', name: 'Cocos (Keeling) Islands' },
51
- { code: 'CD', name: 'Congo, Democratic Republic of the' },
52
- { code: 'CF', name: 'Central African Republic' },
53
- { code: 'CG', name: 'Congo' },
54
- { code: 'CH', name: 'Switzerland' },
55
- { code: 'CI', name: "Côte d'Ivoire" },
56
- { code: 'CK', name: 'Cook Islands' },
57
- { code: 'CL', name: 'Chile' },
58
- { code: 'CM', name: 'Cameroon' },
59
- { code: 'CN', name: 'China' },
60
- { code: 'CO', name: 'Colombia' },
61
- { code: 'CR', name: 'Costa Rica' },
62
- { code: 'CU', name: 'Cuba' },
63
- { code: 'CV', name: 'Cabo Verde' },
64
- { code: 'CW', name: 'Curaçao' },
65
- { code: 'CX', name: 'Christmas Island' },
66
- { code: 'CY', name: 'Cyprus' },
67
- { code: 'CZ', name: 'Czechia' },
68
- { code: 'DE', name: 'Germany' },
69
- { code: 'DJ', name: 'Djibouti' },
70
- { code: 'DK', name: 'Denmark' },
71
- { code: 'DM', name: 'Dominica' },
72
- { code: 'DO', name: 'Dominican Republic' },
73
- { code: 'DZ', name: 'Algeria' },
74
- { code: 'EC', name: 'Ecuador' },
75
- { code: 'EE', name: 'Estonia' },
76
- { code: 'EG', name: 'Egypt' },
77
- { code: 'EH', name: 'Western Sahara' },
78
- { code: 'ER', name: 'Eritrea' },
79
- { code: 'ES', name: 'Spain' },
80
- { code: 'ET', name: 'Ethiopia' },
81
- { code: 'FI', name: 'Finland' },
82
- { code: 'FJ', name: 'Fiji' },
83
- { code: 'FK', name: 'Falkland Islands (Malvinas)' },
84
- { code: 'FM', name: 'Micronesia, Federated States of' },
85
- { code: 'FO', name: 'Faroe Islands' },
86
- { code: 'FR', name: 'France' },
87
- { code: 'GA', name: 'Gabon' },
88
- { code: 'GB', name: 'United Kingdom of Great Britain and Northern Ireland' },
89
- { code: 'GD', name: 'Grenada' },
90
- { code: 'GE', name: 'Georgia' },
91
- { code: 'GF', name: 'French Guiana' },
92
- { code: 'GG', name: 'Guernsey' },
93
- { code: 'GH', name: 'Ghana' },
94
- { code: 'GI', name: 'Gibraltar' },
95
- { code: 'GL', name: 'Greenland' },
96
- { code: 'GM', name: 'Gambia' },
97
- { code: 'GN', name: 'Guinea' },
98
- { code: 'GP', name: 'Guadeloupe' },
99
- { code: 'GQ', name: 'Equatorial Guinea' },
100
- { code: 'GR', name: 'Greece' },
101
- { code: 'GS', name: 'South Georgia and the South Sandwich Islands' },
102
- { code: 'GT', name: 'Guatemala' },
103
- { code: 'GU', name: 'Guam' },
104
- { code: 'GW', name: 'Guinea-Bissau' },
105
- { code: 'GY', name: 'Guyana' },
106
- { code: 'HK', name: 'Hong Kong' },
107
- { code: 'HM', name: 'Heard Island and McDonald Islands' },
108
- { code: 'HN', name: 'Honduras' },
109
- { code: 'HR', name: 'Croatia' },
110
- { code: 'HT', name: 'Haiti' },
111
- { code: 'HU', name: 'Hungary' },
112
- { code: 'ID', name: 'Indonesia' },
113
- { code: 'IE', name: 'Ireland' },
114
- { code: 'IL', name: 'Israel' },
115
- { code: 'IM', name: 'Isle of Man' },
116
- { code: 'IN', name: 'India' },
117
- { code: 'IO', name: 'British Indian Ocean Territory' },
118
- { code: 'IQ', name: 'Iraq' },
119
- { code: 'IR', name: 'Iran, Islamic Republic of' },
120
- { code: 'IS', name: 'Iceland' },
121
- { code: 'IT', name: 'Italy' },
122
- { code: 'JE', name: 'Jersey' },
123
- { code: 'JM', name: 'Jamaica' },
124
- { code: 'JO', name: 'Jordan' },
125
- { code: 'JP', name: 'Japan' },
126
- { code: 'KE', name: 'Kenya' },
127
- { code: 'KG', name: 'Kyrgyzstan' },
128
- { code: 'KH', name: 'Cambodia' },
129
- { code: 'KI', name: 'Kiribati' },
130
- { code: 'KM', name: 'Comoros' },
131
- { code: 'KN', name: 'Saint Kitts and Nevis' },
132
- { code: 'KP', name: "Korea, Democratic People's Republic of" },
133
- { code: 'KR', name: 'Korea, Republic of' },
134
- { code: 'KW', name: 'Kuwait' },
135
- { code: 'KY', name: 'Cayman Islands' },
136
- { code: 'KZ', name: 'Kazakhstan' },
137
- { code: 'LA', name: "Lao People's Democratic Republic" },
138
- { code: 'LB', name: 'Lebanon' },
139
- { code: 'LC', name: 'Saint Lucia' },
140
- { code: 'LI', name: 'Liechtenstein' },
141
- { code: 'LK', name: 'Sri Lanka' },
142
- { code: 'LR', name: 'Liberia' },
143
- { code: 'LS', name: 'Lesotho' },
144
- { code: 'LT', name: 'Lithuania' },
145
- { code: 'LU', name: 'Luxembourg' },
146
- { code: 'LV', name: 'Latvia' },
147
- { code: 'LY', name: 'Libya' },
148
- { code: 'MA', name: 'Morocco' },
149
- { code: 'MC', name: 'Monaco' },
150
- { code: 'MD', name: 'Moldova, Republic of' },
151
- { code: 'ME', name: 'Montenegro' },
152
- { code: 'MF', name: 'Saint Martin, (French part)' },
153
- { code: 'MG', name: 'Madagascar' },
154
- { code: 'MH', name: 'Marshall Islands' },
155
- { code: 'MK', name: 'North Macedonia' },
156
- { code: 'ML', name: 'Mali' },
157
- { code: 'MM', name: 'Myanmar' },
158
- { code: 'MN', name: 'Mongolia' },
159
- { code: 'MO', name: 'Macao' },
160
- { code: 'MP', name: 'Northern Mariana Islands' },
161
- { code: 'MQ', name: 'Martinique' },
162
- { code: 'MR', name: 'Mauritania' },
163
- { code: 'MS', name: 'Montserrat' },
164
- { code: 'MT', name: 'Malta' },
165
- { code: 'MU', name: 'Mauritius' },
166
- { code: 'MV', name: 'Maldives' },
167
- { code: 'MW', name: 'Malawi' },
168
- { code: 'MX', name: 'Mexico' },
169
- { code: 'MY', name: 'Malaysia' },
170
- { code: 'MZ', name: 'Mozambique' },
171
- { code: 'NA', name: 'Namibia' },
172
- { code: 'NC', name: 'New Caledonia' },
173
- { code: 'NE', name: 'Niger' },
174
- { code: 'NF', name: 'Norfolk Island' },
175
- { code: 'NG', name: 'Nigeria' },
176
- { code: 'NI', name: 'Nicaragua' },
177
- { code: 'NL', name: 'Netherlands' },
178
- { code: 'NO', name: 'Norway' },
179
- { code: 'NP', name: 'Nepal' },
180
- { code: 'NR', name: 'Nauru' },
181
- { code: 'NU', name: 'Niue' },
182
- { code: 'NZ', name: 'New Zealand' },
183
- { code: 'OM', name: 'Oman' },
184
- { code: 'PA', name: 'Panama' },
185
- { code: 'PE', name: 'Peru' },
186
- { code: 'PF', name: 'French Polynesia' },
187
- { code: 'PG', name: 'Papua New Guinea' },
188
- { code: 'PH', name: 'Philippines' },
189
- { code: 'PK', name: 'Pakistan' },
190
- { code: 'PL', name: 'Poland' },
191
- { code: 'PM', name: 'Saint Pierre and Miquelon' },
192
- { code: 'PN', name: 'Pitcairn' },
193
- { code: 'PR', name: 'Puerto Rico' },
194
- { code: 'PS', name: 'Palestine, State of' },
195
- { code: 'PT', name: 'Portugal' },
196
- { code: 'PW', name: 'Palau' },
197
- { code: 'PY', name: 'Paraguay' },
198
- { code: 'QA', name: 'Qatar' },
199
- { code: 'RE', name: 'Réunion' },
200
- { code: 'RO', name: 'Romania' },
201
- { code: 'RS', name: 'Serbia' },
202
- { code: 'RU', name: 'Russian Federation' },
203
- { code: 'RW', name: 'Rwanda' },
204
- { code: 'SA', name: 'Saudi Arabia' },
205
- { code: 'SB', name: 'Solomon Islands' },
206
- { code: 'SC', name: 'Seychelles' },
207
- { code: 'SD', name: 'Sudan' },
208
- { code: 'SE', name: 'Sweden' },
209
- { code: 'SG', name: 'Singapore' },
210
- { code: 'SH', name: 'Saint Helena, Ascension and Tristan da Cunha' },
211
- { code: 'SI', name: 'Slovenia' },
212
- { code: 'SJ', name: 'Svalbard and Jan Mayen' },
213
- { code: 'SK', name: 'Slovakia' },
214
- { code: 'SL', name: 'Sierra Leone' },
215
- { code: 'SM', name: 'San Marino' },
216
- { code: 'SN', name: 'Senegal' },
217
- { code: 'SO', name: 'Somalia' },
218
- { code: 'SR', name: 'Suriname' },
219
- { code: 'SS', name: 'South Sudan' },
220
- { code: 'ST', name: 'Sao Tome and Principe' },
221
- { code: 'SV', name: 'El Salvador' },
222
- { code: 'SX', name: 'Sint Maarten, (Dutch part)' },
223
- { code: 'SY', name: 'Syrian Arab Republic' },
224
- { code: 'SZ', name: 'Eswatini' },
225
- { code: 'TC', name: 'Turks and Caicos Islands' },
226
- { code: 'TD', name: 'Chad' },
227
- { code: 'TF', name: 'French Southern Territories' },
228
- { code: 'TG', name: 'Togo' },
229
- { code: 'TH', name: 'Thailand' },
230
- { code: 'TJ', name: 'Tajikistan' },
231
- { code: 'TK', name: 'Tokelau' },
232
- { code: 'TL', name: 'Timor-Leste' },
233
- { code: 'TM', name: 'Turkmenistan' },
234
- { code: 'TN', name: 'Tunisia' },
235
- { code: 'TO', name: 'Tonga' },
236
- { code: 'TR', name: 'Türkiye' },
237
- { code: 'TT', name: 'Trinidad and Tobago' },
238
- { code: 'TV', name: 'Tuvalu' },
239
- { code: 'TW', name: 'Taiwan, Province of China' },
240
- { code: 'TZ', name: 'Tanzania, United Republic of' },
241
- { code: 'UA', name: 'Ukraine' },
242
- { code: 'UG', name: 'Uganda' },
243
- { code: 'UM', name: 'United States Minor Outlying Islands' },
244
- { code: 'US', name: 'United States of America' },
245
- { code: 'UY', name: 'Uruguay' },
246
- { code: 'UZ', name: 'Uzbekistan' },
247
- { code: 'VA', name: 'Holy See' },
248
- { code: 'VC', name: 'Saint Vincent and the Grenadines' },
249
- { code: 'VE', name: 'Venezuela, Bolivarian Republic of' },
250
- { code: 'VG', name: 'Virgin Islands, British' },
251
- { code: 'VI', name: 'Virgin Islands, U.S.' },
252
- { code: 'VN', name: 'Viet Nam' },
253
- { code: 'VU', name: 'Vanuatu' },
254
- { code: 'WF', name: 'Wallis and Futuna' },
255
- { code: 'WS', name: 'Samoa' },
256
- { code: 'YE', name: 'Yemen' },
257
- { code: 'YT', name: 'Mayotte' },
258
- { code: 'ZA', name: 'South Africa' },
259
- { code: 'ZM', name: 'Zambia' },
260
- { code: 'ZW', name: 'Zimbabwe' },
261
- ] as const;
262
- const validatedCountries = CountriesSchema.parse(countries);
263
-
264
- export const CountryCodes = countries.map((c) => c.code);
265
-
266
- const countryEnum = countries.reduce(
267
- (acc, country) => {
268
- acc[country.code] = country.code;
269
- return acc;
270
- },
271
- {} as Record<string, string>,
272
- );
273
-
274
- export const CountryCode = Object.freeze(countryEnum);
275
-
276
- export const CountryEnumSchema = z.nativeEnum(CountryCode);
277
-
278
- /**
279
- * Grey list of countries
280
- * This list contains country codes that are considered "grey listed"
281
- */
282
- export const GREY_LIST_COUNTRIES: readonly Country[] = [
283
- { code: 'DZ', name: 'Algeria' },
284
- { code: 'AO', name: 'Angola' },
285
- { code: 'BG', name: 'Bulgaria' },
286
- { code: 'BF', name: 'Burkina Faso' },
287
- { code: 'CM', name: 'Cameroon' },
288
- { code: 'CI', name: "Côte d'Ivoire" },
289
- { code: 'HR', name: 'Croatia' },
290
- { code: 'CD', name: 'Congo, Democratic Republic of the' },
291
- { code: 'HT', name: 'Haiti' },
292
- { code: 'KE', name: 'Kenya' },
293
- { code: 'LA', name: "Lao People's Democratic Republic" },
294
- { code: 'LB', name: 'Lebanon' },
295
- { code: 'ML', name: 'Mali' },
296
- { code: 'MC', name: 'Monaco' },
297
- { code: 'MZ', name: 'Mozambique' },
298
- { code: 'NA', name: 'Namibia' },
299
- { code: 'NP', name: 'Nepal' },
300
- { code: 'NG', name: 'Nigeria' },
301
- { code: 'ZA', name: 'South Africa' },
302
- { code: 'SS', name: 'South Sudan' },
303
- { code: 'SY', name: 'Syrian Arab Republic' },
304
- { code: 'TZ', name: 'Tanzania, United Republic of' },
305
- { code: 'VE', name: 'Venezuela, Bolivarian Republic of' },
306
- { code: 'VN', name: 'Viet Nam' },
307
- { code: 'YE', name: 'Yemen' },
308
- ];
309
-
310
- /**
311
- * Black list of countries
312
- * This list contains country codes that are considered "black listed"
313
- */
314
- export const BLACK_LIST_COUNTRIES: readonly Country[] = [
315
- { code: 'KP', name: "Korea, Democratic People's Republic of" },
316
- { code: 'IR', name: 'Iran, Islamic Republic of' },
317
- { code: 'MM', name: 'Myanmar' },
318
- ];
319
-
320
- /**
321
- * List of grey list country codes for easier lookups
322
- */
323
- export const GREY_LIST_COUNTRY_CODES = GREY_LIST_COUNTRIES.map((c) => c.code);
324
-
325
- /**
326
- * List of black list country codes for easier lookups
327
- */
328
- export const BLACK_LIST_COUNTRY_CODES = BLACK_LIST_COUNTRIES.map((c) => c.code);
329
-
330
- /**
331
- * Checks if a country is in the grey list
332
- * @param code The country code to check
333
- * @returns {boolean} True if the country is in the grey list
334
- *
335
- * @example
336
- * const isGreyListed = isGreyListedCountry('VN');
337
- */
338
- export function isGreyListedCountry(code: string): boolean {
339
- return GREY_LIST_COUNTRY_CODES.includes(code.toUpperCase());
340
- }
341
-
342
- /**
343
- * Checks if a country is in the black list
344
- * @param code The country code to check
345
- * @returns {boolean} True if the country is in the black list
346
- *
347
- * @example
348
- * const isBlackListed = isBlackListedCountry('IR');
349
- */
350
- export function isBlackListedCountry(code: string): boolean {
351
- return BLACK_LIST_COUNTRY_CODES.includes(code.toUpperCase());
352
- }
353
-
354
- /**
355
- *
356
- * @param code The country code
357
- * @returns {Country | undefined} The country object
358
- *
359
- * @example
360
- * const usa = findCountryByCode('US');
361
- * console.log(usa); // { code: "US", name: "United States of America" }
362
- */
363
- function findCountryByCode(code: string): Country | undefined {
364
- return validatedCountries.find(
365
- (country) => country.code === code.toUpperCase(),
366
- );
367
- }
368
-
369
- export {
370
- CountrySchema,
371
- CountriesSchema,
372
- validatedCountries,
373
- findCountryByCode,
374
- };
375
- export type { Country };
@@ -1,275 +0,0 @@
1
- import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
- import { TypeID } from 'typeid-js';
3
- import { z } from 'zod';
4
- import {
5
- AccountZod,
6
- ComplianceReview,
7
- CoveredPersonsRoleType,
8
- CoveredPersonsStatus,
9
- EmailSchema,
10
- IDType,
11
- IPaginationMeta,
12
- } from './common.types';
13
- import { IBaseEntity } from './entity.types';
14
-
15
- import { IIssuer, issuerIdSchema } from './issuer.types';
16
- import { fileIdSchema } from './file.types';
17
- import { accountIdSchema } from './account.types';
18
-
19
- extendZodWithOpenApi(z);
20
- export const coveredPersonIdSchema = z.string().refine(
21
- (value) => {
22
- try {
23
- const tid = TypeID.fromString(value);
24
- return tid.getType() === 'covered_person';
25
- } catch {
26
- return false;
27
- }
28
- },
29
- {
30
- message:
31
- 'Invalid covered person ID format. Must be a valid TypeID with "covered_person" prefix.',
32
- },
33
- );
34
-
35
- export const coveredPersonsInclude = z.enum(['issuer', 'parent', 'account']);
36
-
37
- /**
38
- * @description Query parameters for including related entities
39
- * @xample in contract us as -> query: z.object({}).merge(CoveredPersonsIncludeQuery),
40
- */
41
- export const CoveredPersonsIncludeQuery = z.object({
42
- include: z
43
- .string()
44
- .optional()
45
- .transform((str) => (str ? str.split(',') : []))
46
- .refine(
47
- (includes) =>
48
- includes.every((include) =>
49
- coveredPersonsInclude.options.includes(include as any),
50
- ),
51
- {
52
- message: `Invalid include option provided. Valid options are: ${coveredPersonsInclude.options.join(', ')}`,
53
- },
54
- )
55
- .openapi({
56
- example: `${coveredPersonsInclude.options.join(', ')}`,
57
- }),
58
- });
59
- export interface CoveredPersonsIncludeQuery
60
- extends z.infer<typeof CoveredPersonsIncludeQuery> {}
61
-
62
- export const PostCoveredPersonsZod = z
63
- .object({
64
- firstName: z.string().min(2).max(50).openapi({ example: 'John' }),
65
- lastName: z
66
- .string()
67
- .min(2)
68
- .max(50)
69
- .nullable()
70
- .optional()
71
- .openapi({ example: 'Doe' }),
72
- issuerId: z
73
- .lazy(() => issuerIdSchema)
74
- .openapi({
75
- example: 'issuer_01jatr819xff9s6wek8d2tng3x',
76
- }),
77
- email: z.string().email().nullable().optional(),
78
- role: z
79
- .nativeEnum(CoveredPersonsRoleType)
80
- .openapi({ example: CoveredPersonsRoleType.ACCOUNTING }),
81
- ownership: z.number().min(0).max(100).default(0).openapi({ example: 15 }),
82
- parentId: coveredPersonIdSchema
83
-
84
- .nullable()
85
- .openapi({ example: 'covered_person_01jatr819xff9s6wek8d2tng3x' }),
86
- idType: z
87
- .nativeEnum(IDType)
88
- .nullable()
89
- .optional()
90
- .openapi({ example: IDType.DRIVERS_LICENSE }),
91
- })
92
- .superRefine((data, ctx) => {
93
- if (data.role !== CoveredPersonsRoleType.ENTITY) {
94
- if (!data.email) {
95
- ctx.addIssue({
96
- path: ['email'],
97
- message: 'Email is required when role type is not ENTITY.',
98
- code: 'custom',
99
- });
100
- }
101
- if (!data.idType || data.idType == null) {
102
- ctx.addIssue({
103
- path: ['idType'],
104
- message: 'IdType is required when role type is not ENTITY',
105
- code: 'custom',
106
- });
107
- }
108
- } else {
109
- if (data.lastName) {
110
- ctx.addIssue({
111
- path: ['lastName'],
112
- message: 'Last name is not allowed when the role type is ENTITY',
113
- code: 'custom',
114
- });
115
- }
116
- if (data.idType) {
117
- ctx.addIssue({
118
- path: ['idType'],
119
- message: 'Id Type is not allowed when the role type is ENTITY',
120
- code: 'custom',
121
- });
122
- }
123
- }
124
- });
125
- export type PostCoveredPersonsZod = z.infer<typeof PostCoveredPersonsZod>;
126
- export const PatchCoveredPersonsZod = z
127
- .object({
128
- firstName: z
129
- .string()
130
- .min(2)
131
- .max(50)
132
- .optional()
133
- .openapi({ example: 'John' }),
134
- lastName: z.string().min(2).max(50).optional().openapi({ example: 'Doe' }),
135
- role: z
136
- .nativeEnum(CoveredPersonsRoleType)
137
- .optional()
138
- .openapi({ example: CoveredPersonsRoleType.ACCOUNTING }),
139
-
140
- ownership: z.number().min(0).max(100).openapi({ example: 15 }).optional(),
141
- email: EmailSchema.nullable().optional(),
142
- idType: z
143
- .nativeEnum(IDType)
144
- .optional()
145
- .nullable()
146
- .openapi({ example: IDType.DRIVERS_LICENSE }),
147
- identityFileFrontId: z
148
- .lazy(() => fileIdSchema)
149
- .optional()
150
- .nullable(),
151
- identityFileBackId: z
152
- .lazy(() => fileIdSchema)
153
- .optional()
154
- .nullable(),
155
- badActorReportFileId: z
156
- .lazy(() => fileIdSchema)
157
- .optional()
158
- .nullable(),
159
- })
160
- .superRefine((data, ctx) => {
161
- if (data.role !== CoveredPersonsRoleType.ENTITY && data.role) {
162
- if (!data.email) {
163
- ctx.addIssue({
164
- path: ['email'],
165
- message: 'Email is required when role type is not ENTITY.',
166
- code: 'custom',
167
- });
168
- }
169
- if (!data.idType || data.idType == null) {
170
- ctx.addIssue({
171
- path: ['idType'],
172
- message: 'IdType is required when role type is not ENTITY',
173
- code: 'custom',
174
- });
175
- }
176
- } else if (data.role && data.role === CoveredPersonsRoleType.ENTITY) {
177
- if (data.lastName) {
178
- ctx.addIssue({
179
- path: ['lastName'],
180
- message: 'Last name is not allowed when the role type is ENTITY',
181
- code: 'custom',
182
- });
183
- }
184
- if (data.idType) {
185
- ctx.addIssue({
186
- path: ['idType'],
187
- message: 'Id Type is not allowed when the role type is ENTITY',
188
- code: 'custom',
189
- });
190
- }
191
- }
192
- });
193
- export type PatchCoveredPersonsZod = z.infer<typeof PatchCoveredPersonsZod>;
194
-
195
- export const ReviewCoveredPersons = z.object({
196
- complianceReview: z.enum([
197
- ComplianceReview.APPROVED,
198
- ComplianceReview.REJECTED,
199
- ]),
200
- coveredPersons: z
201
- .array(coveredPersonIdSchema)
202
- .min(1, 'At least one coveredPerson is required')
203
- .max(50, 'Maximum of 50 coveredPersons allowed')
204
- .openapi({
205
- example: [
206
- 'covered_person_01jjsdrx1seqfse7z4z47sgdp5',
207
- 'covered_person_01jjsdrx27enkszq5cnc3hdhrf',
208
- ],
209
- }),
210
- });
211
- export type ReviewCoveredPersons = z.infer<typeof ReviewCoveredPersons>;
212
-
213
- export const ICoveredPerson = IBaseEntity.extend({
214
- firstName: z.string().nullable().optional().openapi({ example: 'John' }),
215
- lastName: z.string().nullable().optional().openapi({ example: 'Doe' }),
216
- role: z
217
- .nativeEnum(CoveredPersonsRoleType)
218
- .openapi({ example: CoveredPersonsRoleType.ENTITY }),
219
- ownership: z.number().openapi({ example: 15 }),
220
- accountId: z.string(),
221
- account: AccountZod.optional().nullable(),
222
- issuer: z
223
- .lazy(() => IIssuer)
224
- .optional()
225
- .nullable(),
226
- issuerId: z.string(),
227
- parent: z.lazy(() => ICoveredPerson.optional().nullable()),
228
- parentId: z.string().nullable().optional().default(null),
229
- idType: z.nativeEnum(IDType).nullable(),
230
- email: z.string().nullable(),
231
- identityFileFrontId: z.string().optional().nullable(),
232
- identityFileBackId: z.string().optional().nullable(),
233
- badActorReportFileId: z.string().optional().nullable(),
234
- status: z.nativeEnum(CoveredPersonsStatus),
235
- });
236
-
237
- export type ICoveredPerson = z.infer<typeof ICoveredPerson>;
238
-
239
- export const IPaginatedCoveredPerson = z.object({
240
- items: z.array(ICoveredPerson),
241
- meta: IPaginationMeta,
242
- });
243
- export type IPaginatedCoveredPerson = z.infer<typeof IPaginatedCoveredPerson>;
244
-
245
- export const GetCoveredPersonsZod = z.object({
246
- id: coveredPersonIdSchema.optional(),
247
- issuerId: z.lazy(() => issuerIdSchema).optional(),
248
- parentId: z
249
- .union([coveredPersonIdSchema, z.literal('null'), z.undefined()])
250
- .optional() // Allow valid parentId, "null", or undefined
251
- .transform((value) => {
252
- if (value === 'null') {
253
- return null; // Transform "null" string to actual null
254
- }
255
- return value; // Return valid parentId or undefined as is
256
- }),
257
-
258
- firstName: z.string().min(2).max(50).optional().openapi({ example: 'John' }),
259
- role: z
260
- .nativeEnum(CoveredPersonsRoleType)
261
-
262
- .optional()
263
- .openapi({ example: CoveredPersonsRoleType.ACCOUNTING }),
264
- status: z.nativeEnum(CoveredPersonsStatus).optional(),
265
- accountId: accountIdSchema.optional(),
266
- });
267
-
268
- export type GetCoveredPersonsZod = z.infer<typeof GetCoveredPersonsZod>;
269
-
270
- export const CoveredPersonDeleteResponse = z.object({
271
- message: z.string(),
272
- });
273
- export type CoveredPersonDeleteResponse = z.infer<
274
- typeof CoveredPersonDeleteResponse
275
- >;