digicust_types 1.7.141 → 1.7.145

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 (332) hide show
  1. package/lib/contracts/import-ocr-document-into-graph.dto.d.ts +10 -10
  2. package/lib/contracts/import-ocr-document-into-graph.dto.js +2 -2
  3. package/lib/contracts/index.d.ts +14 -14
  4. package/lib/contracts/index.js +26 -26
  5. package/lib/contracts/start-dakosy-submission.dto.d.ts +7 -7
  6. package/lib/contracts/start-dakosy-submission.dto.js +2 -2
  7. package/lib/contracts/start-data-extraction.dto.d.ts +16 -16
  8. package/lib/contracts/start-data-extraction.dto.js +2 -2
  9. package/lib/contracts/start-data-integration.dto.d.ts +7 -7
  10. package/lib/contracts/start-data-integration.dto.js +2 -2
  11. package/lib/contracts/start-data-normalization.dto.d.ts +7 -7
  12. package/lib/contracts/start-data-normalization.dto.js +2 -2
  13. package/lib/contracts/start-data-validation.dto.d.ts +7 -7
  14. package/lib/contracts/start-data-validation.dto.js +2 -2
  15. package/lib/contracts/start-document-classifier.dto.d.ts +7 -7
  16. package/lib/contracts/start-document-classifier.dto.js +2 -2
  17. package/lib/contracts/start-document-merger.dto.d.ts +12 -12
  18. package/lib/contracts/start-document-merger.dto.js +2 -2
  19. package/lib/contracts/start-document-splitting.dto.d.ts +9 -9
  20. package/lib/contracts/start-document-splitting.dto.js +2 -2
  21. package/lib/contracts/start-hs-classification-research.dto.d.ts +5 -5
  22. package/lib/contracts/start-hs-classification-research.dto.js +2 -2
  23. package/lib/contracts/start-hs-classifier.dto.d.ts +8 -8
  24. package/lib/contracts/start-hs-classifier.dto.js +2 -2
  25. package/lib/contracts/start-ocr.dto.d.ts +9 -9
  26. package/lib/contracts/start-ocr.dto.js +2 -2
  27. package/lib/contracts/start-post-processing.dto.d.ts +7 -7
  28. package/lib/contracts/start-post-processing.dto.js +2 -2
  29. package/lib/contracts/trigger-event.dto.d.ts +7 -7
  30. package/lib/contracts/trigger-event.dto.js +2 -2
  31. package/lib/helpers/cleanObject.d.ts +6 -6
  32. package/lib/helpers/cleanObject.js +28 -28
  33. package/lib/index.d.ts +2 -2
  34. package/lib/index.js +14 -14
  35. package/lib/models/common/address.model.d.ts +22 -22
  36. package/lib/models/common/address.model.js +13 -13
  37. package/lib/models/common/bbox.model.d.ts +22 -22
  38. package/lib/models/common/bbox.model.js +2 -2
  39. package/lib/models/common/classification-code.model.d.ts +5 -5
  40. package/lib/models/common/classification-code.model.js +2 -2
  41. package/lib/models/common/company.model.d.ts +22 -22
  42. package/lib/models/common/company.model.js +2 -2
  43. package/lib/models/common/country.model.d.ts +4 -4
  44. package/lib/models/common/country.model.js +2 -2
  45. package/lib/models/common/currency.enum.d.ts +181 -181
  46. package/lib/models/common/currency.enum.js +185 -185
  47. package/lib/models/common/customs-tariff-number.model.d.ts +25 -25
  48. package/lib/models/common/customs-tariff-number.model.js +21 -21
  49. package/lib/models/common/date.model.d.ts +5 -5
  50. package/lib/models/common/date.model.js +2 -2
  51. package/lib/models/common/dialog-window.model.d.ts +6 -6
  52. package/lib/models/common/dialog-window.model.js +2 -2
  53. package/lib/models/common/dimensions-unit.enum.d.ts +7 -7
  54. package/lib/models/common/dimensions-unit.enum.js +11 -11
  55. package/lib/models/common/dimensions.model.d.ts +8 -8
  56. package/lib/models/common/dimensions.model.js +2 -2
  57. package/lib/models/common/extra-styles.model.d.ts +4 -4
  58. package/lib/models/common/extra-styles.model.js +2 -2
  59. package/lib/models/common/field-type.enum.d.ts +10 -10
  60. package/lib/models/common/field-type.enum.js +14 -14
  61. package/lib/models/common/filter.enum.d.ts +5 -5
  62. package/lib/models/common/filter.enum.js +9 -9
  63. package/lib/models/common/frontend-fields.model.d.ts +11 -11
  64. package/lib/models/common/frontend-fields.model.js +2 -2
  65. package/lib/models/common/fuzzy-input.d.ts +4 -4
  66. package/lib/models/common/fuzzy-input.js +2 -2
  67. package/lib/models/common/hs-classification-interaction.d.ts +30 -30
  68. package/lib/models/common/hs-classification-interaction.js +2 -2
  69. package/lib/models/common/hs-classification-response.d.ts +31 -31
  70. package/lib/models/common/hs-classification-response.js +2 -2
  71. package/lib/models/common/hs-code.model.d.ts +11 -11
  72. package/lib/models/common/hs-code.model.js +2 -2
  73. package/lib/models/common/index.d.ts +28 -28
  74. package/lib/models/common/index.js +44 -44
  75. package/lib/models/common/language.model.d.ts +4 -4
  76. package/lib/models/common/language.model.js +2 -2
  77. package/lib/models/common/meta.d.ts +35 -35
  78. package/lib/models/common/meta.js +15 -15
  79. package/lib/models/common/money.model.d.ts +11 -11
  80. package/lib/models/common/money.model.js +16 -16
  81. package/lib/models/common/multerfile.model.d.ts +12 -12
  82. package/lib/models/common/multerfile.model.js +2 -2
  83. package/lib/models/common/package-type.model.d.ts +10 -10
  84. package/lib/models/common/package-type.model.js +2 -2
  85. package/lib/models/common/periods.enum.d.ts +5 -5
  86. package/lib/models/common/periods.enum.js +9 -9
  87. package/lib/models/common/person.model.d.ts +12 -12
  88. package/lib/models/common/person.model.js +2 -2
  89. package/lib/models/common/prefix.enum.d.ts +5 -5
  90. package/lib/models/common/prefix.enum.js +10 -10
  91. package/lib/models/common/quantity.model.d.ts +15 -15
  92. package/lib/models/common/quantity.model.js +10 -10
  93. package/lib/models/common/section-type.enum.d.ts +12 -12
  94. package/lib/models/common/section-type.enum.js +16 -16
  95. package/lib/models/common/sort.enum.d.ts +4 -4
  96. package/lib/models/common/sort.enum.js +8 -8
  97. package/lib/models/common/subscription-price.model.d.ts +9 -9
  98. package/lib/models/common/subscription-price.model.js +2 -2
  99. package/lib/models/common/super.d.ts +7 -7
  100. package/lib/models/common/super.js +2 -2
  101. package/lib/models/common/uom.enum.d.ts +39 -39
  102. package/lib/models/common/uom.enum.js +44 -44
  103. package/lib/models/common/weight-unit.enum.d.ts +10 -10
  104. package/lib/models/common/weight-unit.enum.js +14 -14
  105. package/lib/models/common/weight.model.d.ts +7 -7
  106. package/lib/models/common/weight.model.js +15 -15
  107. package/lib/models/common/workflow.d.ts +23 -22
  108. package/lib/models/common/workflow.js +2 -2
  109. package/lib/models/digicust/AnalyzerMetadataModel.model.d.ts +13 -12
  110. package/lib/models/digicust/AnalyzerMetadataModel.model.js +2 -2
  111. package/lib/models/digicust/QueueWorkspaceModel.model.d.ts +13 -12
  112. package/lib/models/digicust/QueueWorkspaceModel.model.js +2 -2
  113. package/lib/models/digicust/activity.mode.d.ts +18 -18
  114. package/lib/models/digicust/activity.mode.js +2 -2
  115. package/lib/models/digicust/activity.model.d.ts +16 -16
  116. package/lib/models/digicust/activity.model.js +2 -2
  117. package/lib/models/digicust/adjustment.model.d.ts +7 -7
  118. package/lib/models/digicust/adjustment.model.js +2 -2
  119. package/lib/models/digicust/aggregated-case-data.model.d.ts +85 -85
  120. package/lib/models/digicust/aggregated-case-data.model.js +25 -25
  121. package/lib/models/digicust/case-status.enum.d.ts +22 -22
  122. package/lib/models/digicust/case-status.enum.js +26 -26
  123. package/lib/models/digicust/case-submission-transaction.d.ts +29 -29
  124. package/lib/models/digicust/case-submission-transaction.js +19 -19
  125. package/lib/models/digicust/case-type.enum.d.ts +7 -7
  126. package/lib/models/digicust/case-type.enum.js +11 -11
  127. package/lib/models/digicust/case.model.d.ts +47 -47
  128. package/lib/models/digicust/case.model.js +24 -24
  129. package/lib/models/digicust/company.model.d.ts +4 -4
  130. package/lib/models/digicust/company.model.js +2 -2
  131. package/lib/models/digicust/consignment-size.enum.d.ts +4 -4
  132. package/lib/models/digicust/consignment-size.enum.js +8 -8
  133. package/lib/models/digicust/container.model.d.ts +7 -7
  134. package/lib/models/digicust/container.model.js +2 -2
  135. package/lib/models/digicust/context.model.d.ts +9 -9
  136. package/lib/models/digicust/context.model.js +2 -2
  137. package/lib/models/digicust/cost-intersection.model.d.ts +20 -20
  138. package/lib/models/digicust/cost-intersection.model.js +16 -16
  139. package/lib/models/digicust/custom-document.model.d.ts +8 -8
  140. package/lib/models/digicust/custom-document.model.js +2 -2
  141. package/lib/models/digicust/customer.model.d.ts +55 -55
  142. package/lib/models/digicust/customer.model.js +2 -2
  143. package/lib/models/digicust/customsOffice.model.d.ts +15 -15
  144. package/lib/models/digicust/customsOffice.model.js +12 -12
  145. package/lib/models/digicust/declaration.model.d.ts +4 -4
  146. package/lib/models/digicust/declaration.model.js +2 -2
  147. package/lib/models/digicust/digicust-document-type.enum.d.ts +15 -15
  148. package/lib/models/digicust/digicust-document-type.enum.js +19 -19
  149. package/lib/models/digicust/digicust-document.model.d.ts +45 -45
  150. package/lib/models/digicust/digicust-document.model.js +38 -38
  151. package/lib/models/digicust/document-code.model.d.ts +12 -12
  152. package/lib/models/digicust/document-code.model.js +2 -2
  153. package/lib/models/digicust/document-status.enum.d.ts +38 -38
  154. package/lib/models/digicust/document-status.enum.js +45 -45
  155. package/lib/models/digicust/documents/custom-document.model.d.ts +8 -8
  156. package/lib/models/digicust/documents/custom-document.model.js +2 -2
  157. package/lib/models/digicust/documents/digicust-document-type.enum.d.ts +15 -15
  158. package/lib/models/digicust/documents/digicust-document-type.enum.js +19 -19
  159. package/lib/models/digicust/documents/digicust-document.model.d.ts +45 -45
  160. package/lib/models/digicust/documents/digicust-document.model.js +38 -38
  161. package/lib/models/digicust/documents/document-code.model.d.ts +12 -12
  162. package/lib/models/digicust/documents/document-code.model.js +2 -2
  163. package/lib/models/digicust/documents/document-status.enum.d.ts +38 -38
  164. package/lib/models/digicust/documents/document-status.enum.js +45 -45
  165. package/lib/models/digicust/documents/export-declaration.model.d.ts +28 -28
  166. package/lib/models/digicust/documents/export-declaration.model.js +2 -2
  167. package/lib/models/digicust/documents/index.d.ts +11 -11
  168. package/lib/models/digicust/documents/index.js +27 -27
  169. package/lib/models/digicust/documents/invoice-type.model.d.ts +9 -9
  170. package/lib/models/digicust/documents/invoice-type.model.js +2 -2
  171. package/lib/models/digicust/documents/invoice.model.d.ts +62 -62
  172. package/lib/models/digicust/documents/invoice.model.js +2 -2
  173. package/lib/models/digicust/documents/packing-list.model.d.ts +33 -33
  174. package/lib/models/digicust/documents/packing-list.model.js +2 -2
  175. package/lib/models/digicust/documents/waybill-type.model.d.ts +15 -15
  176. package/lib/models/digicust/documents/waybill-type.model.js +11 -11
  177. package/lib/models/digicust/documents/waybill.model.d.ts +33 -33
  178. package/lib/models/digicust/documents/waybill.model.js +2 -2
  179. package/lib/models/digicust/errors.model.d.ts +8 -8
  180. package/lib/models/digicust/errors.model.js +2 -2
  181. package/lib/models/digicust/event.model.d.ts +59 -59
  182. package/lib/models/digicust/event.model.js +10 -10
  183. package/lib/models/digicust/execution-strategy.model.d.ts +96 -96
  184. package/lib/models/digicust/execution-strategy.model.js +15 -15
  185. package/lib/models/digicust/extractions/extraction-grid.model.d.ts +22 -22
  186. package/lib/models/digicust/extractions/extraction-grid.model.js +2 -2
  187. package/lib/models/digicust/extractions/extraction.model.d.ts +65 -65
  188. package/lib/models/digicust/extractions/extraction.model.js +2 -2
  189. package/lib/models/digicust/extractions/index.d.ts +2 -2
  190. package/lib/models/digicust/extractions/index.js +14 -14
  191. package/lib/models/digicust/frontend-big-section.model.d.ts +13 -13
  192. package/lib/models/digicust/frontend-big-section.model.js +2 -2
  193. package/lib/models/digicust/frontend-group.model.d.ts +6 -6
  194. package/lib/models/digicust/frontend-group.model.js +2 -2
  195. package/lib/models/digicust/frontend-mapping.model.d.ts +4 -4
  196. package/lib/models/digicust/frontend-mapping.model.js +2 -2
  197. package/lib/models/digicust/frontend-small-section.mode.d.ts +13 -13
  198. package/lib/models/digicust/frontend-small-section.mode.js +2 -2
  199. package/lib/models/digicust/hs-code-mapping.d.ts +26 -26
  200. package/lib/models/digicust/hs-code-mapping.js +2 -2
  201. package/lib/models/digicust/incoterm.enum.d.ts +17 -17
  202. package/lib/models/digicust/incoterm.enum.js +21 -21
  203. package/lib/models/digicust/incoterm.model.d.ts +25 -25
  204. package/lib/models/digicust/incoterm.model.js +21 -21
  205. package/lib/models/digicust/index.d.ts +41 -41
  206. package/lib/models/digicust/index.js +61 -61
  207. package/lib/models/digicust/invoice-type.model.d.ts +9 -9
  208. package/lib/models/digicust/invoice-type.model.js +2 -2
  209. package/lib/models/digicust/invoice.model.d.ts +62 -62
  210. package/lib/models/digicust/invoice.model.js +2 -2
  211. package/lib/models/digicust/line-item.model.d.ts +69 -69
  212. package/lib/models/digicust/line-item.model.js +17 -17
  213. package/lib/models/digicust/load-type.enum.d.ts +14 -14
  214. package/lib/models/digicust/load-type.enum.js +19 -19
  215. package/lib/models/digicust/masterdata/index.d.ts +7 -7
  216. package/lib/models/digicust/masterdata/index.js +19 -19
  217. package/lib/models/digicust/masterdata/matching-metadata.model.d.ts +11 -11
  218. package/lib/models/digicust/masterdata/matching-metadata.model.js +2 -2
  219. package/lib/models/digicust/masterdata/material.model.d.ts +97 -97
  220. package/lib/models/digicust/masterdata/material.model.js +9 -9
  221. package/lib/models/digicust/masterdata/scoring-algorithm-type.enum.d.ts +5 -5
  222. package/lib/models/digicust/masterdata/scoring-algorithm-type.enum.js +9 -9
  223. package/lib/models/digicust/masterdata/stakeholder-matching-method.enum.d.ts +7 -7
  224. package/lib/models/digicust/masterdata/stakeholder-matching-method.enum.js +11 -11
  225. package/lib/models/digicust/masterdata/stakeholder-role.enum.d.ts +12 -12
  226. package/lib/models/digicust/masterdata/stakeholder-role.enum.js +16 -16
  227. package/lib/models/digicust/masterdata/stakeholder-type.enum.d.ts +12 -12
  228. package/lib/models/digicust/masterdata/stakeholder-type.enum.js +16 -16
  229. package/lib/models/digicust/masterdata/stakeholder.model.d.ts +24 -23
  230. package/lib/models/digicust/masterdata/stakeholder.model.js +2 -2
  231. package/lib/models/digicust/masterdata/user-edited-properties.type.d.ts +3 -3
  232. package/lib/models/digicust/masterdata/user-edited-properties.type.js +2 -2
  233. package/lib/models/digicust/mean-of-transportation.model.d.ts +30 -30
  234. package/lib/models/digicust/mean-of-transportation.model.js +21 -21
  235. package/lib/models/digicust/membership.model.d.ts +7 -7
  236. package/lib/models/digicust/membership.model.js +2 -2
  237. package/lib/models/digicust/module.model.d.ts +49 -49
  238. package/lib/models/digicust/module.model.js +27 -27
  239. package/lib/models/digicust/notifications.model.d.ts +13 -13
  240. package/lib/models/digicust/notifications.model.js +2 -2
  241. package/lib/models/digicust/operationType.enum.d.ts +15 -15
  242. package/lib/models/digicust/operationType.enum.js +19 -19
  243. package/lib/models/digicust/package.model.d.ts +20 -20
  244. package/lib/models/digicust/package.model.js +2 -2
  245. package/lib/models/digicust/packingList.model.d.ts +33 -33
  246. package/lib/models/digicust/packingList.model.js +2 -2
  247. package/lib/models/digicust/preference-state.model.d.ts +21 -21
  248. package/lib/models/digicust/preference-state.model.js +2 -2
  249. package/lib/models/digicust/procedure.model.d.ts +16 -16
  250. package/lib/models/digicust/procedure.model.js +9 -9
  251. package/lib/models/digicust/project.model.d.ts +25 -25
  252. package/lib/models/digicust/project.model.js +2 -2
  253. package/lib/models/digicust/queue-fields.model.d.ts +15 -15
  254. package/lib/models/digicust/queue-fields.model.js +2 -2
  255. package/lib/models/digicust/queue.model.d.ts +18 -18
  256. package/lib/models/digicust/queue.model.js +2 -2
  257. package/lib/models/digicust/report.model.d.ts +5 -5
  258. package/lib/models/digicust/report.model.js +2 -2
  259. package/lib/models/digicust/special-measure.model.d.ts +4 -4
  260. package/lib/models/digicust/special-measure.model.js +2 -2
  261. package/lib/models/digicust/stats-case.model.d.ts +12 -12
  262. package/lib/models/digicust/stats-case.model.js +2 -2
  263. package/lib/models/digicust/submission-case-model.d.ts +24 -8
  264. package/lib/models/digicust/submission-case-model.js +12 -2
  265. package/lib/models/digicust/subscription-info.model.d.ts +13 -13
  266. package/lib/models/digicust/subscription-info.model.js +2 -2
  267. package/lib/models/digicust/subscription.model.d.ts +11 -11
  268. package/lib/models/digicust/subscription.model.js +2 -2
  269. package/lib/models/digicust/tax-details.model.d.ts +10 -10
  270. package/lib/models/digicust/tax-details.model.js +2 -2
  271. package/lib/models/digicust/transit-item.model.d.ts +30 -30
  272. package/lib/models/digicust/transit-item.model.js +67 -67
  273. package/lib/models/digicust/type-of-business.enum.d.ts +44 -44
  274. package/lib/models/digicust/type-of-business.enum.js +48 -48
  275. package/lib/models/digicust/type-of-business.model.d.ts +11 -11
  276. package/lib/models/digicust/type-of-business.model.js +2 -2
  277. package/lib/models/digicust/uploaded-file.model.d.ts +10 -10
  278. package/lib/models/digicust/uploaded-file.model.js +2 -2
  279. package/lib/models/digicust/user.model.d.ts +18 -18
  280. package/lib/models/digicust/user.model.js +2 -2
  281. package/lib/models/digicust/waybill-type.model.d.ts +15 -15
  282. package/lib/models/digicust/waybill-type.model.js +11 -11
  283. package/lib/models/digicust/waybill.model.d.ts +33 -33
  284. package/lib/models/digicust/waybill.model.js +2 -2
  285. package/lib/models/index.d.ts +4 -4
  286. package/lib/models/index.js +16 -16
  287. package/lib/models/ml/dexter/index.d.ts +1 -1
  288. package/lib/models/ml/dexter/index.js +13 -13
  289. package/lib/models/ml/dexter/text-detection.model.d.ts +3 -3
  290. package/lib/models/ml/dexter/text-detection.model.js +2 -2
  291. package/lib/models/ml/index.d.ts +2 -2
  292. package/lib/models/ml/index.js +14 -14
  293. package/lib/models/ml/machine-learning-model.model.d.ts +8 -8
  294. package/lib/models/ml/machine-learning-model.model.js +2 -2
  295. package/lib/models/rossum/index.d.ts +12 -12
  296. package/lib/models/rossum/index.js +24 -24
  297. package/lib/models/rossum/rossum-annotation-changed-event.dto.d.ts +8 -8
  298. package/lib/models/rossum/rossum-annotation-changed-event.dto.js +2 -2
  299. package/lib/models/rossum/rossum-annotation-data.model.d.ts +21 -21
  300. package/lib/models/rossum/rossum-annotation-data.model.js +2 -2
  301. package/lib/models/rossum/rossum-document-data.model.d.ts +12 -12
  302. package/lib/models/rossum/rossum-document-data.model.js +2 -2
  303. package/lib/models/rossum/rossum-embedded-response.model.d.ts +3 -3
  304. package/lib/models/rossum/rossum-embedded-response.model.js +2 -2
  305. package/lib/models/rossum/rossum-import-status.enum.d.ts +14 -14
  306. package/lib/models/rossum/rossum-import-status.enum.js +18 -18
  307. package/lib/models/rossum/rossum-login-response.model.d.ts +3 -3
  308. package/lib/models/rossum/rossum-login-response.model.js +2 -2
  309. package/lib/models/rossum/rossum-paginated-annotations.model.d.ts +6 -6
  310. package/lib/models/rossum/rossum-paginated-annotations.model.js +2 -2
  311. package/lib/models/rossum/rossum-paginated-documents.model.d.ts +5 -5
  312. package/lib/models/rossum/rossum-paginated-documents.model.js +2 -2
  313. package/lib/models/rossum/rossum-pagination.model.d.ts +6 -6
  314. package/lib/models/rossum/rossum-pagination.model.js +2 -2
  315. package/lib/models/rossum/rossum-result-content.dto.d.ts +6 -6
  316. package/lib/models/rossum/rossum-result-content.dto.js +2 -2
  317. package/lib/models/rossum/rossum-result-node.dto.d.ts +13 -13
  318. package/lib/models/rossum/rossum-result-node.dto.js +2 -2
  319. package/lib/models/rossum/rossum-start-analyze.dto.d.ts +5 -5
  320. package/lib/models/rossum/rossum-start-analyze.dto.js +2 -2
  321. package/package.json +37 -37
  322. package/readme.md +48 -48
  323. package/lib/contracts/start-hs-classification.dto.d.ts +0 -3
  324. package/lib/contracts/start-hs-classification.dto.js +0 -2
  325. package/lib/models/common/checkpoint.model.d.ts +0 -21
  326. package/lib/models/common/checkpoint.model.js +0 -8
  327. package/lib/models/common/event.model.d.ts +0 -21
  328. package/lib/models/common/event.model.js +0 -8
  329. package/lib/models/digicust/notification.model.d.ts +0 -13
  330. package/lib/models/digicust/notification.model.js +0 -2
  331. package/lib/models/digicust/shipping-type.model.d.ts +0 -25
  332. package/lib/models/digicust/shipping-type.model.js +0 -21
package/readme.md CHANGED
@@ -1,48 +1,48 @@
1
- # types package
2
-
3
- This package contains important types for communication with and within Digicust services, including:
4
-
5
- - message contracts for communication between services
6
- - common data types interfaces
7
- - digicust-specific data structures
8
-
9
- ## Usage
10
-
11
- 1. Install Digicust Types package using NPM
12
-
13
- ```
14
- npm i digicust_types
15
- ```
16
-
17
- 2. Import your required interfaces using JavaScript's import module syntax
18
-
19
- ```javascript
20
- import {
21
- CaseModel,
22
- CaseStatus,
23
- UploadedFileModel,
24
- StartDataExtractionDto,
25
- DocumentStatus,
26
- } from "digicust_types"
27
- ```
28
-
29
- ## Interfaces
30
-
31
- We believe that the definition of the typescript interfaces are their best documentation themselves. Find all models here:
32
-
33
- - [General interfaces for data structures](./src/models/common/index.ts)
34
- - [Business-specific interfaces](./src/models/digicust/index.ts)
35
- - [Contracts for messages between services](./src/contracts/index.ts)
36
-
37
- ## Development
38
-
39
- ```
40
- tsc
41
- npm run git deploy
42
- ```
43
-
44
- ## Deployment
45
-
46
- ```
47
- npm run build
48
- ```
1
+ # types package
2
+
3
+ This package contains important types for communication with and within Digicust services, including:
4
+
5
+ - message contracts for communication between services
6
+ - common data types interfaces
7
+ - digicust-specific data structures
8
+
9
+ ## Usage
10
+
11
+ 1. Install Digicust Types package using NPM
12
+
13
+ ```
14
+ npm i digicust_types
15
+ ```
16
+
17
+ 2. Import your required interfaces using JavaScript's import module syntax
18
+
19
+ ```javascript
20
+ import {
21
+ CaseModel,
22
+ CaseStatus,
23
+ UploadedFileModel,
24
+ StartDataExtractionDto,
25
+ DocumentStatus,
26
+ } from "digicust_types"
27
+ ```
28
+
29
+ ## Interfaces
30
+
31
+ We believe that the definition of the typescript interfaces are their best documentation themselves. Find all models here:
32
+
33
+ - [General interfaces for data structures](./src/models/common/index.ts)
34
+ - [Business-specific interfaces](./src/models/digicust/index.ts)
35
+ - [Contracts for messages between services](./src/contracts/index.ts)
36
+
37
+ ## Development
38
+
39
+ ```
40
+ tsc
41
+ npm run git deploy
42
+ ```
43
+
44
+ ## Deployment
45
+
46
+ ```
47
+ npm run build
48
+ ```
@@ -1,3 +0,0 @@
1
- export interface StartHsClassificationDto {
2
- caseId: string;
3
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,21 +0,0 @@
1
- export interface Checkpoint {
2
- id?: string;
3
- customerId?: string;
4
- context?: string;
5
- type?: "webhook" | "email";
6
- }
7
- export declare enum CheckPointType {
8
- webhook = "webhook",
9
- mail = "email"
10
- }
11
- export interface WebhookCheckpoint extends Checkpoint {
12
- type: "webhook";
13
- url?: string;
14
- method?: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
15
- body?: any;
16
- }
17
- export interface EmailCheckpoint extends Checkpoint {
18
- type: "email";
19
- emailAddress?: string;
20
- body?: any;
21
- }
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CheckPointType = void 0;
4
- var CheckPointType;
5
- (function (CheckPointType) {
6
- CheckPointType["webhook"] = "webhook";
7
- CheckPointType["mail"] = "email";
8
- })(CheckPointType = exports.CheckPointType || (exports.CheckPointType = {}));
@@ -1,21 +0,0 @@
1
- export interface Event {
2
- id?: string;
3
- customerId?: string;
4
- context?: string;
5
- type?: "webhook" | "email";
6
- }
7
- export declare enum EventType {
8
- webhook = "webhook",
9
- mail = "email"
10
- }
11
- export interface WebhookEvent extends Event {
12
- type: "webhook";
13
- url?: string;
14
- method?: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
15
- body?: any;
16
- }
17
- export interface EmailEvent extends Event {
18
- type: "email";
19
- emailAddress?: string;
20
- body?: any;
21
- }
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EventType = void 0;
4
- var EventType;
5
- (function (EventType) {
6
- EventType["webhook"] = "webhook";
7
- EventType["mail"] = "email";
8
- })(EventType = exports.EventType || (exports.EventType = {}));
@@ -1,13 +0,0 @@
1
- /**
2
- * Information about a notification Model
3
- */
4
- export interface NotificationsModel {
5
- id?: string;
6
- title?: string;
7
- status?: string;
8
- message?: string;
9
- link?: string;
10
- consumer?: string;
11
- addresseeType?: "customer" | "project" | "user";
12
- addresseeId?: string;
13
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,25 +0,0 @@
1
- import { Meta } from "../common";
2
- export interface ShippingType extends Meta<ShippingMode> {
3
- /** unique identifier of the transportation mean */
4
- code?: string;
5
- name?: string;
6
- type?: ShippingTypePlace;
7
- /** ISO Code of nationality of the mean */
8
- countryCode?: string;
9
- }
10
- export declare enum ShippingMode {
11
- maritime = "Maritime",
12
- rail = "Rail",
13
- road = "Road",
14
- air = "Air",
15
- postal = "Postal",
16
- fixedInstallations = "FixedInstallations",
17
- inlandWaterway = "InlandWaterway",
18
- unknown = "Unknown"
19
- }
20
- export declare enum ShippingTypePlace {
21
- border = "Border",
22
- arrival = "Arrival",
23
- departure = "Departure",
24
- inland = "Inland"
25
- }
@@ -1,21 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ShippingTypePlace = exports.ShippingMode = void 0;
4
- var ShippingMode;
5
- (function (ShippingMode) {
6
- ShippingMode["maritime"] = "Maritime";
7
- ShippingMode["rail"] = "Rail";
8
- ShippingMode["road"] = "Road";
9
- ShippingMode["air"] = "Air";
10
- ShippingMode["postal"] = "Postal";
11
- ShippingMode["fixedInstallations"] = "FixedInstallations";
12
- ShippingMode["inlandWaterway"] = "InlandWaterway";
13
- ShippingMode["unknown"] = "Unknown";
14
- })(ShippingMode = exports.ShippingMode || (exports.ShippingMode = {}));
15
- var ShippingTypePlace;
16
- (function (ShippingTypePlace) {
17
- ShippingTypePlace["border"] = "Border";
18
- ShippingTypePlace["arrival"] = "Arrival";
19
- ShippingTypePlace["departure"] = "Departure";
20
- ShippingTypePlace["inland"] = "Inland";
21
- })(ShippingTypePlace = exports.ShippingTypePlace || (exports.ShippingTypePlace = {}));