@djust-b2b/djust-front-sdk 3.0.0-beta.2 → 3.0.0-beta.20

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 (331) hide show
  1. package/README.md +51 -7
  2. package/dist/.tsbuildinfo +1 -0
  3. package/dist/.tsbuildinfo-esm +1 -0
  4. package/dist/client/create-client.d.ts +248 -0
  5. package/dist/client/create-client.d.ts.map +1 -0
  6. package/dist/client/index.d.ts +14 -0
  7. package/dist/client/index.d.ts.map +1 -0
  8. package/dist/client/performance.d.ts +203 -0
  9. package/dist/client/performance.d.ts.map +1 -0
  10. package/dist/client/transport.d.ts +372 -0
  11. package/dist/client/transport.d.ts.map +1 -0
  12. package/dist/errors/base.d.ts +101 -0
  13. package/dist/errors/base.d.ts.map +1 -0
  14. package/dist/errors/classes/auth.error.d.ts +64 -0
  15. package/dist/errors/classes/auth.error.d.ts.map +1 -0
  16. package/dist/errors/classes/forbidden.error.d.ts +52 -0
  17. package/dist/errors/classes/forbidden.error.d.ts.map +1 -0
  18. package/dist/errors/classes/index.d.ts +17 -0
  19. package/dist/errors/classes/index.d.ts.map +1 -0
  20. package/dist/errors/classes/network.error.d.ts +63 -0
  21. package/dist/errors/classes/network.error.d.ts.map +1 -0
  22. package/dist/errors/classes/not-found.error.d.ts +58 -0
  23. package/dist/errors/classes/not-found.error.d.ts.map +1 -0
  24. package/dist/errors/classes/rate-limit.error.d.ts +49 -0
  25. package/dist/errors/classes/rate-limit.error.d.ts.map +1 -0
  26. package/dist/errors/classes/server.error.d.ts +63 -0
  27. package/dist/errors/classes/server.error.d.ts.map +1 -0
  28. package/dist/errors/classes/timeout.error.d.ts +64 -0
  29. package/dist/errors/classes/timeout.error.d.ts.map +1 -0
  30. package/dist/errors/classes/unexpected.error.d.ts +70 -0
  31. package/dist/errors/classes/unexpected.error.d.ts.map +1 -0
  32. package/dist/errors/classes/validation.error.d.ts +68 -0
  33. package/dist/errors/classes/validation.error.d.ts.map +1 -0
  34. package/dist/errors/codes.d.ts +111 -0
  35. package/dist/errors/codes.d.ts.map +1 -0
  36. package/dist/errors/compat.d.ts +99 -0
  37. package/dist/errors/compat.d.ts.map +1 -0
  38. package/dist/errors/factory.d.ts +33 -0
  39. package/dist/errors/factory.d.ts.map +1 -0
  40. package/dist/errors/guards.d.ts +142 -0
  41. package/dist/errors/guards.d.ts.map +1 -0
  42. package/dist/errors/index.d.ts +25 -0
  43. package/dist/errors/index.d.ts.map +1 -0
  44. package/dist/errors/types.d.ts +100 -0
  45. package/dist/errors/types.d.ts.map +1 -0
  46. package/dist/helpers/index.d.ts +42 -0
  47. package/dist/helpers/index.d.ts.map +1 -0
  48. package/dist/helpers/parameters-validation.d.ts +3 -0
  49. package/dist/helpers/parameters-validation.d.ts.map +1 -0
  50. package/dist/helpers/utils.d.ts +5 -0
  51. package/dist/helpers/utils.d.ts.map +1 -0
  52. package/dist/index.cjs +182 -0
  53. package/dist/index.d.ts +266 -0
  54. package/dist/index.d.ts.map +1 -0
  55. package/dist/index.mjs +11611 -0
  56. package/dist/interfaces/index.d.ts +31 -0
  57. package/dist/interfaces/index.d.ts.map +1 -0
  58. package/dist/interfaces/models/address.d.ts +61 -0
  59. package/dist/interfaces/models/address.d.ts.map +1 -0
  60. package/dist/interfaces/models/attribute.d.ts +31 -0
  61. package/dist/interfaces/models/attribute.d.ts.map +1 -0
  62. package/dist/interfaces/models/auth.d.ts +37 -0
  63. package/dist/interfaces/models/auth.d.ts.map +1 -0
  64. package/dist/interfaces/models/cart.d.ts +64 -0
  65. package/dist/interfaces/models/cart.d.ts.map +1 -0
  66. package/dist/interfaces/models/common.d.ts +68 -0
  67. package/dist/interfaces/models/common.d.ts.map +1 -0
  68. package/dist/interfaces/models/custom-field.d.ts +57 -0
  69. package/dist/interfaces/models/custom-field.d.ts.map +1 -0
  70. package/dist/interfaces/models/customer-account.d.ts +52 -0
  71. package/dist/interfaces/models/customer-account.d.ts.map +1 -0
  72. package/dist/interfaces/models/customer-organisation.d.ts +14 -0
  73. package/dist/interfaces/models/customer-organisation.d.ts.map +1 -0
  74. package/dist/interfaces/models/customer-user.d.ts +114 -0
  75. package/dist/interfaces/models/customer-user.d.ts.map +1 -0
  76. package/dist/interfaces/models/incident.d.ts +37 -0
  77. package/dist/interfaces/models/incident.d.ts.map +1 -0
  78. package/dist/interfaces/models/navigation-category.d.ts +22 -0
  79. package/dist/interfaces/models/navigation-category.d.ts.map +1 -0
  80. package/dist/interfaces/models/offer.d.ts +151 -0
  81. package/dist/interfaces/models/offer.d.ts.map +1 -0
  82. package/dist/interfaces/models/order.d.ts +701 -0
  83. package/dist/interfaces/models/order.d.ts.map +1 -0
  84. package/dist/interfaces/models/payment.d.ts +20 -0
  85. package/dist/interfaces/models/payment.d.ts.map +1 -0
  86. package/dist/interfaces/models/price.d.ts +6 -0
  87. package/dist/interfaces/models/price.d.ts.map +1 -0
  88. package/dist/interfaces/models/product.d.ts +243 -0
  89. package/dist/interfaces/models/product.d.ts.map +1 -0
  90. package/dist/interfaces/models/quote.d.ts +77 -0
  91. package/dist/interfaces/models/quote.d.ts.map +1 -0
  92. package/dist/interfaces/models/searchProduct.d.ts +128 -0
  93. package/dist/interfaces/models/searchProduct.d.ts.map +1 -0
  94. package/dist/interfaces/models/supplier.d.ts +72 -0
  95. package/dist/interfaces/models/supplier.d.ts.map +1 -0
  96. package/dist/services/attributes/attributes.service.d.ts +18 -0
  97. package/dist/services/attributes/attributes.service.d.ts.map +1 -0
  98. package/dist/services/attributes/definitions.d.ts +28 -0
  99. package/dist/services/attributes/definitions.d.ts.map +1 -0
  100. package/dist/services/attributes/endpoints.d.ts +12 -0
  101. package/dist/services/attributes/endpoints.d.ts.map +1 -0
  102. package/dist/services/attributes/index.d.ts +33 -0
  103. package/dist/services/attributes/index.d.ts.map +1 -0
  104. package/dist/services/attributes/module.d.ts +11 -0
  105. package/dist/services/attributes/module.d.ts.map +1 -0
  106. package/dist/services/attributes/types.d.ts +35 -0
  107. package/dist/services/attributes/types.d.ts.map +1 -0
  108. package/dist/services/auth/__mocks__/auth.mocks.d.ts +249 -0
  109. package/dist/services/auth/__mocks__/auth.mocks.d.ts.map +1 -0
  110. package/dist/services/auth/auth.service.d.ts +286 -0
  111. package/dist/services/auth/auth.service.d.ts.map +1 -0
  112. package/dist/services/auth/definitions.d.ts +69 -0
  113. package/dist/services/auth/definitions.d.ts.map +1 -0
  114. package/dist/services/auth/definitions.requests.d.ts +25 -0
  115. package/dist/services/auth/definitions.requests.d.ts.map +1 -0
  116. package/dist/services/auth/endpoints.d.ts +30 -0
  117. package/dist/services/auth/endpoints.d.ts.map +1 -0
  118. package/dist/services/auth/index.d.ts +232 -0
  119. package/dist/services/auth/index.d.ts.map +1 -0
  120. package/dist/services/auth/module.d.ts +11 -0
  121. package/dist/services/auth/module.d.ts.map +1 -0
  122. package/dist/services/auth/types.d.ts +124 -0
  123. package/dist/services/auth/types.d.ts.map +1 -0
  124. package/dist/services/base.service.d.ts +83 -0
  125. package/dist/services/base.service.d.ts.map +1 -0
  126. package/dist/services/cart/cart.service.d.ts +443 -0
  127. package/dist/services/cart/cart.service.d.ts.map +1 -0
  128. package/dist/services/cart/definitions.d.ts +84 -0
  129. package/dist/services/cart/definitions.d.ts.map +1 -0
  130. package/dist/services/cart/endpoints.d.ts +24 -0
  131. package/dist/services/cart/endpoints.d.ts.map +1 -0
  132. package/dist/services/cart/index.d.ts +330 -0
  133. package/dist/services/cart/index.d.ts.map +1 -0
  134. package/dist/services/cart/module.d.ts +11 -0
  135. package/dist/services/cart/module.d.ts.map +1 -0
  136. package/dist/services/cart/types.d.ts +236 -0
  137. package/dist/services/cart/types.d.ts.map +1 -0
  138. package/dist/services/commercial-order/commercial-order.service.d.ts +435 -0
  139. package/dist/services/commercial-order/commercial-order.service.d.ts.map +1 -0
  140. package/dist/services/commercial-order/definitions.d.ts +181 -0
  141. package/dist/services/commercial-order/definitions.d.ts.map +1 -0
  142. package/dist/services/commercial-order/endpoints.d.ts +28 -0
  143. package/dist/services/commercial-order/endpoints.d.ts.map +1 -0
  144. package/dist/services/commercial-order/index.d.ts +712 -0
  145. package/dist/services/commercial-order/index.d.ts.map +1 -0
  146. package/dist/services/commercial-order/module.d.ts +11 -0
  147. package/dist/services/commercial-order/module.d.ts.map +1 -0
  148. package/dist/services/commercial-order/types.d.ts +244 -0
  149. package/dist/services/commercial-order/types.d.ts.map +1 -0
  150. package/dist/services/custom-field/custom-field.service.d.ts +23 -0
  151. package/dist/services/custom-field/custom-field.service.d.ts.map +1 -0
  152. package/dist/services/custom-field/definitions.d.ts +107 -0
  153. package/dist/services/custom-field/definitions.d.ts.map +1 -0
  154. package/dist/services/custom-field/endpoints.d.ts +13 -0
  155. package/dist/services/custom-field/endpoints.d.ts.map +1 -0
  156. package/dist/services/custom-field/index.d.ts +115 -0
  157. package/dist/services/custom-field/index.d.ts.map +1 -0
  158. package/dist/services/custom-field/module.d.ts +11 -0
  159. package/dist/services/custom-field/module.d.ts.map +1 -0
  160. package/dist/services/custom-field/types.d.ts +51 -0
  161. package/dist/services/custom-field/types.d.ts.map +1 -0
  162. package/dist/services/customer-account/customer-account.service.d.ts +387 -0
  163. package/dist/services/customer-account/customer-account.service.d.ts.map +1 -0
  164. package/dist/services/customer-account/definitions.d.ts +164 -0
  165. package/dist/services/customer-account/definitions.d.ts.map +1 -0
  166. package/dist/services/customer-account/endpoints.d.ts +25 -0
  167. package/dist/services/customer-account/endpoints.d.ts.map +1 -0
  168. package/dist/services/customer-account/index.d.ts +656 -0
  169. package/dist/services/customer-account/index.d.ts.map +1 -0
  170. package/dist/services/customer-account/module.d.ts +11 -0
  171. package/dist/services/customer-account/module.d.ts.map +1 -0
  172. package/dist/services/customer-account/types.d.ts +253 -0
  173. package/dist/services/customer-account/types.d.ts.map +1 -0
  174. package/dist/services/customer-user/customer-user.service.d.ts +280 -0
  175. package/dist/services/customer-user/customer-user.service.d.ts.map +1 -0
  176. package/dist/services/customer-user/definitions.d.ts +84 -0
  177. package/dist/services/customer-user/definitions.d.ts.map +1 -0
  178. package/dist/services/customer-user/endpoints.d.ts +19 -0
  179. package/dist/services/customer-user/endpoints.d.ts.map +1 -0
  180. package/dist/services/customer-user/index.d.ts +394 -0
  181. package/dist/services/customer-user/index.d.ts.map +1 -0
  182. package/dist/services/customer-user/module.d.ts +11 -0
  183. package/dist/services/customer-user/module.d.ts.map +1 -0
  184. package/dist/services/customer-user/types.d.ts +118 -0
  185. package/dist/services/customer-user/types.d.ts.map +1 -0
  186. package/dist/services/factory.d.ts +104 -0
  187. package/dist/services/factory.d.ts.map +1 -0
  188. package/dist/services/incident/definitions.d.ts +85 -0
  189. package/dist/services/incident/definitions.d.ts.map +1 -0
  190. package/dist/services/incident/endpoints.d.ts +17 -0
  191. package/dist/services/incident/endpoints.d.ts.map +1 -0
  192. package/dist/services/incident/incident.service.d.ts +24 -0
  193. package/dist/services/incident/incident.service.d.ts.map +1 -0
  194. package/dist/services/incident/index.d.ts +270 -0
  195. package/dist/services/incident/index.d.ts.map +1 -0
  196. package/dist/services/incident/module.d.ts +11 -0
  197. package/dist/services/incident/module.d.ts.map +1 -0
  198. package/dist/services/incident/types.d.ts +116 -0
  199. package/dist/services/incident/types.d.ts.map +1 -0
  200. package/dist/services/logistic-order/definitions.d.ts +296 -0
  201. package/dist/services/logistic-order/definitions.d.ts.map +1 -0
  202. package/dist/services/logistic-order/endpoints.d.ts +44 -0
  203. package/dist/services/logistic-order/endpoints.d.ts.map +1 -0
  204. package/dist/services/logistic-order/index.d.ts +1338 -0
  205. package/dist/services/logistic-order/index.d.ts.map +1 -0
  206. package/dist/services/logistic-order/logistic-order.service.d.ts +62 -0
  207. package/dist/services/logistic-order/logistic-order.service.d.ts.map +1 -0
  208. package/dist/services/logistic-order/module.d.ts +11 -0
  209. package/dist/services/logistic-order/module.d.ts.map +1 -0
  210. package/dist/services/logistic-order/types.d.ts +411 -0
  211. package/dist/services/logistic-order/types.d.ts.map +1 -0
  212. package/dist/services/module.d.ts +64 -0
  213. package/dist/services/module.d.ts.map +1 -0
  214. package/dist/services/navigation-category/definitions.d.ts +31 -0
  215. package/dist/services/navigation-category/definitions.d.ts.map +1 -0
  216. package/dist/services/navigation-category/endpoints.d.ts +15 -0
  217. package/dist/services/navigation-category/endpoints.d.ts.map +1 -0
  218. package/dist/services/navigation-category/index.d.ts +114 -0
  219. package/dist/services/navigation-category/index.d.ts.map +1 -0
  220. package/dist/services/navigation-category/module.d.ts +11 -0
  221. package/dist/services/navigation-category/module.d.ts.map +1 -0
  222. package/dist/services/navigation-category/navigation-category.service.d.ts +148 -0
  223. package/dist/services/navigation-category/navigation-category.service.d.ts.map +1 -0
  224. package/dist/services/navigation-category/types.d.ts +51 -0
  225. package/dist/services/navigation-category/types.d.ts.map +1 -0
  226. package/dist/services/offer-inventories/definitions.d.ts +73 -0
  227. package/dist/services/offer-inventories/definitions.d.ts.map +1 -0
  228. package/dist/services/offer-inventories/endpoints.d.ts +16 -0
  229. package/dist/services/offer-inventories/endpoints.d.ts.map +1 -0
  230. package/dist/services/offer-inventories/index.d.ts +120 -0
  231. package/dist/services/offer-inventories/index.d.ts.map +1 -0
  232. package/dist/services/offer-inventories/module.d.ts +11 -0
  233. package/dist/services/offer-inventories/module.d.ts.map +1 -0
  234. package/dist/services/offer-inventories/offer-inventories.service.d.ts +26 -0
  235. package/dist/services/offer-inventories/offer-inventories.service.d.ts.map +1 -0
  236. package/dist/services/offer-inventories/types.d.ts +85 -0
  237. package/dist/services/offer-inventories/types.d.ts.map +1 -0
  238. package/dist/services/offer-prices/__mocks__/offer-prices.mocks.d.ts +109 -0
  239. package/dist/services/offer-prices/__mocks__/offer-prices.mocks.d.ts.map +1 -0
  240. package/dist/services/offer-prices/definitions.d.ts +24 -0
  241. package/dist/services/offer-prices/definitions.d.ts.map +1 -0
  242. package/dist/services/offer-prices/endpoints.d.ts +12 -0
  243. package/dist/services/offer-prices/endpoints.d.ts.map +1 -0
  244. package/dist/services/offer-prices/index.d.ts +36 -0
  245. package/dist/services/offer-prices/index.d.ts.map +1 -0
  246. package/dist/services/offer-prices/module.d.ts +11 -0
  247. package/dist/services/offer-prices/module.d.ts.map +1 -0
  248. package/dist/services/offer-prices/offer-prices.service.d.ts +18 -0
  249. package/dist/services/offer-prices/offer-prices.service.d.ts.map +1 -0
  250. package/dist/services/offer-prices/types.d.ts +33 -0
  251. package/dist/services/offer-prices/types.d.ts.map +1 -0
  252. package/dist/services/operation/definitions.d.ts +280 -0
  253. package/dist/services/operation/definitions.d.ts.map +1 -0
  254. package/dist/services/operation/endpoints.d.ts +18 -0
  255. package/dist/services/operation/endpoints.d.ts.map +1 -0
  256. package/dist/services/operation/index.d.ts +520 -0
  257. package/dist/services/operation/index.d.ts.map +1 -0
  258. package/dist/services/operation/module.d.ts +11 -0
  259. package/dist/services/operation/module.d.ts.map +1 -0
  260. package/dist/services/operation/operation.service.d.ts +32 -0
  261. package/dist/services/operation/operation.service.d.ts.map +1 -0
  262. package/dist/services/operation/types.d.ts +174 -0
  263. package/dist/services/operation/types.d.ts.map +1 -0
  264. package/dist/services/payment/definitions.d.ts +79 -0
  265. package/dist/services/payment/definitions.d.ts.map +1 -0
  266. package/dist/services/payment/endpoints.d.ts +16 -0
  267. package/dist/services/payment/endpoints.d.ts.map +1 -0
  268. package/dist/services/payment/index.d.ts +150 -0
  269. package/dist/services/payment/index.d.ts.map +1 -0
  270. package/dist/services/payment/module.d.ts +11 -0
  271. package/dist/services/payment/module.d.ts.map +1 -0
  272. package/dist/services/payment/payment.service.d.ts +224 -0
  273. package/dist/services/payment/payment.service.d.ts.map +1 -0
  274. package/dist/services/payment/types.d.ts +93 -0
  275. package/dist/services/payment/types.d.ts.map +1 -0
  276. package/dist/services/product/definitions.d.ts +150 -0
  277. package/dist/services/product/definitions.d.ts.map +1 -0
  278. package/dist/services/product/endpoints.d.ts +40 -0
  279. package/dist/services/product/endpoints.d.ts.map +1 -0
  280. package/dist/services/product/index.d.ts +388 -0
  281. package/dist/services/product/index.d.ts.map +1 -0
  282. package/dist/services/product/module.d.ts +11 -0
  283. package/dist/services/product/module.d.ts.map +1 -0
  284. package/dist/services/product/product.service.d.ts +452 -0
  285. package/dist/services/product/product.service.d.ts.map +1 -0
  286. package/dist/services/product/types.d.ts +344 -0
  287. package/dist/services/product/types.d.ts.map +1 -0
  288. package/dist/services/product-variant/definitions.d.ts +172 -0
  289. package/dist/services/product-variant/definitions.d.ts.map +1 -0
  290. package/dist/services/product-variant/endpoints.d.ts +15 -0
  291. package/dist/services/product-variant/endpoints.d.ts.map +1 -0
  292. package/dist/services/product-variant/index.d.ts +123 -0
  293. package/dist/services/product-variant/index.d.ts.map +1 -0
  294. package/dist/services/product-variant/module.d.ts +11 -0
  295. package/dist/services/product-variant/module.d.ts.map +1 -0
  296. package/dist/services/product-variant/product-variant.service.d.ts +21 -0
  297. package/dist/services/product-variant/product-variant.service.d.ts.map +1 -0
  298. package/dist/services/product-variant/types.d.ts +73 -0
  299. package/dist/services/product-variant/types.d.ts.map +1 -0
  300. package/dist/services/quote/definitions.d.ts +102 -0
  301. package/dist/services/quote/definitions.d.ts.map +1 -0
  302. package/dist/services/quote/endpoints.d.ts +20 -0
  303. package/dist/services/quote/endpoints.d.ts.map +1 -0
  304. package/dist/services/quote/index.d.ts +378 -0
  305. package/dist/services/quote/index.d.ts.map +1 -0
  306. package/dist/services/quote/module.d.ts +11 -0
  307. package/dist/services/quote/module.d.ts.map +1 -0
  308. package/dist/services/quote/quote.service.d.ts +346 -0
  309. package/dist/services/quote/quote.service.d.ts.map +1 -0
  310. package/dist/services/quote/types.d.ts +160 -0
  311. package/dist/services/quote/types.d.ts.map +1 -0
  312. package/dist/services/supplier/__mocks__/supplier-mocks.d.ts +49 -0
  313. package/dist/services/supplier/__mocks__/supplier-mocks.d.ts.map +1 -0
  314. package/dist/services/supplier/definitions.d.ts +30 -0
  315. package/dist/services/supplier/definitions.d.ts.map +1 -0
  316. package/dist/services/supplier/endpoints.d.ts +14 -0
  317. package/dist/services/supplier/endpoints.d.ts.map +1 -0
  318. package/dist/services/supplier/index.d.ts +102 -0
  319. package/dist/services/supplier/index.d.ts.map +1 -0
  320. package/dist/services/supplier/module.d.ts +11 -0
  321. package/dist/services/supplier/module.d.ts.map +1 -0
  322. package/dist/services/supplier/supplier.service.d.ts +20 -0
  323. package/dist/services/supplier/supplier.service.d.ts.map +1 -0
  324. package/dist/services/supplier/types.d.ts +58 -0
  325. package/dist/services/supplier/types.d.ts.map +1 -0
  326. package/dist/services/types.d.ts +81 -0
  327. package/dist/services/types.d.ts.map +1 -0
  328. package/dist/settings/fetch-instance.d.ts +30 -0
  329. package/dist/settings/fetch-instance.d.ts.map +1 -0
  330. package/package.json +12 -10
  331. package/dist/djust-b2b-djust-front-sdk-3.0.0-beta.2.tgz +0 -0
@@ -0,0 +1,85 @@
1
+ import { IncidentDto, IncidentStatus, IncidentIdType, IncidentLogisticOrder, IncidentCreatedDto, IncidentThreadDto } from "../../interfaces/models/incident";
2
+ import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
3
+ /**
4
+ * Request parameters type definitions
5
+ */
6
+ export interface getIncidentsParameters {
7
+ linkedType: IncidentLogisticOrder;
8
+ ids?: String[];
9
+ status?: IncidentStatus[];
10
+ customerAccountIds?: String[];
11
+ supplierIds?: String[];
12
+ reasonCodes?: String[];
13
+ customFields?: {
14
+ customFieldId: string;
15
+ customFieldValue: string;
16
+ }[];
17
+ idType: IncidentIdType;
18
+ page: number;
19
+ size: number;
20
+ sort: String[];
21
+ }
22
+ export interface getIncidentParameters {
23
+ incidentId: string;
24
+ idType: IncidentIdType;
25
+ }
26
+ export interface createOrderLogisticIncidentParameters {
27
+ logisticOrderId: string;
28
+ idType: IncidentIdType;
29
+ customField: {
30
+ customFieldValues: CustomFieldValueRequest[];
31
+ idType: IncidentIdType;
32
+ };
33
+ reasonCode: string[];
34
+ }
35
+ export interface createOrderLogisticLineIncidentParameters {
36
+ logisticOrderId: string;
37
+ idType: IncidentIdType;
38
+ customFieldIdType: IncidentIdType;
39
+ orderLines: {
40
+ customFieldValues: CustomFieldValueRequest[];
41
+ lineId: string;
42
+ quantity: number;
43
+ }[];
44
+ reasonCode: string[];
45
+ }
46
+ export interface createOrderLogisticIncidentThreadParameters {
47
+ logisticOrderId: string;
48
+ incidentId: string;
49
+ idType: IncidentIdType;
50
+ customField?: {
51
+ customFieldValues: CustomFieldValueRequest[];
52
+ idType: IncidentIdType;
53
+ };
54
+ name: string;
55
+ message: string;
56
+ reasonCode: string;
57
+ }
58
+ export interface createIncidentParameters {
59
+ customField?: {
60
+ customFieldValues: CustomFieldValueRequest[];
61
+ idType: IncidentIdType;
62
+ };
63
+ externalId?: string;
64
+ logisticOrderId?: string;
65
+ reasonCodes: string[];
66
+ idType?: IncidentIdType;
67
+ }
68
+ export interface createIncidentResponse {
69
+ externalId: string;
70
+ incidentId: string;
71
+ }
72
+ /**
73
+ * Request response type definitions
74
+ */
75
+ export interface getIncidentsResponse extends Array<IncidentDto> {
76
+ }
77
+ export interface getIncidentResponse extends IncidentDto {
78
+ }
79
+ export interface createOrderLogisticIncidentResponse extends IncidentCreatedDto {
80
+ }
81
+ export interface createOrderLogisticLineIncidentResponse extends IncidentCreatedDto {
82
+ }
83
+ export interface createOrderLogisticIncidentThreadResponse extends IncidentThreadDto {
84
+ }
85
+ //# sourceMappingURL=definitions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/services/incident/definitions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAE/E;;GAEG;AAEH,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,qBAAqB,CAAC;IAClC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrE,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,qCAAqC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,EAAE;QACX,iBAAiB,EAAE,uBAAuB,EAAE,CAAC;QAC7C,MAAM,EAAE,cAAc,CAAC;KACxB,CAAC;IACF,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,yCAAyC;IACxD,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,cAAc,CAAC;IACvB,iBAAiB,EAAE,cAAc,CAAC;IAClC,UAAU,EAAE;QACV,iBAAiB,EAAE,uBAAuB,EAAE,CAAC;QAC7C,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,EAAE,CAAC;IACJ,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,2CAA2C;IAC1D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,CAAC,EAAE;QACZ,iBAAiB,EAAE,uBAAuB,EAAE,CAAC;QAC7C,MAAM,EAAE,cAAc,CAAC;KACxB,CAAC;IACF,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE;QACZ,iBAAiB,EAAE,uBAAuB,EAAE,CAAC;QAC7C,MAAM,EAAE,cAAc,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AACD,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AAEH,MAAM,WAAW,oBAAqB,SAAQ,KAAK,CAAC,WAAW,CAAC;CAAG;AAEnE,MAAM,WAAW,mBAAoB,SAAQ,WAAW;CAAG;AAE3D,MAAM,WAAW,mCACf,SAAQ,kBAAkB;CAAG;AAE/B,MAAM,WAAW,uCACf,SAAQ,kBAAkB;CAAG;AAE/B,MAAM,WAAW,yCACf,SAAQ,iBAAiB;CAAG"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * DJUST SDK Incident Service - Endpoints
3
+ * API endpoint constants for incident operations.
4
+ *
5
+ * @module services/incident/endpoints
6
+ * @since 2.17.0
7
+ */
8
+ export declare const IncidentEndpoints: {
9
+ readonly INCIDENTS: "/v1/shop/incidents";
10
+ readonly INCIDENTS_V2: "/v2/shop/incidents";
11
+ readonly INCIDENT: "/v1/shop/incidents/{incidentId}";
12
+ readonly ORDER_INCIDENTS: "/v1/shop/logistic-orders/{logisticOrderId}/incidents";
13
+ readonly ORDER_LINE_INCIDENTS: "/v1/shop/logistic-orders/{logisticOrderId}/lines/incidents";
14
+ readonly ORDER_INCIDENT_THREADS: "/v2/shop/logistic-orders/{logisticOrderId}/incidents/{incidentId}/threads";
15
+ };
16
+ export type IncidentEndpoint = (typeof IncidentEndpoints)[keyof typeof IncidentEndpoints];
17
+ //# sourceMappingURL=endpoints.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../src/services/incident/endpoints.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,eAAO,MAAM,iBAAiB;;;;;;;CASpB,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC"}
@@ -0,0 +1,24 @@
1
+ /**
2
+ * DJUST SDK Incident Service
3
+ * Service class for incident operations.
4
+ *
5
+ * @module services/incident/service
6
+ * @since 2.17.0
7
+ */
8
+ import { BaseService } from "../base.service";
9
+ import type { RequestContext } from "../../client/transport";
10
+ import type { GetIncidentsParams, GetIncidentsV2Params, GetIncidentParams, CreateIncidentParams, CreateOrderLogisticIncidentParams, CreateOrderLogisticLineIncidentParams, CreateOrderLogisticIncidentThreadParams, GetIncidentsResponse, GetIncidentResponse, CreateIncidentResponse, CreateOrderLogisticIncidentResponse, CreateOrderLogisticLineIncidentResponse, CreateOrderLogisticIncidentThreadResponse } from "./types";
11
+ /**
12
+ * Service for incident operations.
13
+ */
14
+ export declare class IncidentService extends BaseService {
15
+ readonly serviceName = "incident";
16
+ getIncidents(params: GetIncidentsParams, context?: RequestContext): Promise<GetIncidentsResponse>;
17
+ getIncidentsV2(params: GetIncidentsV2Params, context?: RequestContext): Promise<GetIncidentsResponse>;
18
+ getIncident(params: GetIncidentParams, context?: RequestContext): Promise<GetIncidentResponse>;
19
+ createIncident(params: CreateIncidentParams, context?: RequestContext): Promise<CreateIncidentResponse>;
20
+ createOrderLogisticIncident(params: CreateOrderLogisticIncidentParams, context?: RequestContext): Promise<CreateOrderLogisticIncidentResponse>;
21
+ createOrderLogisticLineIncident(params: CreateOrderLogisticLineIncidentParams, context?: RequestContext): Promise<CreateOrderLogisticLineIncidentResponse>;
22
+ createOrderLogisticIncidentThread(params: CreateOrderLogisticIncidentThreadParams, context?: RequestContext): Promise<CreateOrderLogisticIncidentThreadResponse>;
23
+ }
24
+ //# sourceMappingURL=incident.service.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"incident.service.d.ts","sourceRoot":"","sources":["../../../src/services/incident/incident.service.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,iCAAiC,EACjC,qCAAqC,EACrC,uCAAuC,EACvC,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,mCAAmC,EACnC,uCAAuC,EACvC,yCAAyC,EAC1C,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,QAAQ,CAAC,WAAW,cAAc;IAE5B,YAAY,CAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAsB1B,cAAc,CAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAuC1B,WAAW,CACf,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAezB,cAAc,CAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAmB5B,2BAA2B,CAC/B,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,mCAAmC,CAAC;IAmBzC,+BAA+B,CACnC,MAAM,EAAE,qCAAqC,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,uCAAuC,CAAC;IAoB7C,iCAAiC,CACrC,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,yCAAyC,CAAC;CA0BtD"}
@@ -0,0 +1,270 @@
1
+ import { getIncidentsParameters, getIncidentParameters, createOrderLogisticIncidentParameters, createOrderLogisticLineIncidentParameters, getIncidentsResponse, getIncidentResponse, createOrderLogisticIncidentResponse, createOrderLogisticLineIncidentResponse, createOrderLogisticIncidentThreadParameters, createOrderLogisticIncidentThreadResponse, createIncidentParameters, createIncidentResponse } from "./definitions";
2
+ /**
3
+ * 🚚 Retrieves a list of incidents based on various filter criteria.
4
+ *
5
+ * This function allows you to fetch incidents with detailed filtering options, such as customer account IDs, status, and sorting preferences.
6
+ *
7
+ * 🛠 **Endpoint**: `GET /v1/shop/incidents`
8
+ *
9
+ * | Parameter | Type | Required | Description |
10
+ * |-----------------------|--------------------|----------|-----------------------------------------------------------------------------|
11
+ * | `customerAccountIds` | `string[]` | ❌ | List of customer account IDs to filter incidents by. |
12
+ * | `linkedType` | `string` | ✅ | Type of entity linked to the incident (e.g., ORDER or ORDER_LINES). |
13
+ * | `ids` | `string[]` | ❌ | Specific incident IDs to retrieve. |
14
+ * | `status` | `IncidentStatus[]`| ❌ | List of statuses to filter incidents by (e.g., OPEN, ON_GOING, CLOSED). |
15
+ * | `idType` | `IncidentIdType` | ❌ | Type of ID used for filtering (e.g., DJUST_ID, EXTERNAL_ID). |
16
+ * | `page` | `number` | ❌ | Page number for paginated results (starting at 0). |
17
+ * | `size` | `number` | ❌ | Number of incidents per page. |
18
+ * | `sort` | `string[]` | ❌ | Sorting criteria in the format `field,(asc|desc)` (e.g., `status,desc`). |
19
+ *
20
+ * 📤 **Returns**:
21
+ * A `Promise<getIncidentsResponse>` containing a paginated list of incidents matching the filter criteria.
22
+ *
23
+ * 🛠 **Example usage**:
24
+ * ```ts
25
+ * const incidents = await getIncidents({
26
+ * customerAccountIds: ["acc123", "acc456"],
27
+ * linkedType: "ORDER",
28
+ * status: ["OPEN", "ON_GOING"],
29
+ * page: 0,
30
+ * size: 10,
31
+ * sort: ["createdAt,desc"],
32
+ * });
33
+ * ```
34
+ *
35
+ * @param {getIncidentsParameters} params - The parameters for filtering and retrieving incidents.
36
+ * @throws {Error} If the required `linkedType` is missing.
37
+ * @returns {Promise<getIncidentsResponse>} A promise that resolves to a response object containing the incidents.
38
+ */
39
+ export declare function getIncidents({ customerAccountIds, linkedType, ids, status, idType, page, size, sort, }: getIncidentsParameters): Promise<getIncidentsResponse>;
40
+ /**
41
+ * 🚚 Retrieves a list of filtered/sorted incidents based on various filter criteria.
42
+ *
43
+ * This function allows you to fetch incidents with detailed filtering options, such as customer account IDs, status, and sorting preferences.
44
+ *
45
+ * 🛠 **Endpoint**: `GET /v1/shop/incidents`
46
+ *
47
+ * | Parameter | Type | Required | Description |
48
+ * |-----------------------|--------------------|----------|-----------------------------------------------------------------------------|
49
+ * | `customerAccountIds` | `string[]` | ❌ | List of customer account IDs to filter incidents by. |
50
+ * | `linkedType` | `string` | ✅ | Type of entity linked to the incident (e.g., ORDER or ORDER_LINES). |
51
+ * | `ids` | `string[]` | ❌ | Specific incident IDs to retrieve. |
52
+ * | `status` | `IncidentStatus[]`| ❌ | List of statuses to filter incidents by (e.g., OPEN, ON_GOING, CLOSED). |
53
+ * | `reasonCodes` | `string[]` | ❌ | List of reasons to filter incidents by (e.g., BROKEN, MISSING,ERROR_ORDER). |
54
+ * | `suppliersIds` | `string[]` | ❌ | List of suppliers to filter incidents by. |
55
+ * | `customerAccountIds` | `string[]` | ❌ | List of accounts to filter incidents by. |
56
+ * | `customFields` | `{ customFieldId: string, customFieldValue: string }[]`| ❌ | List of custom field values to filter incidents by. |
57
+ * | `idType` | `IncidentIdType` | ❌ | Type of ID used for filtering (e.g., DJUST_ID, EXTERNAL_ID). |
58
+ * | `page` | `number` | ❌ | Page number for paginated results (starting at 0). |
59
+ * | `size` | `number` | ❌ | Number of incidents per page. |
60
+ * | `sort` | `string[]` | ❌ | Sorting criteria in the format `field,(asc|desc)` (e.g., `status,desc`). |
61
+ *
62
+ * 📤 **Returns**:
63
+ * A `Promise<getIncidentsResponse>` containing a paginated list of incidents matching the filter criteria.
64
+ *
65
+ * 🛠 **Example usage**:
66
+ * ```ts
67
+ * const incidents = await getIncidents({
68
+ * linkedType: "ORDER",
69
+ * status: ["OPEN", "ON_GOING"],
70
+ * reasonCodes: ["BROKEN", "MISSING"],
71
+ * suppliersIds: ["sup123", "sup456"],
72
+ * customerAccountIds: ["acc123", "acc456"],
73
+ * customFields: [{ customFieldId: "field1", customFieldValue: "value1" }],
74
+ * idType: "EXTERNAL_ID",
75
+ * page: 0,
76
+ * size: 10,
77
+ * sort: ["createdAt,desc"],
78
+ * });
79
+ * ```
80
+ *
81
+ * @param {getIncidentsParameters} params - The parameters for filtering and retrieving incidents.
82
+ * @throws {Error} If the required `linkedType` is missing.
83
+ * @returns {Promise<getIncidentsResponse>} A promise that resolves to a response object containing the incidents.
84
+ */
85
+ export declare function getIncidentsV2({ customerAccountIds, linkedType, ids, status, reasonCodes, supplierIds, customFields, idType, page, size, sort, }: getIncidentsParameters): Promise<getIncidentsResponse>;
86
+ /**
87
+ * 🚚 Retrieves details of a specific incident.
88
+ *
89
+ * This function fetches detailed information about an incident identified by its ID, with an optional ID type for filtering.
90
+ *
91
+ * 🛠 **Endpoint**: `GET /v1/shop/incidents/{incidentId} [ORDER-503]`
92
+ *
93
+ * | Parameter | Type | Required | Description |
94
+ * |--------------|-------------------|----------|------------------------------------------------------------------|
95
+ * | `incidentId` | `string` | ✅ | The unique identifier of the incident to retrieve. |
96
+ * | `idType` | `IncidentIdType` | ❌ | The type of ID used (e.g., DJUST_ID, EXTERNAL_ID) for the incident. |
97
+ *
98
+ * 📤 **Returns**:
99
+ * A `Promise<getIncidentResponse>` containing the details of the specified incident.
100
+ *
101
+ * 🛠 **Example usage**:
102
+ * ```ts
103
+ * const incident = await getIncident({
104
+ * incidentId: "incident123",
105
+ * idType: "EXTERNAL_ID",
106
+ * });
107
+ * ```
108
+ *
109
+ * @param {getIncidentParameters} params - The parameters for identifying the incident.
110
+ * @throws {Error} If the required `incidentId` is missing.
111
+ * @returns {Promise<getIncidentResponse>} A promise that resolves to the incident details.
112
+ */
113
+ export declare function getIncident({ incidentId, idType, }: getIncidentParameters): Promise<getIncidentResponse>;
114
+ /**
115
+ * 🚚 Creates a new incident for a specific logistic order.
116
+ *
117
+ * This function allows the creation of an incident for a given logistic order,
118
+ * requiring essential parameters like the `logisticOrderId` and `reasonCode`.
119
+ * The `customField` and `idType` are used to provide additional information for the incident creation.
120
+ *
121
+ * 🛠 **Endpoint**: `POST /v1/shop/logistic-orders/{logisticOrderId}/incidents [ORDER-101]`
122
+ *
123
+ * | Parameter | Type | Required | Description |
124
+ * |------------------|-------------------------------------|------------|----------------------------------------------------------|
125
+ * | `logisticOrderId`| `string` | ✅ | The ID of the logistic order for which the incident is created. |
126
+ * | `idType` | `IncidentIdType` | ❌ | The type of incident ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
127
+ * | `customField` | `{ customFieldValues: CustomFieldValueRequest[], idType: IncidentIdType }` | ❌ | The custom field data for the incident, including custom field values and ID type. |
128
+ * | `reasonCode` | `string[]` | ✅ | The reason codes for the incident (e.g., `["PRODUCT_DEFECT"]`). |
129
+ *
130
+ * 📤 **Returns**:
131
+ * A `Promise` resolving to a `createOrderLogisticIncidentResponse` object,
132
+ * containing the `incidentId` and `externalId` of the created incident.
133
+ *
134
+ * 🛠 **Example usage**:
135
+ * ```ts
136
+ * const incident = await createOrderLogisticIncident({
137
+ * logisticOrderId: "12345",
138
+ * idType: "EXTERNAL_ID",
139
+ * customField: { customFieldValues: [], idType: "EXTERNAL_ID" },
140
+ * reasonCode: ["PRODUCT_DEFECT"]
141
+ * });
142
+ * ```
143
+ *
144
+ * @param {createOrderLogisticIncidentParameters} params - The parameters for creating the incident.
145
+ * @throws {Error} If `logisticOrderId` or `reasonCode` is missing.
146
+ * @returns {Promise<createOrderLogisticIncidentResponse>} A promise resolving to the response containing the created incident's details.
147
+ */
148
+ export declare function createOrderLogisticIncident({ logisticOrderId, idType, customField, reasonCode, }: createOrderLogisticIncidentParameters): Promise<createOrderLogisticIncidentResponse>;
149
+ /**
150
+ * 🚚 Creates a new incident for a specific line within a logistic order.
151
+ *
152
+ * This function allows the creation of an incident for one or more lines within a logistic order.
153
+ * The `logisticOrderId`, `reasonCode`, and `orderLines` are required parameters.
154
+ * The `customFieldIdType` and `idType` are used for specifying additional information about the incident.
155
+ *
156
+ * 🛠 **Endpoint**: `POST /v1/shop/logistic-orders/{logisticOrderId}/lines/incidents [ORDER-102]`
157
+ *
158
+ * | Parameter | Type | Required | Description |
159
+ * |--------------------|-------------------------------------|------------|----------------------------------------------------------|
160
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order for which the line incident is created. |
161
+ * | `idType` | `IncidentIdType` | ❌ | The type of incident ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
162
+ * | `customFieldIdType`| `IncidentIdType` | ❌ | The ID type for custom field values (e.g., `EXTERNAL_ID`). |
163
+ * | `orderLines` | `{ customFieldValues: CustomFieldValueRequest[], lineId: string, quantity: number }[]` | ✅ | An array of objects describing the order lines, including custom field values, line ID, and quantity. |
164
+ * | `reasonCode` | `string[]` | ✅ | The reason codes for the incident (e.g., `["PRODUCT_DEFECT"]`). |
165
+ *
166
+ * 📤 **Returns**:
167
+ * A `Promise` resolving to a `createOrderLogisticLineIncidentResponse` object,
168
+ * containing the `incidentId` and `externalId` of the created incident.
169
+ *
170
+ * 🛠 **Example usage**:
171
+ * ```ts
172
+ * const incident = await createOrderLogisticLineIncident({
173
+ * logisticOrderId: "12345",
174
+ * idType: "EXTERNAL_ID",
175
+ * customFieldIdType: "DJUST_ID",
176
+ * orderLines: [
177
+ * { customFieldValues: [], lineId: "line_1", quantity: 2 }
178
+ * ],
179
+ * reasonCode: ["PRODUCT_DEFECT"]
180
+ * });
181
+ * ```
182
+ *
183
+ * @param {createOrderLogisticLineIncidentParameters} params - The parameters for creating the incident.
184
+ * @throws {Error} If `logisticOrderId`, `reasonCode`, or `orderLines` is missing.
185
+ * @returns {Promise<createOrderLogisticLineIncidentResponse>} A promise resolving to the response containing the created incident's details.
186
+ */
187
+ export declare function createOrderLogisticLineIncident({ logisticOrderId, idType, customFieldIdType, orderLines, reasonCode, }: createOrderLogisticLineIncidentParameters): Promise<createOrderLogisticLineIncidentResponse>;
188
+ /**
189
+ * 🚚 Creates a new incident thread for a specific logistic order on specific lines.
190
+ *
191
+ * This function allows the creation of a thread related to an incident for one or more lines within a logistic order.
192
+ * The `logisticOrderId`, `incidentId`, `customField`, `reasonCode` and `message` are required parameters.
193
+ * The `idType` is used for specifying additional information about the thread.
194
+ *
195
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads [ORDER-106]`
196
+ *
197
+ * | Parameter | Type | Required | Description |
198
+ * |--------------------|-------------------------------------|------------|----------------------------------------------------------|
199
+ * | `logisticOrderId` | `string` | ✅ | The ID of the logistic order on which the incident happened. |
200
+ * | `incidentId` | `string` | ✅ | The ID of the incident for which thread is created. |
201
+ * | `idType` | `IncidentIdType` | ❌ | The type of incident ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
202
+ * | `name` | `string` | ❌ | The name of the created thread. |
203
+ * | `message` | `string` | ✅ | The message of the created thread. |
204
+ * | `customField` | `{ customFieldValues: CustomFieldValueRequest[], idType: string}[]` | ✅ | An array of objects describing the custom field values to add to the thread. |
205
+ * | `reasonCode` | `string[]` | ✅ | The reason codes for the incident related to the thread (e.g., `["PRODUCT_DEFECT"]`). |
206
+ *
207
+ * 📤 **Returns**:
208
+ * A `Promise` resolving to a `createOrderLogisticLineIncidentResponse` object,
209
+ * containing the `threadId` and `threadExternalId`, and the `messageId` and `messageExternalId` of the created thread.
210
+ *
211
+ * 🛠 **Example usage**:
212
+ * ```ts
213
+ * const incident = await createOrderLogisticLineIncident({
214
+ * logisticOrderId: "12345",
215
+ * incidentId: "6789",
216
+ * idType: "EXTERNAL_ID",
217
+ * customField: [
218
+ * { customFieldValues: [], idType: "DJUST_ID" }
219
+ * ],
220
+ * reasonCode: ["PRODUCT_DEFECT"],
221
+ * name: "thread1",
222
+ * message: "Message related to thread1"
223
+ * });
224
+ * ```
225
+ *
226
+ * @param {createOrderLogisticLineIncidentParameters} params - The parameters for creating the thread.
227
+ * @throws {Error} If `logisticOrderId`, `incidentId`, `customField`, `reasonCode` or `message` is missing.
228
+ * @returns {Promise<createOrderLogisticLineIncidentResponse>} A promise resolving to the response containing the created thread's details.
229
+ */
230
+ export declare function createOrderLogisticIncidentThread({ logisticOrderId, incidentId, idType, customField, message, name, reasonCode, }: createOrderLogisticIncidentThreadParameters): Promise<createOrderLogisticIncidentThreadResponse>;
231
+ /**
232
+ * 🚚 Creates a new incident.
233
+ *
234
+ * This function allows the creation of a new incident with various parameters such as custom fields,
235
+ * external ID, logistic order ID, and reason codes.
236
+ *
237
+ * 🛠 **Endpoint**: `POST /v1/shop/incidents [ORDER-101]`
238
+ *
239
+ * | Parameter | Type | Required | Description |
240
+ * |------------------|-------------------------------------|------------|----------------------------------------------------------|
241
+ * | `customField` | `{ customFieldValues: CustomFieldValueRequest[], idType: IncidentIdType }` | ❌ | The custom field data for the incident, including custom field values and ID type. |
242
+ * | `externalId` | `string` | ❌ | An external identifier for the incident. |
243
+ * | `logisticOrderId`| `string` | ❌ | The ID of the logistic order associated with the incident. |
244
+ * | `reasonCodes` | `string[]` | ✅ | The reason codes for the incident. |
245
+ * | `idType` | `IncidentIdType` | ❌ | The type of ID used (e.g., DJUST_ID, EXTERNAL_ID). |
246
+ *
247
+ * 📤 **Returns**:
248
+ * A `Promise<createIncidentResponse>` containing the details of the created incident.
249
+ *
250
+ * 🛠 **Example usage**:
251
+ * ```ts
252
+ * const createdIncident = await createIncident({
253
+ * customField: {
254
+ * customFieldValues: [
255
+ * { customFieldId: "field1", customFieldValue: "value1" }
256
+ * ],
257
+ * idType: "DJUST_ID"
258
+ * },
259
+ * externalId: "EXT-123",
260
+ * logisticOrderId: "order-789",
261
+ * reasonCodes: ["DAMAGED_PRODUCT", "WRONG_QUANTITY"],
262
+ * });
263
+ * ```
264
+ *
265
+ * @param {createIncidentParameters} params - The parameters for creating the incident.
266
+ * @throws {Error} If the required `reasonCodes` parameter is missing.
267
+ * @returns {Promise<createIncidentResponse>} A promise that resolves to the created incident details.
268
+ */
269
+ export declare function createIncident({ customField, externalId, logisticOrderId, reasonCodes, idType, }: createIncidentParameters): Promise<createIncidentResponse>;
270
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/incident/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,qCAAqC,EACrC,yCAAyC,EACzC,oBAAoB,EACpB,mBAAmB,EACnB,mCAAmC,EACnC,uCAAuC,EACvC,2CAA2C,EAC3C,yCAAyC,EACzC,wBAAwB,EACxB,sBAAsB,EACvB,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,wBAAsB,YAAY,CAAC,EACjC,kBAAkB,EAClB,UAAU,EACV,GAAG,EACH,MAAM,EACN,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,IAAI,GACL,EAAE,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAmBxD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAEH,wBAAsB,cAAc,CAAC,EACnC,kBAAkB,EAClB,UAAU,EACV,GAAG,EACH,MAAM,EACN,WAAW,EACX,WAAW,EACX,YAAY,EACZ,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,IAAI,GACL,EAAE,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA8BxD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,wBAAsB,WAAW,CAAC,EAChC,UAAU,EACV,MAAM,GACP,EAAE,qBAAqB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAYtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,wBAAsB,2BAA2B,CAAC,EAChD,eAAe,EACf,MAAM,EACN,WAAW,EACX,UAAU,GACX,EAAE,qCAAqC,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAgBtF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,+BAA+B,CAAC,EACpD,eAAe,EACf,MAAM,EACN,iBAAiB,EACjB,UAAU,EACV,UAAU,GACX,EAAE,yCAAyC,GAAG,OAAO,CAAC,uCAAuC,CAAC,CAmB9F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,eAAe,EACf,UAAU,EACV,MAAM,EACN,WAAW,EACX,OAAO,EACP,IAAI,EACJ,UAAU,GACX,EAAE,2CAA2C,GAAG,OAAO,CAAC,yCAAyC,CAAC,CAmBlG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAsB,cAAc,CAAC,EACnC,WAAW,EACX,UAAU,EACV,eAAe,EACf,WAAW,EACX,MAAM,GACP,EAAE,wBAAwB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAkB5D"}
@@ -0,0 +1,11 @@
1
+ /**
2
+ * DJUST SDK Incident Module
3
+ * Re-exports all incident-related types and service.
4
+ *
5
+ * @module services/incident
6
+ * @since 2.17.0
7
+ */
8
+ export type { IncidentStatus, IncidentLinkedType, IncidentIdType, CustomFieldValueRequest, CustomFieldRequest, OrderLineIncident, GetIncidentsParams, GetIncidentsV2Params, GetIncidentParams, CreateIncidentParams, CreateOrderLogisticIncidentParams, CreateOrderLogisticLineIncidentParams, CreateOrderLogisticIncidentThreadParams, Incident, IncidentThread, GetIncidentsResponse, GetIncidentResponse, CreateIncidentResponse, CreateOrderLogisticIncidentResponse, CreateOrderLogisticLineIncidentResponse, CreateOrderLogisticIncidentThreadResponse, } from "./types";
9
+ export { IncidentEndpoints, type IncidentEndpoint } from "./endpoints";
10
+ export { IncidentService } from "./incident.service";
11
+ //# sourceMappingURL=module.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../src/services/incident/module.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,EACV,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,iCAAiC,EACjC,qCAAqC,EACrC,uCAAuC,EACvC,QAAQ,EACR,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,mCAAmC,EACnC,uCAAuC,EACvC,yCAAyC,GAC1C,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC"}
@@ -0,0 +1,116 @@
1
+ /**
2
+ * DJUST SDK Incident Service - Types
3
+ * Type definitions for incident operations.
4
+ *
5
+ * @module services/incident/types
6
+ * @since 2.17.0
7
+ */
8
+ import type { PaginatedResponse } from "../types";
9
+ export type IncidentStatus = "OPEN" | "ON_GOING" | "CLOSED";
10
+ export type IncidentLinkedType = "ORDER" | "ORDER_LINES";
11
+ export type IncidentIdType = "DJUST_ID" | "EXTERNAL_ID";
12
+ export interface CustomFieldValueRequest {
13
+ customFieldId: string;
14
+ customFieldValue?: string;
15
+ }
16
+ export interface CustomFieldRequest {
17
+ customFieldValues?: CustomFieldValueRequest[];
18
+ idType?: IncidentIdType;
19
+ }
20
+ export interface OrderLineIncident {
21
+ customFieldValues?: CustomFieldValueRequest[];
22
+ lineId: string;
23
+ quantity: number;
24
+ }
25
+ export interface GetIncidentsParams {
26
+ linkedType: IncidentLinkedType;
27
+ customerAccountIds?: string[];
28
+ ids?: string[];
29
+ status?: IncidentStatus[];
30
+ idType?: IncidentIdType;
31
+ page?: number;
32
+ size?: number;
33
+ sort?: string[];
34
+ }
35
+ export interface GetIncidentsV2Params {
36
+ linkedType: IncidentLinkedType;
37
+ customerAccountIds?: string[];
38
+ ids?: string[];
39
+ status?: IncidentStatus[];
40
+ reasonCodes?: string[];
41
+ supplierIds?: string[];
42
+ customFields?: CustomFieldValueRequest[];
43
+ idType?: IncidentIdType;
44
+ page?: number;
45
+ size?: number;
46
+ sort?: string[];
47
+ }
48
+ export interface GetIncidentParams {
49
+ incidentId: string;
50
+ idType?: IncidentIdType;
51
+ }
52
+ export interface CreateIncidentParams {
53
+ reasonCodes: string[];
54
+ customField?: CustomFieldRequest;
55
+ externalId?: string;
56
+ logisticOrderId?: string;
57
+ idType?: IncidentIdType;
58
+ }
59
+ export interface CreateOrderLogisticIncidentParams {
60
+ logisticOrderId: string;
61
+ reasonCode: string[];
62
+ customField?: CustomFieldRequest;
63
+ idType?: IncidentIdType;
64
+ }
65
+ export interface CreateOrderLogisticLineIncidentParams {
66
+ logisticOrderId: string;
67
+ reasonCode: string[];
68
+ orderLines: OrderLineIncident[];
69
+ customFieldIdType?: IncidentIdType;
70
+ idType?: IncidentIdType;
71
+ }
72
+ export interface CreateOrderLogisticIncidentThreadParams {
73
+ logisticOrderId: string;
74
+ incidentId: string;
75
+ reasonCode: string[];
76
+ message: string;
77
+ customField?: CustomFieldRequest[];
78
+ name?: string;
79
+ idType?: IncidentIdType;
80
+ }
81
+ export interface Incident {
82
+ id: string;
83
+ externalId?: string;
84
+ status: IncidentStatus;
85
+ linkedType: IncidentLinkedType;
86
+ linkedId?: string;
87
+ reasonCodes: string[];
88
+ customFieldValues?: CustomFieldValueRequest[];
89
+ createdAt: string;
90
+ updatedAt: string;
91
+ }
92
+ export interface IncidentThread {
93
+ threadId: string;
94
+ threadExternalId?: string;
95
+ messageId: string;
96
+ messageExternalId?: string;
97
+ }
98
+ export interface GetIncidentsResponse extends PaginatedResponse<Incident> {
99
+ }
100
+ export interface GetIncidentResponse extends Incident {
101
+ }
102
+ export interface CreateIncidentResponse {
103
+ incidentId: string;
104
+ externalId?: string;
105
+ }
106
+ export interface CreateOrderLogisticIncidentResponse {
107
+ incidentId: string;
108
+ externalId?: string;
109
+ }
110
+ export interface CreateOrderLogisticLineIncidentResponse {
111
+ incidentId: string;
112
+ externalId?: string;
113
+ }
114
+ export interface CreateOrderLogisticIncidentThreadResponse extends IncidentThread {
115
+ }
116
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/incident/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAMlD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC5D,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,aAAa,CAAC;AACzD,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,aAAa,CAAC;AAExD,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC9C,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACzC,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,iCAAiC;IAChD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,qCAAqC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,iBAAiB,CAAC,EAAE,cAAc,CAAC;IACnC,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,uCAAuC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAMD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAGD,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB,CAAC,QAAQ,CAAC;CAAG;AAC5E,MAAM,WAAW,mBAAoB,SAAQ,QAAQ;CAAG;AACxD,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,mCAAmC;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,uCAAuC;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,yCACf,SAAQ,cAAc;CAAG"}