@artu-ai/compliance-sdk 0.13.4 → 0.17.0

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 (773) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +130 -258
  3. package/dist/errors/api.d.ts +16 -1
  4. package/dist/errors/api.js +22 -0
  5. package/dist/errors/base.d.ts +8 -1
  6. package/dist/errors/base.js +12 -0
  7. package/dist/errors/index.d.ts +4 -3
  8. package/dist/errors/index.js +5 -2
  9. package/dist/errors/migration.d.ts +30 -0
  10. package/dist/errors/migration.js +33 -0
  11. package/dist/errors/upload.d.ts +13 -2
  12. package/dist/errors/upload.js +11 -0
  13. package/dist/errors/validation.d.ts +0 -1
  14. package/dist/exports/base.d.ts +3 -4
  15. package/dist/exports/base.js +3 -2
  16. package/dist/exports/identity.d.ts +6 -0
  17. package/dist/exports/identity.js +5 -0
  18. package/dist/exports/index.d.ts +7 -10
  19. package/dist/exports/index.js +6 -7
  20. package/dist/exports/mx/av/ari.d.ts +60 -504
  21. package/dist/exports/mx/av/ari.js +1 -1
  22. package/dist/exports/mx/av/avi.d.ts +56 -520
  23. package/dist/exports/mx/av/avi.js +1 -1
  24. package/dist/exports/mx/av/inm.d.ts +1099 -0
  25. package/dist/exports/mx/av/inm.js +118 -0
  26. package/dist/exports/mx/av/jys.d.ts +76 -551
  27. package/dist/exports/mx/av/jys.js +1 -1
  28. package/dist/exports/mx/av/mjr.d.ts +64 -507
  29. package/dist/exports/mx/av/mjr.js +1 -1
  30. package/dist/exports/mx/av/mpc.d.ts +1057 -0
  31. package/dist/exports/mx/av/mpc.js +114 -0
  32. package/dist/exports/mx/av/tsc.d.ts +52 -447
  33. package/dist/exports/mx/av/tsc.js +1 -1
  34. package/dist/exports/mx/av/veh.d.ts +1030 -0
  35. package/dist/exports/mx/av/veh.js +115 -0
  36. package/dist/exports/mx/av.d.ts +39 -410
  37. package/dist/exports/mx/cnbv/transmisor.d.ts +27 -80
  38. package/dist/exports/mx/cnbv.d.ts +15 -15
  39. package/dist/exports/mx/index.d.ts +2 -8
  40. package/dist/exports/mx/index.js +1 -3
  41. package/dist/exports/mx/sdk.d.ts +6 -0
  42. package/dist/exports/mx/sdk.js +3 -0
  43. package/dist/exports/screening.d.ts +6 -0
  44. package/dist/exports/screening.js +5 -0
  45. package/dist/i18n/messages.d.ts +4 -0
  46. package/dist/i18n/messages.en.d.ts +6 -0
  47. package/dist/i18n/messages.en.js +5 -0
  48. package/dist/i18n/messages.es.d.ts +5 -0
  49. package/dist/i18n/messages.es.js +5 -0
  50. package/dist/i18n/messages.js +22 -0
  51. package/dist/models/Address.d.ts +2 -3
  52. package/dist/models/Address.js +3 -3
  53. package/dist/models/Alert.d.ts +53 -17
  54. package/dist/models/Alert.js +96 -29
  55. package/dist/models/AlertClientItem.d.ts +3 -4
  56. package/dist/models/AlertClientItem.js +3 -3
  57. package/dist/models/AlertItem.d.ts +3 -4
  58. package/dist/models/AlertItem.js +5 -5
  59. package/dist/models/AlertTransactionItem.d.ts +4 -5
  60. package/dist/models/AlertTransactionItem.js +4 -4
  61. package/dist/models/BankAccount.d.ts +0 -1
  62. package/dist/models/Client.d.ts +6 -7
  63. package/dist/models/Client.js +9 -9
  64. package/dist/models/ContactMethod.d.ts +0 -1
  65. package/dist/models/Document.d.ts +28 -7
  66. package/dist/models/Document.js +54 -9
  67. package/dist/models/Evidence.d.ts +163 -0
  68. package/dist/models/Evidence.js +298 -0
  69. package/dist/models/LinkedClient.d.ts +0 -1
  70. package/dist/models/Product.d.ts +6 -7
  71. package/dist/models/Product.js +9 -9
  72. package/dist/models/Transaction.d.ts +14 -8
  73. package/dist/models/Transaction.js +19 -9
  74. package/dist/models/Workflow.d.ts +19 -1
  75. package/dist/models/Workflow.js +28 -0
  76. package/dist/models/WorkflowExecution.d.ts +12 -3
  77. package/dist/models/WorkflowExecution.js +23 -3
  78. package/dist/models/WorkflowTemplate.d.ts +0 -1
  79. package/dist/models/WorkflowVariable.d.ts +0 -1
  80. package/dist/models/base.d.ts +0 -1
  81. package/dist/models/index.d.ts +2 -2
  82. package/dist/models/index.js +3 -2
  83. package/dist/models/mx/MexAddress.d.ts +0 -1
  84. package/dist/models/mx/MexAddress.js +1 -1
  85. package/dist/models/mx/MexAlert.d.ts +6 -7
  86. package/dist/models/mx/MexAlert.js +4 -4
  87. package/dist/models/mx/MexAlertClientItem.d.ts +16 -17
  88. package/dist/models/mx/MexAlertClientItem.js +10 -10
  89. package/dist/models/mx/MexAlertItem.d.ts +6 -7
  90. package/dist/models/mx/MexAlertItem.js +3 -3
  91. package/dist/models/mx/MexAlertTransactionItem.d.ts +16 -17
  92. package/dist/models/mx/MexAlertTransactionItem.js +10 -11
  93. package/dist/models/mx/MexBankAccount.d.ts +0 -1
  94. package/dist/models/mx/MexClient.d.ts +7 -8
  95. package/dist/models/mx/MexClient.js +4 -4
  96. package/dist/models/mx/MexDocument.d.ts +1 -2
  97. package/dist/models/mx/MexDocument.js +2 -2
  98. package/dist/models/mx/MexProduct.d.ts +6 -7
  99. package/dist/models/mx/MexProduct.js +3 -3
  100. package/dist/models/mx/MexTransaction.d.ts +6 -7
  101. package/dist/models/mx/MexTransaction.js +3 -3
  102. package/dist/models/mx/av/MexAVAlert.d.ts +3 -4
  103. package/dist/models/mx/av/MexAVAlert.js +2 -2
  104. package/dist/models/mx/av/MexAVAlertClientItem.d.ts +8 -6
  105. package/dist/models/mx/av/MexAVAlertClientItem.js +4 -4
  106. package/dist/models/mx/av/MexAVAlertItem.d.ts +4 -5
  107. package/dist/models/mx/av/MexAVAlertItem.js +3 -3
  108. package/dist/models/mx/av/MexAVAlertTransactionItem.d.ts +107 -8
  109. package/dist/models/mx/av/MexAVAlertTransactionItem.js +4 -4
  110. package/dist/models/mx/av/MexAVClient.d.ts +0 -1
  111. package/dist/models/mx/av/MexAVProduct.d.ts +0 -1
  112. package/dist/models/mx/av/MexAVTransaction.d.ts +0 -1
  113. package/dist/models/mx/av/ari/MexARIAlert.d.ts +2 -3
  114. package/dist/models/mx/av/ari/MexARIAlert.js +1 -1
  115. package/dist/models/mx/av/ari/MexARIAlertClientItem.d.ts +3 -4
  116. package/dist/models/mx/av/ari/MexARIAlertClientItem.js +2 -2
  117. package/dist/models/mx/av/ari/MexARIAlertItem.d.ts +3 -4
  118. package/dist/models/mx/av/ari/MexARIAlertItem.js +2 -2
  119. package/dist/models/mx/av/ari/MexARIAlertTransactionItem.d.ts +3 -4
  120. package/dist/models/mx/av/ari/MexARIAlertTransactionItem.js +2 -2
  121. package/dist/models/mx/av/ari/MexARIClient.d.ts +0 -1
  122. package/dist/models/mx/av/ari/MexARIProduct.d.ts +0 -1
  123. package/dist/models/mx/av/ari/MexARITransaction.d.ts +0 -1
  124. package/dist/models/mx/av/avi/MexAVIAlert.d.ts +2 -3
  125. package/dist/models/mx/av/avi/MexAVIAlert.js +1 -1
  126. package/dist/models/mx/av/avi/MexAVIAlertClientItem.d.ts +3 -4
  127. package/dist/models/mx/av/avi/MexAVIAlertClientItem.js +2 -2
  128. package/dist/models/mx/av/avi/MexAVIAlertItem.d.ts +3 -4
  129. package/dist/models/mx/av/avi/MexAVIAlertItem.js +2 -2
  130. package/dist/models/mx/av/avi/MexAVIAlertTransactionItem.d.ts +3 -4
  131. package/dist/models/mx/av/avi/MexAVIAlertTransactionItem.js +2 -2
  132. package/dist/models/mx/av/avi/MexAVIClient.d.ts +0 -1
  133. package/dist/models/mx/av/avi/MexAVIProduct.d.ts +0 -1
  134. package/dist/models/mx/av/avi/MexAVITransaction.d.ts +0 -1
  135. package/dist/models/mx/av/index.d.ts +21 -1
  136. package/dist/models/mx/av/index.js +21 -0
  137. package/dist/models/mx/av/inm/MexINMAlert.d.ts +53 -0
  138. package/dist/models/mx/av/inm/MexINMAlert.js +77 -0
  139. package/dist/models/mx/av/inm/MexINMAlertClientItem.d.ts +60 -0
  140. package/dist/models/mx/av/inm/MexINMAlertClientItem.js +68 -0
  141. package/dist/models/mx/av/inm/MexINMAlertItem.d.ts +57 -0
  142. package/dist/models/mx/av/inm/MexINMAlertItem.js +67 -0
  143. package/dist/models/mx/av/inm/MexINMAlertTransactionItem.d.ts +96 -0
  144. package/dist/models/mx/av/inm/MexINMAlertTransactionItem.js +125 -0
  145. package/dist/models/mx/av/inm/MexINMClient.d.ts +39 -0
  146. package/dist/models/mx/av/inm/MexINMClient.js +54 -0
  147. package/dist/models/mx/av/inm/MexINMProduct.d.ts +63 -0
  148. package/dist/models/mx/av/inm/MexINMProduct.js +93 -0
  149. package/dist/models/mx/av/inm/MexINMTransaction.d.ts +75 -0
  150. package/dist/models/mx/av/inm/MexINMTransaction.js +116 -0
  151. package/dist/models/mx/av/jys/MexJYSAlert.d.ts +2 -3
  152. package/dist/models/mx/av/jys/MexJYSAlert.js +1 -1
  153. package/dist/models/mx/av/jys/MexJYSAlertClientItem.d.ts +3 -4
  154. package/dist/models/mx/av/jys/MexJYSAlertClientItem.js +2 -2
  155. package/dist/models/mx/av/jys/MexJYSAlertItem.d.ts +3 -4
  156. package/dist/models/mx/av/jys/MexJYSAlertItem.js +2 -2
  157. package/dist/models/mx/av/jys/MexJYSAlertTransactionItem.d.ts +3 -4
  158. package/dist/models/mx/av/jys/MexJYSAlertTransactionItem.js +2 -2
  159. package/dist/models/mx/av/jys/MexJYSClient.d.ts +0 -1
  160. package/dist/models/mx/av/jys/MexJYSProduct.d.ts +0 -1
  161. package/dist/models/mx/av/jys/MexJYSTransaction.d.ts +0 -1
  162. package/dist/models/mx/av/mjr/MexMJRAlert.d.ts +2 -3
  163. package/dist/models/mx/av/mjr/MexMJRAlert.js +1 -1
  164. package/dist/models/mx/av/mjr/MexMJRAlertClientItem.d.ts +3 -4
  165. package/dist/models/mx/av/mjr/MexMJRAlertClientItem.js +2 -2
  166. package/dist/models/mx/av/mjr/MexMJRAlertItem.d.ts +3 -4
  167. package/dist/models/mx/av/mjr/MexMJRAlertItem.js +2 -2
  168. package/dist/models/mx/av/mjr/MexMJRAlertTransactionItem.d.ts +3 -4
  169. package/dist/models/mx/av/mjr/MexMJRAlertTransactionItem.js +2 -2
  170. package/dist/models/mx/av/mjr/MexMJRClient.d.ts +0 -1
  171. package/dist/models/mx/av/mjr/MexMJRProduct.d.ts +0 -1
  172. package/dist/models/mx/av/mjr/MexMJRTransaction.d.ts +0 -1
  173. package/dist/models/mx/av/mpc/MexMPCAlert.d.ts +53 -0
  174. package/dist/models/mx/av/mpc/MexMPCAlert.js +77 -0
  175. package/dist/models/mx/av/mpc/MexMPCAlertClientItem.d.ts +60 -0
  176. package/dist/models/mx/av/mpc/MexMPCAlertClientItem.js +68 -0
  177. package/dist/models/mx/av/mpc/MexMPCAlertItem.d.ts +57 -0
  178. package/dist/models/mx/av/mpc/MexMPCAlertItem.js +67 -0
  179. package/dist/models/mx/av/mpc/MexMPCAlertTransactionItem.d.ts +92 -0
  180. package/dist/models/mx/av/mpc/MexMPCAlertTransactionItem.js +119 -0
  181. package/dist/models/mx/av/mpc/MexMPCClient.d.ts +39 -0
  182. package/dist/models/mx/av/mpc/MexMPCClient.js +54 -0
  183. package/dist/models/mx/av/mpc/MexMPCProduct.d.ts +45 -0
  184. package/dist/models/mx/av/mpc/MexMPCProduct.js +68 -0
  185. package/dist/models/mx/av/mpc/MexMPCTransaction.d.ts +73 -0
  186. package/dist/models/mx/av/mpc/MexMPCTransaction.js +113 -0
  187. package/dist/models/mx/av/tsc/MexTSCAlert.d.ts +2 -3
  188. package/dist/models/mx/av/tsc/MexTSCAlert.js +1 -1
  189. package/dist/models/mx/av/tsc/MexTSCAlertClientItem.d.ts +3 -4
  190. package/dist/models/mx/av/tsc/MexTSCAlertClientItem.js +2 -2
  191. package/dist/models/mx/av/tsc/MexTSCAlertItem.d.ts +3 -4
  192. package/dist/models/mx/av/tsc/MexTSCAlertItem.js +2 -2
  193. package/dist/models/mx/av/tsc/MexTSCAlertTransactionItem.d.ts +3 -4
  194. package/dist/models/mx/av/tsc/MexTSCAlertTransactionItem.js +2 -2
  195. package/dist/models/mx/av/tsc/MexTSCClient.d.ts +0 -1
  196. package/dist/models/mx/av/tsc/MexTSCProduct.d.ts +0 -1
  197. package/dist/models/mx/av/tsc/MexTSCTransaction.d.ts +0 -1
  198. package/dist/models/mx/av/veh/MexVEHAlert.d.ts +53 -0
  199. package/dist/models/mx/av/veh/MexVEHAlert.js +77 -0
  200. package/dist/models/mx/av/veh/MexVEHAlertClientItem.d.ts +58 -0
  201. package/dist/models/mx/av/veh/MexVEHAlertClientItem.js +66 -0
  202. package/dist/models/mx/av/veh/MexVEHAlertItem.d.ts +55 -0
  203. package/dist/models/mx/av/veh/MexVEHAlertItem.js +65 -0
  204. package/dist/models/mx/av/veh/MexVEHAlertTransactionItem.d.ts +90 -0
  205. package/dist/models/mx/av/veh/MexVEHAlertTransactionItem.js +117 -0
  206. package/dist/models/mx/av/veh/MexVEHClient.d.ts +25 -0
  207. package/dist/models/mx/av/veh/MexVEHClient.js +31 -0
  208. package/dist/models/mx/av/veh/MexVEHProduct.d.ts +24 -0
  209. package/dist/models/mx/av/veh/MexVEHProduct.js +30 -0
  210. package/dist/models/mx/av/veh/MexVEHTransaction.d.ts +40 -0
  211. package/dist/models/mx/av/veh/MexVEHTransaction.js +62 -0
  212. package/dist/models/mx/cnbv/MexCNBVAlert.d.ts +1 -2
  213. package/dist/models/mx/cnbv/MexCNBVAlert.js +1 -1
  214. package/dist/models/mx/cnbv/MexCNBVAlertClientItem.d.ts +4 -5
  215. package/dist/models/mx/cnbv/MexCNBVAlertClientItem.js +3 -3
  216. package/dist/models/mx/cnbv/MexCNBVAlertItem.d.ts +1 -2
  217. package/dist/models/mx/cnbv/MexCNBVAlertTransactionItem.d.ts +6 -7
  218. package/dist/models/mx/cnbv/MexCNBVAlertTransactionItem.js +3 -3
  219. package/dist/models/mx/cnbv/MexCNBVClient.d.ts +0 -1
  220. package/dist/models/mx/cnbv/MexCNBVProduct.d.ts +2 -3
  221. package/dist/models/mx/cnbv/MexCNBVTransaction.d.ts +0 -1
  222. package/dist/models/mx/cnbv/index.d.ts +0 -1
  223. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlert.d.ts +2 -3
  224. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlert.js +2 -2
  225. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertClientItem.d.ts +3 -4
  226. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertClientItem.js +4 -4
  227. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertItem.d.ts +2 -3
  228. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertItem.js +2 -2
  229. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertTransactionItem.d.ts +5 -6
  230. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertTransactionItem.js +3 -3
  231. package/dist/models/mx/cnbv/transmisor/MexTransmisorClient.d.ts +1 -2
  232. package/dist/models/mx/cnbv/transmisor/MexTransmisorClient.js +1 -1
  233. package/dist/models/mx/cnbv/transmisor/MexTransmisorProduct.d.ts +1 -2
  234. package/dist/models/mx/cnbv/transmisor/MexTransmisorProduct.js +1 -1
  235. package/dist/models/mx/cnbv/transmisor/MexTransmisorTransaction.d.ts +1 -2
  236. package/dist/models/mx/cnbv/transmisor/MexTransmisorTransaction.js +1 -1
  237. package/dist/models/mx/cnbv/transmisor/index.d.ts +0 -1
  238. package/dist/models/mx/index.d.ts +0 -1
  239. package/dist/models/mx/index.js +4 -4
  240. package/dist/models/types.d.ts +0 -1
  241. package/dist/resources/addresses.d.ts +0 -1
  242. package/dist/resources/alert-items.d.ts +1 -4
  243. package/dist/resources/alert-items.js +1 -0
  244. package/dist/resources/alerts.d.ts +89 -19
  245. package/dist/resources/alerts.js +126 -24
  246. package/dist/resources/api-keys.d.ts +0 -3
  247. package/dist/resources/api-keys.js +1 -0
  248. package/dist/resources/audit-logs.d.ts +0 -3
  249. package/dist/resources/audit-logs.js +1 -0
  250. package/dist/resources/bank-accounts.d.ts +4 -5
  251. package/dist/resources/bank-accounts.js +4 -61
  252. package/dist/resources/base.d.ts +53 -16
  253. package/dist/resources/base.js +75 -2
  254. package/dist/resources/clients.d.ts +189 -14
  255. package/dist/resources/clients.js +238 -16
  256. package/dist/resources/contact-methods.d.ts +2 -3
  257. package/dist/resources/contact-methods.js +2 -2
  258. package/dist/resources/documents.d.ts +76 -8
  259. package/dist/resources/documents.js +140 -13
  260. package/dist/resources/evidence.d.ts +393 -0
  261. package/dist/resources/evidence.js +603 -0
  262. package/dist/resources/exchange-rates.d.ts +0 -3
  263. package/dist/resources/exchange-rates.js +1 -0
  264. package/dist/resources/identity/identity.d.ts +61 -0
  265. package/dist/resources/identity/identity.js +29 -0
  266. package/dist/resources/identity/index.d.ts +7 -0
  267. package/dist/resources/identity/index.js +7 -0
  268. package/dist/resources/index.d.ts +7 -5
  269. package/dist/resources/index.js +11 -6
  270. package/dist/resources/merge-tenant-defaults/index.d.ts +0 -1
  271. package/dist/resources/merge-tenant-defaults/mx/av/merge.d.ts +8 -9
  272. package/dist/resources/merge-tenant-defaults/mx/av/merge.js +11 -11
  273. package/dist/resources/merge-tenant-defaults/mx/cnbv/merge.d.ts +2 -3
  274. package/dist/resources/merge-tenant-defaults/mx/cnbv/merge.js +4 -4
  275. package/dist/resources/merge-tenant-defaults/utils.d.ts +0 -1
  276. package/dist/resources/mx/addresses.d.ts +11 -12
  277. package/dist/resources/mx/addresses.js +11 -11
  278. package/dist/resources/mx/alerts.d.ts +24 -12
  279. package/dist/resources/mx/alerts.js +46 -30
  280. package/dist/resources/mx/av/alerts.d.ts +41 -8
  281. package/dist/resources/mx/av/alerts.js +36 -19
  282. package/dist/resources/mx/av/ari/alerts.d.ts +40 -7
  283. package/dist/resources/mx/av/ari/alerts.js +37 -20
  284. package/dist/resources/mx/av/ari/clients.d.ts +21 -5
  285. package/dist/resources/mx/av/ari/clients.js +38 -17
  286. package/dist/resources/mx/av/ari/index.d.ts +0 -1
  287. package/dist/resources/mx/av/ari/products.d.ts +15 -5
  288. package/dist/resources/mx/av/ari/products.js +23 -9
  289. package/dist/resources/mx/av/ari/tenant.d.ts +0 -1
  290. package/dist/resources/mx/av/ari/transactions.d.ts +16 -6
  291. package/dist/resources/mx/av/ari/transactions.js +40 -68
  292. package/dist/resources/mx/av/avi/alerts.d.ts +41 -8
  293. package/dist/resources/mx/av/avi/alerts.js +43 -27
  294. package/dist/resources/mx/av/avi/clients.d.ts +26 -8
  295. package/dist/resources/mx/av/avi/clients.js +44 -24
  296. package/dist/resources/mx/av/avi/index.d.ts +0 -1
  297. package/dist/resources/mx/av/avi/products.d.ts +15 -5
  298. package/dist/resources/mx/av/avi/products.js +23 -9
  299. package/dist/resources/mx/av/avi/tenant.d.ts +0 -1
  300. package/dist/resources/mx/av/avi/transactions.d.ts +16 -6
  301. package/dist/resources/mx/av/avi/transactions.js +40 -73
  302. package/dist/resources/mx/av/clients.d.ts +19 -4
  303. package/dist/resources/mx/av/clients.js +32 -14
  304. package/dist/resources/mx/av/index.d.ts +3 -1
  305. package/dist/resources/mx/av/index.js +6 -0
  306. package/dist/resources/mx/av/inm/alerts.d.ts +271 -0
  307. package/dist/resources/mx/av/inm/alerts.js +442 -0
  308. package/dist/resources/mx/av/inm/clients.d.ts +144 -0
  309. package/dist/resources/mx/av/inm/clients.js +292 -0
  310. package/dist/resources/mx/av/inm/index.d.ts +7 -0
  311. package/dist/resources/mx/av/inm/index.js +7 -0
  312. package/dist/resources/mx/av/inm/products.d.ts +68 -0
  313. package/dist/resources/mx/av/inm/products.js +179 -0
  314. package/dist/resources/mx/av/inm/tenant.d.ts +29 -0
  315. package/dist/resources/mx/av/inm/tenant.js +36 -0
  316. package/dist/resources/mx/av/inm/transactions.d.ts +107 -0
  317. package/dist/resources/mx/av/inm/transactions.js +291 -0
  318. package/dist/resources/mx/av/jys/alerts.d.ts +41 -8
  319. package/dist/resources/mx/av/jys/alerts.js +40 -24
  320. package/dist/resources/mx/av/jys/clients.d.ts +21 -5
  321. package/dist/resources/mx/av/jys/clients.js +39 -19
  322. package/dist/resources/mx/av/jys/index.d.ts +0 -1
  323. package/dist/resources/mx/av/jys/products.d.ts +15 -5
  324. package/dist/resources/mx/av/jys/products.js +23 -9
  325. package/dist/resources/mx/av/jys/tenant.d.ts +0 -1
  326. package/dist/resources/mx/av/jys/transactions.d.ts +16 -6
  327. package/dist/resources/mx/av/jys/transactions.js +40 -72
  328. package/dist/resources/mx/av/mjr/alerts.d.ts +41 -8
  329. package/dist/resources/mx/av/mjr/alerts.js +40 -24
  330. package/dist/resources/mx/av/mjr/clients.d.ts +21 -5
  331. package/dist/resources/mx/av/mjr/clients.js +38 -18
  332. package/dist/resources/mx/av/mjr/index.d.ts +0 -1
  333. package/dist/resources/mx/av/mjr/products.d.ts +15 -5
  334. package/dist/resources/mx/av/mjr/products.js +23 -9
  335. package/dist/resources/mx/av/mjr/tenant.d.ts +0 -1
  336. package/dist/resources/mx/av/mjr/transactions.d.ts +16 -6
  337. package/dist/resources/mx/av/mjr/transactions.js +40 -83
  338. package/dist/resources/mx/av/mpc/alerts.d.ts +271 -0
  339. package/dist/resources/mx/av/mpc/alerts.js +442 -0
  340. package/dist/resources/mx/av/mpc/clients.d.ts +144 -0
  341. package/dist/resources/mx/av/mpc/clients.js +291 -0
  342. package/dist/resources/mx/av/mpc/index.d.ts +7 -0
  343. package/dist/resources/mx/av/mpc/index.js +7 -0
  344. package/dist/resources/mx/av/mpc/products.d.ts +71 -0
  345. package/dist/resources/mx/av/mpc/products.js +178 -0
  346. package/dist/resources/mx/av/mpc/tenant.d.ts +29 -0
  347. package/dist/resources/mx/av/mpc/tenant.js +36 -0
  348. package/dist/resources/mx/av/mpc/transactions.d.ts +107 -0
  349. package/dist/resources/mx/av/mpc/transactions.js +291 -0
  350. package/dist/resources/mx/av/products.d.ts +15 -5
  351. package/dist/resources/mx/av/products.js +21 -7
  352. package/dist/resources/mx/av/tenant.d.ts +0 -1
  353. package/dist/resources/mx/av/transactions.d.ts +15 -5
  354. package/dist/resources/mx/av/transactions.js +25 -11
  355. package/dist/resources/mx/av/tsc/alerts.d.ts +41 -8
  356. package/dist/resources/mx/av/tsc/alerts.js +40 -24
  357. package/dist/resources/mx/av/tsc/clients.d.ts +21 -5
  358. package/dist/resources/mx/av/tsc/clients.js +38 -18
  359. package/dist/resources/mx/av/tsc/index.d.ts +0 -1
  360. package/dist/resources/mx/av/tsc/products.d.ts +15 -5
  361. package/dist/resources/mx/av/tsc/products.js +23 -9
  362. package/dist/resources/mx/av/tsc/tenant.d.ts +0 -1
  363. package/dist/resources/mx/av/tsc/transactions.d.ts +16 -6
  364. package/dist/resources/mx/av/tsc/transactions.js +40 -80
  365. package/dist/resources/mx/av/veh/alerts.d.ts +271 -0
  366. package/dist/resources/mx/av/veh/alerts.js +442 -0
  367. package/dist/resources/mx/av/veh/clients.d.ts +144 -0
  368. package/dist/resources/mx/av/veh/clients.js +291 -0
  369. package/dist/resources/mx/av/veh/index.d.ts +7 -0
  370. package/dist/resources/mx/av/veh/index.js +7 -0
  371. package/dist/resources/mx/av/veh/products.d.ts +55 -0
  372. package/dist/resources/mx/av/veh/products.js +158 -0
  373. package/dist/resources/mx/av/veh/tenant.d.ts +18 -0
  374. package/dist/resources/mx/av/veh/tenant.js +22 -0
  375. package/dist/resources/mx/av/veh/transactions.d.ts +104 -0
  376. package/dist/resources/mx/av/veh/transactions.js +288 -0
  377. package/dist/resources/mx/bank-accounts.d.ts +4 -5
  378. package/dist/resources/mx/bank-accounts.js +3 -3
  379. package/dist/resources/mx/clients.d.ts +26 -10
  380. package/dist/resources/mx/clients.js +47 -27
  381. package/dist/resources/mx/cnbv/alerts.d.ts +19 -7
  382. package/dist/resources/mx/cnbv/alerts.js +37 -20
  383. package/dist/resources/mx/cnbv/clients.d.ts +23 -6
  384. package/dist/resources/mx/cnbv/clients.js +35 -17
  385. package/dist/resources/mx/cnbv/index.d.ts +0 -1
  386. package/dist/resources/mx/cnbv/products.d.ts +16 -6
  387. package/dist/resources/mx/cnbv/products.js +29 -15
  388. package/dist/resources/mx/cnbv/tenant.d.ts +0 -1
  389. package/dist/resources/mx/cnbv/transactions.d.ts +16 -6
  390. package/dist/resources/mx/cnbv/transactions.js +33 -19
  391. package/dist/resources/mx/cnbv/transmisor/addresses.d.ts +11 -12
  392. package/dist/resources/mx/cnbv/transmisor/addresses.js +8 -8
  393. package/dist/resources/mx/cnbv/transmisor/alerts.d.ts +40 -7
  394. package/dist/resources/mx/cnbv/transmisor/alerts.js +36 -19
  395. package/dist/resources/mx/cnbv/transmisor/clients.d.ts +23 -5
  396. package/dist/resources/mx/cnbv/transmisor/clients.js +37 -16
  397. package/dist/resources/mx/cnbv/transmisor/index.d.ts +0 -1
  398. package/dist/resources/mx/cnbv/transmisor/products.d.ts +15 -5
  399. package/dist/resources/mx/cnbv/transmisor/products.js +23 -9
  400. package/dist/resources/mx/cnbv/transmisor/tenant.d.ts +0 -1
  401. package/dist/resources/mx/cnbv/transmisor/transactions.d.ts +16 -6
  402. package/dist/resources/mx/cnbv/transmisor/transactions.js +35 -65
  403. package/dist/resources/mx/index.d.ts +0 -1
  404. package/dist/resources/mx/products.d.ts +15 -5
  405. package/dist/resources/mx/products.js +27 -10
  406. package/dist/resources/mx/tenant.d.ts +4 -2
  407. package/dist/resources/mx/tenant.js +2 -2
  408. package/dist/resources/mx/transactions.d.ts +20 -8
  409. package/dist/resources/mx/transactions.js +37 -20
  410. package/dist/resources/mx/update-split.d.ts +48 -0
  411. package/dist/resources/mx/update-split.js +105 -0
  412. package/dist/resources/products.d.ts +43 -9
  413. package/dist/resources/products.js +54 -11
  414. package/dist/resources/reference-data/custom-reference-data.d.ts +0 -3
  415. package/dist/resources/reference-data/custom-reference-data.js +1 -0
  416. package/dist/resources/reference-data/index.d.ts +0 -1
  417. package/dist/resources/reference-data/reference-data.d.ts +0 -3
  418. package/dist/resources/reference-data/reference-data.js +1 -0
  419. package/dist/resources/related-parties/base.d.ts +72 -0
  420. package/dist/resources/related-parties/base.js +28 -0
  421. package/dist/resources/reports.d.ts +0 -3
  422. package/dist/resources/reports.js +1 -0
  423. package/dist/resources/roles.d.ts +0 -3
  424. package/dist/resources/roles.js +1 -0
  425. package/dist/resources/screening/index.d.ts +7 -0
  426. package/dist/resources/screening/index.js +7 -0
  427. package/dist/resources/screening/screening.d.ts +61 -0
  428. package/dist/resources/screening/screening.js +35 -0
  429. package/dist/resources/signable-templates.d.ts +80 -0
  430. package/dist/resources/signable-templates.js +146 -0
  431. package/dist/resources/tags.d.ts +0 -3
  432. package/dist/resources/tags.js +1 -0
  433. package/dist/resources/tenant.d.ts +6 -5
  434. package/dist/resources/tenant.js +9 -3
  435. package/dist/resources/transactions.d.ts +126 -11
  436. package/dist/resources/transactions.js +176 -29
  437. package/dist/resources/users.d.ts +32 -4
  438. package/dist/resources/users.js +23 -0
  439. package/dist/resources/workflow-executions.d.ts +86 -13
  440. package/dist/resources/workflow-executions.js +89 -11
  441. package/dist/resources/workflow-links.d.ts +61 -0
  442. package/dist/resources/workflow-links.js +68 -0
  443. package/dist/resources/workflow-templates.d.ts +2 -3
  444. package/dist/resources/workflow-templates.js +1 -0
  445. package/dist/resources/workflow-variables.d.ts +3 -4
  446. package/dist/resources/workflow-variables.js +2 -0
  447. package/dist/resources/workflows.d.ts +108 -17
  448. package/dist/resources/workflows.js +178 -16
  449. package/dist/sdk/ComplianceSDK.d.ts +55 -22
  450. package/dist/sdk/ComplianceSDK.js +74 -23
  451. package/dist/sdk/base.d.ts +0 -1
  452. package/dist/sdk/index.d.ts +1 -2
  453. package/dist/sdk/index.js +1 -1
  454. package/dist/sdk/mx/ComplianceSDK.d.ts +1 -2
  455. package/dist/sdk/mx/ComplianceSDK.js +1 -1
  456. package/dist/sdk/mx/av/ComplianceSDK.d.ts +3 -4
  457. package/dist/sdk/mx/av/ComplianceSDK.js +3 -3
  458. package/dist/sdk/mx/av/ari/ComplianceSDK.d.ts +3 -4
  459. package/dist/sdk/mx/av/ari/ComplianceSDK.js +3 -3
  460. package/dist/sdk/mx/av/ari/index.d.ts +0 -1
  461. package/dist/sdk/mx/av/ari/types.d.ts +0 -1
  462. package/dist/sdk/mx/av/avi/ComplianceSDK.d.ts +1 -2
  463. package/dist/sdk/mx/av/avi/ComplianceSDK.js +1 -1
  464. package/dist/sdk/mx/av/avi/index.d.ts +0 -1
  465. package/dist/sdk/mx/av/avi/types.d.ts +0 -1
  466. package/dist/sdk/mx/av/index.d.ts +4 -5
  467. package/dist/sdk/mx/av/index.js +13 -22
  468. package/dist/sdk/mx/av/inm/ComplianceSDK.d.ts +41 -0
  469. package/dist/sdk/mx/av/inm/ComplianceSDK.js +35 -0
  470. package/dist/sdk/mx/av/inm/index.d.ts +7 -0
  471. package/dist/sdk/mx/av/inm/index.js +9 -0
  472. package/dist/sdk/mx/av/inm/types.d.ts +31 -0
  473. package/dist/sdk/mx/av/inm/types.js +21 -0
  474. package/dist/sdk/mx/av/jys/ComplianceSDK.d.ts +3 -4
  475. package/dist/sdk/mx/av/jys/ComplianceSDK.js +3 -3
  476. package/dist/sdk/mx/av/jys/index.d.ts +0 -1
  477. package/dist/sdk/mx/av/jys/types.d.ts +0 -1
  478. package/dist/sdk/mx/av/mjr/ComplianceSDK.d.ts +3 -4
  479. package/dist/sdk/mx/av/mjr/ComplianceSDK.js +3 -3
  480. package/dist/sdk/mx/av/mjr/index.d.ts +0 -1
  481. package/dist/sdk/mx/av/mjr/types.d.ts +0 -1
  482. package/dist/sdk/mx/av/mpc/ComplianceSDK.d.ts +41 -0
  483. package/dist/sdk/mx/av/mpc/ComplianceSDK.js +35 -0
  484. package/dist/sdk/mx/av/mpc/index.d.ts +7 -0
  485. package/dist/sdk/mx/av/mpc/index.js +9 -0
  486. package/dist/sdk/mx/av/mpc/types.d.ts +31 -0
  487. package/dist/sdk/mx/av/mpc/types.js +21 -0
  488. package/dist/sdk/mx/av/register-scopes.d.ts +4 -0
  489. package/dist/sdk/mx/av/register-scopes.js +28 -0
  490. package/dist/sdk/mx/av/tsc/ComplianceSDK.d.ts +3 -4
  491. package/dist/sdk/mx/av/tsc/ComplianceSDK.js +3 -3
  492. package/dist/sdk/mx/av/tsc/index.d.ts +0 -1
  493. package/dist/sdk/mx/av/tsc/types.d.ts +0 -1
  494. package/dist/sdk/mx/av/types.d.ts +0 -1
  495. package/dist/sdk/mx/av/veh/ComplianceSDK.d.ts +41 -0
  496. package/dist/sdk/mx/av/veh/ComplianceSDK.js +35 -0
  497. package/dist/sdk/mx/av/veh/index.d.ts +7 -0
  498. package/dist/sdk/mx/av/veh/index.js +9 -0
  499. package/dist/sdk/mx/av/veh/types.d.ts +31 -0
  500. package/dist/sdk/mx/av/veh/types.js +21 -0
  501. package/dist/sdk/mx/cnbv/ComplianceSDK.d.ts +3 -4
  502. package/dist/sdk/mx/cnbv/ComplianceSDK.js +3 -3
  503. package/dist/sdk/mx/cnbv/index.d.ts +1 -5
  504. package/dist/sdk/mx/cnbv/index.js +1 -12
  505. package/dist/sdk/mx/cnbv/register-scopes.d.ts +4 -0
  506. package/dist/sdk/mx/cnbv/register-scopes.js +12 -0
  507. package/dist/sdk/mx/cnbv/transmisor/ComplianceSDK.d.ts +3 -4
  508. package/dist/sdk/mx/cnbv/transmisor/ComplianceSDK.js +3 -3
  509. package/dist/sdk/mx/cnbv/transmisor/index.d.ts +0 -1
  510. package/dist/sdk/mx/cnbv/transmisor/types.d.ts +0 -1
  511. package/dist/sdk/mx/cnbv/types.d.ts +0 -1
  512. package/dist/sdk/mx/index.d.ts +0 -1
  513. package/dist/sdk/mx/registration.d.ts +0 -1
  514. package/dist/sdk/mx/types.d.ts +5 -4
  515. package/dist/sdk/mx/types.js +1 -1
  516. package/dist/sdk/registry-init.d.ts +0 -1
  517. package/dist/sdk/resource-registry.d.ts +4 -10
  518. package/dist/sdk/resource-registry.js +3 -3
  519. package/dist/sdk/sdk-registry.d.ts +0 -6
  520. package/dist/sdk/types.d.ts +16 -4
  521. package/dist/sdk/types.js +2 -2
  522. package/dist/utils/environment.d.ts +3 -3
  523. package/dist/utils/environment.js +7 -5
  524. package/dist/utils/filters.d.ts +0 -1
  525. package/dist/utils/index.d.ts +2 -3
  526. package/dist/utils/index.js +1 -1
  527. package/dist/utils/pagination.d.ts +0 -1
  528. package/dist/utils/session.d.ts +7 -1
  529. package/dist/utils/session.js +3 -1
  530. package/dist/utils/trpc-client.d.ts +14 -48
  531. package/dist/utils/trpc-client.js +43 -13
  532. package/dist/utils/upload.d.ts +0 -7
  533. package/package.json +53 -9
  534. package/dist/errors/api.d.ts.map +0 -1
  535. package/dist/errors/base.d.ts.map +0 -1
  536. package/dist/errors/index.d.ts.map +0 -1
  537. package/dist/errors/upload.d.ts.map +0 -1
  538. package/dist/errors/validation.d.ts.map +0 -1
  539. package/dist/exports/base.d.ts.map +0 -1
  540. package/dist/exports/index.d.ts.map +0 -1
  541. package/dist/exports/mx/av/ari.d.ts.map +0 -1
  542. package/dist/exports/mx/av/avi.d.ts.map +0 -1
  543. package/dist/exports/mx/av/jys.d.ts.map +0 -1
  544. package/dist/exports/mx/av/mjr.d.ts.map +0 -1
  545. package/dist/exports/mx/av/tsc.d.ts.map +0 -1
  546. package/dist/exports/mx/av.d.ts.map +0 -1
  547. package/dist/exports/mx/cnbv/transmisor.d.ts.map +0 -1
  548. package/dist/exports/mx/cnbv.d.ts.map +0 -1
  549. package/dist/exports/mx/index.d.ts.map +0 -1
  550. package/dist/models/Address.d.ts.map +0 -1
  551. package/dist/models/Alert.d.ts.map +0 -1
  552. package/dist/models/AlertClientItem.d.ts.map +0 -1
  553. package/dist/models/AlertItem.d.ts.map +0 -1
  554. package/dist/models/AlertTransactionItem.d.ts.map +0 -1
  555. package/dist/models/BankAccount.d.ts.map +0 -1
  556. package/dist/models/Client.d.ts.map +0 -1
  557. package/dist/models/ContactMethod.d.ts.map +0 -1
  558. package/dist/models/Document.d.ts.map +0 -1
  559. package/dist/models/LinkedClient.d.ts.map +0 -1
  560. package/dist/models/Product.d.ts.map +0 -1
  561. package/dist/models/Transaction.d.ts.map +0 -1
  562. package/dist/models/Workflow.d.ts.map +0 -1
  563. package/dist/models/WorkflowExecution.d.ts.map +0 -1
  564. package/dist/models/WorkflowTemplate.d.ts.map +0 -1
  565. package/dist/models/WorkflowVariable.d.ts.map +0 -1
  566. package/dist/models/base.d.ts.map +0 -1
  567. package/dist/models/index.d.ts.map +0 -1
  568. package/dist/models/mx/MexAddress.d.ts.map +0 -1
  569. package/dist/models/mx/MexAlert.d.ts.map +0 -1
  570. package/dist/models/mx/MexAlertClientItem.d.ts.map +0 -1
  571. package/dist/models/mx/MexAlertItem.d.ts.map +0 -1
  572. package/dist/models/mx/MexAlertTransactionItem.d.ts.map +0 -1
  573. package/dist/models/mx/MexBankAccount.d.ts.map +0 -1
  574. package/dist/models/mx/MexClient.d.ts.map +0 -1
  575. package/dist/models/mx/MexDocument.d.ts.map +0 -1
  576. package/dist/models/mx/MexProduct.d.ts.map +0 -1
  577. package/dist/models/mx/MexTransaction.d.ts.map +0 -1
  578. package/dist/models/mx/av/MexAVAlert.d.ts.map +0 -1
  579. package/dist/models/mx/av/MexAVAlertClientItem.d.ts.map +0 -1
  580. package/dist/models/mx/av/MexAVAlertItem.d.ts.map +0 -1
  581. package/dist/models/mx/av/MexAVAlertTransactionItem.d.ts.map +0 -1
  582. package/dist/models/mx/av/MexAVClient.d.ts.map +0 -1
  583. package/dist/models/mx/av/MexAVProduct.d.ts.map +0 -1
  584. package/dist/models/mx/av/MexAVTransaction.d.ts.map +0 -1
  585. package/dist/models/mx/av/ari/MexARIAlert.d.ts.map +0 -1
  586. package/dist/models/mx/av/ari/MexARIAlertClientItem.d.ts.map +0 -1
  587. package/dist/models/mx/av/ari/MexARIAlertItem.d.ts.map +0 -1
  588. package/dist/models/mx/av/ari/MexARIAlertTransactionItem.d.ts.map +0 -1
  589. package/dist/models/mx/av/ari/MexARIClient.d.ts.map +0 -1
  590. package/dist/models/mx/av/ari/MexARIProduct.d.ts.map +0 -1
  591. package/dist/models/mx/av/ari/MexARITransaction.d.ts.map +0 -1
  592. package/dist/models/mx/av/avi/MexAVIAlert.d.ts.map +0 -1
  593. package/dist/models/mx/av/avi/MexAVIAlertClientItem.d.ts.map +0 -1
  594. package/dist/models/mx/av/avi/MexAVIAlertItem.d.ts.map +0 -1
  595. package/dist/models/mx/av/avi/MexAVIAlertTransactionItem.d.ts.map +0 -1
  596. package/dist/models/mx/av/avi/MexAVIClient.d.ts.map +0 -1
  597. package/dist/models/mx/av/avi/MexAVIProduct.d.ts.map +0 -1
  598. package/dist/models/mx/av/avi/MexAVITransaction.d.ts.map +0 -1
  599. package/dist/models/mx/av/index.d.ts.map +0 -1
  600. package/dist/models/mx/av/jys/MexJYSAlert.d.ts.map +0 -1
  601. package/dist/models/mx/av/jys/MexJYSAlertClientItem.d.ts.map +0 -1
  602. package/dist/models/mx/av/jys/MexJYSAlertItem.d.ts.map +0 -1
  603. package/dist/models/mx/av/jys/MexJYSAlertTransactionItem.d.ts.map +0 -1
  604. package/dist/models/mx/av/jys/MexJYSClient.d.ts.map +0 -1
  605. package/dist/models/mx/av/jys/MexJYSProduct.d.ts.map +0 -1
  606. package/dist/models/mx/av/jys/MexJYSTransaction.d.ts.map +0 -1
  607. package/dist/models/mx/av/mjr/MexMJRAlert.d.ts.map +0 -1
  608. package/dist/models/mx/av/mjr/MexMJRAlertClientItem.d.ts.map +0 -1
  609. package/dist/models/mx/av/mjr/MexMJRAlertItem.d.ts.map +0 -1
  610. package/dist/models/mx/av/mjr/MexMJRAlertTransactionItem.d.ts.map +0 -1
  611. package/dist/models/mx/av/mjr/MexMJRClient.d.ts.map +0 -1
  612. package/dist/models/mx/av/mjr/MexMJRProduct.d.ts.map +0 -1
  613. package/dist/models/mx/av/mjr/MexMJRTransaction.d.ts.map +0 -1
  614. package/dist/models/mx/av/tsc/MexTSCAlert.d.ts.map +0 -1
  615. package/dist/models/mx/av/tsc/MexTSCAlertClientItem.d.ts.map +0 -1
  616. package/dist/models/mx/av/tsc/MexTSCAlertItem.d.ts.map +0 -1
  617. package/dist/models/mx/av/tsc/MexTSCAlertTransactionItem.d.ts.map +0 -1
  618. package/dist/models/mx/av/tsc/MexTSCClient.d.ts.map +0 -1
  619. package/dist/models/mx/av/tsc/MexTSCProduct.d.ts.map +0 -1
  620. package/dist/models/mx/av/tsc/MexTSCTransaction.d.ts.map +0 -1
  621. package/dist/models/mx/cnbv/MexCNBVAlert.d.ts.map +0 -1
  622. package/dist/models/mx/cnbv/MexCNBVAlertClientItem.d.ts.map +0 -1
  623. package/dist/models/mx/cnbv/MexCNBVAlertItem.d.ts.map +0 -1
  624. package/dist/models/mx/cnbv/MexCNBVAlertTransactionItem.d.ts.map +0 -1
  625. package/dist/models/mx/cnbv/MexCNBVClient.d.ts.map +0 -1
  626. package/dist/models/mx/cnbv/MexCNBVProduct.d.ts.map +0 -1
  627. package/dist/models/mx/cnbv/MexCNBVTransaction.d.ts.map +0 -1
  628. package/dist/models/mx/cnbv/index.d.ts.map +0 -1
  629. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlert.d.ts.map +0 -1
  630. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertClientItem.d.ts.map +0 -1
  631. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertItem.d.ts.map +0 -1
  632. package/dist/models/mx/cnbv/transmisor/MexTransmisorAlertTransactionItem.d.ts.map +0 -1
  633. package/dist/models/mx/cnbv/transmisor/MexTransmisorClient.d.ts.map +0 -1
  634. package/dist/models/mx/cnbv/transmisor/MexTransmisorProduct.d.ts.map +0 -1
  635. package/dist/models/mx/cnbv/transmisor/MexTransmisorTransaction.d.ts.map +0 -1
  636. package/dist/models/mx/cnbv/transmisor/index.d.ts.map +0 -1
  637. package/dist/models/mx/index.d.ts.map +0 -1
  638. package/dist/models/types.d.ts.map +0 -1
  639. package/dist/resources/addresses.d.ts.map +0 -1
  640. package/dist/resources/alert-items.d.ts.map +0 -1
  641. package/dist/resources/alerts.d.ts.map +0 -1
  642. package/dist/resources/api-keys.d.ts.map +0 -1
  643. package/dist/resources/audit-logs.d.ts.map +0 -1
  644. package/dist/resources/bank-accounts.d.ts.map +0 -1
  645. package/dist/resources/base.d.ts.map +0 -1
  646. package/dist/resources/clients.d.ts.map +0 -1
  647. package/dist/resources/contact-methods.d.ts.map +0 -1
  648. package/dist/resources/documents.d.ts.map +0 -1
  649. package/dist/resources/exchange-rates.d.ts.map +0 -1
  650. package/dist/resources/index.d.ts.map +0 -1
  651. package/dist/resources/merge-tenant-defaults/index.d.ts.map +0 -1
  652. package/dist/resources/merge-tenant-defaults/mx/av/merge.d.ts.map +0 -1
  653. package/dist/resources/merge-tenant-defaults/mx/cnbv/merge.d.ts.map +0 -1
  654. package/dist/resources/merge-tenant-defaults/utils.d.ts.map +0 -1
  655. package/dist/resources/mx/addresses.d.ts.map +0 -1
  656. package/dist/resources/mx/alerts.d.ts.map +0 -1
  657. package/dist/resources/mx/av/alerts.d.ts.map +0 -1
  658. package/dist/resources/mx/av/ari/alerts.d.ts.map +0 -1
  659. package/dist/resources/mx/av/ari/clients.d.ts.map +0 -1
  660. package/dist/resources/mx/av/ari/index.d.ts.map +0 -1
  661. package/dist/resources/mx/av/ari/products.d.ts.map +0 -1
  662. package/dist/resources/mx/av/ari/tenant.d.ts.map +0 -1
  663. package/dist/resources/mx/av/ari/transactions.d.ts.map +0 -1
  664. package/dist/resources/mx/av/avi/alerts.d.ts.map +0 -1
  665. package/dist/resources/mx/av/avi/clients.d.ts.map +0 -1
  666. package/dist/resources/mx/av/avi/index.d.ts.map +0 -1
  667. package/dist/resources/mx/av/avi/products.d.ts.map +0 -1
  668. package/dist/resources/mx/av/avi/tenant.d.ts.map +0 -1
  669. package/dist/resources/mx/av/avi/transactions.d.ts.map +0 -1
  670. package/dist/resources/mx/av/clients.d.ts.map +0 -1
  671. package/dist/resources/mx/av/index.d.ts.map +0 -1
  672. package/dist/resources/mx/av/jys/alerts.d.ts.map +0 -1
  673. package/dist/resources/mx/av/jys/clients.d.ts.map +0 -1
  674. package/dist/resources/mx/av/jys/index.d.ts.map +0 -1
  675. package/dist/resources/mx/av/jys/products.d.ts.map +0 -1
  676. package/dist/resources/mx/av/jys/tenant.d.ts.map +0 -1
  677. package/dist/resources/mx/av/jys/transactions.d.ts.map +0 -1
  678. package/dist/resources/mx/av/mjr/alerts.d.ts.map +0 -1
  679. package/dist/resources/mx/av/mjr/clients.d.ts.map +0 -1
  680. package/dist/resources/mx/av/mjr/index.d.ts.map +0 -1
  681. package/dist/resources/mx/av/mjr/products.d.ts.map +0 -1
  682. package/dist/resources/mx/av/mjr/tenant.d.ts.map +0 -1
  683. package/dist/resources/mx/av/mjr/transactions.d.ts.map +0 -1
  684. package/dist/resources/mx/av/products.d.ts.map +0 -1
  685. package/dist/resources/mx/av/tenant.d.ts.map +0 -1
  686. package/dist/resources/mx/av/transactions.d.ts.map +0 -1
  687. package/dist/resources/mx/av/tsc/alerts.d.ts.map +0 -1
  688. package/dist/resources/mx/av/tsc/clients.d.ts.map +0 -1
  689. package/dist/resources/mx/av/tsc/index.d.ts.map +0 -1
  690. package/dist/resources/mx/av/tsc/products.d.ts.map +0 -1
  691. package/dist/resources/mx/av/tsc/tenant.d.ts.map +0 -1
  692. package/dist/resources/mx/av/tsc/transactions.d.ts.map +0 -1
  693. package/dist/resources/mx/bank-accounts.d.ts.map +0 -1
  694. package/dist/resources/mx/clients.d.ts.map +0 -1
  695. package/dist/resources/mx/cnbv/alerts.d.ts.map +0 -1
  696. package/dist/resources/mx/cnbv/clients.d.ts.map +0 -1
  697. package/dist/resources/mx/cnbv/index.d.ts.map +0 -1
  698. package/dist/resources/mx/cnbv/products.d.ts.map +0 -1
  699. package/dist/resources/mx/cnbv/tenant.d.ts.map +0 -1
  700. package/dist/resources/mx/cnbv/transactions.d.ts.map +0 -1
  701. package/dist/resources/mx/cnbv/transmisor/addresses.d.ts.map +0 -1
  702. package/dist/resources/mx/cnbv/transmisor/alerts.d.ts.map +0 -1
  703. package/dist/resources/mx/cnbv/transmisor/clients.d.ts.map +0 -1
  704. package/dist/resources/mx/cnbv/transmisor/index.d.ts.map +0 -1
  705. package/dist/resources/mx/cnbv/transmisor/products.d.ts.map +0 -1
  706. package/dist/resources/mx/cnbv/transmisor/tenant.d.ts.map +0 -1
  707. package/dist/resources/mx/cnbv/transmisor/transactions.d.ts.map +0 -1
  708. package/dist/resources/mx/index.d.ts.map +0 -1
  709. package/dist/resources/mx/products.d.ts.map +0 -1
  710. package/dist/resources/mx/tenant.d.ts.map +0 -1
  711. package/dist/resources/mx/transactions.d.ts.map +0 -1
  712. package/dist/resources/ocr.d.ts +0 -17
  713. package/dist/resources/ocr.d.ts.map +0 -1
  714. package/dist/resources/ocr.js +0 -33
  715. package/dist/resources/onboarding-links.d.ts +0 -101
  716. package/dist/resources/onboarding-links.d.ts.map +0 -1
  717. package/dist/resources/onboarding-links.js +0 -124
  718. package/dist/resources/products.d.ts.map +0 -1
  719. package/dist/resources/reference-data/custom-reference-data.d.ts.map +0 -1
  720. package/dist/resources/reference-data/index.d.ts.map +0 -1
  721. package/dist/resources/reference-data/reference-data.d.ts.map +0 -1
  722. package/dist/resources/reports.d.ts.map +0 -1
  723. package/dist/resources/roles.d.ts.map +0 -1
  724. package/dist/resources/tags.d.ts.map +0 -1
  725. package/dist/resources/tenant.d.ts.map +0 -1
  726. package/dist/resources/transactions.d.ts.map +0 -1
  727. package/dist/resources/users.d.ts.map +0 -1
  728. package/dist/resources/workflow-executions.d.ts.map +0 -1
  729. package/dist/resources/workflow-templates.d.ts.map +0 -1
  730. package/dist/resources/workflow-variables.d.ts.map +0 -1
  731. package/dist/resources/workflows.d.ts.map +0 -1
  732. package/dist/sdk/ComplianceSDK.d.ts.map +0 -1
  733. package/dist/sdk/base.d.ts.map +0 -1
  734. package/dist/sdk/index.d.ts.map +0 -1
  735. package/dist/sdk/mx/ComplianceSDK.d.ts.map +0 -1
  736. package/dist/sdk/mx/av/ComplianceSDK.d.ts.map +0 -1
  737. package/dist/sdk/mx/av/ari/ComplianceSDK.d.ts.map +0 -1
  738. package/dist/sdk/mx/av/ari/index.d.ts.map +0 -1
  739. package/dist/sdk/mx/av/ari/types.d.ts.map +0 -1
  740. package/dist/sdk/mx/av/avi/ComplianceSDK.d.ts.map +0 -1
  741. package/dist/sdk/mx/av/avi/index.d.ts.map +0 -1
  742. package/dist/sdk/mx/av/avi/types.d.ts.map +0 -1
  743. package/dist/sdk/mx/av/index.d.ts.map +0 -1
  744. package/dist/sdk/mx/av/jys/ComplianceSDK.d.ts.map +0 -1
  745. package/dist/sdk/mx/av/jys/index.d.ts.map +0 -1
  746. package/dist/sdk/mx/av/jys/types.d.ts.map +0 -1
  747. package/dist/sdk/mx/av/mjr/ComplianceSDK.d.ts.map +0 -1
  748. package/dist/sdk/mx/av/mjr/index.d.ts.map +0 -1
  749. package/dist/sdk/mx/av/mjr/types.d.ts.map +0 -1
  750. package/dist/sdk/mx/av/tsc/ComplianceSDK.d.ts.map +0 -1
  751. package/dist/sdk/mx/av/tsc/index.d.ts.map +0 -1
  752. package/dist/sdk/mx/av/tsc/types.d.ts.map +0 -1
  753. package/dist/sdk/mx/av/types.d.ts.map +0 -1
  754. package/dist/sdk/mx/cnbv/ComplianceSDK.d.ts.map +0 -1
  755. package/dist/sdk/mx/cnbv/index.d.ts.map +0 -1
  756. package/dist/sdk/mx/cnbv/transmisor/ComplianceSDK.d.ts.map +0 -1
  757. package/dist/sdk/mx/cnbv/transmisor/index.d.ts.map +0 -1
  758. package/dist/sdk/mx/cnbv/transmisor/types.d.ts.map +0 -1
  759. package/dist/sdk/mx/cnbv/types.d.ts.map +0 -1
  760. package/dist/sdk/mx/index.d.ts.map +0 -1
  761. package/dist/sdk/mx/registration.d.ts.map +0 -1
  762. package/dist/sdk/mx/types.d.ts.map +0 -1
  763. package/dist/sdk/registry-init.d.ts.map +0 -1
  764. package/dist/sdk/resource-registry.d.ts.map +0 -1
  765. package/dist/sdk/sdk-registry.d.ts.map +0 -1
  766. package/dist/sdk/types.d.ts.map +0 -1
  767. package/dist/utils/environment.d.ts.map +0 -1
  768. package/dist/utils/filters.d.ts.map +0 -1
  769. package/dist/utils/index.d.ts.map +0 -1
  770. package/dist/utils/pagination.d.ts.map +0 -1
  771. package/dist/utils/session.d.ts.map +0 -1
  772. package/dist/utils/trpc-client.d.ts.map +0 -1
  773. package/dist/utils/upload.d.ts.map +0 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Artu AI, Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,287 +1,194 @@
1
1
  # @artu-ai/compliance-sdk
2
2
 
3
- TypeScript SDK for the Artu Compliance API. Provides type-safe, scope-aware access to KYC verification and regulatory reporting functionality using a registry-based dispatch pattern.
3
+ Type-safe TypeScript SDK for the Artu Compliance API manage KYC/KYB clients, transactions, alerts, documents, and regulatory reporting, with first-class support for jurisdiction-specific compliance scopes (e.g. Mexico AML).
4
+
5
+ - 🔒 Fully typed requests and responses
6
+ - 🌎 Scope-aware: get types specific to a jurisdiction + activity (e.g. Mexico · Actividad Vulnerable · Activos Virtuales)
7
+ - 🔁 Async auto-pagination
8
+ - ✅ Client-side validation with clear, typed errors
4
9
 
5
10
  ## Installation
6
11
 
7
12
  ```bash
8
- # npm
9
13
  npm install @artu-ai/compliance-sdk
14
+ ```
10
15
 
11
- # pnpm
16
+ ```bash
12
17
  pnpm add @artu-ai/compliance-sdk
13
-
14
- # yarn
15
- yarn add @artu-ai/compliance-sdk
16
18
  ```
17
19
 
18
- ### Private Package Access
19
-
20
- The SDK is a private npm package. Authenticate with npm:
21
-
22
20
  ```bash
23
- npm login --scope=@artu-ai
21
+ yarn add @artu-ai/compliance-sdk
24
22
  ```
25
23
 
26
- Or add to your `.npmrc`:
24
+ `@artu-ai/shared` and `zod` are installed automatically as dependencies.
27
25
 
28
- ```ini
29
- //registry.npmjs.org/:_authToken=YOUR_NPM_TOKEN
30
- ```
31
-
32
- ## Quick Start
26
+ ## Quick start
33
27
 
34
28
  ```typescript
35
29
  import { ComplianceSDK, ClientType } from "@artu-ai/compliance-sdk";
36
30
 
37
- // Initialize the SDK (unscoped)
38
31
  const sdk = new ComplianceSDK({
39
32
  apiKey: process.env.ARTU_API_KEY,
40
- environment: "test",
41
- });
42
-
43
- // Or initialize with a scope for typed resources
44
- const aviSdk = new ComplianceSDK({
45
- apiKey: process.env.ARTU_API_KEY,
46
- environment: "test",
47
- scope: "MX:AV:AVI",
33
+ environment: "test", // "test" | "live"
48
34
  });
49
35
 
50
- // Create a client (AVI-typed)
51
- const client = await aviSdk.clients.create({
36
+ // Create a client
37
+ const client = await sdk.clients.create({
52
38
  type: ClientType.Individual,
53
39
  name: "Juan García",
40
+ scopes: ["MX"],
54
41
  });
55
42
 
56
- // List with auto-pagination
57
- for await (const txn of aviSdk.transactions.iterate()) {
43
+ // Retrieve, update
44
+ await sdk.clients.update(client.id, { name: "Juan A. García" });
45
+
46
+ // Auto-paginate
47
+ for await (const txn of sdk.transactions.iterate()) {
58
48
  console.log(txn.id, txn.amount);
59
49
  }
60
50
  ```
61
51
 
62
- ## Project Structure
52
+ ## Authentication & configuration
63
53
 
64
- ```
65
- src/
66
- ├── sdk/ # SDK classes
67
- │ ├── ComplianceSDK.ts # Main SDK with scope dispatch
68
- │ ├── base.ts # Base scope registration
69
- │ ├── types.ts # SDK configuration types
70
- │ ├── resource-registry.ts # Resource factory registry
71
- │ ├── sdk-registry.ts # SDK class dispatch registry
72
- │ └── mex/ # Mexico jurisdiction SDKs
73
- │ ├── ComplianceSDK.ts # Mexico SDK class
74
- │ ├── types.ts
75
- │ ├── actividad-vulnerable/
76
- │ │ ├── avi/ # AVI SDK class + types
77
- │ │ ├── jys/ # JYS SDK class + types
78
- │ │ ├── mjr/ # MJR SDK class + types
79
- │ │ └── tsc/ # TSC SDK class + types
80
- │ └── cnbv/
81
- │ └── transmisor/ # CNBV Transmisor SDK class + types
82
- ├── resources/ # API resource methods
83
- │ ├── base.ts # BaseResource abstract class
84
- │ ├── clients.ts
85
- │ ├── addresses.ts
86
- │ ├── bank-accounts.ts
87
- │ ├── contact-methods.ts
88
- │ ├── documents.ts
89
- │ ├── transactions.ts
90
- │ ├── alerts.ts
91
- │ ├── reports.ts
92
- │ ├── rules.ts
93
- │ ├── rule-variables.ts
94
- │ ├── exchange-rates.ts
95
- │ ├── ocr.ts
96
- │ └── mex/ # Mexico-specific resources
97
- │ ├── clients.ts # MexClientsResource
98
- │ ├── transactions.ts
99
- │ ├── alerts.ts
100
- │ ├── addresses.ts
101
- │ ├── bank-accounts.ts
102
- │ ├── actividad-vulnerable/
103
- │ │ ├── avi/ # AVI-specific resources
104
- │ │ ├── jys/
105
- │ │ ├── mjr/
106
- │ │ └── tsc/
107
- │ └── cnbv/
108
- │ └── transmisor/
109
- ├── models/ # Data models with helpers
110
- │ ├── base.ts
111
- │ ├── Client.ts # Type guards (isIndividual, isCompany)
112
- │ ├── Transaction.ts
113
- │ ├── Alert.ts
114
- │ ├── Address.ts
115
- │ ├── BankAccount.ts
116
- │ ├── Document.ts
117
- │ └── mex/ # Mexico-specific models
118
- ├── errors/ # Error types
119
- │ ├── base.ts
120
- │ ├── api.ts # ComplianceAPIError
121
- │ └── validation.ts # ValidationError
122
- ├── utils/
123
- │ ├── trpc-client.ts # tRPC client factory
124
- │ ├── environment.ts # Environment resolution
125
- │ ├── session.ts
126
- │ ├── filters.ts
127
- │ └── pagination.ts
128
- └── exports/ # Entry point exports
129
- ├── base.ts
130
- ├── index.ts
131
- └── mexico/
132
- ├── index.ts
133
- └── actividad-vulnerable/
134
- ├── avi.ts
135
- ├── jys.ts
136
- ├── mjr.ts
137
- └── tsc.ts
54
+ ```typescript
55
+ const sdk = new ComplianceSDK({
56
+ apiKey: "sk_test_...", // or the ARTU_API_KEY env var
57
+ environment: "test", // "test" | "live" (or ARTU_ENVIRONMENT)
58
+
59
+ // Optional
60
+ scope: "MX:AV:AVI", // see "Scopes" below
61
+ baseUrl: "https://api.artu.ai",
62
+ organizationId: "org_...",
63
+ apiVersion: "v1",
64
+ timeout: 30000, // ms
65
+ });
138
66
  ```
139
67
 
140
- ## Scope System
68
+ Configuration can also be supplied via environment variables: `ARTU_API_KEY`,
69
+ `ARTU_ENVIRONMENT`, `ARTU_BASE_URL`, `ARTU_ORGANIZATION_ID`.
141
70
 
142
- The SDK uses a **registry-based dispatch pattern**. When you construct a `ComplianceSDK` with a scope, it returns a scope-typed instance with the correct resource types:
71
+ ### Browser / server-side (cookie auth)
143
72
 
144
- ```typescript
145
- import { ComplianceSDK } from "@artu-ai/compliance-sdk";
73
+ For session-cookie authentication (e.g. a dashboard or a Next.js server component),
74
+ use cookie mode instead of an API key:
146
75
 
147
- // Unscoped — base types
148
- const sdk = new ComplianceSDK({ apiKey, environment: "test" });
149
-
150
- // Mexico scope — Mexico-typed resources
151
- const mexSdk = new ComplianceSDK({ apiKey, environment: "test", scope: "MX" });
152
-
153
- // AVI scope — AVI-typed resources (clients, transactions, alerts)
154
- const aviSdk = new ComplianceSDK({ apiKey, environment: "test", scope: "MX:AV:AVI" });
76
+ ```typescript
77
+ // Browser send the session cookie with each request
78
+ const sdk = new ComplianceSDK({ mode: "cookie", environment: "test", credentials: "include" });
155
79
 
156
- // Properties
157
- aviSdk.scope // "MX:AV:AVI"
158
- aviSdk.isScoped // true
159
- aviSdk.environment // "test"
160
- aviSdk.isTest // true
161
- aviSdk.isLive // false
80
+ // Next.js server component — forward the incoming cookie
81
+ import { cookies } from "next/headers";
82
+ const sdk = new ComplianceSDK({
83
+ mode: "cookie",
84
+ environment: "test",
85
+ headers: { cookie: (await cookies()).toString() },
86
+ });
162
87
  ```
163
88
 
164
- ### Scope-Specific Entry Points
89
+ ## Scopes
165
90
 
166
- For static typing without runtime dispatch, import from scope-specific entry points:
91
+ Scopes partition data by jurisdiction and regulated activity. Pass a `scope` and the SDK
92
+ returns an instance whose resources are typed for that scope:
167
93
 
168
94
  ```typescript
169
- // Unscoped
170
- import { ComplianceSDK } from "@artu-ai/compliance-sdk";
95
+ // Unscoped — base types
96
+ const sdk = new ComplianceSDK({ apiKey, environment: "test" });
171
97
 
172
98
  // Mexico
173
- import { ComplianceSDK } from "@artu-ai/compliance-sdk/mx";
99
+ const mx = new ComplianceSDK({ apiKey, environment: "test", scope: "MX" });
174
100
 
175
- // Actividad Vulnerable scopes
176
- import { ComplianceSDK } from "@artu-ai/compliance-sdk/mx/av/avi";
177
- import { ComplianceSDK } from "@artu-ai/compliance-sdk/mx/av/jys";
178
- import { ComplianceSDK } from "@artu-ai/compliance-sdk/mx/av/mjr";
179
- import { ComplianceSDK } from "@artu-ai/compliance-sdk/mx/av/tsc";
101
+ // Mexico · Actividad Vulnerable · Activos Virtuales (crypto) — AVI-typed resources
102
+ const avi = new ComplianceSDK({ apiKey, environment: "test", scope: "MX:AV:AVI" });
180
103
 
181
- // CNBV
182
- import { ComplianceSDK } from "@artu-ai/compliance-sdk/mx/cnbv/transmisor";
104
+ avi.scope; // "MX:AV:AVI"
105
+ avi.isScoped; // true
106
+ avi.environment; // "test"
107
+ avi.isTest; // true
183
108
  ```
184
109
 
185
- Each entry point re-exports scope-specific types:
110
+ ### Scoped entry points
111
+
112
+ For static typing without runtime dispatch, import from a scope-specific entry point. Each
113
+ re-exports the input/output types and resources for that scope:
186
114
 
187
115
  ```typescript
188
116
  import {
189
117
  ComplianceSDK,
190
- type CreateClientInput, // AVI-specific create input
191
- type Client, // AVI-typed client
192
- ClientsResource, // AVI clients resource
118
+ type CreateClientInput, // AVI-specific
119
+ type Client, // AVI-typed
193
120
  } from "@artu-ai/compliance-sdk/mx/av/avi";
194
121
  ```
195
122
 
196
- ### Resource Factory Pattern
197
-
198
- Resources are registered per scope and fall back to parent scopes:
199
-
200
- ```
201
- Query for "MX:AV:AVI"
202
- ├── Try exact match → AVIClientsResource, AVITransactionsResource
203
- ├── Fallback to "MX" → MexBankAccountsResource, MexAddressesResource
204
- └── Fallback to "base" → DocumentsResource, RulesResource
205
- ```
206
-
207
- ## SDK Configuration
123
+ Available entry points:
208
124
 
209
- ```typescript
210
- const sdk = new ComplianceSDK({
211
- // Auth (choose one mode)
212
- mode: "apiKey", // "apiKey" | "cookie"
213
- apiKey: string, // or ARTU_API_KEY env var
214
- credentials: "include", // for cookie mode (browser)
215
- headers: { cookie: "..." }, // for cookie mode (Next.js server-side)
216
-
217
- // Environment
218
- environment: "test" | "live", // or ARTU_ENVIRONMENT env var
219
- baseUrl: string, // or ARTU_BASE_URL env var
220
- organizationId: string, // or ARTU_ORGANIZATION_ID env var
221
-
222
- // Scope (optional)
223
- scope: "MX:AV:AVI", // Jurisdiction scope
224
-
225
- // Options
226
- apiVersion: "v1",
227
- timeout: 30000, // ms
228
- });
229
- ```
125
+ | Import path | Scope |
126
+ | --- | --- |
127
+ | `@artu-ai/compliance-sdk` | Base (all data) |
128
+ | `@artu-ai/compliance-sdk/mx` | Mexico |
129
+ | `@artu-ai/compliance-sdk/mx/av/avi` | MX · Actividad Vulnerable · Activos Virtuales |
130
+ | `@artu-ai/compliance-sdk/mx/av/ari` | MX · Actividad Vulnerable · Arrendamiento |
131
+ | `@artu-ai/compliance-sdk/mx/av/inm` | MX · Actividad Vulnerable · Inmuebles |
132
+ | `@artu-ai/compliance-sdk/mx/av/jys` | MX · Actividad Vulnerable · Joyería y Piedras |
133
+ | `@artu-ai/compliance-sdk/mx/av/mjr` | MX · Actividad Vulnerable · Metales y Joyas |
134
+ | `@artu-ai/compliance-sdk/mx/av/tsc` | MX · Actividad Vulnerable · Tarjetas de Servicio |
135
+ | `@artu-ai/compliance-sdk/mx/cnbv` | MX · CNBV |
136
+ | `@artu-ai/compliance-sdk/mx/cnbv/transmisor` | MX · CNBV · Transmisores de Dinero |
230
137
 
231
138
  ## Resources
232
139
 
233
- | Resource | Description | Methods |
234
- | -------------------- | ------------------ | ----------------------------------------------------------- |
235
- | `sdk.clients` | Client management | `list`, `retrieve`, `create`, `update`, `delete`, `iterate` |
236
- | `sdk.addresses` | Address management | `list`, `retrieve`, `create`, `update`, `delete` |
237
- | `sdk.bankAccounts` | Bank accounts | `list`, `retrieve`, `create`, `update`, `delete` |
238
- | `sdk.contactMethods` | Contact methods | `list`, `retrieve`, `create`, `update`, `delete` |
239
- | `sdk.documents` | Documents | `list`, `retrieve`, `create`, `update`, `delete` |
240
- | `sdk.transactions` | Transactions | `list`, `retrieve`, `create`, `update`, `delete`, `iterate` |
241
- | `sdk.alerts` | Alerts | `list`, `retrieve`, `create`, `update`, `delete`, `generate`, `validate`, `submit` |
242
- | `sdk.reports` | Reports | `list`, `retrieve`, `create` |
243
- | `sdk.rules` | Monitoring rules | `list`, `retrieve`, `create`, `update`, `delete` |
244
- | `sdk.ruleVariables` | Rule variables | `list`, `retrieve`, `create`, `update`, `delete` |
245
- | `sdk.exchangeRates` | Exchange rates | `list`, `retrieve` |
246
- | `sdk.ocr` | OCR extraction | `extract` |
140
+ Resources are accessed as properties on the SDK instance. Each supports the standard
141
+ operations `list`, `retrieve`, `create`, `update`, `delete` — and list endpoints also
142
+ provide `iterate()` for async auto-pagination.
143
+
144
+ | Resource | Description |
145
+ | --- | --- |
146
+ | `sdk.clients` | KYC/KYB clients (individuals, companies, trusts) |
147
+ | `sdk.transactions` | Transactions |
148
+ | `sdk.alerts` | Regulatory alerts (also `generate`, `validate`, `submit`) |
149
+ | `sdk.documents` | Documents |
150
+ | `sdk.evidence` | Supporting evidence and file uploads |
151
+ | `sdk.addresses` | Addresses |
152
+ | `sdk.bankAccounts` | Bank accounts |
153
+ | `sdk.contactMethods` | Contact methods |
154
+ | `sdk.products` | Products |
155
+ | `sdk.reports` | Regulatory reports |
156
+ | `sdk.exchangeRates` | Exchange rates (read-only) |
157
+ | `sdk.workflows` | Compliance workflows |
158
+ | `sdk.auditLogs` | Audit trail (read-only) |
159
+ | `sdk.tenant` | Tenant settings and defaults |
160
+
161
+ The SDK also exposes account-management resources (`sdk.users`, `sdk.roles`, `sdk.apiKeys`).
162
+ Workflow tooling is nested under `sdk.workflows` — `sdk.workflows.executions`,
163
+ `.variables`, `.templates`, and `.links`. See the full API reference in the Artu documentation.
247
164
 
248
165
  ## Models
249
166
 
250
- All resources return model instances with helper methods:
167
+ Resource methods return immutable model instances with typed accessors and type guards:
251
168
 
252
169
  ```typescript
253
170
  const client = await sdk.clients.retrieve("client_123");
254
171
 
255
- // Type guards
256
- if (client.isIndividual()) {
257
- console.log(client.data.dateOfBirth);
172
+ if (client.isIndividual) {
173
+ console.log(client.birthDate);
174
+ } else if (client.isCompany) {
175
+ console.log(client.incorporationDate);
258
176
  }
259
- if (client.isCompany()) {
260
- console.log(client.data.incorporationDate);
261
- }
262
-
263
- // Refresh from server
264
- await client.refresh();
265
177
 
266
- // Update in place
267
- await client.update({ name: "New Name" });
178
+ // Models are immutable data containers — persist changes through the resource:
179
+ const updated = await sdk.clients.update(client.id, { name: "New Name" });
268
180
  ```
269
181
 
270
182
  ## Pagination
271
183
 
272
- ### Auto-pagination
273
-
274
184
  ```typescript
185
+ // Auto-pagination
275
186
  for await (const client of sdk.clients.iterate()) {
276
187
  console.log(client.id);
277
188
  }
278
- ```
279
189
 
280
- ### Manual Pagination
281
-
282
- ```typescript
190
+ // Manual pagination
283
191
  const page1 = await sdk.clients.list({ limit: 10 });
284
-
285
192
  if (page1.hasMore) {
286
193
  const page2 = await sdk.clients.list({
287
194
  limit: 10,
@@ -290,80 +197,45 @@ if (page1.hasMore) {
290
197
  }
291
198
  ```
292
199
 
293
- ## Filtering & Sorting
200
+ ## Filtering & sorting
294
201
 
295
202
  ```typescript
296
203
  const clients = await sdk.clients.list({
297
- filter: {
298
- type: "individual",
299
- primaryJurisdiction: "mexico",
300
- },
301
- sort: {
302
- field: "createdAt",
303
- order: "desc",
304
- },
204
+ filter: { type: "individual" },
205
+ sort: { field: "createdAt", order: "desc" },
305
206
  });
306
207
  ```
307
208
 
308
- ## Error Handling
209
+ ## Error handling
210
+
211
+ All errors extend `ComplianceError`. The two you'll handle most often are `ValidationError`
212
+ (client-side input validation) and `APIError` (errors returned by the API):
309
213
 
310
214
  ```typescript
311
- import { ComplianceAPIError, ValidationError } from "@artu-ai/compliance-sdk";
215
+ import { APIError, ValidationError } from "@artu-ai/compliance-sdk";
312
216
 
313
217
  try {
314
218
  await sdk.clients.create({ /* ... */ });
315
219
  } catch (error) {
316
220
  if (error instanceof ValidationError) {
317
- console.log("Validation errors:", error.errors);
318
- } else if (error instanceof ComplianceAPIError) {
221
+ console.log("Invalid input:", error.errors);
222
+ } else if (error instanceof APIError) {
319
223
  console.log("API error:", error.code, error.message);
320
224
  }
321
225
  }
322
226
  ```
323
227
 
324
- ## API Communication
325
-
326
- The SDK communicates with the API via a tRPC client using `httpBatchLink`:
327
-
328
- ```
329
- SDK method call (e.g., sdk.clients.list())
330
- → Input validation (Zod schema)
331
- → tRPC client call
332
- → POST {baseUrl}/api/trpc (batched)
333
- → Response deserialization
334
- → Error mapping (tRPC → ValidationError | ComplianceAPIError)
335
- → Return typed model instance
336
- ```
337
-
338
- ## Scripts
339
-
340
- | Script | Description |
341
- | ------------------ | ------------------------ |
342
- | `pnpm build` | Build package |
343
- | `pnpm test` | Run tests |
344
- | `pnpm test:watch` | Run tests in watch mode |
345
- | `pnpm lint` | Run ESLint |
346
- | `pnpm check-types` | TypeScript type checking |
347
-
348
- ## Key Files
228
+ `APIError` has typed subclasses you can narrow on when useful: `NotFoundError`,
229
+ `UnauthorizedError`, `ForbiddenError`, `RateLimitError`, `ServerError`, `NetworkError`,
230
+ and `TimeoutError`.
349
231
 
350
- | File | Description |
351
- | ---- | ----------- |
352
- | [`src/sdk/ComplianceSDK.ts`](./src/sdk/ComplianceSDK.ts) | Main SDK class with scope dispatch |
353
- | [`src/sdk/resource-registry.ts`](./src/sdk/resource-registry.ts) | Resource factory registration |
354
- | [`src/sdk/sdk-registry.ts`](./src/sdk/sdk-registry.ts) | SDK class dispatch |
355
- | [`src/resources/base.ts`](./src/resources/base.ts) | BaseResource abstract class |
356
- | [`src/models/`](./src/models/) | Data models with helper methods |
357
- | [`src/errors/`](./src/errors/) | Error type definitions |
358
- | [`src/utils/trpc-client.ts`](./src/utils/trpc-client.ts) | tRPC client factory |
232
+ ## Documentation
359
233
 
360
- ## Related Packages
234
+ Full guides and API reference are at **[docs.artu.ai](https://docs.artu.ai)**:
361
235
 
362
- - [`@artu-ai/compliance-sdk-react`](../sdk-react/README.md) - React hooks built on this SDK
363
- - [`@artu-ai/shared`](../shared/README.md) - Shared schemas, scopes, and types
364
- - [`apps/api`](../../apps/api/README.md) - API server
365
- - [`apps/docs`](../../apps/docs/README.md) - SDK documentation
236
+ - [SDK guide](https://docs.artu.ai/sdk)
237
+ - [API reference](https://docs.artu.ai/api-reference)
366
238
 
367
239
  ## License
368
240
 
369
- UNLICENSED - Private package for Artu AI organization members only.
241
+ [MIT](./LICENSE)
@@ -78,6 +78,22 @@ export declare class UnauthorizedError extends APIError {
78
78
  export declare class ForbiddenError extends APIError {
79
79
  constructor(message?: string, requestId?: string);
80
80
  }
81
+ /**
82
+ * Organization mismatch error (403).
83
+ *
84
+ * Thrown when the client-asserted `X-Organization-ID` no longer matches the
85
+ * organization of the authenticated session — typically a stale browser tab
86
+ * after the user switched organizations in another tab. This is an expected,
87
+ * transient condition, not a permissions failure; host applications should
88
+ * recover by re-syncing to the session's current organization rather than
89
+ * surfacing it as an error.
90
+ *
91
+ * Subclasses `ForbiddenError` so existing `instanceof ForbiddenError` handling
92
+ * continues to work.
93
+ */
94
+ export declare class OrganizationMismatchError extends ForbiddenError {
95
+ constructor(message?: string, requestId?: string);
96
+ }
81
97
  /**
82
98
  * Rate limit exceeded error (429).
83
99
  * Includes retry information when available.
@@ -157,4 +173,3 @@ export declare function mapTRPCError(error: TRPCClientError<any>): ComplianceErr
157
173
  * @returns True if error is an instance of the specified type
158
174
  */
159
175
  export declare function isAPIError<T extends typeof APIError>(error: unknown, type?: T): error is InstanceType<T>;
160
- //# sourceMappingURL=api.d.ts.map
@@ -101,6 +101,25 @@ export class ForbiddenError extends APIError {
101
101
  this.name = "ForbiddenError";
102
102
  }
103
103
  }
104
+ /**
105
+ * Organization mismatch error (403).
106
+ *
107
+ * Thrown when the client-asserted `X-Organization-ID` no longer matches the
108
+ * organization of the authenticated session — typically a stale browser tab
109
+ * after the user switched organizations in another tab. This is an expected,
110
+ * transient condition, not a permissions failure; host applications should
111
+ * recover by re-syncing to the session's current organization rather than
112
+ * surfacing it as an error.
113
+ *
114
+ * Subclasses `ForbiddenError` so existing `instanceof ForbiddenError` handling
115
+ * continues to work.
116
+ */
117
+ export class OrganizationMismatchError extends ForbiddenError {
118
+ constructor(message = "Organization ID mismatch: the authenticated organization does not match the requested organization", requestId) {
119
+ super(message, requestId);
120
+ this.name = "OrganizationMismatchError";
121
+ }
122
+ }
104
123
  /**
105
124
  * Rate limit exceeded error (429).
106
125
  * Includes retry information when available.
@@ -211,6 +230,9 @@ export function mapTRPCError(error) {
211
230
  case "UNAUTHORIZED":
212
231
  return new UnauthorizedError(error.message, requestId);
213
232
  case "FORBIDDEN":
233
+ if (data?.reason === "organization_mismatch") {
234
+ return new OrganizationMismatchError(error.message, requestId);
235
+ }
214
236
  return new ForbiddenError(error.message, requestId);
215
237
  case "BAD_REQUEST": {
216
238
  // Check for Zod validation errors
@@ -84,4 +84,11 @@ export declare class ComplianceError extends Error {
84
84
  */
85
85
  toSupportInfo(): string;
86
86
  }
87
- //# sourceMappingURL=base.d.ts.map
87
+ /**
88
+ * Thrown when a scoped SDK read is given an explicit scope filter without
89
+ * `crossScope: true`. The scoped SDK injects its own scope filter; passing
90
+ * one explicitly is ambiguous, so we fail loudly before the network call.
91
+ */
92
+ export declare class ScopeViolationError extends ComplianceError {
93
+ constructor(scope: string, key: "scope" | "scopes");
94
+ }
@@ -82,3 +82,15 @@ export class ComplianceError extends Error {
82
82
  return parts.join("\n");
83
83
  }
84
84
  }
85
+ /**
86
+ * Thrown when a scoped SDK read is given an explicit scope filter without
87
+ * `crossScope: true`. The scoped SDK injects its own scope filter; passing
88
+ * one explicitly is ambiguous, so we fail loudly before the network call.
89
+ */
90
+ export class ScopeViolationError extends ComplianceError {
91
+ constructor(scope, key) {
92
+ super(`Scoped SDK (scope=${scope}) cannot accept an explicit \`${key}\` filter. ` +
93
+ `Pass \`crossScope: true\` to broaden the query, or use an unscoped SDK.`, "SCOPE_VIOLATION");
94
+ this.name = "ScopeViolationError";
95
+ }
96
+ }
@@ -13,6 +13,7 @@
13
13
  * │ ├── NotFoundError
14
14
  * │ ├── UnauthorizedError
15
15
  * │ ├── ForbiddenError
16
+ * │ │ └── OrganizationMismatchError
16
17
  * │ ├── RateLimitError
17
18
  * │ ├── ServerError
18
19
  * │ ├── NetworkError
@@ -25,8 +26,8 @@
25
26
  * └── UploadUrlExpiredError
26
27
  * ```
27
28
  */
28
- export { APIError, ForbiddenError, isAPIError, mapTRPCError, NetworkError, NotFoundError, RateLimitError, ServerError, TimeoutError, UnauthorizedError, } from "./api";
29
- export { ComplianceError, type ComplianceErrorJSON, type ComplianceErrorOptions, } from "./base";
29
+ export { APIError, ForbiddenError, isAPIError, mapTRPCError, NetworkError, NotFoundError, OrganizationMismatchError, RateLimitError, ServerError, TimeoutError, UnauthorizedError, } from "./api";
30
+ export { ComplianceError, type ComplianceErrorJSON, type ComplianceErrorOptions, ScopeViolationError, } from "./base";
31
+ export { MigrationBlockedError } from "./migration";
30
32
  export { FileTooLargeError, InvalidFileTypeError, isUploadError, UploadAbortedError, UploadError, type UploadStage, UploadTimeoutError, UploadUrlExpiredError, } from "./upload";
31
33
  export { ValidationError, type ValidationIssue } from "./validation";
32
- //# sourceMappingURL=index.d.ts.map
@@ -13,6 +13,7 @@
13
13
  * │ ├── NotFoundError
14
14
  * │ ├── UnauthorizedError
15
15
  * │ ├── ForbiddenError
16
+ * │ │ └── OrganizationMismatchError
16
17
  * │ ├── RateLimitError
17
18
  * │ ├── ServerError
18
19
  * │ ├── NetworkError
@@ -26,9 +27,11 @@
26
27
  * ```
27
28
  */
28
29
  // API errors
29
- export { APIError, ForbiddenError, isAPIError, mapTRPCError, NetworkError, NotFoundError, RateLimitError, ServerError, TimeoutError, UnauthorizedError, } from "./api";
30
+ export { APIError, ForbiddenError, isAPIError, mapTRPCError, NetworkError, NotFoundError, OrganizationMismatchError, RateLimitError, ServerError, TimeoutError, UnauthorizedError, } from "./api";
30
31
  // Base error
31
- export { ComplianceError, } from "./base";
32
+ export { ComplianceError, ScopeViolationError, } from "./base";
33
+ // Migration errors
34
+ export { MigrationBlockedError } from "./migration";
32
35
  // Upload errors
33
36
  export { FileTooLargeError, InvalidFileTypeError, isUploadError, UploadAbortedError, UploadError, UploadTimeoutError, UploadUrlExpiredError, } from "./upload";
34
37
  // Validation errors