@dalmore/api-contracts 0.0.0-dev.2dc8e92 → 0.0.0-dev.2fec89f

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 (718) hide show
  1. package/README.md +23 -19
  2. package/common/constants.d.ts +43 -0
  3. package/common/constants.js +77 -0
  4. package/common/constants.js.map +1 -0
  5. package/common/helpers/index.d.ts +77 -0
  6. package/common/helpers/index.js +179 -0
  7. package/common/helpers/index.js.map +1 -0
  8. package/common/types/account-contact.types.d.ts +485 -0
  9. package/common/types/account-contact.types.js +75 -0
  10. package/common/types/account-contact.types.js.map +1 -0
  11. package/common/types/account-detail.types.d.ts +304 -0
  12. package/common/types/account-detail.types.js +20 -0
  13. package/common/types/account-detail.types.js.map +1 -0
  14. package/common/types/account-integration.types.d.ts +242 -0
  15. package/common/types/account-integration.types.js +121 -0
  16. package/common/types/account-integration.types.js.map +1 -0
  17. package/common/types/account-manager.types.d.ts +917 -0
  18. package/common/types/account-manager.types.js +89 -0
  19. package/common/types/account-manager.types.js.map +1 -0
  20. package/common/types/account-setting.types.d.ts +140 -0
  21. package/common/types/account-setting.types.js +23 -0
  22. package/common/types/account-setting.types.js.map +1 -0
  23. package/common/types/account.types.d.ts +640 -0
  24. package/common/types/account.types.js +218 -0
  25. package/common/types/account.types.js.map +1 -0
  26. package/common/types/activity.types.d.ts +590 -0
  27. package/common/types/activity.types.js +258 -0
  28. package/common/types/activity.types.js.map +1 -0
  29. package/common/types/address.types.d.ts +89 -0
  30. package/common/types/address.types.js +36 -0
  31. package/common/types/address.types.js.map +1 -0
  32. package/common/types/aic.types.d.ts +434 -0
  33. package/common/types/aic.types.js +170 -0
  34. package/common/types/aic.types.js.map +1 -0
  35. package/common/types/aml.types.d.ts +41 -0
  36. package/common/types/aml.types.js +16 -0
  37. package/common/types/aml.types.js.map +1 -0
  38. package/common/types/api-key-logs.types.d.ts +204 -0
  39. package/common/types/api-key-logs.types.js +52 -0
  40. package/common/types/api-key-logs.types.js.map +1 -0
  41. package/common/types/api-keys.types.d.ts +192 -0
  42. package/common/types/api-keys.types.js +57 -0
  43. package/common/types/api-keys.types.js.map +1 -0
  44. package/common/types/asset.types.d.ts +1100 -0
  45. package/common/types/asset.types.js +353 -0
  46. package/common/types/asset.types.js.map +1 -0
  47. package/common/types/attribution.types.d.ts +578 -0
  48. package/common/types/attribution.types.js +152 -0
  49. package/common/types/attribution.types.js.map +1 -0
  50. package/common/types/auth.types.d.ts +523 -0
  51. package/common/types/auth.types.js +280 -0
  52. package/common/types/auth.types.js.map +1 -0
  53. package/common/types/batch-jobs.types.d.ts +321 -0
  54. package/common/types/batch-jobs.types.js +111 -0
  55. package/common/types/batch-jobs.types.js.map +1 -0
  56. package/common/types/bonus-tier.types.d.ts +991 -0
  57. package/common/types/bonus-tier.types.js +166 -0
  58. package/common/types/bonus-tier.types.js.map +1 -0
  59. package/common/types/cap-table.types.d.ts +1311 -0
  60. package/common/types/cap-table.types.js +458 -0
  61. package/common/types/cap-table.types.js.map +1 -0
  62. package/common/types/cart.types.d.ts +28 -0
  63. package/common/types/cart.types.js +19 -0
  64. package/common/types/cart.types.js.map +1 -0
  65. package/common/types/checklist-items.types.d.ts +195 -0
  66. package/common/types/checklist-items.types.js +54 -0
  67. package/common/types/checklist-items.types.js.map +1 -0
  68. package/common/types/checklist.types.d.ts +140 -0
  69. package/common/types/checklist.types.js +71 -0
  70. package/common/types/checklist.types.js.map +1 -0
  71. package/common/types/common.types.d.ts +1861 -0
  72. package/common/types/common.types.js +1511 -0
  73. package/common/types/common.types.js.map +1 -0
  74. package/common/types/comply-advantage-api.types.d.ts +3626 -0
  75. package/common/types/comply-advantage-api.types.js +291 -0
  76. package/common/types/comply-advantage-api.types.js.map +1 -0
  77. package/common/types/comply-advantage.types.d.ts +48 -0
  78. package/common/types/comply-advantage.types.js +21 -0
  79. package/common/types/comply-advantage.types.js.map +1 -0
  80. package/common/types/contact-us.types.d.ts +126 -0
  81. package/common/types/contact-us.types.js +91 -0
  82. package/common/types/contact-us.types.js.map +1 -0
  83. package/common/types/countries.types.d.ts +77 -0
  84. package/common/types/countries.types.js +349 -0
  85. package/common/types/countries.types.js.map +1 -0
  86. package/common/types/covered-person.types.d.ts +204 -0
  87. package/common/types/covered-person.types.js +234 -0
  88. package/common/types/covered-person.types.js.map +1 -0
  89. package/common/types/csv.types.d.ts +3612 -0
  90. package/common/types/csv.types.js +290 -0
  91. package/common/types/csv.types.js.map +1 -0
  92. package/common/types/dashboard.types.d.ts +2086 -0
  93. package/common/types/dashboard.types.js +690 -0
  94. package/common/types/dashboard.types.js.map +1 -0
  95. package/common/types/data-record.types.d.ts +347 -0
  96. package/common/types/data-record.types.js +261 -0
  97. package/common/types/data-record.types.js.map +1 -0
  98. package/common/types/data-room.types.d.ts +1277 -0
  99. package/common/types/data-room.types.js +167 -0
  100. package/common/types/data-room.types.js.map +1 -0
  101. package/common/types/default-theme-config.types.d.ts +445 -0
  102. package/common/types/default-theme-config.types.js +63 -0
  103. package/common/types/default-theme-config.types.js.map +1 -0
  104. package/common/types/disbursement-adjustment.types.d.ts +21 -0
  105. package/common/types/disbursement-adjustment.types.js +25 -0
  106. package/common/types/disbursement-adjustment.types.js.map +1 -0
  107. package/common/types/disbursement-approval-user.types.d.ts +935 -0
  108. package/common/types/disbursement-approval-user.types.js +68 -0
  109. package/common/types/disbursement-approval-user.types.js.map +1 -0
  110. package/common/types/disbursement-review.types.d.ts +923 -0
  111. package/common/types/disbursement-review.types.js +76 -0
  112. package/common/types/disbursement-review.types.js.map +1 -0
  113. package/common/types/disbursement-transaction.types.d.ts +621 -0
  114. package/common/types/disbursement-transaction.types.js +51 -0
  115. package/common/types/disbursement-transaction.types.js.map +1 -0
  116. package/common/types/disbursements.types.d.ts +3496 -0
  117. package/common/types/disbursements.types.js +435 -0
  118. package/common/types/disbursements.types.js.map +1 -0
  119. package/common/types/domain-filter.types.d.ts +135 -0
  120. package/common/types/domain-filter.types.js +40 -0
  121. package/common/types/domain-filter.types.js.map +1 -0
  122. package/common/types/email-theme.types.d.ts +1359 -0
  123. package/common/types/email-theme.types.js +318 -0
  124. package/common/types/email-theme.types.js.map +1 -0
  125. package/common/types/entity.types.d.ts +21 -0
  126. package/common/types/entity.types.js +14 -0
  127. package/common/types/entity.types.js.map +1 -0
  128. package/common/types/error-responses.types.d.ts +144 -0
  129. package/common/types/error-responses.types.js +125 -0
  130. package/common/types/error-responses.types.js.map +1 -0
  131. package/common/types/escrow-account.types.d.ts +415 -0
  132. package/common/types/escrow-account.types.js +78 -0
  133. package/common/types/escrow-account.types.js.map +1 -0
  134. package/common/types/exchange-api-key.types.d.ts +1010 -0
  135. package/common/types/exchange-api-key.types.js +90 -0
  136. package/common/types/exchange-api-key.types.js.map +1 -0
  137. package/common/types/exchange-import.types.d.ts +23 -0
  138. package/common/types/exchange-import.types.js +23 -0
  139. package/common/types/exchange-import.types.js.map +1 -0
  140. package/common/types/exchange-provider.types.d.ts +1308 -0
  141. package/common/types/exchange-provider.types.js +268 -0
  142. package/common/types/exchange-provider.types.js.map +1 -0
  143. package/common/types/file.types.d.ts +428 -0
  144. package/common/types/file.types.js +392 -0
  145. package/common/types/file.types.js.map +1 -0
  146. package/common/types/health.types.d.ts +112 -0
  147. package/common/types/health.types.js +22 -0
  148. package/common/types/health.types.js.map +1 -0
  149. package/common/types/i-will-do-it-later.types.d.ts +51 -0
  150. package/common/types/i-will-do-it-later.types.js +30 -0
  151. package/common/types/i-will-do-it-later.types.js.map +1 -0
  152. package/common/types/{index.ts → index.d.ts} +10 -5
  153. package/common/types/index.js +55 -0
  154. package/common/types/index.js.map +1 -0
  155. package/common/types/individuals.types.d.ts +2289 -0
  156. package/common/types/individuals.types.js +500 -0
  157. package/common/types/individuals.types.js.map +1 -0
  158. package/common/types/investor-account.types.d.ts +2996 -0
  159. package/common/types/investor-account.types.js +931 -0
  160. package/common/types/investor-account.types.js.map +1 -0
  161. package/common/types/investorAccountIdSchema.type.js +1 -0
  162. package/common/types/investorAccountIdSchema.type.js.map +1 -0
  163. package/common/types/investors-offering.types.d.ts +399 -0
  164. package/common/types/investors-offering.types.js +50 -0
  165. package/common/types/investors-offering.types.js.map +1 -0
  166. package/common/types/invite.types.d.ts +644 -0
  167. package/common/types/invite.types.js +114 -0
  168. package/common/types/invite.types.js.map +1 -0
  169. package/common/types/issuer-bank-account.types.d.ts +113 -0
  170. package/common/types/issuer-bank-account.types.js +81 -0
  171. package/common/types/issuer-bank-account.types.js.map +1 -0
  172. package/common/types/issuer-offering.types.d.ts +2236 -0
  173. package/common/types/issuer-offering.types.js +605 -0
  174. package/common/types/issuer-offering.types.js.map +1 -0
  175. package/common/types/issuer-payment-method.types.d.ts +1100 -0
  176. package/common/types/issuer-payment-method.types.js +311 -0
  177. package/common/types/issuer-payment-method.types.js.map +1 -0
  178. package/common/types/issuer.types.d.ts +539 -0
  179. package/common/types/issuer.types.js +275 -0
  180. package/common/types/issuer.types.js.map +1 -0
  181. package/common/types/job-item.types.d.ts +230 -0
  182. package/common/types/job-item.types.js +89 -0
  183. package/common/types/job-item.types.js.map +1 -0
  184. package/common/types/jobs.types.d.ts +296 -0
  185. package/common/types/jobs.types.js +150 -0
  186. package/common/types/jobs.types.js.map +1 -0
  187. package/common/types/kyb.types.d.ts +167 -0
  188. package/common/types/kyb.types.js +45 -0
  189. package/common/types/kyb.types.js.map +1 -0
  190. package/common/types/kyc.types.d.ts +2197 -0
  191. package/common/types/kyc.types.js +301 -0
  192. package/common/types/kyc.types.js.map +1 -0
  193. package/common/types/legal-entity.types.d.ts +676 -0
  194. package/common/types/legal-entity.types.js +151 -0
  195. package/common/types/legal-entity.types.js.map +1 -0
  196. package/common/types/login-history.types.d.ts +160 -0
  197. package/common/types/login-history.types.js +39 -0
  198. package/common/types/login-history.types.js.map +1 -0
  199. package/common/types/mail-template.types.d.ts +595 -0
  200. package/common/types/mail-template.types.js +401 -0
  201. package/common/types/mail-template.types.js.map +1 -0
  202. package/common/types/north-cap-integration.types.d.ts +1303 -0
  203. package/common/types/north-cap-integration.types.js +145 -0
  204. package/common/types/north-cap-integration.types.js.map +1 -0
  205. package/common/types/note.types.d.ts +216 -0
  206. package/common/types/note.types.js +82 -0
  207. package/common/types/note.types.js.map +1 -0
  208. package/common/types/notification.types.d.ts +2690 -0
  209. package/common/types/notification.types.js +411 -0
  210. package/common/types/notification.types.js.map +1 -0
  211. package/common/types/notion-api.types.d.ts +3626 -0
  212. package/common/types/notion-api.types.js +271 -0
  213. package/common/types/notion-api.types.js.map +1 -0
  214. package/common/types/notion-database.types.d.ts +191 -0
  215. package/common/types/notion-database.types.js +95 -0
  216. package/common/types/notion-database.types.js.map +1 -0
  217. package/common/types/notion-page.types.d.ts +3482 -0
  218. package/common/types/notion-page.types.js +208 -0
  219. package/common/types/notion-page.types.js.map +1 -0
  220. package/common/types/offering-reports.types.d.ts +525 -0
  221. package/common/types/offering-reports.types.js +111 -0
  222. package/common/types/offering-reports.types.js.map +1 -0
  223. package/common/types/offering-submission.types.d.ts +785 -0
  224. package/common/types/offering-submission.types.js +291 -0
  225. package/common/types/offering-submission.types.js.map +1 -0
  226. package/common/types/offering.types.d.ts +2859 -0
  227. package/common/types/offering.types.js +832 -0
  228. package/common/types/offering.types.js.map +1 -0
  229. package/common/types/page-revision.types.d.ts +74 -0
  230. package/common/types/page-revision.types.js +68 -0
  231. package/common/types/page-revision.types.js.map +1 -0
  232. package/common/types/page.types.d.ts +540 -0
  233. package/common/types/page.types.js +361 -0
  234. package/common/types/page.types.js.map +1 -0
  235. package/common/types/password.type.d.ts +2 -0
  236. package/common/types/password.type.js +14 -0
  237. package/common/types/password.type.js.map +1 -0
  238. package/common/types/payment-methods.types.d.ts +1165 -0
  239. package/common/types/payment-methods.types.js +381 -0
  240. package/common/types/payment-methods.types.js.map +1 -0
  241. package/common/types/phone.type.d.ts +12 -0
  242. package/common/types/phone.type.js +29 -0
  243. package/common/types/phone.type.js.map +1 -0
  244. package/common/types/portfolio.types.d.ts +185 -0
  245. package/common/types/portfolio.types.js +36 -0
  246. package/common/types/portfolio.types.js.map +1 -0
  247. package/common/types/privacy-policy-and-tos.types.d.ts +2 -0
  248. package/common/types/{privacy-policy-and-tos.types.ts → privacy-policy-and-tos.types.js} +1 -1
  249. package/common/types/privacy-policy-and-tos.types.js.map +1 -0
  250. package/common/types/queue.types.d.ts +22 -0
  251. package/common/types/queue.types.js +73 -0
  252. package/common/types/queue.types.js.map +1 -0
  253. package/common/types/registered-reps.types.d.ts +6 -0
  254. package/common/types/registered-reps.types.js +21 -0
  255. package/common/types/registered-reps.types.js.map +1 -0
  256. package/common/types/rejection-reasons.types.d.ts +35 -0
  257. package/common/types/rejection-reasons.types.js +49 -0
  258. package/common/types/rejection-reasons.types.js.map +1 -0
  259. package/common/types/reports.types.d.ts +345 -0
  260. package/common/types/reports.types.js +69 -0
  261. package/common/types/reports.types.js.map +1 -0
  262. package/common/types/review.types.d.ts +419 -0
  263. package/common/types/review.types.js +101 -0
  264. package/common/types/review.types.js.map +1 -0
  265. package/common/types/role.types.d.ts +30 -0
  266. package/common/types/role.types.js +21 -0
  267. package/common/types/role.types.js.map +1 -0
  268. package/common/types/secondary-customer.types.d.ts +586 -0
  269. package/common/types/secondary-customer.types.js +39 -0
  270. package/common/types/secondary-customer.types.js.map +1 -0
  271. package/common/types/secondary-issuer.types.d.ts +283 -0
  272. package/common/types/secondary-issuer.types.js +37 -0
  273. package/common/types/secondary-issuer.types.js.map +1 -0
  274. package/common/types/secondary-order.types.d.ts +508 -0
  275. package/common/types/secondary-order.types.js +40 -0
  276. package/common/types/secondary-order.types.js.map +1 -0
  277. package/common/types/secondary-security.types.d.ts +175 -0
  278. package/common/types/secondary-security.types.js +45 -0
  279. package/common/types/secondary-security.types.js.map +1 -0
  280. package/common/types/secondary-trade.entity.d.ts +16 -0
  281. package/common/types/secondary-trade.entity.js +12 -0
  282. package/common/types/secondary-trade.entity.js.map +1 -0
  283. package/common/types/secondary-trade.types.d.ts +465 -0
  284. package/common/types/secondary-trade.types.js +61 -0
  285. package/common/types/secondary-trade.types.js.map +1 -0
  286. package/common/types/secure-request.types.d.ts +171 -0
  287. package/common/types/secure-request.types.js +51 -0
  288. package/common/types/secure-request.types.js.map +1 -0
  289. package/common/types/signer.types.d.ts +3406 -0
  290. package/common/types/signer.types.js +532 -0
  291. package/common/types/signer.types.js.map +1 -0
  292. package/common/types/site-link.types.d.ts +875 -0
  293. package/common/types/site-link.types.js +126 -0
  294. package/common/types/site-link.types.js.map +1 -0
  295. package/common/types/site-settings.types.d.ts +1673 -0
  296. package/common/types/site-settings.types.js +500 -0
  297. package/common/types/site-settings.types.js.map +1 -0
  298. package/common/types/site.types.d.ts +1481 -0
  299. package/common/types/site.types.js +213 -0
  300. package/common/types/site.types.js.map +1 -0
  301. package/common/types/sms.types.d.ts +40 -0
  302. package/common/types/sms.types.js +27 -0
  303. package/common/types/sms.types.js.map +1 -0
  304. package/common/types/state-machine.types.d.ts +591 -0
  305. package/common/types/state-machine.types.js +144 -0
  306. package/common/types/state-machine.types.js.map +1 -0
  307. package/common/types/states.types.d.ts +77 -0
  308. package/common/types/states.types.js +137 -0
  309. package/common/types/states.types.js.map +1 -0
  310. package/common/types/subdoc-preview.types.d.ts +379 -0
  311. package/common/types/subdoc-preview.types.js +24 -0
  312. package/common/types/subdoc-preview.types.js.map +1 -0
  313. package/common/types/task.types.d.ts +545 -0
  314. package/common/types/task.types.js +214 -0
  315. package/common/types/task.types.js.map +1 -0
  316. package/common/types/trade-adjustment.type.d.ts +40 -0
  317. package/common/types/trade-adjustment.type.js +26 -0
  318. package/common/types/trade-adjustment.type.js.map +1 -0
  319. package/common/types/trade-line-item.types.d.ts +353 -0
  320. package/common/types/trade-line-item.types.js +103 -0
  321. package/common/types/trade-line-item.types.js.map +1 -0
  322. package/common/types/trade.types.d.ts +2012 -0
  323. package/common/types/trade.types.js +800 -0
  324. package/common/types/trade.types.js.map +1 -0
  325. package/common/types/transaction.types.d.ts +476 -0
  326. package/common/types/transaction.types.js +199 -0
  327. package/common/types/transaction.types.js.map +1 -0
  328. package/common/types/trusted-contact.types.d.ts +440 -0
  329. package/common/types/trusted-contact.types.js +95 -0
  330. package/common/types/trusted-contact.types.js.map +1 -0
  331. package/common/types/typography.types.d.ts +52 -0
  332. package/common/types/typography.types.js +67 -0
  333. package/common/types/typography.types.js.map +1 -0
  334. package/common/types/user-manual.types.d.ts +287 -0
  335. package/common/types/user-manual.types.js +192 -0
  336. package/common/types/user-manual.types.js.map +1 -0
  337. package/common/types/user-setting.types.d.ts +273 -0
  338. package/common/types/user-setting.types.js +85 -0
  339. package/common/types/user-setting.types.js.map +1 -0
  340. package/common/types/user.types.d.ts +1977 -0
  341. package/common/types/user.types.js +225 -0
  342. package/common/types/user.types.js.map +1 -0
  343. package/common/types/webhook.types.d.ts +10829 -0
  344. package/common/types/webhook.types.js +658 -0
  345. package/common/types/webhook.types.js.map +1 -0
  346. package/common/types/zapier.types.d.ts +126 -0
  347. package/common/types/zapier.types.js +247 -0
  348. package/common/types/zapier.types.js.map +1 -0
  349. package/common/types/zip.type.d.ts +35 -0
  350. package/common/types/zip.type.js +28 -0
  351. package/common/types/zip.type.js.map +1 -0
  352. package/contracts/clients/accounts/index.d.ts +308 -0
  353. package/contracts/clients/accounts/index.js +43 -0
  354. package/contracts/clients/accounts/index.js.map +1 -0
  355. package/contracts/clients/aic/index.d.ts +280 -0
  356. package/contracts/clients/aic/index.js +47 -0
  357. package/contracts/clients/aic/index.js.map +1 -0
  358. package/contracts/clients/api-key-logs/index.d.ts +287 -0
  359. package/contracts/clients/api-key-logs/index.js +37 -0
  360. package/contracts/clients/api-key-logs/index.js.map +1 -0
  361. package/contracts/clients/api-keys/index.d.ts +374 -0
  362. package/contracts/clients/api-keys/index.js +59 -0
  363. package/contracts/clients/api-keys/index.js.map +1 -0
  364. package/contracts/clients/assets/index.d.ts +1050 -0
  365. package/contracts/clients/assets/index.js +80 -0
  366. package/contracts/clients/assets/index.js.map +1 -0
  367. package/contracts/clients/auth/index.d.ts +236 -0
  368. package/contracts/clients/auth/index.js +38 -0
  369. package/contracts/clients/auth/index.js.map +1 -0
  370. package/contracts/clients/cart/index.d.ts +229 -0
  371. package/contracts/clients/cart/index.js +63 -0
  372. package/contracts/clients/cart/index.js.map +1 -0
  373. package/contracts/clients/csv/index.d.ts +1988 -0
  374. package/contracts/clients/csv/index.js +96 -0
  375. package/contracts/clients/csv/index.js.map +1 -0
  376. package/contracts/clients/files/index.d.ts +552 -0
  377. package/contracts/clients/files/index.js +142 -0
  378. package/contracts/clients/files/index.js.map +1 -0
  379. package/contracts/clients/files-public/index.d.ts +552 -0
  380. package/contracts/clients/files-public/index.js +142 -0
  381. package/contracts/clients/files-public/index.js.map +1 -0
  382. package/contracts/clients/index.d.ts +15678 -0
  383. package/contracts/clients/index.js +58 -0
  384. package/contracts/clients/index.js.map +1 -0
  385. package/contracts/clients/individuals/index.d.ts +3575 -0
  386. package/contracts/clients/individuals/index.js +74 -0
  387. package/contracts/clients/individuals/index.js.map +1 -0
  388. package/contracts/clients/investor-accounts/index.d.ts +339 -0
  389. package/contracts/clients/investor-accounts/index.js +73 -0
  390. package/contracts/clients/investor-accounts/index.js.map +1 -0
  391. package/contracts/clients/issuer-payment-methods/index.d.ts +276 -0
  392. package/contracts/clients/issuer-payment-methods/index.js +24 -0
  393. package/contracts/clients/issuer-payment-methods/index.js.map +1 -0
  394. package/contracts/clients/issuers/index.d.ts +449 -0
  395. package/contracts/clients/issuers/index.js +75 -0
  396. package/contracts/clients/issuers/index.js.map +1 -0
  397. package/contracts/clients/kyc/index.d.ts +345 -0
  398. package/contracts/clients/kyc/index.js +49 -0
  399. package/contracts/clients/kyc/index.js.map +1 -0
  400. package/contracts/clients/legal-entities/index.d.ts +887 -0
  401. package/contracts/clients/legal-entities/index.js +74 -0
  402. package/contracts/clients/legal-entities/index.js.map +1 -0
  403. package/contracts/clients/offerings/index.d.ts +1068 -0
  404. package/contracts/clients/offerings/index.js +95 -0
  405. package/contracts/clients/offerings/index.js.map +1 -0
  406. package/contracts/clients/payment-methods/index.d.ts +456 -0
  407. package/contracts/clients/payment-methods/index.js +68 -0
  408. package/contracts/clients/payment-methods/index.js.map +1 -0
  409. package/contracts/clients/review/index.d.ts +85 -0
  410. package/contracts/clients/review/index.js +27 -0
  411. package/contracts/clients/review/index.js.map +1 -0
  412. package/contracts/clients/secure-requests/index.d.ts +100 -0
  413. package/contracts/clients/secure-requests/index.js +22 -0
  414. package/contracts/clients/secure-requests/index.js.map +1 -0
  415. package/contracts/clients/sites/index.d.ts +657 -0
  416. package/contracts/clients/sites/index.js +40 -0
  417. package/contracts/clients/sites/index.js.map +1 -0
  418. package/contracts/clients/trade-line-items/index.d.ts +216 -0
  419. package/contracts/clients/trade-line-items/index.js +47 -0
  420. package/contracts/clients/trade-line-items/index.js.map +1 -0
  421. package/contracts/clients/trades/index.d.ts +871 -0
  422. package/contracts/clients/trades/index.js +156 -0
  423. package/contracts/clients/trades/index.js.map +1 -0
  424. package/contracts/clients/transactions/index.d.ts +88 -0
  425. package/contracts/clients/transactions/index.js +25 -0
  426. package/contracts/clients/transactions/index.js.map +1 -0
  427. package/contracts/clients/webhooks/index.d.ts +506 -0
  428. package/contracts/clients/webhooks/index.js +118 -0
  429. package/contracts/clients/webhooks/index.js.map +1 -0
  430. package/package.json +27 -36
  431. package/common/helpers/index.ts +0 -59
  432. package/common/types/account-contact.types.ts +0 -98
  433. package/common/types/account-detail.types.ts +0 -27
  434. package/common/types/account-integration.types.ts +0 -143
  435. package/common/types/account-manager.types.ts +0 -124
  436. package/common/types/account.types.ts +0 -296
  437. package/common/types/activity.types.ts +0 -274
  438. package/common/types/address.types.ts +0 -41
  439. package/common/types/aic.types.ts +0 -246
  440. package/common/types/aml.types.ts +0 -18
  441. package/common/types/api-key-logs.types.ts +0 -66
  442. package/common/types/api-keys.types.ts +0 -69
  443. package/common/types/asset.types.ts +0 -338
  444. package/common/types/auth.types.ts +0 -370
  445. package/common/types/batch-jobs.types.ts +0 -151
  446. package/common/types/bonus-tier.types.ts +0 -147
  447. package/common/types/cart.types.ts +0 -18
  448. package/common/types/checklist-items.types.ts +0 -70
  449. package/common/types/checklist.types.ts +0 -97
  450. package/common/types/common.types.ts +0 -1520
  451. package/common/types/comply-advantage-api.types.ts +0 -316
  452. package/common/types/comply-advantage.types.ts +0 -25
  453. package/common/types/contact-us.types.ts +0 -107
  454. package/common/types/countries.types.ts +0 -375
  455. package/common/types/covered-person.types.ts +0 -274
  456. package/common/types/dashboard.types.ts +0 -799
  457. package/common/types/data-record.types.ts +0 -325
  458. package/common/types/data-room.types.ts +0 -242
  459. package/common/types/default-theme-config.types.ts +0 -87
  460. package/common/types/disbursement-adjustment.types.ts +0 -32
  461. package/common/types/disbursement-approval-user.types.ts +0 -100
  462. package/common/types/disbursement-review.types.ts +0 -110
  463. package/common/types/disbursement-transaction.types.ts +0 -72
  464. package/common/types/disbursements.types.ts +0 -310
  465. package/common/types/domain-filter.types.ts +0 -55
  466. package/common/types/email-theme.types.ts +0 -442
  467. package/common/types/entity.types.ts +0 -15
  468. package/common/types/error-responses.types.ts +0 -135
  469. package/common/types/escrow-account.types.ts +0 -104
  470. package/common/types/exchange-api-key.types.ts +0 -121
  471. package/common/types/exchange-import.types.ts +0 -36
  472. package/common/types/exchange-provider.types.ts +0 -329
  473. package/common/types/file.types.ts +0 -461
  474. package/common/types/health.types.ts +0 -29
  475. package/common/types/individuals.types.ts +0 -554
  476. package/common/types/investor-account.types.ts +0 -1239
  477. package/common/types/investors-offering.types.ts +0 -65
  478. package/common/types/invite.types.ts +0 -133
  479. package/common/types/issuer-bank-account.types.ts +0 -107
  480. package/common/types/issuer-offering.types.ts +0 -306
  481. package/common/types/issuer-payment-method.types.ts +0 -341
  482. package/common/types/issuer.types.ts +0 -312
  483. package/common/types/job-item.types.ts +0 -119
  484. package/common/types/jobs.types.ts +0 -171
  485. package/common/types/kyb.types.ts +0 -53
  486. package/common/types/kyc.types.ts +0 -188
  487. package/common/types/legal-entity.types.ts +0 -185
  488. package/common/types/login-history.types.ts +0 -46
  489. package/common/types/mail-template.types.ts +0 -436
  490. package/common/types/north-cap-integration.types.ts +0 -190
  491. package/common/types/note.types.ts +0 -109
  492. package/common/types/notification.types.ts +0 -58
  493. package/common/types/notion-api.types.ts +0 -374
  494. package/common/types/notion-database.types.ts +0 -125
  495. package/common/types/notion-page.types.ts +0 -267
  496. package/common/types/offering-reports.types.ts +0 -153
  497. package/common/types/offering-submission.types.ts +0 -314
  498. package/common/types/offering.types.ts +0 -590
  499. package/common/types/page-revision.types.ts +0 -86
  500. package/common/types/page.types.ts +0 -436
  501. package/common/types/password.type.ts +0 -15
  502. package/common/types/payment-methods.types.ts +0 -298
  503. package/common/types/phone.type.ts +0 -27
  504. package/common/types/portfolio.types.ts +0 -50
  505. package/common/types/queue.types.ts +0 -112
  506. package/common/types/registered-reps.types.ts +0 -25
  507. package/common/types/rejection-reasons.types.ts +0 -56
  508. package/common/types/reminder-config.types.ts +0 -40
  509. package/common/types/review.types.ts +0 -133
  510. package/common/types/role.types.ts +0 -26
  511. package/common/types/secondary-customer.types.ts +0 -66
  512. package/common/types/secondary-issuer.types.ts +0 -50
  513. package/common/types/secondary-order.types.ts +0 -58
  514. package/common/types/secondary-security.types.ts +0 -60
  515. package/common/types/secondary-trade.entity.ts +0 -16
  516. package/common/types/secondary-trade.types.ts +0 -95
  517. package/common/types/secure-request.types.ts +0 -68
  518. package/common/types/signer.types.ts +0 -651
  519. package/common/types/site-link.types.ts +0 -166
  520. package/common/types/site-settings.types.ts +0 -726
  521. package/common/types/site.types.ts +0 -270
  522. package/common/types/sms.types.ts +0 -30
  523. package/common/types/state-machine.types.ts +0 -177
  524. package/common/types/states.types.ts +0 -163
  525. package/common/types/subdoc-preview.types.ts +0 -35
  526. package/common/types/task.types.ts +0 -258
  527. package/common/types/trade-adjustment.type.ts +0 -33
  528. package/common/types/trade-line-item.type.ts +0 -132
  529. package/common/types/trade.types.ts +0 -929
  530. package/common/types/transaction.types.ts +0 -198
  531. package/common/types/trusted-contact.types.ts +0 -122
  532. package/common/types/typography.types.ts +0 -75
  533. package/common/types/user-manual.types.ts +0 -290
  534. package/common/types/user-setting.types.ts +0 -133
  535. package/common/types/user.types.ts +0 -320
  536. package/common/types/webhook.types.ts +0 -588
  537. package/common/types/zip.type.ts +0 -36
  538. package/contracts/clients/accounts/index.ts +0 -61
  539. package/contracts/clients/aic/index.ts +0 -59
  540. package/contracts/clients/api-key-logs/index.ts +0 -53
  541. package/contracts/clients/api-keys/index.ts +0 -73
  542. package/contracts/clients/assets/index.ts +0 -102
  543. package/contracts/clients/auth/index.ts +0 -50
  544. package/contracts/clients/files/index.ts +0 -166
  545. package/contracts/clients/files-public/index.ts +0 -166
  546. package/contracts/clients/index.ts +0 -44
  547. package/contracts/clients/individuals/index.ts +0 -93
  548. package/contracts/clients/investor-accounts/index.ts +0 -93
  549. package/contracts/clients/issuers/index.ts +0 -94
  550. package/contracts/clients/legal-entities/index.ts +0 -93
  551. package/contracts/clients/offerings/index.ts +0 -117
  552. package/contracts/clients/secure-requests/index.ts +0 -34
  553. package/contracts/clients/sites/index.ts +0 -56
  554. package/contracts/clients/trades/index.ts +0 -122
  555. package/contracts/compliance/account-contacts/index.ts +0 -82
  556. package/contracts/compliance/account-managers/index.ts +0 -142
  557. package/contracts/compliance/accounts/index.ts +0 -187
  558. package/contracts/compliance/activities/index.ts +0 -55
  559. package/contracts/compliance/aic/index.ts +0 -60
  560. package/contracts/compliance/api-keys/index.ts +0 -91
  561. package/contracts/compliance/assets/index.ts +0 -122
  562. package/contracts/compliance/auth/index.ts +0 -134
  563. package/contracts/compliance/batch-jobs/index.ts +0 -62
  564. package/contracts/compliance/bonus-tiers/index.ts +0 -55
  565. package/contracts/compliance/checklist/index.ts +0 -87
  566. package/contracts/compliance/checklist-items/index.ts +0 -86
  567. package/contracts/compliance/covered-persons/index.ts +0 -97
  568. package/contracts/compliance/dashboard/index.ts +0 -111
  569. package/contracts/compliance/data-records/index.ts +0 -116
  570. package/contracts/compliance/data-rooms/index.ts +0 -113
  571. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  572. package/contracts/compliance/disbursement/index.ts +0 -165
  573. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  574. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  575. package/contracts/compliance/domain-filters/index.ts +0 -117
  576. package/contracts/compliance/email-themes/index.ts +0 -284
  577. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  578. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  579. package/contracts/compliance/exchange-imports/index.ts +0 -137
  580. package/contracts/compliance/files/index.ts +0 -267
  581. package/contracts/compliance/files-public/index.ts +0 -188
  582. package/contracts/compliance/health/index.ts +0 -26
  583. package/contracts/compliance/index.ts +0 -147
  584. package/contracts/compliance/individuals/index.ts +0 -57
  585. package/contracts/compliance/investor-accounts/index.ts +0 -141
  586. package/contracts/compliance/invites/index.ts +0 -137
  587. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  588. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  589. package/contracts/compliance/issuers/index.ts +0 -97
  590. package/contracts/compliance/job-items/index.ts +0 -58
  591. package/contracts/compliance/jobs/index.ts +0 -59
  592. package/contracts/compliance/kyb/index.ts +0 -54
  593. package/contracts/compliance/kyc/index.ts +0 -77
  594. package/contracts/compliance/legal-entities/index.ts +0 -57
  595. package/contracts/compliance/login-histories/index.ts +0 -37
  596. package/contracts/compliance/notes/index.ts +0 -69
  597. package/contracts/compliance/notion-databases/index.ts +0 -107
  598. package/contracts/compliance/notion-pages/index.ts +0 -105
  599. package/contracts/compliance/offering-reports/index.ts +0 -149
  600. package/contracts/compliance/offerings/index.ts +0 -233
  601. package/contracts/compliance/pages/index.ts +0 -178
  602. package/contracts/compliance/payment-methods/index.ts +0 -57
  603. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  604. package/contracts/compliance/review/index.ts +0 -169
  605. package/contracts/compliance/roles/index.ts +0 -34
  606. package/contracts/compliance/secondary-customers/index.ts +0 -77
  607. package/contracts/compliance/secondary-orders/index.ts +0 -60
  608. package/contracts/compliance/secondary-trades/index.ts +0 -100
  609. package/contracts/compliance/secure-requests/index.ts +0 -54
  610. package/contracts/compliance/signer/index.ts +0 -369
  611. package/contracts/compliance/site-links/index.ts +0 -128
  612. package/contracts/compliance/site-settings/index.ts +0 -669
  613. package/contracts/compliance/sites/index.ts +0 -56
  614. package/contracts/compliance/state-machine/index.ts +0 -94
  615. package/contracts/compliance/tasks/index.ts +0 -91
  616. package/contracts/compliance/third-parties/index.ts +0 -52
  617. package/contracts/compliance/trade-line-items/index.ts +0 -59
  618. package/contracts/compliance/trades/index.ts +0 -230
  619. package/contracts/compliance/transactions/index.ts +0 -161
  620. package/contracts/compliance/user-manuals/index.ts +0 -271
  621. package/contracts/compliance/user-settings/index.ts +0 -189
  622. package/contracts/compliance/users/index.ts +0 -200
  623. package/contracts/compliance/webhooks/index.ts +0 -41
  624. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  625. package/contracts/compliance-apikey/index.ts +0 -14
  626. package/contracts/index.ts +0 -6
  627. package/contracts/investors/account-contacts/index.ts +0 -58
  628. package/contracts/investors/aic/index.ts +0 -59
  629. package/contracts/investors/assets/index.ts +0 -61
  630. package/contracts/investors/auth/index.ts +0 -116
  631. package/contracts/investors/bonus-tiers/index.ts +0 -37
  632. package/contracts/investors/cart/index.ts +0 -75
  633. package/contracts/investors/contact-us/index.ts +0 -48
  634. package/contracts/investors/data-records/index.ts +0 -113
  635. package/contracts/investors/data-rooms/index.ts +0 -96
  636. package/contracts/investors/files/index.ts +0 -167
  637. package/contracts/investors/files-public/index.ts +0 -185
  638. package/contracts/investors/index.ts +0 -72
  639. package/contracts/investors/individuals/index.ts +0 -99
  640. package/contracts/investors/investor-accounts/index.ts +0 -110
  641. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  642. package/contracts/investors/issuers/index.ts +0 -30
  643. package/contracts/investors/legal-entities/index.ts +0 -93
  644. package/contracts/investors/notes/index.ts +0 -69
  645. package/contracts/investors/offerings/index.ts +0 -93
  646. package/contracts/investors/pages/index.ts +0 -88
  647. package/contracts/investors/payment-methods/index.ts +0 -149
  648. package/contracts/investors/portfolios/index.ts +0 -53
  649. package/contracts/investors/sites/index.ts +0 -96
  650. package/contracts/investors/tasks/index.ts +0 -111
  651. package/contracts/investors/trade-line-items/index.ts +0 -75
  652. package/contracts/investors/trades/index.ts +0 -114
  653. package/contracts/investors/transactions/index.ts +0 -37
  654. package/contracts/investors/trusted-contacts/index.ts +0 -93
  655. package/contracts/investors/user-manuals/index.ts +0 -62
  656. package/contracts/investors/user-settings/index.ts +0 -170
  657. package/contracts/investors/users/index.ts +0 -45
  658. package/contracts/investors/webhooks/index.ts +0 -30
  659. package/contracts/issuers/account-contacts/index.ts +0 -76
  660. package/contracts/issuers/account-integrations/index.ts +0 -97
  661. package/contracts/issuers/accounts/index.ts +0 -97
  662. package/contracts/issuers/activities/index.ts +0 -54
  663. package/contracts/issuers/aic/index.ts +0 -39
  664. package/contracts/issuers/api-key-logs/index.ts +0 -53
  665. package/contracts/issuers/api-keys/index.ts +0 -93
  666. package/contracts/issuers/assets/index.ts +0 -122
  667. package/contracts/issuers/auth/index.ts +0 -152
  668. package/contracts/issuers/bonus-tiers/index.ts +0 -55
  669. package/contracts/issuers/contact-us/index.ts +0 -48
  670. package/contracts/issuers/covered-persons/index.ts +0 -136
  671. package/contracts/issuers/dashboard/index.ts +0 -72
  672. package/contracts/issuers/data-records/index.ts +0 -257
  673. package/contracts/issuers/data-rooms/index.ts +0 -134
  674. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  675. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  676. package/contracts/issuers/disbursements/index.ts +0 -153
  677. package/contracts/issuers/email-themes/index.ts +0 -242
  678. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  679. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  680. package/contracts/issuers/files/index.ts +0 -166
  681. package/contracts/issuers/files-public/index.ts +0 -166
  682. package/contracts/issuers/health/index.ts +0 -24
  683. package/contracts/issuers/index.ts +0 -112
  684. package/contracts/issuers/investor-accounts/index.ts +0 -148
  685. package/contracts/issuers/invites/index.ts +0 -129
  686. package/contracts/issuers/issuer/index.ts +0 -94
  687. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  688. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  689. package/contracts/issuers/kyc/index.ts +0 -38
  690. package/contracts/issuers/login-histories/index.ts +0 -51
  691. package/contracts/issuers/notes/index.ts +0 -69
  692. package/contracts/issuers/offerings/index.ts +0 -206
  693. package/contracts/issuers/pages/index.ts +0 -138
  694. package/contracts/issuers/payment-methods/index.ts +0 -61
  695. package/contracts/issuers/portfolios/index.ts +0 -36
  696. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  697. package/contracts/issuers/review/index.ts +0 -63
  698. package/contracts/issuers/secondary-customers/index.ts +0 -55
  699. package/contracts/issuers/secondary-orders/index.ts +0 -57
  700. package/contracts/issuers/secondary-trades/index.ts +0 -57
  701. package/contracts/issuers/secure-requests/index.ts +0 -34
  702. package/contracts/issuers/site-links/index.ts +0 -116
  703. package/contracts/issuers/site-settings/index.ts +0 -585
  704. package/contracts/issuers/sites/index.ts +0 -32
  705. package/contracts/issuers/tasks/index.ts +0 -111
  706. package/contracts/issuers/trades/index.ts +0 -132
  707. package/contracts/issuers/transactions/index.ts +0 -158
  708. package/contracts/issuers/user-manuals/index.ts +0 -62
  709. package/contracts/issuers/user-settings/index.ts +0 -170
  710. package/contracts/issuers/users/index.ts +0 -126
  711. package/contracts/secondaries/accounts/index.ts +0 -58
  712. package/contracts/secondaries/index.ts +0 -23
  713. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  714. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  715. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  716. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  717. package/contracts/secondaries/secondary-trades/index.ts +0 -56
  718. /package/common/types/{investorAccountIdSchema.type.ts → investorAccountIdSchema.type.d.ts} +0 -0
@@ -1,270 +0,0 @@
1
- import { z } from 'zod';
2
- import { IBaseEntity } from './entity.types';
3
- import { TypeID } from 'typeid-js';
4
- import {
5
- AccountStatus,
6
- AccountZod,
7
- IPaginationMeta,
8
- UrlSchema,
9
- } from './common.types';
10
- import { accountIdSchema } from './account.types';
11
- import { fileIdSchema } from './file.types';
12
- import { IAsset } from './asset.types';
13
- import { GetInvestorAccountTypeSettingsZod } from './site-settings.types';
14
- import { InvestorPageResponseZod, pageIdSchema } from './page.types';
15
- import { ThemeFileType } from './common.types';
16
- import { IAccountContact } from './account-contact.types';
17
-
18
- export const sitesIdSchema = z.string().refine(
19
- (value) => {
20
- try {
21
- const tid = TypeID.fromString(value);
22
- return tid.getType() === 'site';
23
- } catch {
24
- return false;
25
- }
26
- },
27
- {
28
- message: `Invalid site ID format. Must be a valid TypeID with "site" prefix. Example: site_01j5y5ghx5fg68d663j1fvy2x7`,
29
- },
30
- );
31
-
32
- export const SiteZod = IBaseEntity.extend({
33
- id: sitesIdSchema,
34
- accountId: accountIdSchema.nullable(),
35
- account: AccountZod.nullable().optional(),
36
- title: z.string().nullable(),
37
- description: z.string().nullable(),
38
- keywords: z.string().nullable(),
39
- logo: z.lazy(() => fileIdSchema).nullable(),
40
- favicon: z.lazy(() => fileIdSchema).nullable(),
41
- backgroundImage: z.lazy(() => fileIdSchema).nullable(),
42
- domain: z.string(),
43
- customDomain: z.string().nullable(),
44
- enabled: z.boolean().default(false),
45
- message: z.string().nullable(),
46
- withPersonaThemeId: z.string().nullable(),
47
- gaIds: z.array(z.string()).nullable(),
48
- investorAccountTypes: z
49
- .object({
50
- individual: z.boolean(),
51
- joint: z.boolean(),
52
- entity: z.boolean(),
53
- retirement: z.boolean(),
54
- })
55
- .nullable(),
56
- tagline: z.string().nullable(),
57
- supportEmail: z.string(),
58
- senderEmail: z.string(),
59
- trackingPixelCode: z.string().nullable(),
60
- conversionPixelCode: z.string().nullable(),
61
- demoEmail: z.string().nullable(),
62
- demoPassword: z.string().nullable(),
63
- publicOfferings: z.boolean().default(false),
64
- publicPages: z.boolean().default(false),
65
- publicDataRooms: z.boolean().default(false),
66
- });
67
- export type SiteZod = z.infer<typeof SiteZod>;
68
-
69
- export const SitesParamSchema = z.object({
70
- id: sitesIdSchema,
71
- });
72
-
73
- export const SitesFiltersZod = z.object({
74
- url: z.string().optional(),
75
- accountId: accountIdSchema.optional(),
76
- enabled: z.preprocess(
77
- (val) =>
78
- val === 'true' || val === '1'
79
- ? true
80
- : val === 'false' || val === '0'
81
- ? false
82
- : val,
83
- z.boolean().optional(),
84
- ),
85
- });
86
-
87
- const sitesInclude = z.enum(['account']);
88
- export const SitesIncludeQuery = z.object({
89
- include: z
90
- .string()
91
- .optional()
92
- .transform((str) => (str ? str.split(',') : []))
93
- .refine(
94
- (includes) =>
95
- includes.every((include) =>
96
- sitesInclude.options.includes(include as any),
97
- ),
98
- {
99
- message: `Invalid include option provided. Valid options are: ${sitesInclude.options.join(',')}`,
100
- },
101
- )
102
- .openapi({
103
- example: `${sitesInclude.options.join(',')}`,
104
- }),
105
- });
106
- export interface SitesIncludeQuery extends z.infer<typeof SitesIncludeQuery> {}
107
-
108
- export const SitesPaginated = z.object({
109
- items: z.array(SiteZod),
110
- meta: IPaginationMeta,
111
- });
112
-
113
- /**
114
- * Zod schema for validating a DNS CNAME record response from Cloudflare's API.
115
- *
116
- * This schema defines the structure of a CNAME DNS record response from Cloudflare,
117
- * including metadata, settings, and record-specific details. It is based on the API
118
- * specification for DNS records.
119
- *
120
- * For more details on the API response structure, see:
121
- * @see {@link https://developers.cloudflare.com/api/resources/dns/subresources/records/models/cname_record/#(schema) Cloudflare CNAME Record Schema Documentation
122
- *
123
- ***/
124
- export const CloudflareRecordResponse = z.object({
125
- comment: z.string().optional(), // Comments or notes about the DNS record. This field has no effect on DNS responses.
126
- content: z.string().optional(), // A valid hostname. Must not match the record's name.
127
- name: z.string().optional(), // DNS record name (or @ for the zone apex) in Punycode.
128
- proxied: z.boolean().optional(), // Whether the record is receiving the performance and security benefits of Cloudflare.
129
- settings: z
130
- .object({
131
- flatten_cname: z.boolean().optional(), // If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
132
- ipv4_only: z.boolean().optional(), // When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
133
- ipv6_only: z.boolean().optional(), // When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
134
- })
135
- .optional(), // Settings for the DNS record.
136
- tags: z.array(z.string().optional()), // Custom tags for the DNS record. This field has no effect on DNS responses.
137
- ttl: z.number().optional(), // Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
138
- type: z.enum(['CNAME']).optional(), // Record type.
139
- id: z.string(), // Identifier
140
- created_on: z.string(), // When the record was created.
141
- meta: z.unknown().optional(), // Extra Cloudflare-specific information about the record,
142
- modified_on: z.string(), // When the record was last modified.
143
- proxiable: z.boolean(), // Whether the record can be proxied by Cloudflare or not.
144
- comment_modified_on: z.string().optional(), // When the record comment was last modified. Omitted if there is no comment.
145
- tags_modified_on: z.string().optional(), // When the record tags were last modified. Omitted if there are no tags.
146
- });
147
- export type CloudflareRecordResponse = z.infer<typeof CloudflareRecordResponse>;
148
-
149
- /**
150
- * Zod schema for validating Cloudflare API response information.
151
- *
152
- * This schema defines the structure of the response info object from Cloudflare APIs, including
153
- * a numeric code and a message string.
154
- *
155
- * @see {@link https://developers.cloudflare.com/api/resources/$shared/models/response_info/#(schema) Cloudflare API Response Info Schema}
156
- */
157
- export const CloudflareResponseInfoZod = z.object({
158
- code: z.number(),
159
- message: z.string(),
160
- });
161
-
162
- export type CloudflareResponseInfoZod = z.infer<
163
- typeof CloudflareResponseInfoZod
164
- >;
165
-
166
- /**
167
- * Zod schema for validating a response from the Cloudflare DNS Records API.
168
- *
169
- * For more details on the API response structure, see the Cloudflare documentation:
170
- * @see {@link https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/create/ Cloudflare DNS Records API - Create Method}
171
- */
172
- export const CloudflareResponseZod = z.object({
173
- errors: z.array(CloudflareResponseInfoZod),
174
- messages: z.array(CloudflareResponseInfoZod),
175
- success: z.boolean(),
176
- result: CloudflareRecordResponse,
177
- });
178
- export type CloudflareResponseZod = z.infer<typeof CloudflareResponseZod>;
179
-
180
- export enum OperationType {
181
- CREATE = 'CREATE',
182
- UPDATE = 'UPDATE',
183
- RETRIEVE = 'RETRIEVE',
184
- }
185
-
186
- export const SiteUrlsZod = z.object({
187
- backgroundImage: z.string().nullable(),
188
- favicon: z.string().nullable(),
189
- logo: z.string().nullable(),
190
- title: z.string().nullable(),
191
- description: z.string().nullable(),
192
- keywords: z.string().nullable(),
193
- withPersonaThemeId: z.string().nullable(),
194
- siteId: z.string().nullable(),
195
- tagline: z.string().nullable(),
196
- });
197
- export type SiteUrlsZod = z.infer<typeof SiteUrlsZod>;
198
-
199
- export const DownloadThemeFileZod = z.object({
200
- type: z.nativeEnum(ThemeFileType).openapi({ example: ThemeFileType.LIGHT }),
201
- url: UrlSchema,
202
- });
203
-
204
- export type DownloadThemeFileZod = z.infer<typeof DownloadThemeFileZod>;
205
-
206
- export const SiteUrlZod = z.object({
207
- url: UrlSchema,
208
- });
209
- export type SiteUrlZod = z.infer<typeof SiteUrlZod>;
210
-
211
- export const VerifyPasswordZod = z.object({
212
- password: z.string(),
213
- });
214
- export type VerifyPasswordZod = z.infer<typeof VerifyPasswordZod>;
215
-
216
- export const VerifyPasswordResponseZod = z.object({
217
- success: z.boolean(),
218
- });
219
- export type VerifyPasswordResponseZod = z.infer<
220
- typeof VerifyPasswordResponseZod
221
- >;
222
-
223
- export const SiteConfigsZod = z.object({
224
- id: z.string(),
225
- name: z.string(),
226
- accountId: accountIdSchema,
227
- withPersonaThemeId: z.string().nullable(),
228
- gaIds: z.array(z.string()).nullable(),
229
- heroAsset: z.lazy(() => IAsset).nullable(),
230
- investorAccountSettings: GetInvestorAccountTypeSettingsZod.nullable(),
231
- tagline: z.string().nullable(),
232
- senderEmail: z.string(),
233
- landingPageId: pageIdSchema.nullable(),
234
- landingPage: z.lazy(() => InvestorPageResponseZod).nullable(),
235
- trackingPixelCode: z.string().nullable(),
236
- conversionPixelCode: z.string().nullable(),
237
- publicOfferings: z.boolean().default(false),
238
- publicPages: z.boolean().default(false),
239
- publicDataRooms: z.boolean().default(false),
240
- themeCss: z.string().nullable().optional(),
241
- demoEmail: z.string().nullable(),
242
- demoPassword: z.string().nullable(),
243
- accountContacts: z.array(IAccountContact).nullable().optional(),
244
- status: z.nativeEnum(AccountStatus),
245
- });
246
- export type SiteConfigsZod = z.infer<typeof SiteConfigsZod>;
247
-
248
- /**
249
- * Cloudflare Turnstile server-side validation response schema.
250
- * Handles both successful and failed responses.
251
- *
252
- * @see {@link https://developers.cloudflare.com/turnstile/get-started/server-side-validation/ Cloudflare Turnstile Server-side Validation}
253
- */
254
- export const CloudflareTurnstileResponseZod = z.object({
255
- success: z.boolean(),
256
- 'error-codes': z.array(z.string()).optional(),
257
- challenge_ts: z.string().datetime().optional(),
258
- hostname: z.string().optional(),
259
- action: z.string().optional(),
260
- cdata: z.string().optional(),
261
- metadata: z
262
- .object({
263
- ephemeral_id: z.string(),
264
- })
265
- .optional(),
266
- });
267
-
268
- export type CloudflareTurnstileResponseZod = z.infer<
269
- typeof CloudflareTurnstileResponseZod
270
- >;
@@ -1,30 +0,0 @@
1
- import { z } from 'zod';
2
-
3
- /**
4
- * @description list of supported country codes.. Informs supported sms functionality.
5
- */
6
- export const SupportedCountryCodes = ['US'] as const;
7
-
8
- /**
9
- * @description list of supported country schemas. Informs supported sms functionality.
10
- */
11
- export const SupportedCountryCodesSchema = z.enum([...SupportedCountryCodes]);
12
-
13
- /**
14
- * @description list of supported two factor methods.
15
- */
16
- export enum TwoFactorMethod {
17
- NONE = 'NONE',
18
- AUTHENTICATOR = 'AUTHENTICATOR',
19
- SMS = 'SMS',
20
- }
21
-
22
- export const PhoneNumberData = z.object({
23
- countryCallingCode: z.string(),
24
- country: z.string(),
25
- nationalNumber: z.string(),
26
- number: z.string(),
27
- formatNational: z.string(),
28
- formatInternational: z.string(),
29
- });
30
- export type PhoneNumberData = z.infer<typeof PhoneNumberData>;
@@ -1,177 +0,0 @@
1
- import { z } from 'zod';
2
- import { AicZod } from './aic.types';
3
- import { FileZod } from './file.types';
4
- import {
5
- TradeStatus,
6
- TransactionType,
7
- TransactionStatus,
8
- } from './common.types';
9
- import { typeid } from 'typeid-js';
10
-
11
- export enum StateMachineType {
12
- AIC_VALIDATION = 'AIC_VALIDATION',
13
- FILE_REVIEW = 'FILE_REVIEW',
14
- FINALIZE_TRADE = 'FINALIZE_TRADE',
15
- }
16
-
17
- export enum StateMachineEvents {
18
- START = 'START',
19
- STEP_FORWARD = 'STEP_FORWARD',
20
- COMPLETE = 'COMPLETE',
21
- }
22
-
23
- export enum StateMachineTags {
24
- CAN_PROGRESS = 'CAN_PROGRESS',
25
- }
26
-
27
- export const BaseStateMachineStates = {
28
- IDLE: 'IDLE',
29
- COMPLETED: 'COMPLETED',
30
- DONE: 'DONE',
31
- } as const;
32
-
33
- export type BaseStateMachineStatesType = typeof BaseStateMachineStates;
34
-
35
- // Simplified schema for FINALIZE_TRADE state machine payload
36
- // Frontend sends minimal data, we transform it to Trade entity structure
37
- const FinalizeTradePayloadZod = z
38
- .object({
39
- txnChargedAmount: z.number(),
40
- totalAmount: z.number().nullable().optional(),
41
- tradeStatus: z.nativeEnum(TradeStatus),
42
- transactions: z
43
- .array(
44
- z.object({
45
- type: z.nativeEnum(TransactionType),
46
- status: z.nativeEnum(TransactionStatus),
47
- amount: z.number(),
48
- refundTransactions: z
49
- .array(
50
- z.object({
51
- type: z.nativeEnum(TransactionType),
52
- status: z.nativeEnum(TransactionStatus),
53
- amount: z.number(),
54
- }),
55
- )
56
- .optional()
57
- .nullable()
58
- .default([]),
59
- }),
60
- )
61
- .optional()
62
- .nullable()
63
- .default([]),
64
- })
65
- .transform((data) => {
66
- return {
67
- id: typeid('trade').toString(),
68
- txnChargedAmount: data.txnChargedAmount || null,
69
- tradeStatus: data.tradeStatus,
70
- totalAmount: data.txnChargedAmount || null,
71
- adjustments: [],
72
- transactions: (data.transactions || []).map((txn) => ({
73
- id: typeid('transaction').toString(),
74
- type: txn.type,
75
- status: txn.status,
76
- amount: txn.amount,
77
- tradeId: typeid('trade').toString(),
78
- refundTransactions: (txn.refundTransactions || []).map((refund) => ({
79
- id: typeid('refund_transaction').toString(),
80
- type: refund.type,
81
- status: refund.status,
82
- amount: refund.amount,
83
- transactionId: typeid('transaction').toString(),
84
- })),
85
- })),
86
- };
87
- });
88
- export type FinalizeTradePayloadZod = z.infer<typeof FinalizeTradePayloadZod>;
89
-
90
- export const CreateStateMachineConfigurationZod = z.discriminatedUnion('type', [
91
- z.object({
92
- name: z.string(),
93
- description: z.string(),
94
- type: z.literal(StateMachineType.AIC_VALIDATION),
95
- payload: AicZod,
96
- }),
97
- z.object({
98
- type: z.literal(StateMachineType.FILE_REVIEW),
99
- name: z.string(),
100
- description: z.string(),
101
- payload: FileZod,
102
- }),
103
- z.object({
104
- type: z.literal(StateMachineType.FINALIZE_TRADE),
105
- name: z.string(),
106
- description: z.string(),
107
- payload: FinalizeTradePayloadZod,
108
- }),
109
- ]);
110
- export type CreateStateMachineConfigurationZod = z.infer<
111
- typeof CreateStateMachineConfigurationZod
112
- >;
113
-
114
- export const StateMachineConfigurationZod = z.object({
115
- id: z.string(),
116
- name: z.string(),
117
- description: z.string(),
118
- type: z.nativeEnum(StateMachineType),
119
- payload: z.record(z.string(), z.any()),
120
- });
121
-
122
- export type StateMachineConfigurationZod = z.infer<
123
- typeof StateMachineConfigurationZod
124
- >;
125
-
126
- export const StartStateMachineZod = z.discriminatedUnion('type', [
127
- z.object({
128
- type: z.literal(StateMachineType.AIC_VALIDATION),
129
- payload: AicZod,
130
- debugMode: z.boolean().optional().default(false),
131
- }),
132
- z.object({
133
- type: z.literal(StateMachineType.FILE_REVIEW),
134
- payload: FileZod,
135
- debugMode: z.boolean().optional().default(false),
136
- }),
137
- z.object({
138
- type: z.literal(StateMachineType.FINALIZE_TRADE),
139
- payload: FinalizeTradePayloadZod,
140
- debugMode: z.boolean().optional().default(false),
141
- }),
142
- ]);
143
- export type StartStateMachineZod = z.infer<typeof StartStateMachineZod>;
144
-
145
- export const DebugStateMachineZod = z.object({
146
- sessionId: z.string(),
147
- });
148
- export type DebugStateMachineZod = z.infer<typeof DebugStateMachineZod>;
149
-
150
- export const StateMachineTransitionZod = z.object({
151
- to: z.string(),
152
- from: z.string(),
153
- timestamp: z.string(),
154
- });
155
- export type StateMachineTransitionZod = z.infer<
156
- typeof StateMachineTransitionZod
157
- >;
158
-
159
- export const StateMachineResponseZod = z.object({
160
- sessionId: z.string(),
161
- currentState: z.string(),
162
- error: z.string().optional(),
163
- transitionHistory: z.array(StateMachineTransitionZod),
164
- isCompleted: z.boolean(),
165
- isDebugMode: z.boolean(),
166
- canTransition: z.boolean(),
167
- });
168
- export type StateMachineResponseZod = z.infer<typeof StateMachineResponseZod>;
169
-
170
- export const StateMachineSessionZod = z.object({
171
- id: z.string(),
172
- type: z.nativeEnum(StateMachineType),
173
- persistedSnapshot: z.string().nullable(),
174
- payload: z.record(z.string(), z.any()),
175
- debugMode: z.boolean(),
176
- });
177
- export type StateMachineSessionZod = z.infer<typeof StateMachineSessionZod>;
@@ -1,163 +0,0 @@
1
- import { z } from 'zod';
2
- import { CountryCode, CountryEnumSchema } from './countries.types';
3
-
4
- const StateSchema = z.object({
5
- code: z.string().length(2),
6
- name: z.string(),
7
- });
8
- type State = z.infer<typeof StateSchema>;
9
-
10
- const StatesSchema = z.array(StateSchema);
11
-
12
- export const states: State[] = [
13
- { code: 'AL', name: 'Alabama' },
14
- { code: 'AK', name: 'Alaska' },
15
- { code: 'AZ', name: 'Arizona' },
16
- { code: 'AR', name: 'Arkansas' },
17
- { code: 'CA', name: 'California' },
18
- { code: 'CO', name: 'Colorado' },
19
- { code: 'CT', name: 'Connecticut' },
20
- { code: 'DE', name: 'Delaware' },
21
- { code: 'FL', name: 'Florida' },
22
- { code: 'GA', name: 'Georgia' },
23
- { code: 'HI', name: 'Hawaii' },
24
- { code: 'ID', name: 'Idaho' },
25
- { code: 'IL', name: 'Illinois' },
26
- { code: 'IN', name: 'Indiana' },
27
- { code: 'IA', name: 'Iowa' },
28
- { code: 'KS', name: 'Kansas' },
29
- { code: 'KY', name: 'Kentucky' },
30
- { code: 'LA', name: 'Louisiana' },
31
- { code: 'ME', name: 'Maine' },
32
- { code: 'MD', name: 'Maryland' },
33
- { code: 'MA', name: 'Massachusetts' },
34
- { code: 'MI', name: 'Michigan' },
35
- { code: 'MN', name: 'Minnesota' },
36
- { code: 'MS', name: 'Mississippi' },
37
- { code: 'MO', name: 'Missouri' },
38
- { code: 'MT', name: 'Montana' },
39
- { code: 'NE', name: 'Nebraska' },
40
- { code: 'NV', name: 'Nevada' },
41
- { code: 'NH', name: 'New Hampshire' },
42
- { code: 'NJ', name: 'New Jersey' },
43
- { code: 'NM', name: 'New Mexico' },
44
- { code: 'NY', name: 'New York' },
45
- { code: 'NC', name: 'North Carolina' },
46
- { code: 'ND', name: 'North Dakota' },
47
- { code: 'OH', name: 'Ohio' },
48
- { code: 'OK', name: 'Oklahoma' },
49
- { code: 'OR', name: 'Oregon' },
50
- { code: 'PA', name: 'Pennsylvania' },
51
- { code: 'RI', name: 'Rhode Island' },
52
- { code: 'SC', name: 'South Carolina' },
53
- { code: 'SD', name: 'South Dakota' },
54
- { code: 'TN', name: 'Tennessee' },
55
- { code: 'TX', name: 'Texas' },
56
- { code: 'UT', name: 'Utah' },
57
- { code: 'VT', name: 'Vermont' },
58
- { code: 'VA', name: 'Virginia' },
59
- { code: 'WA', name: 'Washington' },
60
- { code: 'WV', name: 'West Virginia' },
61
- { code: 'WI', name: 'Wisconsin' },
62
- { code: 'WY', name: 'Wyoming' },
63
- ];
64
- const validatedStates = StatesSchema.parse(states);
65
-
66
- const stateEnum = states.reduce(
67
- (acc, state) => {
68
- acc[state.code] = state.code;
69
- return acc;
70
- },
71
- {} as Record<string, string>,
72
- );
73
-
74
- export const StateCode = Object.freeze(stateEnum);
75
-
76
- /**
77
- * Finds a state by its code
78
- *
79
- * @param {string} code the state code
80
- * @returns {State | undefined} the state or undefined
81
- * @example findStateByCode('CA') => { code: 'CA', name: 'California' }
82
- * @example findStateByCode('XX') => undefined
83
- */
84
- function findStateByCode(code: string): State | undefined {
85
- return validatedStates.find((state) => state.code === code.toUpperCase());
86
- }
87
-
88
- export { StatesSchema, findStateByCode, validatedStates };
89
- export type { State };
90
-
91
- export const canadaProvinces = [
92
- { name: 'Alberta', code: 'AB' },
93
- { name: 'British Columbia', code: 'BC' },
94
- { name: 'Manitoba', code: 'MB' },
95
- { name: 'New Brunswick', code: 'NB' },
96
- { name: 'Newfoundland and Labrador', code: 'NL' },
97
- { name: 'Nova Scotia', code: 'NS' },
98
- { name: 'Ontario', code: 'ON' },
99
- { name: 'Prince Edward Island', code: 'PE' },
100
- { name: 'Quebec', code: 'QC' },
101
- { name: 'Saskatchewan', code: 'SK' },
102
- { name: 'Northwest Territories', code: 'NT' },
103
- { name: 'Nunavut', code: 'NU' },
104
- { name: 'Yukon', code: 'YT' },
105
- ];
106
-
107
- const canadaProvinceEnum = canadaProvinces.reduce(
108
- (acc, province) => {
109
- acc[province.code] = province.code;
110
- return acc;
111
- },
112
- {} as Record<string, string>,
113
- );
114
-
115
- export const CanadaProvinceCode = Object.freeze(canadaProvinceEnum);
116
-
117
- export function refineAddressState(
118
- country: string | undefined | null,
119
- state: string | undefined | null,
120
- ) {
121
- {
122
- if (country === CountryCode['US'])
123
- return z.nativeEnum(StateCode).nullable().optional().safeParse(state)
124
- .success;
125
- if (country === CountryCode['CA'])
126
- return z
127
- .nativeEnum(CanadaProvinceCode)
128
- .nullable()
129
- .optional()
130
- .safeParse(state).success;
131
- return z.string().min(2).max(35).nullable().optional().safeParse(state)
132
- .success;
133
- }
134
- }
135
-
136
- export const CountryStateSchema = z
137
- .object({
138
- country: CountryEnumSchema.nullable().optional(),
139
- state: z.string().nullable().optional(),
140
- })
141
- .refine(({ state, country }) => refineAddressState(country, state), {
142
- message: `state value is not valid. It should be 2 uppercase letters representing the valid state for the country.`,
143
- });
144
-
145
- export const RequiredCountryStateSchema = z
146
- .object({
147
- country: CountryEnumSchema,
148
- state: z.string(),
149
- })
150
- .refine(
151
- ({ state, country }) => {
152
- if (country === CountryCode['US']) {
153
- return z.nativeEnum(StateCode).safeParse(state).success;
154
- }
155
- if (country === CountryCode['CA']) {
156
- return z.nativeEnum(CanadaProvinceCode).safeParse(state).success;
157
- }
158
- return z.string().min(2).max(35).safeParse(state).success;
159
- },
160
- {
161
- message: `state value is not valid. It should be 2 uppercase letters representing the valid state for the country.`,
162
- },
163
- );
@@ -1,35 +0,0 @@
1
- import { z } from 'zod';
2
- import { IBaseEntity } from './entity.types';
3
- import { SignatureStatus } from './common.types';
4
- import { SignerDataSchema } from './signer.types';
5
-
6
- export const ISubDocPreview = IBaseEntity.extend({
7
- templateId: z.string().min(1).max(36),
8
- signers: z.array(SignerDataSchema).nullable(),
9
- documentId: z.string().min(1).max(36).nullable(),
10
- signatureUrl: z.string().min(1).max(255).nullable(),
11
- errors: z.string().nullable(),
12
- status: z.nativeEnum(SignatureStatus),
13
- jointStatus: z.nativeEnum(SignatureStatus),
14
- });
15
- export type ISubDocPreview = z.infer<typeof ISubDocPreview>;
16
-
17
- export const CreateSubDocPreview = z.object({
18
- templateId: z.string().min(1).max(36),
19
- subDocPreviewData: z.record(z.string()),
20
- });
21
- export type CreateSubDocPreview = z.infer<typeof CreateSubDocPreview>;
22
-
23
- export const CreateSubDocPreviewResponse = z.object({ documentId: z.string() });
24
- export type CreateSubDocPreviewResponse = z.infer<
25
- typeof CreateSubDocPreviewResponse
26
- >;
27
-
28
- export const SubDocPreviewFormFields = z.array(
29
- z.object({
30
- id: z.string().min(1).max(255),
31
- type: z.string().min(1).max(255),
32
- options: z.array(z.string()).optional(),
33
- }),
34
- );
35
- export type SubDocPreviewFormFields = z.infer<typeof SubDocPreviewFormFields>;