@gradientedge/commercetools-utils 5.9.0 → 5.10.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 (695) hide show
  1. package/dist/cjs/api/CommercetoolsApi.d.ts +1252 -0
  2. package/dist/cjs/api/CommercetoolsApi.d.ts.map +1 -0
  3. package/dist/cjs/api/CommercetoolsApi.js +2106 -0
  4. package/dist/cjs/api/CommercetoolsApi.js.map +1 -0
  5. package/dist/cjs/api/index.d.ts +3 -0
  6. package/dist/cjs/api/index.d.ts.map +1 -0
  7. package/dist/cjs/api/index.js +19 -0
  8. package/dist/cjs/api/index.js.map +1 -0
  9. package/dist/cjs/api/types.d.ts +33 -0
  10. package/dist/cjs/api/types.d.ts.map +1 -0
  11. package/dist/cjs/api/types.js +3 -0
  12. package/dist/cjs/api/types.js.map +1 -0
  13. package/dist/cjs/auth/CommercetoolsAuth.d.ts +182 -0
  14. package/dist/cjs/auth/CommercetoolsAuth.d.ts.map +1 -0
  15. package/dist/cjs/auth/CommercetoolsAuth.js +238 -0
  16. package/dist/cjs/auth/CommercetoolsAuth.js.map +1 -0
  17. package/dist/cjs/auth/CommercetoolsAuthApi.d.ts +83 -0
  18. package/dist/cjs/auth/CommercetoolsAuthApi.d.ts.map +1 -0
  19. package/dist/cjs/auth/CommercetoolsAuthApi.js +169 -0
  20. package/dist/cjs/auth/CommercetoolsAuthApi.js.map +1 -0
  21. package/dist/cjs/auth/CommercetoolsGrant.d.ts +66 -0
  22. package/dist/cjs/auth/CommercetoolsGrant.d.ts.map +1 -0
  23. package/dist/cjs/auth/CommercetoolsGrant.js +99 -0
  24. package/dist/cjs/auth/CommercetoolsGrant.js.map +1 -0
  25. package/dist/cjs/auth/constants.d.ts +7 -0
  26. package/dist/cjs/auth/constants.d.ts.map +1 -0
  27. package/dist/cjs/auth/constants.js +31 -0
  28. package/dist/cjs/auth/constants.js.map +1 -0
  29. package/dist/cjs/auth/index.d.ts +4 -0
  30. package/dist/cjs/auth/index.d.ts.map +1 -0
  31. package/dist/cjs/auth/index.js +19 -0
  32. package/dist/cjs/auth/index.js.map +1 -0
  33. package/dist/cjs/auth/scopes.d.ts +11 -0
  34. package/dist/cjs/auth/scopes.d.ts.map +1 -0
  35. package/dist/cjs/auth/scopes.js +30 -0
  36. package/dist/cjs/auth/scopes.js.map +1 -0
  37. package/dist/cjs/auth/types.d.ts +118 -0
  38. package/dist/cjs/auth/types.d.ts.map +1 -0
  39. package/dist/cjs/auth/types.js +28 -0
  40. package/dist/cjs/auth/types.js.map +1 -0
  41. package/dist/{typings → cjs}/auth/utils.d.ts +1 -0
  42. package/dist/cjs/auth/utils.d.ts.map +1 -0
  43. package/dist/cjs/auth/utils.js +14 -0
  44. package/dist/cjs/auth/utils.js.map +1 -0
  45. package/dist/cjs/constants.d.ts +33 -0
  46. package/dist/cjs/constants.d.ts.map +1 -0
  47. package/dist/cjs/constants.js +46 -0
  48. package/dist/cjs/constants.js.map +1 -0
  49. package/dist/cjs/error/CommercetoolsError.d.ts +33 -0
  50. package/dist/cjs/error/CommercetoolsError.d.ts.map +1 -0
  51. package/dist/cjs/error/CommercetoolsError.js +110 -0
  52. package/dist/cjs/error/CommercetoolsError.js.map +1 -0
  53. package/dist/cjs/error/index.d.ts +2 -0
  54. package/dist/cjs/error/index.d.ts.map +1 -0
  55. package/dist/cjs/error/index.js +18 -0
  56. package/dist/cjs/error/index.js.map +1 -0
  57. package/dist/cjs/index.d.ts +8 -0
  58. package/dist/cjs/index.d.ts.map +1 -0
  59. package/dist/cjs/index.js +26 -0
  60. package/dist/cjs/index.js.map +1 -0
  61. package/dist/cjs/models/associate-role.d.ts +319 -0
  62. package/dist/cjs/models/associate-role.d.ts.map +1 -0
  63. package/dist/cjs/models/associate-role.js +8 -0
  64. package/dist/cjs/models/associate-role.js.map +1 -0
  65. package/dist/cjs/models/attribute-group.d.ts +253 -0
  66. package/dist/cjs/models/attribute-group.d.ts.map +1 -0
  67. package/dist/cjs/models/attribute-group.js +8 -0
  68. package/dist/cjs/models/attribute-group.js.map +1 -0
  69. package/dist/cjs/models/business-unit.d.ts +1197 -0
  70. package/dist/cjs/models/business-unit.d.ts.map +1 -0
  71. package/dist/cjs/models/business-unit.js +8 -0
  72. package/dist/cjs/models/business-unit.js.map +1 -0
  73. package/dist/cjs/models/cart-discount.d.ts +716 -0
  74. package/dist/cjs/models/cart-discount.d.ts.map +1 -0
  75. package/dist/cjs/models/cart-discount.js +8 -0
  76. package/dist/cjs/models/cart-discount.js.map +1 -0
  77. package/dist/cjs/models/cart.d.ts +3350 -0
  78. package/dist/cjs/models/cart.d.ts.map +1 -0
  79. package/dist/cjs/models/cart.js +8 -0
  80. package/dist/cjs/models/cart.js.map +1 -0
  81. package/dist/cjs/models/category.d.ts +634 -0
  82. package/dist/cjs/models/category.d.ts.map +1 -0
  83. package/dist/cjs/models/category.js +8 -0
  84. package/dist/cjs/models/category.js.map +1 -0
  85. package/dist/cjs/models/channel.d.ts +379 -0
  86. package/dist/cjs/models/channel.d.ts.map +1 -0
  87. package/dist/cjs/models/channel.js +8 -0
  88. package/dist/cjs/models/channel.js.map +1 -0
  89. package/dist/cjs/models/common.d.ts +1096 -0
  90. package/dist/cjs/models/common.d.ts.map +1 -0
  91. package/dist/cjs/models/common.js +8 -0
  92. package/dist/cjs/models/common.js.map +1 -0
  93. package/dist/cjs/models/custom-object.d.ts +151 -0
  94. package/dist/cjs/models/custom-object.d.ts.map +1 -0
  95. package/dist/cjs/models/custom-object.js +8 -0
  96. package/dist/cjs/models/custom-object.js.map +1 -0
  97. package/dist/cjs/models/customer-group.d.ts +235 -0
  98. package/dist/cjs/models/customer-group.d.ts.map +1 -0
  99. package/dist/cjs/models/customer-group.js +8 -0
  100. package/dist/cjs/models/customer-group.js.map +1 -0
  101. package/dist/cjs/models/customer.d.ts +1221 -0
  102. package/dist/cjs/models/customer.d.ts.map +1 -0
  103. package/dist/cjs/models/customer.js +8 -0
  104. package/dist/cjs/models/customer.js.map +1 -0
  105. package/dist/cjs/models/discount-code.d.ts +439 -0
  106. package/dist/cjs/models/discount-code.d.ts.map +1 -0
  107. package/dist/cjs/models/discount-code.js +8 -0
  108. package/dist/cjs/models/discount-code.js.map +1 -0
  109. package/dist/cjs/models/error.d.ts +3062 -0
  110. package/dist/cjs/models/error.d.ts.map +1 -0
  111. package/dist/cjs/models/error.js +8 -0
  112. package/dist/cjs/models/error.js.map +1 -0
  113. package/dist/cjs/models/extension.d.ts +335 -0
  114. package/dist/cjs/models/extension.d.ts.map +1 -0
  115. package/dist/cjs/models/extension.js +8 -0
  116. package/dist/cjs/models/extension.js.map +1 -0
  117. package/dist/cjs/models/graph-ql.d.ts +63 -0
  118. package/dist/cjs/models/graph-ql.d.ts.map +1 -0
  119. package/dist/cjs/models/graph-ql.js +8 -0
  120. package/dist/cjs/models/graph-ql.js.map +1 -0
  121. package/dist/cjs/models/index.d.ts +42 -0
  122. package/dist/cjs/models/index.d.ts.map +1 -0
  123. package/dist/cjs/models/index.js +58 -0
  124. package/dist/cjs/models/index.js.map +1 -0
  125. package/dist/cjs/models/inventory.d.ts +327 -0
  126. package/dist/cjs/models/inventory.d.ts.map +1 -0
  127. package/dist/cjs/models/inventory.js +8 -0
  128. package/dist/cjs/models/inventory.js.map +1 -0
  129. package/dist/cjs/models/me.d.ts +2483 -0
  130. package/dist/cjs/models/me.d.ts.map +1 -0
  131. package/dist/cjs/models/me.js +8 -0
  132. package/dist/cjs/models/me.js.map +1 -0
  133. package/dist/cjs/models/message.d.ts +15095 -0
  134. package/dist/cjs/models/message.d.ts.map +1 -0
  135. package/dist/cjs/models/message.js +8 -0
  136. package/dist/cjs/models/message.js.map +1 -0
  137. package/dist/cjs/models/order-edit.d.ts +1645 -0
  138. package/dist/cjs/models/order-edit.d.ts.map +1 -0
  139. package/dist/cjs/models/order-edit.js +8 -0
  140. package/dist/cjs/models/order-edit.js.map +1 -0
  141. package/dist/{typings → cjs}/models/order.d.ts +1490 -15
  142. package/dist/cjs/models/order.d.ts.map +1 -0
  143. package/dist/cjs/models/order.js +8 -0
  144. package/dist/cjs/models/order.js.map +1 -0
  145. package/dist/cjs/models/payment.d.ts +734 -0
  146. package/dist/cjs/models/payment.d.ts.map +1 -0
  147. package/dist/cjs/models/payment.js +8 -0
  148. package/dist/cjs/models/payment.js.map +1 -0
  149. package/dist/cjs/models/product-discount.d.ts +461 -0
  150. package/dist/cjs/models/product-discount.d.ts.map +1 -0
  151. package/dist/cjs/models/product-discount.js +8 -0
  152. package/dist/cjs/models/product-discount.js.map +1 -0
  153. package/dist/cjs/models/product-selection.d.ts +638 -0
  154. package/dist/cjs/models/product-selection.d.ts.map +1 -0
  155. package/dist/cjs/models/product-selection.js +8 -0
  156. package/dist/cjs/models/product-selection.js.map +1 -0
  157. package/dist/cjs/models/product-type.d.ts +774 -0
  158. package/dist/cjs/models/product-type.d.ts.map +1 -0
  159. package/dist/cjs/models/product-type.js +8 -0
  160. package/dist/cjs/models/product-type.js.map +1 -0
  161. package/dist/cjs/models/product.d.ts +2282 -0
  162. package/dist/cjs/models/product.d.ts.map +1 -0
  163. package/dist/cjs/models/product.js +8 -0
  164. package/dist/cjs/models/product.js.map +1 -0
  165. package/dist/cjs/models/project.d.ts +381 -0
  166. package/dist/cjs/models/project.d.ts.map +1 -0
  167. package/dist/cjs/models/project.js +8 -0
  168. package/dist/cjs/models/project.js.map +1 -0
  169. package/dist/cjs/models/quote-request.d.ts +430 -0
  170. package/dist/cjs/models/quote-request.d.ts.map +1 -0
  171. package/dist/cjs/models/quote-request.js +8 -0
  172. package/dist/cjs/models/quote-request.js.map +1 -0
  173. package/dist/cjs/models/quote.d.ts +458 -0
  174. package/dist/cjs/models/quote.d.ts.map +1 -0
  175. package/dist/cjs/models/quote.js +8 -0
  176. package/dist/cjs/models/quote.js.map +1 -0
  177. package/dist/cjs/models/review.d.ts +435 -0
  178. package/dist/cjs/models/review.d.ts.map +1 -0
  179. package/dist/cjs/models/review.js +8 -0
  180. package/dist/cjs/models/review.js.map +1 -0
  181. package/dist/cjs/models/scalar-types.d.ts +9 -0
  182. package/dist/cjs/models/scalar-types.d.ts.map +1 -0
  183. package/dist/cjs/models/scalar-types.js +8 -0
  184. package/dist/cjs/models/scalar-types.js.map +1 -0
  185. package/dist/cjs/models/shipping-method.d.ts +569 -0
  186. package/dist/cjs/models/shipping-method.d.ts.map +1 -0
  187. package/dist/cjs/models/shipping-method.js +8 -0
  188. package/dist/cjs/models/shipping-method.js.map +1 -0
  189. package/dist/cjs/models/shopping-list.d.ts +844 -0
  190. package/dist/cjs/models/shopping-list.d.ts.map +1 -0
  191. package/dist/cjs/models/shopping-list.js +8 -0
  192. package/dist/cjs/models/shopping-list.js.map +1 -0
  193. package/dist/cjs/models/staged-quote.d.ts +338 -0
  194. package/dist/cjs/models/staged-quote.d.ts.map +1 -0
  195. package/dist/cjs/models/staged-quote.js +8 -0
  196. package/dist/cjs/models/staged-quote.js.map +1 -0
  197. package/dist/cjs/models/standalone-price.d.ts +410 -0
  198. package/dist/cjs/models/standalone-price.d.ts.map +1 -0
  199. package/dist/cjs/models/standalone-price.js +8 -0
  200. package/dist/cjs/models/standalone-price.js.map +1 -0
  201. package/dist/cjs/models/state.d.ts +341 -0
  202. package/dist/cjs/models/state.d.ts.map +1 -0
  203. package/dist/cjs/models/state.js +8 -0
  204. package/dist/cjs/models/state.js.map +1 -0
  205. package/dist/cjs/models/store-country.d.ts +14 -0
  206. package/dist/cjs/models/store-country.d.ts.map +1 -0
  207. package/dist/cjs/models/store-country.js +8 -0
  208. package/dist/cjs/models/store-country.js.map +1 -0
  209. package/dist/cjs/models/store.d.ts +547 -0
  210. package/dist/cjs/models/store.d.ts.map +1 -0
  211. package/dist/cjs/models/store.js +8 -0
  212. package/dist/cjs/models/store.js.map +1 -0
  213. package/dist/cjs/models/subscription.d.ts +717 -0
  214. package/dist/cjs/models/subscription.d.ts.map +1 -0
  215. package/dist/cjs/models/subscription.js +8 -0
  216. package/dist/cjs/models/subscription.js.map +1 -0
  217. package/dist/cjs/models/tax-category.d.ts +376 -0
  218. package/dist/cjs/models/tax-category.d.ts.map +1 -0
  219. package/dist/cjs/models/tax-category.js +8 -0
  220. package/dist/cjs/models/tax-category.js.map +1 -0
  221. package/dist/cjs/models/type.d.ts +645 -0
  222. package/dist/cjs/models/type.d.ts.map +1 -0
  223. package/dist/cjs/models/type.js +8 -0
  224. package/dist/cjs/models/type.js.map +1 -0
  225. package/dist/cjs/models/zone.d.ts +234 -0
  226. package/dist/cjs/models/zone.d.ts.map +1 -0
  227. package/dist/cjs/models/zone.js +8 -0
  228. package/dist/cjs/models/zone.js.map +1 -0
  229. package/dist/cjs/package.json +1 -0
  230. package/dist/cjs/request/index.d.ts +3 -0
  231. package/dist/cjs/request/index.d.ts.map +1 -0
  232. package/dist/cjs/request/index.js +19 -0
  233. package/dist/cjs/request/index.js.map +1 -0
  234. package/dist/cjs/request/is-retryable-error.d.ts +6 -0
  235. package/dist/cjs/request/is-retryable-error.d.ts.map +1 -0
  236. package/dist/cjs/request/is-retryable-error.js +28 -0
  237. package/dist/cjs/request/is-retryable-error.js.map +1 -0
  238. package/dist/{typings → cjs}/request/request-executor.d.ts +3 -2
  239. package/dist/cjs/request/request-executor.d.ts.map +1 -0
  240. package/dist/cjs/request/request-executor.js +23 -0
  241. package/dist/cjs/request/request-executor.js.map +1 -0
  242. package/dist/{typings → cjs}/request/request.d.ts +3 -2
  243. package/dist/cjs/request/request.d.ts.map +1 -0
  244. package/dist/cjs/request/request.js +84 -0
  245. package/dist/cjs/request/request.js.map +1 -0
  246. package/dist/cjs/request/transform-error.d.ts +7 -0
  247. package/dist/cjs/request/transform-error.d.ts.map +1 -0
  248. package/dist/cjs/request/transform-error.js +16 -0
  249. package/dist/cjs/request/transform-error.js.map +1 -0
  250. package/dist/{typings → cjs}/types.d.ts +39 -1
  251. package/dist/cjs/types.d.ts.map +1 -0
  252. package/dist/cjs/types.js +16 -0
  253. package/dist/cjs/types.js.map +1 -0
  254. package/dist/{typings → cjs}/utils/axios/convert-error.d.ts +2 -1
  255. package/dist/cjs/utils/axios/convert-error.d.ts.map +1 -0
  256. package/dist/cjs/utils/axios/convert-error.js +28 -0
  257. package/dist/cjs/utils/axios/convert-error.js.map +1 -0
  258. package/dist/{typings → cjs}/utils/axios/convert-response.d.ts +2 -1
  259. package/dist/cjs/utils/axios/convert-response.d.ts.map +1 -0
  260. package/dist/cjs/utils/axios/convert-response.js +23 -0
  261. package/dist/cjs/utils/axios/convert-response.js.map +1 -0
  262. package/dist/{typings → cjs}/utils/axios/create-instance.d.ts +5 -0
  263. package/dist/cjs/utils/axios/create-instance.d.ts.map +1 -0
  264. package/dist/cjs/utils/axios/create-instance.js +30 -0
  265. package/dist/cjs/utils/axios/create-instance.js.map +1 -0
  266. package/dist/{typings → cjs}/utils/axios/extract-headers.d.ts +1 -0
  267. package/dist/cjs/utils/axios/extract-headers.d.ts.map +1 -0
  268. package/dist/cjs/utils/axios/extract-headers.js +23 -0
  269. package/dist/cjs/utils/axios/extract-headers.js.map +1 -0
  270. package/dist/cjs/utils/axios/index.d.ts +5 -0
  271. package/dist/cjs/utils/axios/index.d.ts.map +1 -0
  272. package/dist/cjs/utils/axios/index.js +21 -0
  273. package/dist/cjs/utils/axios/index.js.map +1 -0
  274. package/dist/cjs/utils/calculate-delay.d.ts +7 -0
  275. package/dist/cjs/utils/calculate-delay.d.ts.map +1 -0
  276. package/dist/cjs/utils/calculate-delay.js +30 -0
  277. package/dist/cjs/utils/calculate-delay.js.map +1 -0
  278. package/dist/cjs/utils/ensure-non-empty-string.d.ts +16 -0
  279. package/dist/cjs/utils/ensure-non-empty-string.d.ts.map +1 -0
  280. package/dist/cjs/utils/ensure-non-empty-string.js +16 -0
  281. package/dist/cjs/utils/ensure-non-empty-string.js.map +1 -0
  282. package/dist/cjs/utils/format.d.ts +11 -0
  283. package/dist/cjs/utils/format.d.ts.map +1 -0
  284. package/dist/cjs/utils/format.js +48 -0
  285. package/dist/cjs/utils/format.js.map +1 -0
  286. package/dist/cjs/utils/get-attribute-value.d.ts +17 -0
  287. package/dist/cjs/utils/get-attribute-value.d.ts.map +1 -0
  288. package/dist/cjs/utils/get-attribute-value.js +19 -0
  289. package/dist/cjs/utils/get-attribute-value.js.map +1 -0
  290. package/dist/cjs/utils/index.d.ts +9 -0
  291. package/dist/cjs/utils/index.d.ts.map +1 -0
  292. package/dist/cjs/utils/index.js +25 -0
  293. package/dist/cjs/utils/index.js.map +1 -0
  294. package/dist/cjs/utils/mask.d.ts +28 -0
  295. package/dist/cjs/utils/mask.d.ts.map +1 -0
  296. package/dist/cjs/utils/mask.js +63 -0
  297. package/dist/cjs/utils/mask.js.map +1 -0
  298. package/dist/cjs/utils/plain-clone.d.ts +14 -0
  299. package/dist/cjs/utils/plain-clone.d.ts.map +1 -0
  300. package/dist/cjs/utils/plain-clone.js +41 -0
  301. package/dist/cjs/utils/plain-clone.js.map +1 -0
  302. package/dist/cjs/utils/retry-on-conflict.d.ts +99 -0
  303. package/dist/cjs/utils/retry-on-conflict.d.ts.map +1 -0
  304. package/dist/cjs/utils/retry-on-conflict.js +109 -0
  305. package/dist/cjs/utils/retry-on-conflict.js.map +1 -0
  306. package/dist/cjs/utils/useragent.d.ts +10 -0
  307. package/dist/cjs/utils/useragent.d.ts.map +1 -0
  308. package/dist/cjs/utils/useragent.js +21 -0
  309. package/dist/cjs/utils/useragent.js.map +1 -0
  310. package/dist/mjs/api/CommercetoolsApi.d.ts +1252 -0
  311. package/dist/mjs/api/CommercetoolsApi.d.ts.map +1 -0
  312. package/dist/mjs/api/CommercetoolsApi.js +2102 -0
  313. package/dist/mjs/api/CommercetoolsApi.js.map +1 -0
  314. package/dist/mjs/api/index.d.ts +3 -0
  315. package/dist/mjs/api/index.d.ts.map +1 -0
  316. package/dist/mjs/api/index.js +3 -0
  317. package/dist/mjs/api/index.js.map +1 -0
  318. package/dist/mjs/api/types.d.ts +33 -0
  319. package/dist/mjs/api/types.d.ts.map +1 -0
  320. package/dist/mjs/api/types.js +2 -0
  321. package/dist/mjs/api/types.js.map +1 -0
  322. package/dist/mjs/auth/CommercetoolsAuth.d.ts +182 -0
  323. package/dist/mjs/auth/CommercetoolsAuth.d.ts.map +1 -0
  324. package/dist/mjs/auth/CommercetoolsAuth.js +234 -0
  325. package/dist/mjs/auth/CommercetoolsAuth.js.map +1 -0
  326. package/dist/mjs/auth/CommercetoolsAuthApi.d.ts +83 -0
  327. package/dist/mjs/auth/CommercetoolsAuthApi.d.ts.map +1 -0
  328. package/dist/mjs/auth/CommercetoolsAuthApi.js +165 -0
  329. package/dist/mjs/auth/CommercetoolsAuthApi.js.map +1 -0
  330. package/dist/mjs/auth/CommercetoolsGrant.d.ts +66 -0
  331. package/dist/mjs/auth/CommercetoolsGrant.d.ts.map +1 -0
  332. package/dist/mjs/auth/CommercetoolsGrant.js +95 -0
  333. package/dist/mjs/auth/CommercetoolsGrant.js.map +1 -0
  334. package/dist/mjs/auth/constants.d.ts +7 -0
  335. package/dist/mjs/auth/constants.d.ts.map +1 -0
  336. package/dist/mjs/auth/constants.js +28 -0
  337. package/dist/mjs/auth/constants.js.map +1 -0
  338. package/dist/mjs/auth/index.d.ts +4 -0
  339. package/dist/mjs/auth/index.d.ts.map +1 -0
  340. package/dist/mjs/auth/index.js +3 -0
  341. package/dist/mjs/auth/index.js.map +1 -0
  342. package/dist/mjs/auth/scopes.d.ts +11 -0
  343. package/dist/mjs/auth/scopes.d.ts.map +1 -0
  344. package/dist/mjs/auth/scopes.js +25 -0
  345. package/dist/mjs/auth/scopes.js.map +1 -0
  346. package/dist/mjs/auth/types.d.ts +118 -0
  347. package/dist/mjs/auth/types.d.ts.map +1 -0
  348. package/dist/mjs/auth/types.js +25 -0
  349. package/dist/mjs/auth/types.js.map +1 -0
  350. package/dist/mjs/auth/utils.d.ts +2 -0
  351. package/dist/mjs/auth/utils.d.ts.map +1 -0
  352. package/dist/mjs/auth/utils.js +10 -0
  353. package/dist/mjs/auth/utils.js.map +1 -0
  354. package/dist/mjs/constants.d.ts +33 -0
  355. package/dist/mjs/constants.d.ts.map +1 -0
  356. package/dist/mjs/constants.js +43 -0
  357. package/dist/mjs/constants.js.map +1 -0
  358. package/dist/mjs/error/CommercetoolsError.d.ts +33 -0
  359. package/dist/mjs/error/CommercetoolsError.d.ts.map +1 -0
  360. package/dist/mjs/error/CommercetoolsError.js +103 -0
  361. package/dist/mjs/error/CommercetoolsError.js.map +1 -0
  362. package/dist/mjs/error/index.d.ts +2 -0
  363. package/dist/mjs/error/index.d.ts.map +1 -0
  364. package/dist/mjs/error/index.js +2 -0
  365. package/dist/mjs/error/index.js.map +1 -0
  366. package/dist/mjs/index.d.ts +8 -0
  367. package/dist/mjs/index.d.ts.map +1 -0
  368. package/dist/mjs/index.js +8 -0
  369. package/dist/mjs/index.js.map +1 -0
  370. package/dist/mjs/models/associate-role.d.ts +319 -0
  371. package/dist/mjs/models/associate-role.d.ts.map +1 -0
  372. package/dist/mjs/models/associate-role.js +7 -0
  373. package/dist/mjs/models/associate-role.js.map +1 -0
  374. package/dist/mjs/models/attribute-group.d.ts +253 -0
  375. package/dist/mjs/models/attribute-group.d.ts.map +1 -0
  376. package/dist/mjs/models/attribute-group.js +7 -0
  377. package/dist/mjs/models/attribute-group.js.map +1 -0
  378. package/dist/mjs/models/business-unit.d.ts +1197 -0
  379. package/dist/mjs/models/business-unit.d.ts.map +1 -0
  380. package/dist/mjs/models/business-unit.js +7 -0
  381. package/dist/mjs/models/business-unit.js.map +1 -0
  382. package/dist/mjs/models/cart-discount.d.ts +716 -0
  383. package/dist/mjs/models/cart-discount.d.ts.map +1 -0
  384. package/dist/mjs/models/cart-discount.js +7 -0
  385. package/dist/mjs/models/cart-discount.js.map +1 -0
  386. package/dist/mjs/models/cart.d.ts +3350 -0
  387. package/dist/mjs/models/cart.d.ts.map +1 -0
  388. package/dist/mjs/models/cart.js +7 -0
  389. package/dist/mjs/models/cart.js.map +1 -0
  390. package/dist/mjs/models/category.d.ts +634 -0
  391. package/dist/mjs/models/category.d.ts.map +1 -0
  392. package/dist/mjs/models/category.js +7 -0
  393. package/dist/mjs/models/category.js.map +1 -0
  394. package/dist/mjs/models/channel.d.ts +379 -0
  395. package/dist/mjs/models/channel.d.ts.map +1 -0
  396. package/dist/mjs/models/channel.js +7 -0
  397. package/dist/mjs/models/channel.js.map +1 -0
  398. package/dist/mjs/models/common.d.ts +1096 -0
  399. package/dist/mjs/models/common.d.ts.map +1 -0
  400. package/dist/mjs/models/common.js +7 -0
  401. package/dist/mjs/models/common.js.map +1 -0
  402. package/dist/mjs/models/custom-object.d.ts +151 -0
  403. package/dist/mjs/models/custom-object.d.ts.map +1 -0
  404. package/dist/mjs/models/custom-object.js +7 -0
  405. package/dist/mjs/models/custom-object.js.map +1 -0
  406. package/dist/mjs/models/customer-group.d.ts +235 -0
  407. package/dist/mjs/models/customer-group.d.ts.map +1 -0
  408. package/dist/mjs/models/customer-group.js +7 -0
  409. package/dist/mjs/models/customer-group.js.map +1 -0
  410. package/dist/mjs/models/customer.d.ts +1221 -0
  411. package/dist/mjs/models/customer.d.ts.map +1 -0
  412. package/dist/mjs/models/customer.js +7 -0
  413. package/dist/mjs/models/customer.js.map +1 -0
  414. package/dist/mjs/models/discount-code.d.ts +439 -0
  415. package/dist/mjs/models/discount-code.d.ts.map +1 -0
  416. package/dist/mjs/models/discount-code.js +7 -0
  417. package/dist/mjs/models/discount-code.js.map +1 -0
  418. package/dist/mjs/models/error.d.ts +3062 -0
  419. package/dist/mjs/models/error.d.ts.map +1 -0
  420. package/dist/mjs/models/error.js +7 -0
  421. package/dist/mjs/models/error.js.map +1 -0
  422. package/dist/mjs/models/extension.d.ts +335 -0
  423. package/dist/mjs/models/extension.d.ts.map +1 -0
  424. package/dist/mjs/models/extension.js +7 -0
  425. package/dist/mjs/models/extension.js.map +1 -0
  426. package/dist/mjs/models/graph-ql.d.ts +63 -0
  427. package/dist/mjs/models/graph-ql.d.ts.map +1 -0
  428. package/dist/mjs/models/graph-ql.js +7 -0
  429. package/dist/mjs/models/graph-ql.js.map +1 -0
  430. package/dist/mjs/models/index.d.ts +42 -0
  431. package/dist/mjs/models/index.d.ts.map +1 -0
  432. package/dist/mjs/models/index.js +42 -0
  433. package/dist/mjs/models/index.js.map +1 -0
  434. package/dist/mjs/models/inventory.d.ts +327 -0
  435. package/dist/mjs/models/inventory.d.ts.map +1 -0
  436. package/dist/mjs/models/inventory.js +7 -0
  437. package/dist/mjs/models/inventory.js.map +1 -0
  438. package/dist/mjs/models/me.d.ts +2483 -0
  439. package/dist/mjs/models/me.d.ts.map +1 -0
  440. package/dist/mjs/models/me.js +7 -0
  441. package/dist/mjs/models/me.js.map +1 -0
  442. package/dist/mjs/models/message.d.ts +15095 -0
  443. package/dist/mjs/models/message.d.ts.map +1 -0
  444. package/dist/mjs/models/message.js +7 -0
  445. package/dist/mjs/models/message.js.map +1 -0
  446. package/dist/mjs/models/order-edit.d.ts +1645 -0
  447. package/dist/mjs/models/order-edit.d.ts.map +1 -0
  448. package/dist/mjs/models/order-edit.js +7 -0
  449. package/dist/mjs/models/order-edit.js.map +1 -0
  450. package/dist/mjs/models/order.d.ts +2157 -0
  451. package/dist/mjs/models/order.d.ts.map +1 -0
  452. package/dist/mjs/models/order.js +7 -0
  453. package/dist/mjs/models/order.js.map +1 -0
  454. package/dist/mjs/models/payment.d.ts +734 -0
  455. package/dist/mjs/models/payment.d.ts.map +1 -0
  456. package/dist/mjs/models/payment.js +7 -0
  457. package/dist/mjs/models/payment.js.map +1 -0
  458. package/dist/mjs/models/product-discount.d.ts +461 -0
  459. package/dist/mjs/models/product-discount.d.ts.map +1 -0
  460. package/dist/mjs/models/product-discount.js +7 -0
  461. package/dist/mjs/models/product-discount.js.map +1 -0
  462. package/dist/mjs/models/product-selection.d.ts +638 -0
  463. package/dist/mjs/models/product-selection.d.ts.map +1 -0
  464. package/dist/mjs/models/product-selection.js +7 -0
  465. package/dist/mjs/models/product-selection.js.map +1 -0
  466. package/dist/mjs/models/product-type.d.ts +774 -0
  467. package/dist/mjs/models/product-type.d.ts.map +1 -0
  468. package/dist/mjs/models/product-type.js +7 -0
  469. package/dist/mjs/models/product-type.js.map +1 -0
  470. package/dist/mjs/models/product.d.ts +2282 -0
  471. package/dist/mjs/models/product.d.ts.map +1 -0
  472. package/dist/mjs/models/product.js +7 -0
  473. package/dist/mjs/models/product.js.map +1 -0
  474. package/dist/mjs/models/project.d.ts +381 -0
  475. package/dist/mjs/models/project.d.ts.map +1 -0
  476. package/dist/mjs/models/project.js +7 -0
  477. package/dist/mjs/models/project.js.map +1 -0
  478. package/dist/mjs/models/quote-request.d.ts +430 -0
  479. package/dist/mjs/models/quote-request.d.ts.map +1 -0
  480. package/dist/mjs/models/quote-request.js +7 -0
  481. package/dist/mjs/models/quote-request.js.map +1 -0
  482. package/dist/mjs/models/quote.d.ts +458 -0
  483. package/dist/mjs/models/quote.d.ts.map +1 -0
  484. package/dist/mjs/models/quote.js +7 -0
  485. package/dist/mjs/models/quote.js.map +1 -0
  486. package/dist/mjs/models/review.d.ts +435 -0
  487. package/dist/mjs/models/review.d.ts.map +1 -0
  488. package/dist/mjs/models/review.js +7 -0
  489. package/dist/mjs/models/review.js.map +1 -0
  490. package/dist/mjs/models/scalar-types.d.ts +9 -0
  491. package/dist/mjs/models/scalar-types.d.ts.map +1 -0
  492. package/dist/mjs/models/scalar-types.js +7 -0
  493. package/dist/mjs/models/scalar-types.js.map +1 -0
  494. package/dist/mjs/models/shipping-method.d.ts +569 -0
  495. package/dist/mjs/models/shipping-method.d.ts.map +1 -0
  496. package/dist/mjs/models/shipping-method.js +7 -0
  497. package/dist/mjs/models/shipping-method.js.map +1 -0
  498. package/dist/mjs/models/shopping-list.d.ts +844 -0
  499. package/dist/mjs/models/shopping-list.d.ts.map +1 -0
  500. package/dist/mjs/models/shopping-list.js +7 -0
  501. package/dist/mjs/models/shopping-list.js.map +1 -0
  502. package/dist/mjs/models/staged-quote.d.ts +338 -0
  503. package/dist/mjs/models/staged-quote.d.ts.map +1 -0
  504. package/dist/mjs/models/staged-quote.js +7 -0
  505. package/dist/mjs/models/staged-quote.js.map +1 -0
  506. package/dist/mjs/models/standalone-price.d.ts +410 -0
  507. package/dist/mjs/models/standalone-price.d.ts.map +1 -0
  508. package/dist/mjs/models/standalone-price.js +7 -0
  509. package/dist/mjs/models/standalone-price.js.map +1 -0
  510. package/dist/mjs/models/state.d.ts +341 -0
  511. package/dist/mjs/models/state.d.ts.map +1 -0
  512. package/dist/mjs/models/state.js +7 -0
  513. package/dist/mjs/models/state.js.map +1 -0
  514. package/dist/mjs/models/store-country.d.ts +14 -0
  515. package/dist/mjs/models/store-country.d.ts.map +1 -0
  516. package/dist/mjs/models/store-country.js +7 -0
  517. package/dist/mjs/models/store-country.js.map +1 -0
  518. package/dist/mjs/models/store.d.ts +547 -0
  519. package/dist/mjs/models/store.d.ts.map +1 -0
  520. package/dist/mjs/models/store.js +7 -0
  521. package/dist/mjs/models/store.js.map +1 -0
  522. package/dist/mjs/models/subscription.d.ts +717 -0
  523. package/dist/mjs/models/subscription.d.ts.map +1 -0
  524. package/dist/mjs/models/subscription.js +7 -0
  525. package/dist/mjs/models/subscription.js.map +1 -0
  526. package/dist/mjs/models/tax-category.d.ts +376 -0
  527. package/dist/mjs/models/tax-category.d.ts.map +1 -0
  528. package/dist/mjs/models/tax-category.js +7 -0
  529. package/dist/mjs/models/tax-category.js.map +1 -0
  530. package/dist/mjs/models/type.d.ts +645 -0
  531. package/dist/mjs/models/type.d.ts.map +1 -0
  532. package/dist/mjs/models/type.js +7 -0
  533. package/dist/mjs/models/type.js.map +1 -0
  534. package/dist/mjs/models/zone.d.ts +234 -0
  535. package/dist/mjs/models/zone.d.ts.map +1 -0
  536. package/dist/mjs/models/zone.js +7 -0
  537. package/dist/mjs/models/zone.js.map +1 -0
  538. package/dist/mjs/request/index.d.ts +3 -0
  539. package/dist/mjs/request/index.d.ts.map +1 -0
  540. package/dist/mjs/request/index.js +3 -0
  541. package/dist/mjs/request/index.js.map +1 -0
  542. package/dist/mjs/request/is-retryable-error.d.ts +6 -0
  543. package/dist/mjs/request/is-retryable-error.d.ts.map +1 -0
  544. package/dist/mjs/request/is-retryable-error.js +24 -0
  545. package/dist/mjs/request/is-retryable-error.js.map +1 -0
  546. package/dist/mjs/request/request-executor.d.ts +12 -0
  547. package/dist/mjs/request/request-executor.d.ts.map +1 -0
  548. package/dist/mjs/request/request-executor.js +19 -0
  549. package/dist/mjs/request/request-executor.js.map +1 -0
  550. package/dist/mjs/request/request.d.ts +11 -0
  551. package/dist/mjs/request/request.d.ts.map +1 -0
  552. package/dist/mjs/request/request.js +80 -0
  553. package/dist/mjs/request/request.js.map +1 -0
  554. package/dist/mjs/request/transform-error.d.ts +7 -0
  555. package/dist/mjs/request/transform-error.d.ts.map +1 -0
  556. package/dist/mjs/request/transform-error.js +12 -0
  557. package/dist/mjs/request/transform-error.js.map +1 -0
  558. package/dist/mjs/types.d.ts +96 -0
  559. package/dist/mjs/types.d.ts.map +1 -0
  560. package/dist/mjs/types.js +13 -0
  561. package/dist/mjs/types.js.map +1 -0
  562. package/dist/mjs/utils/axios/convert-error.d.ts +4 -0
  563. package/dist/mjs/utils/axios/convert-error.d.ts.map +1 -0
  564. package/dist/mjs/utils/axios/convert-error.js +24 -0
  565. package/dist/mjs/utils/axios/convert-error.js.map +1 -0
  566. package/dist/mjs/utils/axios/convert-response.d.ts +4 -0
  567. package/dist/mjs/utils/axios/convert-response.d.ts.map +1 -0
  568. package/dist/mjs/utils/axios/convert-response.js +19 -0
  569. package/dist/mjs/utils/axios/convert-response.js.map +1 -0
  570. package/dist/mjs/utils/axios/create-instance.d.ts +11 -0
  571. package/dist/mjs/utils/axios/create-instance.d.ts.map +1 -0
  572. package/dist/mjs/utils/axios/create-instance.js +23 -0
  573. package/dist/mjs/utils/axios/create-instance.js.map +1 -0
  574. package/dist/mjs/utils/axios/extract-headers.d.ts +2 -0
  575. package/dist/mjs/utils/axios/extract-headers.d.ts.map +1 -0
  576. package/dist/mjs/utils/axios/extract-headers.js +19 -0
  577. package/dist/mjs/utils/axios/extract-headers.js.map +1 -0
  578. package/dist/mjs/utils/axios/index.d.ts +5 -0
  579. package/dist/mjs/utils/axios/index.d.ts.map +1 -0
  580. package/dist/mjs/utils/axios/index.js +5 -0
  581. package/dist/mjs/utils/axios/index.js.map +1 -0
  582. package/dist/mjs/utils/calculate-delay.d.ts +7 -0
  583. package/dist/mjs/utils/calculate-delay.d.ts.map +1 -0
  584. package/dist/mjs/utils/calculate-delay.js +26 -0
  585. package/dist/mjs/utils/calculate-delay.js.map +1 -0
  586. package/dist/mjs/utils/ensure-non-empty-string.d.ts +16 -0
  587. package/dist/mjs/utils/ensure-non-empty-string.d.ts.map +1 -0
  588. package/dist/mjs/utils/ensure-non-empty-string.js +12 -0
  589. package/dist/mjs/utils/ensure-non-empty-string.js.map +1 -0
  590. package/dist/mjs/utils/format.d.ts +11 -0
  591. package/dist/mjs/utils/format.d.ts.map +1 -0
  592. package/dist/mjs/utils/format.js +44 -0
  593. package/dist/mjs/utils/format.js.map +1 -0
  594. package/dist/mjs/utils/get-attribute-value.d.ts +17 -0
  595. package/dist/mjs/utils/get-attribute-value.d.ts.map +1 -0
  596. package/dist/mjs/utils/get-attribute-value.js +15 -0
  597. package/dist/mjs/utils/get-attribute-value.js.map +1 -0
  598. package/dist/mjs/utils/index.d.ts +9 -0
  599. package/dist/mjs/utils/index.d.ts.map +1 -0
  600. package/dist/mjs/utils/index.js +9 -0
  601. package/dist/mjs/utils/index.js.map +1 -0
  602. package/dist/mjs/utils/mask.d.ts +28 -0
  603. package/dist/mjs/utils/mask.d.ts.map +1 -0
  604. package/dist/mjs/utils/mask.js +54 -0
  605. package/dist/mjs/utils/mask.js.map +1 -0
  606. package/dist/mjs/utils/plain-clone.d.ts +14 -0
  607. package/dist/mjs/utils/plain-clone.d.ts.map +1 -0
  608. package/dist/mjs/utils/plain-clone.js +37 -0
  609. package/dist/mjs/utils/plain-clone.js.map +1 -0
  610. package/dist/mjs/utils/retry-on-conflict.d.ts +99 -0
  611. package/dist/mjs/utils/retry-on-conflict.d.ts.map +1 -0
  612. package/dist/mjs/utils/retry-on-conflict.js +105 -0
  613. package/dist/mjs/utils/retry-on-conflict.js.map +1 -0
  614. package/dist/mjs/utils/useragent.d.ts +10 -0
  615. package/dist/mjs/utils/useragent.d.ts.map +1 -0
  616. package/dist/mjs/utils/useragent.js +17 -0
  617. package/dist/mjs/utils/useragent.js.map +1 -0
  618. package/package.json +48 -46
  619. package/dist/ge-commercetools-utils-browser.cjs.js +0 -2
  620. package/dist/ge-commercetools-utils-browser.cjs.js.map +0 -1
  621. package/dist/ge-commercetools-utils-browser.esm.js +0 -2
  622. package/dist/ge-commercetools-utils-browser.esm.js.map +0 -1
  623. package/dist/ge-commercetools-utils-node.cjs.js +0 -3
  624. package/dist/ge-commercetools-utils-node.cjs.js.LICENSE.txt +0 -13
  625. package/dist/ge-commercetools-utils-node.cjs.js.map +0 -1
  626. package/dist/ge-commercetools-utils-node.esm.js +0 -2
  627. package/dist/ge-commercetools-utils-node.esm.js.LICENSE.txt +0 -13
  628. package/dist/typings/api/CommercetoolsApi.d.ts +0 -515
  629. package/dist/typings/api/index.d.ts +0 -2
  630. package/dist/typings/api/types.d.ts +0 -12
  631. package/dist/typings/auth/CommercetoolsAuth.d.ts +0 -22
  632. package/dist/typings/auth/CommercetoolsAuthApi.d.ts +0 -27
  633. package/dist/typings/auth/CommercetoolsGrant.d.ts +0 -13
  634. package/dist/typings/auth/constants.d.ts +0 -3
  635. package/dist/typings/auth/index.d.ts +0 -3
  636. package/dist/typings/auth/scopes.d.ts +0 -2
  637. package/dist/typings/auth/types.d.ts +0 -41
  638. package/dist/typings/constants.d.ts +0 -12
  639. package/dist/typings/error/CommercetoolsError.d.ts +0 -11
  640. package/dist/typings/error/index.d.ts +0 -1
  641. package/dist/typings/index.d.ts +0 -7
  642. package/dist/typings/models/associate-role.d.ts +0 -79
  643. package/dist/typings/models/attribute-group.d.ts +0 -68
  644. package/dist/typings/models/business-unit.d.ts +0 -272
  645. package/dist/typings/models/cart-discount.d.ts +0 -196
  646. package/dist/typings/models/cart.d.ts +0 -745
  647. package/dist/typings/models/category.d.ts +0 -166
  648. package/dist/typings/models/channel.d.ts +0 -103
  649. package/dist/typings/models/common.d.ts +0 -256
  650. package/dist/typings/models/custom-object.d.ts +0 -30
  651. package/dist/typings/models/customer-group.d.ts +0 -58
  652. package/dist/typings/models/customer.d.ts +0 -293
  653. package/dist/typings/models/discount-code.d.ts +0 -116
  654. package/dist/typings/models/error.d.ts +0 -874
  655. package/dist/typings/models/extension.d.ts +0 -83
  656. package/dist/typings/models/graph-ql.d.ts +0 -23
  657. package/dist/typings/models/index.d.ts +0 -41
  658. package/dist/typings/models/inventory.d.ts +0 -88
  659. package/dist/typings/models/me.d.ts +0 -640
  660. package/dist/typings/models/message.d.ts +0 -3210
  661. package/dist/typings/models/order-edit.d.ts +0 -572
  662. package/dist/typings/models/payment.d.ts +0 -191
  663. package/dist/typings/models/product-discount.d.ts +0 -123
  664. package/dist/typings/models/product-selection.d.ts +0 -158
  665. package/dist/typings/models/product-type.d.ts +0 -213
  666. package/dist/typings/models/product.d.ts +0 -535
  667. package/dist/typings/models/project.d.ts +0 -120
  668. package/dist/typings/models/quote-request.d.ts +0 -94
  669. package/dist/typings/models/quote.d.ts +0 -103
  670. package/dist/typings/models/review.d.ts +0 -115
  671. package/dist/typings/models/scalar-types.d.ts +0 -3
  672. package/dist/typings/models/shipping-method.d.ts +0 -160
  673. package/dist/typings/models/shopping-list.d.ts +0 -217
  674. package/dist/typings/models/staged-quote.d.ts +0 -84
  675. package/dist/typings/models/standalone-price.d.ts +0 -95
  676. package/dist/typings/models/state.d.ts +0 -86
  677. package/dist/typings/models/store-country.d.ts +0 -3
  678. package/dist/typings/models/store.d.ts +0 -137
  679. package/dist/typings/models/subscription.d.ts +0 -161
  680. package/dist/typings/models/tax-category.d.ts +0 -91
  681. package/dist/typings/models/type.d.ts +0 -177
  682. package/dist/typings/models/zone.d.ts +0 -65
  683. package/dist/typings/request/index.d.ts +0 -2
  684. package/dist/typings/request/is-retryable-error.d.ts +0 -1
  685. package/dist/typings/request/transform-error.d.ts +0 -2
  686. package/dist/typings/utils/axios/index.d.ts +0 -4
  687. package/dist/typings/utils/calculate-delay.d.ts +0 -2
  688. package/dist/typings/utils/ensure-non-empty-string.d.ts +0 -5
  689. package/dist/typings/utils/format.d.ts +0 -1
  690. package/dist/typings/utils/get-attribute-value.d.ts +0 -6
  691. package/dist/typings/utils/index.d.ts +0 -8
  692. package/dist/typings/utils/mask.d.ts +0 -6
  693. package/dist/typings/utils/plain-clone.d.ts +0 -1
  694. package/dist/typings/utils/retry-on-conflict.d.ts +0 -7
  695. package/dist/typings/utils/useragent.d.ts +0 -1
@@ -1,222 +1,848 @@
1
- import { BusinessUnitKeyReference, BusinessUnitResourceIdentifier } from './business-unit';
2
- import { CartOrigin, CartReference, CartResourceIdentifier, CustomLineItem, CustomLineItemImportDraft, DiscountCodeInfo, DiscountedLineItemPortion, InventoryMode, ItemShippingDetailsDraft, LineItem, RoundingMode, Shipping, ShippingInfo, ShippingMethodState, ShippingMode, ShippingRateInput, TaxCalculationMode, TaxedPrice, TaxedPriceDraft, TaxMode } from './cart';
3
- import { CartDiscountReference } from './cart-discount';
4
- import { ChannelReference, ChannelResourceIdentifier } from './channel';
5
- import { Address, AddressDraft, BaseAddress, BaseResource, CreatedBy, Image, LastModifiedBy, LocalizedString, PriceDraft, TypedMoney, _BaseAddress, _Money } from './common';
6
- import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group';
7
- import { StagedOrder, StagedOrderAddCustomLineItemAction, StagedOrderAddDeliveryAction, StagedOrderAddDiscountCodeAction, StagedOrderAddItemShippingAddressAction, StagedOrderAddLineItemAction, StagedOrderAddParcelToDeliveryAction, StagedOrderAddPaymentAction, StagedOrderAddReturnInfoAction, StagedOrderAddShoppingListAction, StagedOrderChangeCustomLineItemMoneyAction, StagedOrderChangeCustomLineItemQuantityAction, StagedOrderChangeLineItemQuantityAction, StagedOrderChangeOrderStateAction, StagedOrderChangePaymentStateAction, StagedOrderChangeShipmentStateAction, StagedOrderChangeTaxCalculationModeAction, StagedOrderChangeTaxModeAction, StagedOrderChangeTaxRoundingModeAction, StagedOrderImportCustomLineItemStateAction, StagedOrderImportLineItemStateAction, StagedOrderRemoveCustomLineItemAction, StagedOrderRemoveDeliveryAction, StagedOrderRemoveDiscountCodeAction, StagedOrderRemoveItemShippingAddressAction, StagedOrderRemoveLineItemAction, StagedOrderRemoveParcelFromDeliveryAction, StagedOrderRemovePaymentAction, StagedOrderSetBillingAddressAction, StagedOrderSetBillingAddressCustomFieldAction, StagedOrderSetBillingAddressCustomTypeAction, StagedOrderSetCountryAction, StagedOrderSetCustomerEmailAction, StagedOrderSetCustomerGroupAction, StagedOrderSetCustomerIdAction, StagedOrderSetCustomFieldAction, StagedOrderSetCustomLineItemCustomFieldAction, StagedOrderSetCustomLineItemCustomTypeAction, StagedOrderSetCustomLineItemShippingDetailsAction, StagedOrderSetCustomLineItemTaxAmountAction, StagedOrderSetCustomLineItemTaxRateAction, StagedOrderSetCustomShippingMethodAction, StagedOrderSetCustomTypeAction, StagedOrderSetDeliveryAddressAction, StagedOrderSetDeliveryAddressCustomFieldAction, StagedOrderSetDeliveryAddressCustomTypeAction, StagedOrderSetDeliveryCustomFieldAction, StagedOrderSetDeliveryCustomTypeAction, StagedOrderSetDeliveryItemsAction, StagedOrderSetItemShippingAddressCustomFieldAction, StagedOrderSetItemShippingAddressCustomTypeAction, StagedOrderSetLineItemCustomFieldAction, StagedOrderSetLineItemCustomTypeAction, StagedOrderSetLineItemDistributionChannelAction, StagedOrderSetLineItemPriceAction, StagedOrderSetLineItemShippingDetailsAction, StagedOrderSetLineItemTaxAmountAction, StagedOrderSetLineItemTaxRateAction, StagedOrderSetLineItemTotalPriceAction, StagedOrderSetLocaleAction, StagedOrderSetOrderNumberAction, StagedOrderSetOrderTotalTaxAction, StagedOrderSetParcelCustomFieldAction, StagedOrderSetParcelCustomTypeAction, StagedOrderSetParcelItemsAction, StagedOrderSetParcelMeasurementsAction, StagedOrderSetParcelTrackingDataAction, StagedOrderSetPurchaseOrderNumberAction, StagedOrderSetReturnInfoAction, StagedOrderSetReturnItemCustomFieldAction, StagedOrderSetReturnItemCustomTypeAction, StagedOrderSetReturnPaymentStateAction, StagedOrderSetReturnShipmentStateAction, StagedOrderSetShippingAddressAction, StagedOrderSetShippingAddressAndCustomShippingMethodAction, StagedOrderSetShippingAddressAndShippingMethodAction, StagedOrderSetShippingAddressCustomFieldAction, StagedOrderSetShippingAddressCustomTypeAction, StagedOrderSetShippingMethodAction, StagedOrderSetShippingMethodTaxAmountAction, StagedOrderSetShippingMethodTaxRateAction, StagedOrderSetShippingRateInputAction, StagedOrderTransitionCustomLineItemStateAction, StagedOrderTransitionLineItemStateAction, StagedOrderTransitionStateAction, StagedOrderUpdateItemShippingAddressAction, StagedOrderUpdateSyncInfoAction } from './order-edit';
8
- import { PaymentReference, PaymentResourceIdentifier } from './payment';
9
- import { Attribute } from './product';
10
- import { QuoteReference, QuoteResourceIdentifier } from './quote';
11
- import { ShippingMethodResourceIdentifier, ShippingRateDraft } from './shipping-method';
12
- import { StateReference, StateResourceIdentifier } from './state';
13
- import { StoreKeyReference, StoreResourceIdentifier } from './store';
14
- import { TaxCategoryResourceIdentifier, TaxRate } from './tax-category';
15
- import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
1
+ /**
2
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
3
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
+ */
6
+ import { BusinessUnitKeyReference, BusinessUnitResourceIdentifier } from './business-unit.js';
7
+ import { CartOrigin, CartReference, CartResourceIdentifier, CustomLineItem, CustomLineItemImportDraft, DiscountCodeInfo, DiscountedLineItemPortion, InventoryMode, ItemShippingDetailsDraft, LineItem, RoundingMode, Shipping, ShippingInfo, ShippingMethodState, ShippingMode, ShippingRateInput, TaxCalculationMode, TaxedPrice, TaxedPriceDraft, TaxMode } from './cart.js';
8
+ import { CartDiscountReference } from './cart-discount.js';
9
+ import { ChannelReference, ChannelResourceIdentifier } from './channel.js';
10
+ import { Address, AddressDraft, BaseAddress, BaseResource, CreatedBy, Image, LastModifiedBy, LocalizedString, PriceDraft, TypedMoney, _BaseAddress, _Money } from './common.js';
11
+ import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group.js';
12
+ import { StagedOrder, StagedOrderAddCustomLineItemAction, StagedOrderAddDeliveryAction, StagedOrderAddDiscountCodeAction, StagedOrderAddItemShippingAddressAction, StagedOrderAddLineItemAction, StagedOrderAddParcelToDeliveryAction, StagedOrderAddPaymentAction, StagedOrderAddReturnInfoAction, StagedOrderAddShoppingListAction, StagedOrderChangeCustomLineItemMoneyAction, StagedOrderChangeCustomLineItemQuantityAction, StagedOrderChangeLineItemQuantityAction, StagedOrderChangeOrderStateAction, StagedOrderChangePaymentStateAction, StagedOrderChangeShipmentStateAction, StagedOrderChangeTaxCalculationModeAction, StagedOrderChangeTaxModeAction, StagedOrderChangeTaxRoundingModeAction, StagedOrderImportCustomLineItemStateAction, StagedOrderImportLineItemStateAction, StagedOrderRemoveCustomLineItemAction, StagedOrderRemoveDeliveryAction, StagedOrderRemoveDiscountCodeAction, StagedOrderRemoveItemShippingAddressAction, StagedOrderRemoveLineItemAction, StagedOrderRemoveParcelFromDeliveryAction, StagedOrderRemovePaymentAction, StagedOrderSetBillingAddressAction, StagedOrderSetBillingAddressCustomFieldAction, StagedOrderSetBillingAddressCustomTypeAction, StagedOrderSetCountryAction, StagedOrderSetCustomerEmailAction, StagedOrderSetCustomerGroupAction, StagedOrderSetCustomerIdAction, StagedOrderSetCustomFieldAction, StagedOrderSetCustomLineItemCustomFieldAction, StagedOrderSetCustomLineItemCustomTypeAction, StagedOrderSetCustomLineItemShippingDetailsAction, StagedOrderSetCustomLineItemTaxAmountAction, StagedOrderSetCustomLineItemTaxRateAction, StagedOrderSetCustomShippingMethodAction, StagedOrderSetCustomTypeAction, StagedOrderSetDeliveryAddressAction, StagedOrderSetDeliveryAddressCustomFieldAction, StagedOrderSetDeliveryAddressCustomTypeAction, StagedOrderSetDeliveryCustomFieldAction, StagedOrderSetDeliveryCustomTypeAction, StagedOrderSetDeliveryItemsAction, StagedOrderSetItemShippingAddressCustomFieldAction, StagedOrderSetItemShippingAddressCustomTypeAction, StagedOrderSetLineItemCustomFieldAction, StagedOrderSetLineItemCustomTypeAction, StagedOrderSetLineItemDistributionChannelAction, StagedOrderSetLineItemPriceAction, StagedOrderSetLineItemShippingDetailsAction, StagedOrderSetLineItemTaxAmountAction, StagedOrderSetLineItemTaxRateAction, StagedOrderSetLineItemTotalPriceAction, StagedOrderSetLocaleAction, StagedOrderSetOrderNumberAction, StagedOrderSetOrderTotalTaxAction, StagedOrderSetParcelCustomFieldAction, StagedOrderSetParcelCustomTypeAction, StagedOrderSetParcelItemsAction, StagedOrderSetParcelMeasurementsAction, StagedOrderSetParcelTrackingDataAction, StagedOrderSetPurchaseOrderNumberAction, StagedOrderSetReturnInfoAction, StagedOrderSetReturnItemCustomFieldAction, StagedOrderSetReturnItemCustomTypeAction, StagedOrderSetReturnPaymentStateAction, StagedOrderSetReturnShipmentStateAction, StagedOrderSetShippingAddressAction, StagedOrderSetShippingAddressAndCustomShippingMethodAction, StagedOrderSetShippingAddressAndShippingMethodAction, StagedOrderSetShippingAddressCustomFieldAction, StagedOrderSetShippingAddressCustomTypeAction, StagedOrderSetShippingMethodAction, StagedOrderSetShippingMethodTaxAmountAction, StagedOrderSetShippingMethodTaxRateAction, StagedOrderSetShippingRateInputAction, StagedOrderTransitionCustomLineItemStateAction, StagedOrderTransitionLineItemStateAction, StagedOrderTransitionStateAction, StagedOrderUpdateItemShippingAddressAction, StagedOrderUpdateSyncInfoAction } from './order-edit.js';
13
+ import { PaymentReference, PaymentResourceIdentifier } from './payment.js';
14
+ import { Attribute } from './product.js';
15
+ import { QuoteReference, QuoteResourceIdentifier } from './quote.js';
16
+ import { ShippingMethodResourceIdentifier, ShippingRateDraft } from './shipping-method.js';
17
+ import { StateReference, StateResourceIdentifier } from './state.js';
18
+ import { StoreKeyReference, StoreResourceIdentifier } from './store.js';
19
+ import { TaxCategoryResourceIdentifier, TaxRate } from './tax-category.js';
20
+ import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
16
21
  export type StagedOrderUpdateAction = StagedOrderAddCustomLineItemAction | StagedOrderAddDeliveryAction | StagedOrderAddDiscountCodeAction | StagedOrderAddItemShippingAddressAction | StagedOrderAddLineItemAction | StagedOrderAddParcelToDeliveryAction | StagedOrderAddPaymentAction | StagedOrderAddReturnInfoAction | StagedOrderAddShoppingListAction | StagedOrderChangeCustomLineItemMoneyAction | StagedOrderChangeCustomLineItemQuantityAction | StagedOrderChangeLineItemQuantityAction | StagedOrderChangeOrderStateAction | StagedOrderChangePaymentStateAction | StagedOrderChangeShipmentStateAction | StagedOrderChangeTaxCalculationModeAction | StagedOrderChangeTaxModeAction | StagedOrderChangeTaxRoundingModeAction | StagedOrderImportCustomLineItemStateAction | StagedOrderImportLineItemStateAction | StagedOrderRemoveCustomLineItemAction | StagedOrderRemoveDeliveryAction | StagedOrderRemoveDiscountCodeAction | StagedOrderRemoveItemShippingAddressAction | StagedOrderRemoveLineItemAction | StagedOrderRemoveParcelFromDeliveryAction | StagedOrderRemovePaymentAction | StagedOrderSetBillingAddressAction | StagedOrderSetBillingAddressCustomFieldAction | StagedOrderSetBillingAddressCustomTypeAction | StagedOrderSetCountryAction | StagedOrderSetCustomFieldAction | StagedOrderSetCustomLineItemCustomFieldAction | StagedOrderSetCustomLineItemCustomTypeAction | StagedOrderSetCustomLineItemShippingDetailsAction | StagedOrderSetCustomLineItemTaxAmountAction | StagedOrderSetCustomLineItemTaxRateAction | StagedOrderSetCustomShippingMethodAction | StagedOrderSetCustomTypeAction | StagedOrderSetCustomerEmailAction | StagedOrderSetCustomerGroupAction | StagedOrderSetCustomerIdAction | StagedOrderSetDeliveryAddressAction | StagedOrderSetDeliveryAddressCustomFieldAction | StagedOrderSetDeliveryAddressCustomTypeAction | StagedOrderSetDeliveryCustomFieldAction | StagedOrderSetDeliveryCustomTypeAction | StagedOrderSetDeliveryItemsAction | StagedOrderSetItemShippingAddressCustomFieldAction | StagedOrderSetItemShippingAddressCustomTypeAction | StagedOrderSetLineItemCustomFieldAction | StagedOrderSetLineItemCustomTypeAction | StagedOrderSetLineItemDistributionChannelAction | StagedOrderSetLineItemPriceAction | StagedOrderSetLineItemShippingDetailsAction | StagedOrderSetLineItemTaxAmountAction | StagedOrderSetLineItemTaxRateAction | StagedOrderSetLineItemTotalPriceAction | StagedOrderSetLocaleAction | StagedOrderSetOrderNumberAction | StagedOrderSetOrderTotalTaxAction | StagedOrderSetParcelCustomFieldAction | StagedOrderSetParcelCustomTypeAction | StagedOrderSetParcelItemsAction | StagedOrderSetParcelMeasurementsAction | StagedOrderSetParcelTrackingDataAction | StagedOrderSetPurchaseOrderNumberAction | StagedOrderSetReturnInfoAction | StagedOrderSetReturnItemCustomFieldAction | StagedOrderSetReturnItemCustomTypeAction | StagedOrderSetReturnPaymentStateAction | StagedOrderSetReturnShipmentStateAction | StagedOrderSetShippingAddressAction | StagedOrderSetShippingAddressAndCustomShippingMethodAction | StagedOrderSetShippingAddressAndShippingMethodAction | StagedOrderSetShippingAddressCustomFieldAction | StagedOrderSetShippingAddressCustomTypeAction | StagedOrderSetShippingMethodAction | StagedOrderSetShippingMethodTaxAmountAction | StagedOrderSetShippingMethodTaxRateAction | StagedOrderSetShippingRateInputAction | StagedOrderTransitionCustomLineItemStateAction | StagedOrderTransitionLineItemStateAction | StagedOrderTransitionStateAction | StagedOrderUpdateItemShippingAddressAction | StagedOrderUpdateSyncInfoAction;
17
22
  export interface Hit {
23
+ /**
24
+ * Unique identifier of the Order.
25
+ *
26
+ */
18
27
  readonly id: string;
28
+ /**
29
+ * Current version of the Order.
30
+ *
31
+ */
19
32
  readonly version: number;
33
+ /**
34
+ * The higher the value is, the more relevant the hit is for the search request.
35
+ *
36
+ */
20
37
  readonly relevance?: number;
21
38
  }
22
39
  export interface OrderPagedSearchResponse {
40
+ /**
41
+ * Total number of results matching the query.
42
+ *
43
+ */
23
44
  readonly total: number;
45
+ /**
46
+ * Number of [elements skipped](/../api/general-concepts#offset).
47
+ *
48
+ *
49
+ */
24
50
  readonly offset?: number;
51
+ /**
52
+ * Number of [results requested](/../api/general-concepts#limit).
53
+ *
54
+ *
55
+ */
25
56
  readonly limit?: number;
57
+ /**
58
+ * Actual results.
59
+ *
60
+ */
26
61
  readonly hits: Hit[];
27
62
  }
28
63
  export type OrderSearchMatchType = 'all' | 'any' | string;
29
64
  export interface OrderSearchQueryExpressionValue {
65
+ /**
66
+ *
67
+ */
30
68
  readonly field: string;
69
+ /**
70
+ *
71
+ */
31
72
  readonly boost?: number;
73
+ /**
74
+ *
75
+ */
32
76
  readonly customType?: string;
33
77
  }
34
78
  export type _OrderSearchQueryExpressionValue = OrderSearchQueryExpressionValue | OrderSearchAnyValue | OrderSearchDateRangeValue | OrderSearchFullTextValue | OrderSearchLongRangeValue | OrderSearchNumberRangeValue | OrderSearchStringValue;
35
79
  export interface OrderSearchAnyValue extends OrderSearchQueryExpressionValue {
80
+ /**
81
+ *
82
+ */
36
83
  readonly value: any;
84
+ /**
85
+ *
86
+ */
37
87
  readonly language?: string;
88
+ /**
89
+ *
90
+ */
38
91
  readonly caseInsensitive?: boolean;
39
92
  }
40
93
  export interface OrderSearchDateRangeValue extends OrderSearchQueryExpressionValue {
94
+ /**
95
+ *
96
+ */
41
97
  readonly gte?: string;
98
+ /**
99
+ *
100
+ */
42
101
  readonly lte?: string;
43
102
  }
44
103
  export interface OrderSearchFullTextValue extends OrderSearchQueryExpressionValue {
104
+ /**
105
+ *
106
+ */
45
107
  readonly value: string;
108
+ /**
109
+ *
110
+ */
46
111
  readonly language?: string;
112
+ /**
113
+ *
114
+ */
47
115
  readonly mustMatch?: OrderSearchMatchType;
48
116
  }
49
117
  export interface OrderSearchLongRangeValue extends OrderSearchQueryExpressionValue {
118
+ /**
119
+ *
120
+ */
50
121
  readonly gte?: number;
122
+ /**
123
+ *
124
+ */
51
125
  readonly lte?: number;
52
126
  }
53
127
  export interface OrderSearchNumberRangeValue extends OrderSearchQueryExpressionValue {
128
+ /**
129
+ *
130
+ */
54
131
  readonly gte?: number;
132
+ /**
133
+ *
134
+ */
55
135
  readonly lte?: number;
56
136
  }
57
137
  export type OrderSearchSortMode = 'avg' | 'max' | 'min' | 'sum' | string;
58
138
  export type OrderSearchSortOrder = 'asc' | 'desc' | string;
59
139
  export interface OrderSearchStringValue extends OrderSearchQueryExpressionValue {
140
+ /**
141
+ *
142
+ */
60
143
  readonly value: string;
144
+ /**
145
+ *
146
+ */
61
147
  readonly language?: string;
148
+ /**
149
+ *
150
+ */
62
151
  readonly caseInsensitive?: boolean;
63
152
  }
64
153
  export interface Delivery {
154
+ /**
155
+ * Unique identifier of the Delivery.
156
+ *
157
+ */
65
158
  readonly id: string;
159
+ /**
160
+ *
161
+ */
66
162
  readonly createdAt: string;
163
+ /**
164
+ * Items which are shipped in this delivery regardless their distribution over several parcels.
165
+ * Can also be specified individually for each Parcel.
166
+ *
167
+ */
67
168
  readonly items: DeliveryItem[];
169
+ /**
170
+ *
171
+ */
68
172
  readonly parcels: Parcel[];
173
+ /**
174
+ *
175
+ */
69
176
  readonly address?: Address;
177
+ /**
178
+ * Custom Fields for the Transaction.
179
+ *
180
+ */
70
181
  readonly custom?: CustomFields;
71
182
  }
72
183
  export interface DeliveryDraft {
184
+ /**
185
+ * Items which are shipped in this delivery regardless their distribution over several parcels.
186
+ * Can also be specified individually for each Parcel.
187
+ *
188
+ */
73
189
  readonly items?: DeliveryItem[];
190
+ /**
191
+ *
192
+ */
74
193
  readonly parcels?: ParcelDraft[];
194
+ /**
195
+ *
196
+ */
75
197
  readonly address?: AddressDraft;
198
+ /**
199
+ * Custom Fields for the Transaction.
200
+ *
201
+ */
76
202
  readonly custom?: CustomFieldsDraft;
77
203
  }
78
204
  export interface DeliveryItem {
205
+ /**
206
+ * Unique identifier of the DeliveryItem.
207
+ *
208
+ */
79
209
  readonly id: string;
210
+ /**
211
+ *
212
+ */
80
213
  readonly quantity: number;
81
214
  }
82
215
  export interface DiscountedLineItemPriceDraft {
216
+ /**
217
+ * Draft type that stores amounts only in cent precision for the specified currency.
218
+ *
219
+ *
220
+ */
83
221
  readonly value: _Money;
222
+ /**
223
+ *
224
+ */
84
225
  readonly includedDiscounts: DiscountedLineItemPortion[];
85
226
  }
86
227
  export interface ItemState {
228
+ /**
229
+ *
230
+ */
87
231
  readonly quantity: number;
232
+ /**
233
+ *
234
+ */
88
235
  readonly state: StateReference;
89
236
  }
90
237
  export interface LineItemImportDraft {
238
+ /**
239
+ * ID of the existing product.
240
+ * You also need to specify the ID of the variant if this property is set or alternatively you can just specify SKU of the product variant.
241
+ *
242
+ */
91
243
  readonly productId?: string;
244
+ /**
245
+ * The product name.
246
+ *
247
+ */
92
248
  readonly name: LocalizedString;
249
+ /**
250
+ *
251
+ */
93
252
  readonly variant: ProductVariantImportDraft;
253
+ /**
254
+ *
255
+ */
94
256
  readonly price: PriceDraft;
257
+ /**
258
+ *
259
+ */
95
260
  readonly quantity: number;
261
+ /**
262
+ *
263
+ */
96
264
  readonly state?: ItemState[];
265
+ /**
266
+ * Connection to a particular supplier.
267
+ * By providing supply channel information, you can uniquely identify
268
+ * inventory entries that should be reserved.
269
+ * The provided channel should have the
270
+ * InventorySupply role.
271
+ *
272
+ */
97
273
  readonly supplyChannel?: ChannelResourceIdentifier;
274
+ /**
275
+ * The channel is used to select a ProductPrice.
276
+ * The provided channel should have the ProductDistribution role.
277
+ *
278
+ */
98
279
  readonly distributionChannel?: ChannelResourceIdentifier;
280
+ /**
281
+ *
282
+ */
99
283
  readonly taxRate?: TaxRate;
284
+ /**
285
+ * The custom fields.
286
+ *
287
+ */
100
288
  readonly custom?: CustomFieldsDraft;
289
+ /**
290
+ * Inventory mode specific to the line item only, valid for the entire `quantity` of the line item.
291
+ * Set only if inventory mode should be different from the `inventoryMode` specified on the [OrderImportDraft](ctp:api:type:OrderImportDraft).
292
+ *
293
+ */
101
294
  readonly inventoryMode?: InventoryMode;
295
+ /**
296
+ *
297
+ */
102
298
  readonly shippingDetails?: ItemShippingDetailsDraft;
103
299
  }
104
300
  export interface Order extends BaseResource {
301
+ /**
302
+ * Unique identifier of the Order.
303
+ *
304
+ */
105
305
  readonly id: string;
306
+ /**
307
+ * The current version of the order.
308
+ *
309
+ */
106
310
  readonly version: number;
311
+ /**
312
+ *
313
+ */
107
314
  readonly createdAt: string;
315
+ /**
316
+ *
317
+ */
108
318
  readonly lastModifiedAt: string;
319
+ /**
320
+ * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
321
+ *
322
+ *
323
+ */
109
324
  readonly lastModifiedBy?: LastModifiedBy;
325
+ /**
326
+ * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
327
+ *
328
+ *
329
+ */
110
330
  readonly createdBy?: CreatedBy;
331
+ /**
332
+ * This field will only be present if it was set for Order Import
333
+ *
334
+ */
111
335
  readonly completedAt?: string;
336
+ /**
337
+ * String that uniquely identifies an order.
338
+ * It can be used to create more human-readable (in contrast to ID) identifier for the order.
339
+ * It should be unique across a project.
340
+ * Once it's set it cannot be changed.
341
+ *
342
+ */
112
343
  readonly orderNumber?: string;
344
+ /**
345
+ *
346
+ */
113
347
  readonly customerId?: string;
348
+ /**
349
+ *
350
+ */
114
351
  readonly customerEmail?: string;
352
+ /**
353
+ * Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).
354
+ *
355
+ */
115
356
  readonly anonymousId?: string;
357
+ /**
358
+ * The Business Unit the Order belongs to.
359
+ *
360
+ *
361
+ */
116
362
  readonly businessUnit?: BusinessUnitKeyReference;
363
+ /**
364
+ *
365
+ */
117
366
  readonly store?: StoreKeyReference;
367
+ /**
368
+ *
369
+ */
118
370
  readonly lineItems: LineItem[];
371
+ /**
372
+ *
373
+ */
119
374
  readonly customLineItems: CustomLineItem[];
375
+ /**
376
+ *
377
+ */
120
378
  readonly totalPrice: TypedMoney;
379
+ /**
380
+ * The taxes are calculated based on the shipping address.
381
+ *
382
+ */
121
383
  readonly taxedPrice?: TaxedPrice;
384
+ /**
385
+ * Sum of `taxedPrice` of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
386
+ * For `Platform` [TaxMode](ctp:api:type:TaxMode), it is set automatically only if [shipping address is set](ctp:api:type:CartSetShippingAddressAction) or [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction) to the Cart.
387
+ *
388
+ */
122
389
  readonly taxedShippingPrice?: TaxedPrice;
390
+ /**
391
+ * Holds all shipping-related information per Shipping Method.
392
+ *
393
+ * For `Multi` [ShippingMode](ctp:api:typeShippingMode), it is updated automatically after the Shipping Methods are added.
394
+ *
395
+ *
396
+ */
123
397
  readonly shippingAddress?: Address;
398
+ /**
399
+ *
400
+ */
124
401
  readonly billingAddress?: Address;
402
+ /**
403
+ * Indicates whether one or multiple Shipping Methods are added to the Cart.
404
+ *
405
+ *
406
+ */
125
407
  readonly shippingMode: ShippingMode;
408
+ /**
409
+ * User-defined unique identifier of the Shipping Method with `Single` [ShippingMode](ctp:api:type:ShippingMode).
410
+ *
411
+ *
412
+ */
126
413
  readonly shippingKey?: string;
414
+ /**
415
+ * Custom Fields of the Shipping Method for `Single` [ShippingMode](ctp:api:type:ShippingMode).
416
+ *
417
+ *
418
+ */
127
419
  readonly shippingCustomFields?: CustomFields;
420
+ /**
421
+ * Holds all shipping-related information per Shipping Method for `Multi` [ShippingMode](ctp:api:typeShippingMode).
422
+ *
423
+ * It is updated automatically after the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
424
+ *
425
+ *
426
+ */
128
427
  readonly shipping: Shipping[];
428
+ /**
429
+ *
430
+ */
129
431
  readonly taxMode?: TaxMode;
432
+ /**
433
+ * When calculating taxes for `taxedPrice`, the selected mode is used for rouding.
434
+ *
435
+ */
130
436
  readonly taxRoundingMode?: RoundingMode;
437
+ /**
438
+ * Set when the customer is set and the customer is a member of a customer group.
439
+ * Used for product variant price selection.
440
+ *
441
+ */
131
442
  readonly customerGroup?: CustomerGroupReference;
443
+ /**
444
+ * A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
445
+ * Used for product variant price selection.
446
+ *
447
+ */
132
448
  readonly country?: string;
449
+ /**
450
+ * One of the four predefined OrderStates.
451
+ *
452
+ */
133
453
  readonly orderState: OrderState;
454
+ /**
455
+ * This reference can point to a state in a custom workflow.
456
+ *
457
+ */
134
458
  readonly state?: StateReference;
459
+ /**
460
+ *
461
+ */
135
462
  readonly shipmentState?: ShipmentState;
463
+ /**
464
+ *
465
+ */
136
466
  readonly paymentState?: PaymentState;
467
+ /**
468
+ * Set if the ShippingMethod is set.
469
+ *
470
+ */
137
471
  readonly shippingInfo?: ShippingInfo;
472
+ /**
473
+ *
474
+ */
138
475
  readonly syncInfo: SyncInfo[];
476
+ /**
477
+ *
478
+ */
139
479
  readonly returnInfo?: ReturnInfo[];
480
+ /**
481
+ * The Purchase Order Number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
482
+ * track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
483
+ *
484
+ */
140
485
  readonly purchaseOrderNumber?: string;
486
+ /**
487
+ *
488
+ */
141
489
  readonly discountCodes?: DiscountCodeInfo[];
490
+ /**
491
+ * Internal-only field.
492
+ * @deprecated
493
+ */
142
494
  readonly lastMessageSequenceNumber?: number;
495
+ /**
496
+ * Set when this order was created from a cart.
497
+ * The cart will have the state `Ordered`.
498
+ *
499
+ */
143
500
  readonly cart?: CartReference;
501
+ /**
502
+ * Set when this order was created from a quote.
503
+ *
504
+ */
144
505
  readonly quote?: QuoteReference;
506
+ /**
507
+ *
508
+ */
145
509
  readonly custom?: CustomFields;
510
+ /**
511
+ *
512
+ */
146
513
  readonly paymentInfo?: PaymentInfo;
514
+ /**
515
+ *
516
+ */
147
517
  readonly locale?: string;
518
+ /**
519
+ *
520
+ */
148
521
  readonly inventoryMode?: InventoryMode;
522
+ /**
523
+ *
524
+ */
149
525
  readonly origin: CartOrigin;
526
+ /**
527
+ * When calculating taxes for `taxedPrice`, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.
528
+ *
529
+ */
150
530
  readonly taxCalculationMode?: TaxCalculationMode;
531
+ /**
532
+ * Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
533
+ * The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
534
+ *
535
+ * - If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
536
+ * - If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
537
+ * - If `CartValue`, it cannot be used.
538
+ *
539
+ *
540
+ */
151
541
  readonly shippingRateInput?: ShippingRateInput;
542
+ /**
543
+ * Contains addresses for orders with multiple shipping addresses.
544
+ *
545
+ */
152
546
  readonly itemShippingAddresses?: Address[];
547
+ /**
548
+ * Automatically filled when a line item with LineItemMode `GiftLineItem` is removed from this order.
549
+ *
550
+ */
153
551
  readonly refusedGifts: CartDiscountReference[];
154
552
  }
155
553
  export type _Order = Order | StagedOrder;
156
554
  export interface OrderFromCartDraft {
555
+ /**
556
+ * Unique identifier of the Cart from which you can create an Order.
557
+ * @deprecated
558
+ */
157
559
  readonly id?: string;
560
+ /**
561
+ * ResourceIdentifier of the Cart from which the Order is created.
562
+ *
563
+ */
158
564
  readonly cart?: CartResourceIdentifier;
565
+ /**
566
+ * Expected version of the Cart from which the Order is created.
567
+ * If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned.
568
+ *
569
+ *
570
+ */
159
571
  readonly version: number;
572
+ /**
573
+ * String that uniquely identifies an order.
574
+ * It can be used to create more human-readable (in contrast to ID) identifier for the order.
575
+ * It should be unique across a project.
576
+ * Once it's set it cannot be changed.
577
+ * For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression `[a-z0-9_\-]{2,36}`.
578
+ *
579
+ */
160
580
  readonly orderNumber?: string;
581
+ /**
582
+ * Identifier for a purchase order, usually in a B2B context.
583
+ * The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer) and can also be used with [Quotes](/quotes-overview).
584
+ *
585
+ */
161
586
  readonly purchaseOrderNumber?: string;
587
+ /**
588
+ * Payment state for the Order.
589
+ *
590
+ *
591
+ */
162
592
  readonly paymentState?: PaymentState;
593
+ /**
594
+ * Shipment state for the Order.
595
+ *
596
+ *
597
+ */
163
598
  readonly shipmentState?: ShipmentState;
599
+ /**
600
+ * Order will be created with `Open` status by default.
601
+ *
602
+ */
164
603
  readonly orderState?: OrderState;
604
+ /**
605
+ * [Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State) indicating the Order's state.
606
+ *
607
+ *
608
+ */
165
609
  readonly state?: StateResourceIdentifier;
610
+ /**
611
+ * [Custom Fields](/../api/projects/custom-fields) for the Order. The Custom Field type must match the type of the Custom Fields in the referenced [Cart](/../api/projects/carts#cart).
612
+ * If specified, the Custom Fields are merged with the Custom Fields on the referenced [Cart](/../api/projects/carts#cart) and added to the Order.
613
+ * If empty, the Custom Fields on the referenced [Cart](/../api/projects/carts#cart) are added to the Order automatically.
614
+ *
615
+ *
616
+ */
166
617
  readonly custom?: CustomFieldsDraft;
167
618
  }
168
619
  export interface OrderFromQuoteDraft {
620
+ /**
621
+ * ResourceIdentifier of the Quote from which this Order is created. If the Quote has `QuoteState` in `Accepted`, `Declined` or `Withdrawn` then the order creation will fail. The creation will also fail if the `Quote` has expired (`validTo` check).
622
+ *
623
+ */
169
624
  readonly quote: QuoteResourceIdentifier;
625
+ /**
626
+ * `version` of the [Quote](ctp:api:type:Quote) from which an Order is created.
627
+ *
628
+ *
629
+ */
170
630
  readonly version: number;
631
+ /**
632
+ * If `true`, the `quoteState` of the referenced [Quote](ctp:api:type:Quote) will be set to `Accepted`.
633
+ *
634
+ *
635
+ */
171
636
  readonly quoteStateToAccepted?: boolean;
637
+ /**
638
+ * String that uniquely identifies an order.
639
+ * It can be used to create more human-readable (in contrast to ID) identifier for the order.
640
+ * It should be unique across a project.
641
+ * Once it's set it cannot be changed.
642
+ * For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression `[a-z0-9_\-]{2,36}`.
643
+ *
644
+ */
172
645
  readonly orderNumber?: string;
646
+ /**
647
+ * Payment state of the Order.
648
+ *
649
+ *
650
+ */
173
651
  readonly paymentState?: PaymentState;
652
+ /**
653
+ * Shipment state of the Order.
654
+ *
655
+ */
174
656
  readonly shipmentState?: ShipmentState;
657
+ /**
658
+ * Order will be created with `Open` status by default.
659
+ *
660
+ */
175
661
  readonly orderState?: OrderState;
662
+ /**
663
+ * [Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State) indicating the Order's state.
664
+ *
665
+ *
666
+ */
176
667
  readonly state?: StateResourceIdentifier;
177
668
  }
178
669
  export interface OrderImportDraft {
670
+ /**
671
+ * String that unique identifies an order.
672
+ * It can be used to create more human-readable (in contrast to ID) identifier for the order.
673
+ * It should be unique within a project.
674
+ *
675
+ */
179
676
  readonly orderNumber?: string;
677
+ /**
678
+ * If given the customer with that ID must exist in the project.
679
+ *
680
+ */
180
681
  readonly customerId?: string;
682
+ /**
683
+ * The customer email can be used when no check against existing Customers is desired during order import.
684
+ *
685
+ */
181
686
  readonly customerEmail?: string;
687
+ /**
688
+ * If not given `customLineItems` must not be empty.
689
+ *
690
+ */
182
691
  readonly lineItems?: LineItemImportDraft[];
692
+ /**
693
+ * If not given `lineItems` must not be empty.
694
+ *
695
+ */
183
696
  readonly customLineItems?: CustomLineItemImportDraft[];
697
+ /**
698
+ *
699
+ */
184
700
  readonly totalPrice: _Money;
701
+ /**
702
+ * Order Import does not support calculation of taxes.
703
+ * When setting the draft the taxedPrice is to be provided.
704
+ *
705
+ */
185
706
  readonly taxedPrice?: TaxedPriceDraft;
707
+ /**
708
+ *
709
+ */
186
710
  readonly shippingAddress?: _BaseAddress;
711
+ /**
712
+ *
713
+ */
187
714
  readonly billingAddress?: _BaseAddress;
715
+ /**
716
+ * Set when the customer is set and the customer is a member of a customer group.
717
+ * Used for product variant price selection.
718
+ *
719
+ */
188
720
  readonly customerGroup?: CustomerGroupResourceIdentifier;
721
+ /**
722
+ * A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
723
+ * Used for product variant price selection.
724
+ *
725
+ */
189
726
  readonly country?: string;
727
+ /**
728
+ * If not given the `Open` state will be assigned by default.
729
+ *
730
+ */
190
731
  readonly orderState?: OrderState;
732
+ /**
733
+ * This reference can point to a state in a custom workflow.
734
+ *
735
+ */
191
736
  readonly state?: StateReference;
737
+ /**
738
+ *
739
+ */
192
740
  readonly shipmentState?: ShipmentState;
741
+ /**
742
+ *
743
+ */
193
744
  readonly paymentState?: PaymentState;
745
+ /**
746
+ * Set if the ShippingMethod is set.
747
+ *
748
+ */
194
749
  readonly shippingInfo?: ShippingInfoImportDraft;
750
+ /**
751
+ *
752
+ */
195
753
  readonly paymentInfo?: PaymentInfo;
754
+ /**
755
+ *
756
+ */
196
757
  readonly completedAt?: string;
758
+ /**
759
+ * The custom fields.
760
+ *
761
+ */
197
762
  readonly custom?: CustomFieldsDraft;
763
+ /**
764
+ * If not given the mode `None` will be assigned by default.
765
+ *
766
+ */
198
767
  readonly inventoryMode?: InventoryMode;
768
+ /**
769
+ * If not given the tax rounding mode `HalfEven` will be assigned by default.
770
+ *
771
+ */
199
772
  readonly taxRoundingMode?: RoundingMode;
773
+ /**
774
+ * Contains addresses for orders with multiple shipping addresses.
775
+ *
776
+ */
200
777
  readonly itemShippingAddresses?: BaseAddress[];
778
+ /**
779
+ * The Business Unit the Cart belongs to.
780
+ *
781
+ *
782
+ */
201
783
  readonly businessUnit?: BusinessUnitResourceIdentifier;
784
+ /**
785
+ *
786
+ */
202
787
  readonly store?: StoreResourceIdentifier;
788
+ /**
789
+ * The default origin is `Customer`.
790
+ *
791
+ */
203
792
  readonly origin?: CartOrigin;
204
793
  }
205
794
  export interface OrderPagedQueryResponse {
795
+ /**
796
+ * Number of [results requested](/../api/general-concepts#limit).
797
+ *
798
+ *
799
+ */
206
800
  readonly limit: number;
801
+ /**
802
+ *
803
+ */
207
804
  readonly count: number;
805
+ /**
806
+ *
807
+ */
208
808
  readonly total?: number;
809
+ /**
810
+ * Number of [elements skipped](/../api/general-concepts#offset).
811
+ *
812
+ *
813
+ */
209
814
  readonly offset: number;
815
+ /**
816
+ *
817
+ */
210
818
  readonly results: Order[];
211
819
  }
212
820
  export interface OrderReference {
213
821
  readonly typeId: 'order';
822
+ /**
823
+ * Unique ID of the referenced resource.
824
+ *
825
+ *
826
+ */
214
827
  readonly id: string;
828
+ /**
829
+ *
830
+ */
215
831
  readonly obj?: _Order;
216
832
  }
217
833
  export interface OrderResourceIdentifier {
218
834
  readonly typeId: 'order';
835
+ /**
836
+ * Unique identifier of the referenced resource. Required if `key` is absent.
837
+ *
838
+ *
839
+ */
219
840
  readonly id?: string;
841
+ /**
842
+ * User-defined unique identifier of the referenced resource. Required if `id` is absent.
843
+ *
844
+ *
845
+ */
220
846
  readonly key?: string;
221
847
  }
222
848
  export interface OrderSearchQuery {
@@ -226,457 +852,1306 @@ export interface OrderSearchCompoundExpression extends OrderSearchQuery {
226
852
  }
227
853
  export type _OrderSearchCompoundExpression = OrderSearchCompoundExpression | OrderSearchAndExpression | OrderSearchFilterExpression | OrderSearchNotExpression | OrderSearchOrExpression;
228
854
  export interface OrderSearchAndExpression extends OrderSearchCompoundExpression {
855
+ /**
856
+ *
857
+ */
229
858
  readonly and: OrderSearchQuery[];
230
859
  }
231
860
  export interface OrderSearchFilterExpression extends OrderSearchCompoundExpression {
861
+ /**
862
+ *
863
+ */
232
864
  readonly filter: OrderSearchQueryExpression[];
233
865
  }
234
866
  export interface OrderSearchNotExpression extends OrderSearchCompoundExpression {
867
+ /**
868
+ *
869
+ */
235
870
  readonly not: OrderSearchQuery[];
236
871
  }
237
872
  export interface OrderSearchOrExpression extends OrderSearchCompoundExpression {
873
+ /**
874
+ *
875
+ */
238
876
  readonly or: OrderSearchQuery[];
239
877
  }
240
878
  export interface OrderSearchQueryExpression extends OrderSearchQuery {
241
879
  }
242
880
  export type _OrderSearchQueryExpression = OrderSearchQueryExpression | OrderSearchDateRangeExpression | OrderSearchExactExpression | OrderSearchExistsExpression | OrderSearchFullTextExpression | OrderSearchLongRangeExpression | OrderSearchNumberRangeExpression | OrderSearchPrefixExpression | OrderSearchWildCardExpression;
243
881
  export interface OrderSearchDateRangeExpression extends OrderSearchQueryExpression {
882
+ /**
883
+ *
884
+ */
244
885
  readonly range: OrderSearchDateRangeValue;
245
886
  }
246
887
  export interface OrderSearchExactExpression extends OrderSearchQueryExpression {
888
+ /**
889
+ *
890
+ */
247
891
  readonly exact: OrderSearchAnyValue;
248
892
  }
249
893
  export interface OrderSearchExistsExpression extends OrderSearchQueryExpression {
894
+ /**
895
+ *
896
+ */
250
897
  readonly exists: _OrderSearchQueryExpressionValue;
251
898
  }
252
899
  export interface OrderSearchFullTextExpression extends OrderSearchQueryExpression {
900
+ /**
901
+ *
902
+ */
253
903
  readonly fullText: OrderSearchFullTextValue;
254
904
  }
255
905
  export interface OrderSearchLongRangeExpression extends OrderSearchQueryExpression {
906
+ /**
907
+ *
908
+ */
256
909
  readonly range: OrderSearchLongRangeValue;
257
910
  }
258
911
  export interface OrderSearchNumberRangeExpression extends OrderSearchQueryExpression {
912
+ /**
913
+ *
914
+ */
259
915
  readonly range: OrderSearchNumberRangeValue;
260
916
  }
261
917
  export interface OrderSearchPrefixExpression extends OrderSearchQueryExpression {
918
+ /**
919
+ *
920
+ */
262
921
  readonly prefix: OrderSearchStringValue;
263
922
  }
264
923
  export interface OrderSearchWildCardExpression extends OrderSearchQueryExpression {
924
+ /**
925
+ *
926
+ */
265
927
  readonly wildcard: OrderSearchStringValue;
266
928
  }
267
929
  export interface OrderSearchRequest {
930
+ /**
931
+ * The Order search query.
932
+ *
933
+ */
268
934
  readonly query: _OrderSearchQuery;
935
+ /**
936
+ * Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.
937
+ *
938
+ */
269
939
  readonly sort?: OrderSearchSorting[];
940
+ /**
941
+ * The maximum number of search results to be returned.
942
+ *
943
+ */
270
944
  readonly limit?: number;
945
+ /**
946
+ * The number of search results to be skipped in the response for pagination.
947
+ *
948
+ */
271
949
  readonly offset?: number;
272
950
  }
273
951
  export interface OrderSearchSorting {
952
+ /**
953
+ *
954
+ */
274
955
  readonly field: string;
956
+ /**
957
+ *
958
+ */
275
959
  readonly language?: string;
960
+ /**
961
+ *
962
+ */
276
963
  readonly order?: OrderSearchSortOrder;
964
+ /**
965
+ *
966
+ */
277
967
  readonly mode?: OrderSearchSortMode;
968
+ /**
969
+ *
970
+ */
278
971
  readonly filter?: _OrderSearchQueryExpression;
279
972
  }
280
973
  export type OrderState = 'Cancelled' | 'Complete' | 'Confirmed' | 'Open' | string;
281
974
  export interface OrderUpdate {
975
+ /**
976
+ * Expected version of the Order on which the changes should be applied.
977
+ * If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned.
978
+ *
979
+ *
980
+ */
282
981
  readonly version: number;
982
+ /**
983
+ * Update actions to be performed on the Order.
984
+ *
985
+ *
986
+ */
283
987
  readonly actions: OrderUpdateAction[];
284
988
  }
285
989
  export type OrderUpdateAction = OrderAddDeliveryAction | OrderAddItemShippingAddressAction | OrderAddParcelToDeliveryAction | OrderAddPaymentAction | OrderAddReturnInfoAction | OrderChangeOrderStateAction | OrderChangePaymentStateAction | OrderChangeShipmentStateAction | OrderImportCustomLineItemStateAction | OrderImportLineItemStateAction | OrderRemoveDeliveryAction | OrderRemoveItemShippingAddressAction | OrderRemoveParcelFromDeliveryAction | OrderRemovePaymentAction | OrderSetBillingAddressAction | OrderSetBillingAddressCustomFieldAction | OrderSetBillingAddressCustomTypeAction | OrderSetCustomFieldAction | OrderSetCustomLineItemCustomFieldAction | OrderSetCustomLineItemCustomTypeAction | OrderSetCustomLineItemShippingDetailsAction | OrderSetCustomTypeAction | OrderSetCustomerEmailAction | OrderSetCustomerIdAction | OrderSetDeliveryAddressAction | OrderSetDeliveryAddressCustomFieldAction | OrderSetDeliveryAddressCustomTypeAction | OrderSetDeliveryCustomFieldAction | OrderSetDeliveryCustomTypeAction | OrderSetDeliveryItemsAction | OrderSetItemShippingAddressCustomFieldAction | OrderSetItemShippingAddressCustomTypeAction | OrderSetLineItemCustomFieldAction | OrderSetLineItemCustomTypeAction | OrderSetLineItemShippingDetailsAction | OrderSetLocaleAction | OrderSetOrderNumberAction | OrderSetParcelCustomFieldAction | OrderSetParcelCustomTypeAction | OrderSetParcelItemsAction | OrderSetParcelMeasurementsAction | OrderSetParcelTrackingDataAction | OrderSetPurchaseOrderNumberAction | OrderSetReturnInfoAction | OrderSetReturnItemCustomFieldAction | OrderSetReturnItemCustomTypeAction | OrderSetReturnPaymentStateAction | OrderSetReturnShipmentStateAction | OrderSetShippingAddressAction | OrderSetShippingAddressCustomFieldAction | OrderSetShippingAddressCustomTypeAction | OrderSetStoreAction | OrderTransitionCustomLineItemStateAction | OrderTransitionLineItemStateAction | OrderTransitionStateAction | OrderUpdateItemShippingAddressAction | OrderUpdateSyncInfoAction;
286
990
  export interface Parcel {
991
+ /**
992
+ * Unique identifier of the Parcel.
993
+ *
994
+ */
287
995
  readonly id: string;
996
+ /**
997
+ *
998
+ */
288
999
  readonly createdAt: string;
1000
+ /**
1001
+ *
1002
+ */
289
1003
  readonly measurements?: ParcelMeasurements;
1004
+ /**
1005
+ *
1006
+ */
290
1007
  readonly trackingData?: TrackingData;
1008
+ /**
1009
+ * The delivery items contained in this parcel.
1010
+ *
1011
+ */
291
1012
  readonly items?: DeliveryItem[];
1013
+ /**
1014
+ * Custom Fields of this parcel.
1015
+ *
1016
+ */
292
1017
  readonly custom?: CustomFields;
293
1018
  }
294
1019
  export interface ParcelDraft {
1020
+ /**
1021
+ *
1022
+ */
295
1023
  readonly measurements?: ParcelMeasurements;
1024
+ /**
1025
+ *
1026
+ */
296
1027
  readonly trackingData?: TrackingData;
1028
+ /**
1029
+ * The delivery items contained in this parcel.
1030
+ *
1031
+ */
297
1032
  readonly items?: DeliveryItem[];
1033
+ /**
1034
+ * Custom Fields of this parcel.
1035
+ *
1036
+ */
298
1037
  readonly custom?: CustomFieldsDraft;
299
1038
  }
300
1039
  export interface ParcelMeasurements {
1040
+ /**
1041
+ *
1042
+ */
301
1043
  readonly heightInMillimeter?: number;
1044
+ /**
1045
+ *
1046
+ */
302
1047
  readonly lengthInMillimeter?: number;
1048
+ /**
1049
+ *
1050
+ */
303
1051
  readonly widthInMillimeter?: number;
1052
+ /**
1053
+ *
1054
+ */
304
1055
  readonly weightInGram?: number;
305
1056
  }
306
1057
  export interface PaymentInfo {
1058
+ /**
1059
+ *
1060
+ */
307
1061
  readonly payments: PaymentReference[];
308
1062
  }
309
1063
  export type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending' | string;
310
1064
  export interface ProductVariantImportDraft {
1065
+ /**
1066
+ * The sequential ID of the variant within the product.
1067
+ * The variant with provided ID should exist in some existing product, so you also need to specify the productId if this property is set,
1068
+ * or alternatively you can just specify SKU of the product variant.
1069
+ *
1070
+ */
311
1071
  readonly id?: number;
1072
+ /**
1073
+ * The SKU of the existing variant.
1074
+ *
1075
+ */
312
1076
  readonly sku?: string;
1077
+ /**
1078
+ * The [Embedded Prices](ctp:api:type:Price) of the variant.
1079
+ * The prices should not contain two prices for the same price scope (same currency, country, customer group, channel, valid from and valid until).
1080
+ * If this property is defined, then it will override the `prices` property from the original product variant, otherwise `prices` property from the original product variant would be copied in the resulting order.
1081
+ *
1082
+ */
313
1083
  readonly prices?: PriceDraft[];
1084
+ /**
1085
+ * If this property is defined, then it will override the `attributes` property from the original
1086
+ * product variant, otherwise `attributes` property from the original product variant would be copied in the resulting order.
1087
+ *
1088
+ */
314
1089
  readonly attributes?: Attribute[];
1090
+ /**
1091
+ * If this property is defined, then it will override the `images` property from the original
1092
+ * product variant, otherwise `images` property from the original product variant would be copied in the resulting order.
1093
+ *
1094
+ */
315
1095
  readonly images?: Image[];
316
1096
  }
317
1097
  export interface ReturnInfo {
1098
+ /**
1099
+ *
1100
+ */
318
1101
  readonly items: ReturnItem[];
1102
+ /**
1103
+ * Identifies, which return tracking ID is connected to this particular return.
1104
+ *
1105
+ */
319
1106
  readonly returnTrackingId?: string;
1107
+ /**
1108
+ *
1109
+ */
320
1110
  readonly returnDate?: string;
321
1111
  }
322
1112
  export interface ReturnInfoDraft {
1113
+ /**
1114
+ *
1115
+ */
323
1116
  readonly items: ReturnItemDraft[];
1117
+ /**
1118
+ * Identifies, which return tracking ID is connected to this particular return.
1119
+ *
1120
+ */
324
1121
  readonly returnTrackingId?: string;
1122
+ /**
1123
+ *
1124
+ */
325
1125
  readonly returnDate?: string;
326
1126
  }
327
1127
  export type ReturnItem = CustomLineItemReturnItem | LineItemReturnItem;
328
1128
  export interface CustomLineItemReturnItem {
329
1129
  readonly type: 'CustomLineItemReturnItem';
1130
+ /**
1131
+ * Unique identifier of the ReturnItem.
1132
+ *
1133
+ */
330
1134
  readonly id: string;
1135
+ /**
1136
+ *
1137
+ */
331
1138
  readonly quantity: number;
1139
+ /**
1140
+ *
1141
+ */
332
1142
  readonly comment?: string;
1143
+ /**
1144
+ *
1145
+ */
333
1146
  readonly shipmentState: ReturnShipmentState;
1147
+ /**
1148
+ *
1149
+ */
334
1150
  readonly paymentState: ReturnPaymentState;
1151
+ /**
1152
+ * Custom Fields of this return item.
1153
+ *
1154
+ */
335
1155
  readonly custom?: CustomFields;
1156
+ /**
1157
+ *
1158
+ */
336
1159
  readonly lastModifiedAt: string;
1160
+ /**
1161
+ *
1162
+ */
337
1163
  readonly createdAt: string;
1164
+ /**
1165
+ *
1166
+ */
338
1167
  readonly customLineItemId: string;
339
1168
  }
340
1169
  export interface LineItemReturnItem {
341
1170
  readonly type: 'LineItemReturnItem';
1171
+ /**
1172
+ * Unique identifier of the ReturnItem.
1173
+ *
1174
+ */
342
1175
  readonly id: string;
1176
+ /**
1177
+ *
1178
+ */
343
1179
  readonly quantity: number;
1180
+ /**
1181
+ *
1182
+ */
344
1183
  readonly comment?: string;
1184
+ /**
1185
+ *
1186
+ */
345
1187
  readonly shipmentState: ReturnShipmentState;
1188
+ /**
1189
+ *
1190
+ */
346
1191
  readonly paymentState: ReturnPaymentState;
1192
+ /**
1193
+ * Custom Fields of this return item.
1194
+ *
1195
+ */
347
1196
  readonly custom?: CustomFields;
1197
+ /**
1198
+ *
1199
+ */
348
1200
  readonly lastModifiedAt: string;
1201
+ /**
1202
+ *
1203
+ */
349
1204
  readonly createdAt: string;
1205
+ /**
1206
+ *
1207
+ */
350
1208
  readonly lineItemId: string;
351
1209
  }
352
1210
  export interface ReturnItemDraft {
1211
+ /**
1212
+ *
1213
+ */
353
1214
  readonly quantity: number;
1215
+ /**
1216
+ *
1217
+ */
354
1218
  readonly lineItemId?: string;
1219
+ /**
1220
+ *
1221
+ */
355
1222
  readonly customLineItemId?: string;
1223
+ /**
1224
+ *
1225
+ */
356
1226
  readonly comment?: string;
1227
+ /**
1228
+ *
1229
+ */
357
1230
  readonly shipmentState: ReturnShipmentState;
1231
+ /**
1232
+ * Custom Fields of this return item.
1233
+ *
1234
+ */
358
1235
  readonly custom?: CustomFieldsDraft;
359
1236
  }
360
1237
  export type ReturnPaymentState = 'Initial' | 'NonRefundable' | 'NotRefunded' | 'Refunded' | string;
361
1238
  export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable' | string;
362
1239
  export type ShipmentState = 'Backorder' | 'Delayed' | 'Delivered' | 'Partial' | 'Pending' | 'Ready' | 'Shipped' | string;
363
1240
  export interface ShippingInfoImportDraft {
1241
+ /**
1242
+ *
1243
+ */
364
1244
  readonly shippingMethodName: string;
1245
+ /**
1246
+ *
1247
+ */
365
1248
  readonly price: _Money;
1249
+ /**
1250
+ * The shipping rate used to determine the price.
1251
+ *
1252
+ */
366
1253
  readonly shippingRate: ShippingRateDraft;
1254
+ /**
1255
+ *
1256
+ */
367
1257
  readonly taxRate?: TaxRate;
1258
+ /**
1259
+ *
1260
+ */
368
1261
  readonly taxCategory?: TaxCategoryResourceIdentifier;
1262
+ /**
1263
+ * Not set if custom shipping method is used.
1264
+ *
1265
+ */
369
1266
  readonly shippingMethod?: ShippingMethodResourceIdentifier;
1267
+ /**
1268
+ * Deliveries are compilations of information on how the articles are being delivered to the customers.
1269
+ *
1270
+ */
370
1271
  readonly deliveries?: DeliveryDraft[];
1272
+ /**
1273
+ *
1274
+ */
371
1275
  readonly discountedPrice?: DiscountedLineItemPriceDraft;
1276
+ /**
1277
+ * Indicates whether the ShippingMethod referenced is allowed for the cart or not.
1278
+ *
1279
+ */
372
1280
  readonly shippingMethodState?: ShippingMethodState;
373
1281
  }
374
1282
  export interface SyncInfo {
1283
+ /**
1284
+ * Connection to a particular synchronization destination.
1285
+ *
1286
+ */
375
1287
  readonly channel: ChannelReference;
1288
+ /**
1289
+ * Can be used to reference an external order instance, file etc.
1290
+ *
1291
+ */
376
1292
  readonly externalId?: string;
1293
+ /**
1294
+ *
1295
+ */
377
1296
  readonly syncedAt: string;
378
1297
  }
379
1298
  export interface TaxedItemPriceDraft {
1299
+ /**
1300
+ * Draft type that stores amounts only in cent precision for the specified currency.
1301
+ *
1302
+ *
1303
+ */
380
1304
  readonly totalNet: _Money;
1305
+ /**
1306
+ * Draft type that stores amounts only in cent precision for the specified currency.
1307
+ *
1308
+ *
1309
+ */
381
1310
  readonly totalGross: _Money;
382
1311
  }
383
1312
  export interface TrackingData {
1313
+ /**
1314
+ * The ID to track one parcel.
1315
+ *
1316
+ */
384
1317
  readonly trackingId?: string;
1318
+ /**
1319
+ * The carrier that delivers the parcel.
1320
+ *
1321
+ */
385
1322
  readonly carrier?: string;
1323
+ /**
1324
+ *
1325
+ */
386
1326
  readonly provider?: string;
1327
+ /**
1328
+ *
1329
+ */
387
1330
  readonly providerTransaction?: string;
1331
+ /**
1332
+ * Flag to distinguish if the parcel is on the way to the customer (false) or on the way back (true).
1333
+ *
1334
+ */
388
1335
  readonly isReturn?: boolean;
389
1336
  }
390
1337
  export interface OrderAddDeliveryAction {
391
1338
  readonly action: 'addDelivery';
1339
+ /**
1340
+ *
1341
+ */
392
1342
  readonly items?: DeliveryItem[];
1343
+ /**
1344
+ * User-defined unique identifier of the Shipping Method in a Cart with `Multi` [ShippingMode](ctp:api:type:ShippingMode).
1345
+ *
1346
+ *
1347
+ */
393
1348
  readonly shippingKey?: string;
1349
+ /**
1350
+ * Polymorphic base type that represents a postal address and contact details.
1351
+ * Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
1352
+ * only differ in the data type for the optional `custom` field.
1353
+ *
1354
+ *
1355
+ */
394
1356
  readonly address?: _BaseAddress;
1357
+ /**
1358
+ *
1359
+ */
395
1360
  readonly parcels?: ParcelDraft[];
1361
+ /**
1362
+ * Custom Fields for the Transaction.
1363
+ *
1364
+ */
396
1365
  readonly custom?: CustomFieldsDraft;
397
1366
  }
398
1367
  export interface OrderAddItemShippingAddressAction {
399
1368
  readonly action: 'addItemShippingAddress';
1369
+ /**
1370
+ * Polymorphic base type that represents a postal address and contact details.
1371
+ * Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
1372
+ * only differ in the data type for the optional `custom` field.
1373
+ *
1374
+ *
1375
+ */
400
1376
  readonly address: _BaseAddress;
401
1377
  }
402
1378
  export interface OrderAddParcelToDeliveryAction {
403
1379
  readonly action: 'addParcelToDelivery';
1380
+ /**
1381
+ *
1382
+ */
404
1383
  readonly deliveryId: string;
1384
+ /**
1385
+ *
1386
+ */
405
1387
  readonly measurements?: ParcelMeasurements;
1388
+ /**
1389
+ *
1390
+ */
406
1391
  readonly trackingData?: TrackingData;
1392
+ /**
1393
+ *
1394
+ */
407
1395
  readonly items?: DeliveryItem[];
408
1396
  }
409
1397
  export interface OrderAddPaymentAction {
410
1398
  readonly action: 'addPayment';
1399
+ /**
1400
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
1401
+ *
1402
+ *
1403
+ */
411
1404
  readonly payment: PaymentResourceIdentifier;
412
1405
  }
413
1406
  export interface OrderAddReturnInfoAction {
414
1407
  readonly action: 'addReturnInfo';
1408
+ /**
1409
+ *
1410
+ */
415
1411
  readonly returnTrackingId?: string;
1412
+ /**
1413
+ *
1414
+ */
416
1415
  readonly items: ReturnItemDraft[];
1416
+ /**
1417
+ *
1418
+ */
417
1419
  readonly returnDate?: string;
418
1420
  }
419
1421
  export interface OrderChangeOrderStateAction {
420
1422
  readonly action: 'changeOrderState';
1423
+ /**
1424
+ *
1425
+ */
421
1426
  readonly orderState: OrderState;
422
1427
  }
423
1428
  export interface OrderChangePaymentStateAction {
424
1429
  readonly action: 'changePaymentState';
1430
+ /**
1431
+ *
1432
+ */
425
1433
  readonly paymentState?: PaymentState;
426
1434
  }
427
1435
  export interface OrderChangeShipmentStateAction {
428
1436
  readonly action: 'changeShipmentState';
1437
+ /**
1438
+ *
1439
+ */
429
1440
  readonly shipmentState?: ShipmentState;
430
1441
  }
431
1442
  export interface OrderImportCustomLineItemStateAction {
432
1443
  readonly action: 'importCustomLineItemState';
1444
+ /**
1445
+ *
1446
+ */
433
1447
  readonly customLineItemId: string;
1448
+ /**
1449
+ *
1450
+ */
434
1451
  readonly state: ItemState[];
435
1452
  }
436
1453
  export interface OrderImportLineItemStateAction {
437
1454
  readonly action: 'importLineItemState';
1455
+ /**
1456
+ *
1457
+ */
438
1458
  readonly lineItemId: string;
1459
+ /**
1460
+ *
1461
+ */
439
1462
  readonly state: ItemState[];
440
1463
  }
441
1464
  export interface OrderRemoveDeliveryAction {
442
1465
  readonly action: 'removeDelivery';
1466
+ /**
1467
+ *
1468
+ */
443
1469
  readonly deliveryId: string;
444
1470
  }
445
1471
  export interface OrderRemoveItemShippingAddressAction {
446
1472
  readonly action: 'removeItemShippingAddress';
1473
+ /**
1474
+ *
1475
+ */
447
1476
  readonly addressKey: string;
448
1477
  }
449
1478
  export interface OrderRemoveParcelFromDeliveryAction {
450
1479
  readonly action: 'removeParcelFromDelivery';
1480
+ /**
1481
+ *
1482
+ */
451
1483
  readonly parcelId: string;
452
1484
  }
453
1485
  export interface OrderRemovePaymentAction {
454
1486
  readonly action: 'removePayment';
1487
+ /**
1488
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
1489
+ *
1490
+ *
1491
+ */
455
1492
  readonly payment: PaymentResourceIdentifier;
456
1493
  }
457
1494
  export interface OrderSetBillingAddressAction {
458
1495
  readonly action: 'setBillingAddress';
1496
+ /**
1497
+ * Polymorphic base type that represents a postal address and contact details.
1498
+ * Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
1499
+ * only differ in the data type for the optional `custom` field.
1500
+ *
1501
+ *
1502
+ */
459
1503
  readonly address?: _BaseAddress;
460
1504
  }
461
1505
  export interface OrderSetBillingAddressCustomFieldAction {
462
1506
  readonly action: 'setBillingAddressCustomField';
1507
+ /**
1508
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1509
+ *
1510
+ *
1511
+ */
463
1512
  readonly name: string;
1513
+ /**
1514
+ * If `value` is absent or `null`, this field will be removed if it exists.
1515
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1516
+ * If `value` is provided, it is set for the field defined by `name`.
1517
+ *
1518
+ *
1519
+ */
464
1520
  readonly value?: any;
465
1521
  }
466
1522
  export interface OrderSetBillingAddressCustomTypeAction {
467
1523
  readonly action: 'setBillingAddressCustomType';
1524
+ /**
1525
+ * Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
1526
+ * If absent, any existing Type and Custom Fields are removed from the `billingAddress`.
1527
+ *
1528
+ *
1529
+ */
468
1530
  readonly type?: TypeResourceIdentifier;
1531
+ /**
1532
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `billingAddress`.
1533
+ *
1534
+ *
1535
+ */
469
1536
  readonly fields?: FieldContainer;
470
1537
  }
471
1538
  export interface OrderSetCustomFieldAction {
472
1539
  readonly action: 'setCustomField';
1540
+ /**
1541
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1542
+ *
1543
+ *
1544
+ */
473
1545
  readonly name: string;
1546
+ /**
1547
+ * If `value` is absent or `null`, this field will be removed if it exists.
1548
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1549
+ * If `value` is provided, it is set for the field defined by `name`.
1550
+ *
1551
+ *
1552
+ */
474
1553
  readonly value?: any;
475
1554
  }
476
1555
  export interface OrderSetCustomLineItemCustomFieldAction {
477
1556
  readonly action: 'setCustomLineItemCustomField';
1557
+ /**
1558
+ *
1559
+ */
478
1560
  readonly customLineItemId: string;
1561
+ /**
1562
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1563
+ *
1564
+ *
1565
+ */
479
1566
  readonly name: string;
1567
+ /**
1568
+ * If `value` is absent or `null`, this field will be removed if it exists.
1569
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1570
+ * If `value` is provided, it is set for the field defined by `name`.
1571
+ *
1572
+ *
1573
+ */
480
1574
  readonly value?: any;
481
1575
  }
482
1576
  export interface OrderSetCustomLineItemCustomTypeAction {
483
1577
  readonly action: 'setCustomLineItemCustomType';
1578
+ /**
1579
+ *
1580
+ */
484
1581
  readonly customLineItemId: string;
1582
+ /**
1583
+ * Defines the [Type](ctp:api:type:Type) that extends the CustomLineItem with [Custom Fields](/../api/projects/custom-fields).
1584
+ * If absent, any existing Type and Custom Fields are removed from the CustomLineItem.
1585
+ *
1586
+ *
1587
+ */
485
1588
  readonly type?: TypeResourceIdentifier;
1589
+ /**
1590
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the CustomLineItem.
1591
+ *
1592
+ *
1593
+ */
486
1594
  readonly fields?: FieldContainer;
487
1595
  }
488
1596
  export interface OrderSetCustomLineItemShippingDetailsAction {
489
1597
  readonly action: 'setCustomLineItemShippingDetails';
1598
+ /**
1599
+ *
1600
+ */
490
1601
  readonly customLineItemId: string;
1602
+ /**
1603
+ * For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
1604
+ *
1605
+ *
1606
+ */
491
1607
  readonly shippingDetails?: ItemShippingDetailsDraft;
492
1608
  }
493
1609
  export interface OrderSetCustomTypeAction {
494
1610
  readonly action: 'setCustomType';
1611
+ /**
1612
+ * Defines the [Type](ctp:api:type:Type) that extends the Order with [Custom Fields](/../api/projects/custom-fields).
1613
+ * If absent, any existing Type and Custom Fields are removed from the Order.
1614
+ *
1615
+ *
1616
+ */
495
1617
  readonly type?: TypeResourceIdentifier;
1618
+ /**
1619
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Order.
1620
+ *
1621
+ *
1622
+ */
496
1623
  readonly fields?: FieldContainer;
497
1624
  }
498
1625
  export interface OrderSetCustomerEmailAction {
499
1626
  readonly action: 'setCustomerEmail';
1627
+ /**
1628
+ *
1629
+ */
500
1630
  readonly email?: string;
501
1631
  }
502
1632
  export interface OrderSetCustomerIdAction {
503
1633
  readonly action: 'setCustomerId';
1634
+ /**
1635
+ *
1636
+ */
504
1637
  readonly customerId?: string;
505
1638
  }
506
1639
  export interface OrderSetDeliveryAddressAction {
507
1640
  readonly action: 'setDeliveryAddress';
1641
+ /**
1642
+ *
1643
+ */
508
1644
  readonly deliveryId: string;
1645
+ /**
1646
+ * Polymorphic base type that represents a postal address and contact details.
1647
+ * Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
1648
+ * only differ in the data type for the optional `custom` field.
1649
+ *
1650
+ *
1651
+ */
509
1652
  readonly address?: _BaseAddress;
510
1653
  }
511
1654
  export interface OrderSetDeliveryAddressCustomFieldAction {
512
1655
  readonly action: 'setDeliveryAddressCustomField';
1656
+ /**
1657
+ *
1658
+ */
513
1659
  readonly deliveryId: string;
1660
+ /**
1661
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1662
+ *
1663
+ *
1664
+ */
514
1665
  readonly name: string;
1666
+ /**
1667
+ * If `value` is absent or `null`, this field will be removed if it exists.
1668
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1669
+ * If `value` is provided, it is set for the field defined by `name`.
1670
+ *
1671
+ *
1672
+ */
515
1673
  readonly value?: any;
516
1674
  }
517
1675
  export interface OrderSetDeliveryAddressCustomTypeAction {
518
1676
  readonly action: 'setDeliveryAddressCustomType';
1677
+ /**
1678
+ *
1679
+ */
519
1680
  readonly deliveryId: string;
1681
+ /**
1682
+ * Defines the [Type](ctp:api:type:Type) that extends the `address` in a Delivery with [Custom Fields](/../api/projects/custom-fields).
1683
+ * If absent, any existing Type and Custom Fields are removed from the `address` in a Delivery.
1684
+ *
1685
+ *
1686
+ */
520
1687
  readonly type?: TypeResourceIdentifier;
1688
+ /**
1689
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address` in a Delivery.
1690
+ *
1691
+ *
1692
+ */
521
1693
  readonly fields?: FieldContainer;
522
1694
  }
523
1695
  export interface OrderSetDeliveryCustomFieldAction {
524
1696
  readonly action: 'setDeliveryCustomField';
1697
+ /**
1698
+ *
1699
+ */
525
1700
  readonly deliveryId: string;
1701
+ /**
1702
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1703
+ *
1704
+ *
1705
+ */
526
1706
  readonly name: string;
1707
+ /**
1708
+ * If `value` is absent or `null`, this field will be removed if it exists.
1709
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1710
+ * If `value` is provided, it is set for the field defined by `name`.
1711
+ *
1712
+ *
1713
+ */
527
1714
  readonly value?: any;
528
1715
  }
529
1716
  export interface OrderSetDeliveryCustomTypeAction {
530
1717
  readonly action: 'setDeliveryCustomType';
1718
+ /**
1719
+ *
1720
+ */
531
1721
  readonly deliveryId: string;
1722
+ /**
1723
+ * Defines the [Type](ctp:api:type:Type) that extends the Delivery with [Custom Fields](/../api/projects/custom-fields).
1724
+ * If absent, any existing Type and Custom Fields are removed from the Delivery.
1725
+ *
1726
+ *
1727
+ */
532
1728
  readonly type?: TypeResourceIdentifier;
1729
+ /**
1730
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Delivery.
1731
+ *
1732
+ *
1733
+ */
533
1734
  readonly fields?: FieldContainer;
534
1735
  }
535
1736
  export interface OrderSetDeliveryItemsAction {
536
1737
  readonly action: 'setDeliveryItems';
1738
+ /**
1739
+ *
1740
+ */
537
1741
  readonly deliveryId: string;
1742
+ /**
1743
+ *
1744
+ */
538
1745
  readonly items: DeliveryItem[];
539
1746
  }
540
1747
  export interface OrderSetItemShippingAddressCustomFieldAction {
541
1748
  readonly action: 'setItemShippingAddressCustomField';
1749
+ /**
1750
+ *
1751
+ */
542
1752
  readonly addressKey: string;
1753
+ /**
1754
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1755
+ *
1756
+ *
1757
+ */
543
1758
  readonly name: string;
1759
+ /**
1760
+ * If `value` is absent or `null`, this field will be removed if it exists.
1761
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1762
+ * If `value` is provided, it is set for the field defined by `name`.
1763
+ *
1764
+ *
1765
+ */
544
1766
  readonly value?: any;
545
1767
  }
546
1768
  export interface OrderSetItemShippingAddressCustomTypeAction {
547
1769
  readonly action: 'setItemShippingAddressCustomType';
1770
+ /**
1771
+ *
1772
+ */
548
1773
  readonly addressKey: string;
1774
+ /**
1775
+ * Defines the [Type](ctp:api:type:Type) that extends the `itemShippingAddress` with [Custom Fields](/../api/projects/custom-fields).
1776
+ * If absent, any existing Type and Custom Fields are removed from the `itemShippingAddress`.
1777
+ *
1778
+ *
1779
+ */
549
1780
  readonly type?: TypeResourceIdentifier;
1781
+ /**
1782
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `itemShippingAddress`.
1783
+ *
1784
+ *
1785
+ */
550
1786
  readonly fields?: FieldContainer;
551
1787
  }
552
1788
  export interface OrderSetLineItemCustomFieldAction {
553
1789
  readonly action: 'setLineItemCustomField';
1790
+ /**
1791
+ *
1792
+ */
554
1793
  readonly lineItemId: string;
1794
+ /**
1795
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1796
+ *
1797
+ *
1798
+ */
555
1799
  readonly name: string;
1800
+ /**
1801
+ * If `value` is absent or `null`, this field will be removed if it exists.
1802
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1803
+ * If `value` is provided, it is set for the field defined by `name`.
1804
+ *
1805
+ *
1806
+ */
556
1807
  readonly value?: any;
557
1808
  }
558
1809
  export interface OrderSetLineItemCustomTypeAction {
559
1810
  readonly action: 'setLineItemCustomType';
1811
+ /**
1812
+ *
1813
+ */
560
1814
  readonly lineItemId: string;
1815
+ /**
1816
+ * Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields).
1817
+ * If absent, any existing Type and Custom Fields are removed from the LineItem.
1818
+ *
1819
+ *
1820
+ */
561
1821
  readonly type?: TypeResourceIdentifier;
1822
+ /**
1823
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the LineItem.
1824
+ *
1825
+ *
1826
+ */
562
1827
  readonly fields?: FieldContainer;
563
1828
  }
564
1829
  export interface OrderSetLineItemShippingDetailsAction {
565
1830
  readonly action: 'setLineItemShippingDetails';
1831
+ /**
1832
+ *
1833
+ */
566
1834
  readonly lineItemId: string;
1835
+ /**
1836
+ * For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
1837
+ *
1838
+ *
1839
+ */
567
1840
  readonly shippingDetails?: ItemShippingDetailsDraft;
568
1841
  }
569
1842
  export interface OrderSetLocaleAction {
570
1843
  readonly action: 'setLocale';
1844
+ /**
1845
+ *
1846
+ */
571
1847
  readonly locale?: string;
572
1848
  }
573
1849
  export interface OrderSetOrderNumberAction {
574
1850
  readonly action: 'setOrderNumber';
1851
+ /**
1852
+ *
1853
+ */
575
1854
  readonly orderNumber?: string;
576
1855
  }
577
1856
  export interface OrderSetParcelCustomFieldAction {
578
1857
  readonly action: 'setParcelCustomField';
1858
+ /**
1859
+ *
1860
+ */
579
1861
  readonly parcelId: string;
1862
+ /**
1863
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1864
+ *
1865
+ *
1866
+ */
580
1867
  readonly name: string;
1868
+ /**
1869
+ * If `value` is absent or `null`, this field will be removed if it exists.
1870
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1871
+ * If `value` is provided, it is set for the field defined by `name`.
1872
+ *
1873
+ *
1874
+ */
581
1875
  readonly value?: any;
582
1876
  }
583
1877
  export interface OrderSetParcelCustomTypeAction {
584
1878
  readonly action: 'setParcelCustomType';
1879
+ /**
1880
+ *
1881
+ */
585
1882
  readonly parcelId: string;
1883
+ /**
1884
+ * Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields).
1885
+ * If absent, any existing Type and Custom Fields are removed from the Parcel.
1886
+ *
1887
+ *
1888
+ */
586
1889
  readonly type?: TypeResourceIdentifier;
1890
+ /**
1891
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Parcel.
1892
+ *
1893
+ *
1894
+ */
587
1895
  readonly fields?: FieldContainer;
588
1896
  }
589
1897
  export interface OrderSetParcelItemsAction {
590
1898
  readonly action: 'setParcelItems';
1899
+ /**
1900
+ *
1901
+ */
591
1902
  readonly parcelId: string;
1903
+ /**
1904
+ *
1905
+ */
592
1906
  readonly items: DeliveryItem[];
593
1907
  }
594
1908
  export interface OrderSetParcelMeasurementsAction {
595
1909
  readonly action: 'setParcelMeasurements';
1910
+ /**
1911
+ *
1912
+ */
596
1913
  readonly parcelId: string;
1914
+ /**
1915
+ *
1916
+ */
597
1917
  readonly measurements?: ParcelMeasurements;
598
1918
  }
599
1919
  export interface OrderSetParcelTrackingDataAction {
600
1920
  readonly action: 'setParcelTrackingData';
1921
+ /**
1922
+ *
1923
+ */
601
1924
  readonly parcelId: string;
1925
+ /**
1926
+ *
1927
+ */
602
1928
  readonly trackingData?: TrackingData;
603
1929
  }
604
1930
  export interface OrderSetPurchaseOrderNumberAction {
605
1931
  readonly action: 'setPurchaseOrderNumber';
1932
+ /**
1933
+ * Identifier for a purchase order, usually in a B2B context.
1934
+ * The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer) and can also be used with [Quotes](/quotes-overview).
1935
+ *
1936
+ */
606
1937
  readonly purchaseOrderNumber?: string;
607
1938
  }
608
1939
  export interface OrderSetReturnInfoAction {
609
1940
  readonly action: 'setReturnInfo';
1941
+ /**
1942
+ *
1943
+ */
610
1944
  readonly items?: ReturnInfoDraft[];
611
1945
  }
612
1946
  export interface OrderSetReturnItemCustomFieldAction {
613
1947
  readonly action: 'setReturnItemCustomField';
1948
+ /**
1949
+ *
1950
+ */
614
1951
  readonly returnItemId: string;
1952
+ /**
1953
+ * Name of the [Custom Field](/../api/projects/custom-fields).
1954
+ *
1955
+ *
1956
+ */
615
1957
  readonly name: string;
1958
+ /**
1959
+ * If `value` is absent or `null`, this field will be removed if it exists.
1960
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
1961
+ * If `value` is provided, it is set for the field defined by `name`.
1962
+ *
1963
+ *
1964
+ */
616
1965
  readonly value?: any;
617
1966
  }
618
1967
  export interface OrderSetReturnItemCustomTypeAction {
619
1968
  readonly action: 'setReturnItemCustomType';
1969
+ /**
1970
+ *
1971
+ */
620
1972
  readonly returnItemId: string;
1973
+ /**
1974
+ * Defines the [Type](ctp:api:type:Type) that extends the ReturnItem with [Custom Fields](/../api/projects/custom-fields).
1975
+ * If absent, any existing Type and Custom Fields are removed from the ReturnItem.
1976
+ *
1977
+ *
1978
+ */
621
1979
  readonly type?: TypeResourceIdentifier;
1980
+ /**
1981
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ReturnItem.
1982
+ *
1983
+ *
1984
+ */
622
1985
  readonly fields?: FieldContainer;
623
1986
  }
624
1987
  export interface OrderSetReturnPaymentStateAction {
625
1988
  readonly action: 'setReturnPaymentState';
1989
+ /**
1990
+ *
1991
+ */
626
1992
  readonly returnItemId: string;
1993
+ /**
1994
+ *
1995
+ */
627
1996
  readonly paymentState: ReturnPaymentState;
628
1997
  }
629
1998
  export interface OrderSetReturnShipmentStateAction {
630
1999
  readonly action: 'setReturnShipmentState';
2000
+ /**
2001
+ *
2002
+ */
631
2003
  readonly returnItemId: string;
2004
+ /**
2005
+ *
2006
+ */
632
2007
  readonly shipmentState: ReturnShipmentState;
633
2008
  }
634
2009
  export interface OrderSetShippingAddressAction {
635
2010
  readonly action: 'setShippingAddress';
2011
+ /**
2012
+ * Polymorphic base type that represents a postal address and contact details.
2013
+ * Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
2014
+ * only differ in the data type for the optional `custom` field.
2015
+ *
2016
+ *
2017
+ */
636
2018
  readonly address?: _BaseAddress;
637
2019
  }
638
2020
  export interface OrderSetShippingAddressCustomFieldAction {
639
2021
  readonly action: 'setShippingAddressCustomField';
2022
+ /**
2023
+ * Name of the [Custom Field](/../api/projects/custom-fields).
2024
+ *
2025
+ *
2026
+ */
640
2027
  readonly name: string;
2028
+ /**
2029
+ * If `value` is absent or `null`, this field will be removed if it exists.
2030
+ * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
2031
+ * If `value` is provided, it is set for the field defined by `name`.
2032
+ *
2033
+ *
2034
+ */
641
2035
  readonly value?: any;
642
2036
  }
643
2037
  export interface OrderSetShippingAddressCustomTypeAction {
644
2038
  readonly action: 'setShippingAddressCustomType';
2039
+ /**
2040
+ * Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
2041
+ * If absent, any existing Type and Custom Fields are removed from the `shippingAddress`.
2042
+ *
2043
+ *
2044
+ */
645
2045
  readonly type?: TypeResourceIdentifier;
2046
+ /**
2047
+ * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingAddress`.
2048
+ *
2049
+ *
2050
+ */
646
2051
  readonly fields?: FieldContainer;
647
2052
  }
648
2053
  export interface OrderSetStoreAction {
649
2054
  readonly action: 'setStore';
2055
+ /**
2056
+ * [ResourceIdentifier](/../api/types#resourceidentifier) to a [Store](ctp:api:type:Store).
2057
+ *
2058
+ *
2059
+ */
650
2060
  readonly store?: StoreResourceIdentifier;
651
2061
  }
652
2062
  export interface OrderTransitionCustomLineItemStateAction {
653
2063
  readonly action: 'transitionCustomLineItemState';
2064
+ /**
2065
+ *
2066
+ */
654
2067
  readonly customLineItemId: string;
2068
+ /**
2069
+ *
2070
+ */
655
2071
  readonly quantity: number;
2072
+ /**
2073
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
2074
+ *
2075
+ *
2076
+ */
656
2077
  readonly fromState: StateResourceIdentifier;
2078
+ /**
2079
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
2080
+ *
2081
+ *
2082
+ */
657
2083
  readonly toState: StateResourceIdentifier;
2084
+ /**
2085
+ *
2086
+ */
658
2087
  readonly actualTransitionDate?: string;
659
2088
  }
660
2089
  export interface OrderTransitionLineItemStateAction {
661
2090
  readonly action: 'transitionLineItemState';
2091
+ /**
2092
+ *
2093
+ */
662
2094
  readonly lineItemId: string;
2095
+ /**
2096
+ *
2097
+ */
663
2098
  readonly quantity: number;
2099
+ /**
2100
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
2101
+ *
2102
+ *
2103
+ */
664
2104
  readonly fromState: StateResourceIdentifier;
2105
+ /**
2106
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
2107
+ *
2108
+ *
2109
+ */
665
2110
  readonly toState: StateResourceIdentifier;
2111
+ /**
2112
+ *
2113
+ */
666
2114
  readonly actualTransitionDate?: string;
667
2115
  }
668
2116
  export interface OrderTransitionStateAction {
669
2117
  readonly action: 'transitionState';
2118
+ /**
2119
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
2120
+ *
2121
+ *
2122
+ */
670
2123
  readonly state: StateResourceIdentifier;
2124
+ /**
2125
+ *
2126
+ */
671
2127
  readonly force?: boolean;
672
2128
  }
673
2129
  export interface OrderUpdateItemShippingAddressAction {
674
2130
  readonly action: 'updateItemShippingAddress';
2131
+ /**
2132
+ * Polymorphic base type that represents a postal address and contact details.
2133
+ * Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
2134
+ * only differ in the data type for the optional `custom` field.
2135
+ *
2136
+ *
2137
+ */
675
2138
  readonly address: _BaseAddress;
676
2139
  }
677
2140
  export interface OrderUpdateSyncInfoAction {
678
2141
  readonly action: 'updateSyncInfo';
2142
+ /**
2143
+ * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
2144
+ *
2145
+ *
2146
+ */
679
2147
  readonly channel: ChannelResourceIdentifier;
2148
+ /**
2149
+ *
2150
+ */
680
2151
  readonly externalId?: string;
2152
+ /**
2153
+ *
2154
+ */
681
2155
  readonly syncedAt?: string;
682
2156
  }
2157
+ //# sourceMappingURL=order.d.ts.map