@gradientedge/commercetools-utils 5.29.0 → 5.31.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 (307) hide show
  1. package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -1
  2. package/dist/cjs/types/models/approval-flow.d.ts +15 -4
  3. package/dist/cjs/types/models/approval-flow.d.ts.map +1 -1
  4. package/dist/cjs/types/models/approval-flow.js +11 -0
  5. package/dist/cjs/types/models/approval-flow.js.map +1 -1
  6. package/dist/cjs/types/models/approval-rule.d.ts +19 -9
  7. package/dist/cjs/types/models/approval-rule.d.ts.map +1 -1
  8. package/dist/cjs/types/models/approval-rule.js +10 -0
  9. package/dist/cjs/types/models/approval-rule.js.map +1 -1
  10. package/dist/cjs/types/models/associate-role.d.ts +58 -11
  11. package/dist/cjs/types/models/associate-role.d.ts.map +1 -1
  12. package/dist/cjs/types/models/associate-role.js +47 -0
  13. package/dist/cjs/types/models/associate-role.js.map +1 -1
  14. package/dist/cjs/types/models/attribute-group.d.ts +15 -9
  15. package/dist/cjs/types/models/attribute-group.d.ts.map +1 -1
  16. package/dist/cjs/types/models/business-unit-search.d.ts +114 -0
  17. package/dist/cjs/types/models/business-unit-search.d.ts.map +1 -0
  18. package/dist/cjs/types/models/business-unit-search.js +8 -0
  19. package/dist/cjs/types/models/business-unit-search.js.map +1 -0
  20. package/dist/cjs/types/models/business-unit.d.ts +349 -35
  21. package/dist/cjs/types/models/business-unit.d.ts.map +1 -1
  22. package/dist/cjs/types/models/business-unit.js +55 -0
  23. package/dist/cjs/types/models/business-unit.js.map +1 -1
  24. package/dist/cjs/types/models/cart-discount.d.ts +218 -36
  25. package/dist/cjs/types/models/cart-discount.d.ts.map +1 -1
  26. package/dist/cjs/types/models/cart-discount.js +29 -0
  27. package/dist/cjs/types/models/cart-discount.js.map +1 -1
  28. package/dist/cjs/types/models/cart.d.ts +178 -88
  29. package/dist/cjs/types/models/cart.d.ts.map +1 -1
  30. package/dist/cjs/types/models/cart.js +127 -0
  31. package/dist/cjs/types/models/cart.js.map +1 -1
  32. package/dist/cjs/types/models/category.d.ts +32 -26
  33. package/dist/cjs/types/models/category.d.ts.map +1 -1
  34. package/dist/cjs/types/models/channel.d.ts +28 -15
  35. package/dist/cjs/types/models/channel.d.ts.map +1 -1
  36. package/dist/cjs/types/models/channel.js +13 -0
  37. package/dist/cjs/types/models/channel.js.map +1 -1
  38. package/dist/cjs/types/models/common.d.ts +167 -5
  39. package/dist/cjs/types/models/common.d.ts.map +1 -1
  40. package/dist/cjs/types/models/common.js +61 -0
  41. package/dist/cjs/types/models/common.js.map +1 -1
  42. package/dist/cjs/types/models/custom-object.d.ts +2 -2
  43. package/dist/cjs/types/models/custom-object.d.ts.map +1 -1
  44. package/dist/cjs/types/models/customer-group.d.ts +13 -7
  45. package/dist/cjs/types/models/customer-group.d.ts.map +1 -1
  46. package/dist/cjs/types/models/customer.d.ts +53 -39
  47. package/dist/cjs/types/models/customer.d.ts.map +1 -1
  48. package/dist/cjs/types/models/customer.js +11 -0
  49. package/dist/cjs/types/models/customer.js.map +1 -1
  50. package/dist/cjs/types/models/discount-code.d.ts +24 -18
  51. package/dist/cjs/types/models/discount-code.d.ts.map +1 -1
  52. package/dist/cjs/types/models/error.d.ts +193 -167
  53. package/dist/cjs/types/models/error.d.ts.map +1 -1
  54. package/dist/cjs/types/models/extension.d.ts +43 -9
  55. package/dist/cjs/types/models/extension.d.ts.map +1 -1
  56. package/dist/cjs/types/models/extension.js +27 -0
  57. package/dist/cjs/types/models/extension.js.map +1 -1
  58. package/dist/cjs/types/models/graph-ql.d.ts +89 -0
  59. package/dist/cjs/types/models/graph-ql.d.ts.map +1 -0
  60. package/dist/cjs/types/models/graph-ql.js +8 -0
  61. package/dist/cjs/types/models/graph-ql.js.map +1 -0
  62. package/dist/cjs/types/models/index.d.ts +2 -0
  63. package/dist/cjs/types/models/index.d.ts.map +1 -1
  64. package/dist/cjs/types/models/index.js +2 -0
  65. package/dist/cjs/types/models/index.js.map +1 -1
  66. package/dist/cjs/types/models/inventory.d.ts +19 -13
  67. package/dist/cjs/types/models/inventory.d.ts.map +1 -1
  68. package/dist/cjs/types/models/me.d.ts +210 -100
  69. package/dist/cjs/types/models/me.d.ts.map +1 -1
  70. package/dist/cjs/types/models/me.js +10 -0
  71. package/dist/cjs/types/models/me.js.map +1 -1
  72. package/dist/cjs/types/models/message.d.ts +871 -489
  73. package/dist/cjs/types/models/message.d.ts.map +1 -1
  74. package/dist/cjs/types/models/order-edit.d.ts +131 -108
  75. package/dist/cjs/types/models/order-edit.d.ts.map +1 -1
  76. package/dist/cjs/types/models/order.d.ts +211 -69
  77. package/dist/cjs/types/models/order.d.ts.map +1 -1
  78. package/dist/cjs/types/models/order.js +93 -0
  79. package/dist/cjs/types/models/order.js.map +1 -1
  80. package/dist/cjs/types/models/payment.d.ts +42 -23
  81. package/dist/cjs/types/models/payment.d.ts.map +1 -1
  82. package/dist/cjs/types/models/payment.js +20 -0
  83. package/dist/cjs/types/models/payment.js.map +1 -1
  84. package/dist/cjs/types/models/product-discount.d.ts +37 -19
  85. package/dist/cjs/types/models/product-discount.d.ts.map +1 -1
  86. package/dist/cjs/types/models/product-search.d.ts +43 -14
  87. package/dist/cjs/types/models/product-search.d.ts.map +1 -1
  88. package/dist/cjs/types/models/product-search.js +16 -0
  89. package/dist/cjs/types/models/product-search.js.map +1 -1
  90. package/dist/cjs/types/models/product-selection.d.ts +42 -16
  91. package/dist/cjs/types/models/product-selection.d.ts.map +1 -1
  92. package/dist/cjs/types/models/product-selection.js +17 -0
  93. package/dist/cjs/types/models/product-selection.js.map +1 -1
  94. package/dist/cjs/types/models/product-tailoring.d.ts +42 -33
  95. package/dist/cjs/types/models/product-tailoring.d.ts.map +1 -1
  96. package/dist/cjs/types/models/product-type.d.ts +83 -40
  97. package/dist/cjs/types/models/product-type.d.ts.map +1 -1
  98. package/dist/cjs/types/models/product-type.js +48 -0
  99. package/dist/cjs/types/models/product-type.js.map +1 -1
  100. package/dist/cjs/types/models/product.d.ts +97 -59
  101. package/dist/cjs/types/models/product.d.ts.map +1 -1
  102. package/dist/cjs/types/models/product.js +26 -0
  103. package/dist/cjs/types/models/product.js.map +1 -1
  104. package/dist/cjs/types/models/project.d.ts +94 -20
  105. package/dist/cjs/types/models/project.d.ts.map +1 -1
  106. package/dist/cjs/types/models/project.js +73 -0
  107. package/dist/cjs/types/models/project.js.map +1 -1
  108. package/dist/cjs/types/models/quote-request.d.ts +21 -8
  109. package/dist/cjs/types/models/quote-request.d.ts.map +1 -1
  110. package/dist/cjs/types/models/quote-request.js +13 -0
  111. package/dist/cjs/types/models/quote-request.js.map +1 -1
  112. package/dist/cjs/types/models/quote.d.ts +25 -11
  113. package/dist/cjs/types/models/quote.d.ts.map +1 -1
  114. package/dist/cjs/types/models/quote.js +14 -0
  115. package/dist/cjs/types/models/quote.js.map +1 -1
  116. package/dist/cjs/types/models/review.d.ts +20 -14
  117. package/dist/cjs/types/models/review.d.ts.map +1 -1
  118. package/dist/cjs/types/models/search.d.ts +62 -4
  119. package/dist/cjs/types/models/search.d.ts.map +1 -1
  120. package/dist/cjs/types/models/search.js +51 -0
  121. package/dist/cjs/types/models/search.js.map +1 -1
  122. package/dist/cjs/types/models/shipping-method.d.ts +38 -21
  123. package/dist/cjs/types/models/shipping-method.d.ts.map +1 -1
  124. package/dist/cjs/types/models/shipping-method.js +7 -0
  125. package/dist/cjs/types/models/shipping-method.js.map +1 -1
  126. package/dist/cjs/types/models/shopping-list.d.ts +66 -28
  127. package/dist/cjs/types/models/shopping-list.d.ts.map +1 -1
  128. package/dist/cjs/types/models/staged-quote.d.ts +21 -10
  129. package/dist/cjs/types/models/staged-quote.d.ts.map +1 -1
  130. package/dist/cjs/types/models/staged-quote.js +11 -0
  131. package/dist/cjs/types/models/staged-quote.js.map +1 -1
  132. package/dist/cjs/types/models/standalone-price.d.ts +23 -17
  133. package/dist/cjs/types/models/standalone-price.d.ts.map +1 -1
  134. package/dist/cjs/types/models/state.d.ts +33 -13
  135. package/dist/cjs/types/models/state.d.ts.map +1 -1
  136. package/dist/cjs/types/models/state.js +25 -0
  137. package/dist/cjs/types/models/state.js.map +1 -1
  138. package/dist/cjs/types/models/store.d.ts +29 -23
  139. package/dist/cjs/types/models/store.d.ts.map +1 -1
  140. package/dist/cjs/types/models/subscription.d.ts +138 -18
  141. package/dist/cjs/types/models/subscription.d.ts.map +1 -1
  142. package/dist/cjs/types/models/subscription.js +95 -0
  143. package/dist/cjs/types/models/subscription.js.map +1 -1
  144. package/dist/cjs/types/models/tax-category.d.ts +15 -9
  145. package/dist/cjs/types/models/tax-category.d.ts.map +1 -1
  146. package/dist/cjs/types/models/type.d.ts +101 -29
  147. package/dist/cjs/types/models/type.d.ts.map +1 -1
  148. package/dist/cjs/types/models/type.js +76 -0
  149. package/dist/cjs/types/models/type.js.map +1 -1
  150. package/dist/cjs/types/models/warning.d.ts +15 -1
  151. package/dist/cjs/types/models/warning.d.ts.map +1 -1
  152. package/dist/cjs/types/models/zone.d.ts +14 -8
  153. package/dist/cjs/types/models/zone.d.ts.map +1 -1
  154. package/dist/mjs/tsconfig.tsbuildinfo +1 -1
  155. package/dist/mjs/types/models/approval-flow.d.ts +15 -4
  156. package/dist/mjs/types/models/approval-flow.d.ts.map +1 -1
  157. package/dist/mjs/types/models/approval-flow.js +10 -1
  158. package/dist/mjs/types/models/approval-flow.js.map +1 -1
  159. package/dist/mjs/types/models/approval-rule.d.ts +19 -9
  160. package/dist/mjs/types/models/approval-rule.d.ts.map +1 -1
  161. package/dist/mjs/types/models/approval-rule.js +9 -1
  162. package/dist/mjs/types/models/approval-rule.js.map +1 -1
  163. package/dist/mjs/types/models/associate-role.d.ts +58 -11
  164. package/dist/mjs/types/models/associate-role.d.ts.map +1 -1
  165. package/dist/mjs/types/models/associate-role.js +46 -1
  166. package/dist/mjs/types/models/associate-role.js.map +1 -1
  167. package/dist/mjs/types/models/attribute-group.d.ts +15 -9
  168. package/dist/mjs/types/models/attribute-group.d.ts.map +1 -1
  169. package/dist/mjs/types/models/business-unit-search.d.ts +114 -0
  170. package/dist/mjs/types/models/business-unit-search.d.ts.map +1 -0
  171. package/dist/mjs/types/models/business-unit-search.js +7 -0
  172. package/dist/mjs/types/models/business-unit-search.js.map +1 -0
  173. package/dist/mjs/types/models/business-unit.d.ts +349 -35
  174. package/dist/mjs/types/models/business-unit.d.ts.map +1 -1
  175. package/dist/mjs/types/models/business-unit.js +54 -1
  176. package/dist/mjs/types/models/business-unit.js.map +1 -1
  177. package/dist/mjs/types/models/cart-discount.d.ts +218 -36
  178. package/dist/mjs/types/models/cart-discount.d.ts.map +1 -1
  179. package/dist/mjs/types/models/cart-discount.js +28 -1
  180. package/dist/mjs/types/models/cart-discount.js.map +1 -1
  181. package/dist/mjs/types/models/cart.d.ts +178 -88
  182. package/dist/mjs/types/models/cart.d.ts.map +1 -1
  183. package/dist/mjs/types/models/cart.js +126 -1
  184. package/dist/mjs/types/models/cart.js.map +1 -1
  185. package/dist/mjs/types/models/category.d.ts +32 -26
  186. package/dist/mjs/types/models/category.d.ts.map +1 -1
  187. package/dist/mjs/types/models/channel.d.ts +28 -15
  188. package/dist/mjs/types/models/channel.d.ts.map +1 -1
  189. package/dist/mjs/types/models/channel.js +12 -1
  190. package/dist/mjs/types/models/channel.js.map +1 -1
  191. package/dist/mjs/types/models/common.d.ts +167 -5
  192. package/dist/mjs/types/models/common.d.ts.map +1 -1
  193. package/dist/mjs/types/models/common.js +60 -1
  194. package/dist/mjs/types/models/common.js.map +1 -1
  195. package/dist/mjs/types/models/custom-object.d.ts +2 -2
  196. package/dist/mjs/types/models/custom-object.d.ts.map +1 -1
  197. package/dist/mjs/types/models/customer-group.d.ts +13 -7
  198. package/dist/mjs/types/models/customer-group.d.ts.map +1 -1
  199. package/dist/mjs/types/models/customer.d.ts +53 -39
  200. package/dist/mjs/types/models/customer.d.ts.map +1 -1
  201. package/dist/mjs/types/models/customer.js +10 -1
  202. package/dist/mjs/types/models/customer.js.map +1 -1
  203. package/dist/mjs/types/models/discount-code.d.ts +24 -18
  204. package/dist/mjs/types/models/discount-code.d.ts.map +1 -1
  205. package/dist/mjs/types/models/error.d.ts +193 -167
  206. package/dist/mjs/types/models/error.d.ts.map +1 -1
  207. package/dist/mjs/types/models/extension.d.ts +43 -9
  208. package/dist/mjs/types/models/extension.d.ts.map +1 -1
  209. package/dist/mjs/types/models/extension.js +26 -1
  210. package/dist/mjs/types/models/extension.js.map +1 -1
  211. package/dist/mjs/types/models/graph-ql.d.ts +89 -0
  212. package/dist/mjs/types/models/graph-ql.d.ts.map +1 -0
  213. package/dist/mjs/types/models/graph-ql.js +7 -0
  214. package/dist/mjs/types/models/graph-ql.js.map +1 -0
  215. package/dist/mjs/types/models/index.d.ts +2 -0
  216. package/dist/mjs/types/models/index.d.ts.map +1 -1
  217. package/dist/mjs/types/models/index.js +2 -0
  218. package/dist/mjs/types/models/index.js.map +1 -1
  219. package/dist/mjs/types/models/inventory.d.ts +19 -13
  220. package/dist/mjs/types/models/inventory.d.ts.map +1 -1
  221. package/dist/mjs/types/models/me.d.ts +210 -100
  222. package/dist/mjs/types/models/me.d.ts.map +1 -1
  223. package/dist/mjs/types/models/me.js +9 -1
  224. package/dist/mjs/types/models/me.js.map +1 -1
  225. package/dist/mjs/types/models/message.d.ts +871 -489
  226. package/dist/mjs/types/models/message.d.ts.map +1 -1
  227. package/dist/mjs/types/models/order-edit.d.ts +131 -108
  228. package/dist/mjs/types/models/order-edit.d.ts.map +1 -1
  229. package/dist/mjs/types/models/order.d.ts +211 -69
  230. package/dist/mjs/types/models/order.d.ts.map +1 -1
  231. package/dist/mjs/types/models/order.js +92 -1
  232. package/dist/mjs/types/models/order.js.map +1 -1
  233. package/dist/mjs/types/models/payment.d.ts +42 -23
  234. package/dist/mjs/types/models/payment.d.ts.map +1 -1
  235. package/dist/mjs/types/models/payment.js +19 -1
  236. package/dist/mjs/types/models/payment.js.map +1 -1
  237. package/dist/mjs/types/models/product-discount.d.ts +37 -19
  238. package/dist/mjs/types/models/product-discount.d.ts.map +1 -1
  239. package/dist/mjs/types/models/product-search.d.ts +43 -14
  240. package/dist/mjs/types/models/product-search.d.ts.map +1 -1
  241. package/dist/mjs/types/models/product-search.js +15 -1
  242. package/dist/mjs/types/models/product-search.js.map +1 -1
  243. package/dist/mjs/types/models/product-selection.d.ts +42 -16
  244. package/dist/mjs/types/models/product-selection.d.ts.map +1 -1
  245. package/dist/mjs/types/models/product-selection.js +16 -1
  246. package/dist/mjs/types/models/product-selection.js.map +1 -1
  247. package/dist/mjs/types/models/product-tailoring.d.ts +42 -33
  248. package/dist/mjs/types/models/product-tailoring.d.ts.map +1 -1
  249. package/dist/mjs/types/models/product-type.d.ts +83 -40
  250. package/dist/mjs/types/models/product-type.d.ts.map +1 -1
  251. package/dist/mjs/types/models/product-type.js +47 -1
  252. package/dist/mjs/types/models/product-type.js.map +1 -1
  253. package/dist/mjs/types/models/product.d.ts +97 -59
  254. package/dist/mjs/types/models/product.d.ts.map +1 -1
  255. package/dist/mjs/types/models/product.js +25 -1
  256. package/dist/mjs/types/models/product.js.map +1 -1
  257. package/dist/mjs/types/models/project.d.ts +94 -20
  258. package/dist/mjs/types/models/project.d.ts.map +1 -1
  259. package/dist/mjs/types/models/project.js +72 -1
  260. package/dist/mjs/types/models/project.js.map +1 -1
  261. package/dist/mjs/types/models/quote-request.d.ts +21 -8
  262. package/dist/mjs/types/models/quote-request.d.ts.map +1 -1
  263. package/dist/mjs/types/models/quote-request.js +12 -1
  264. package/dist/mjs/types/models/quote-request.js.map +1 -1
  265. package/dist/mjs/types/models/quote.d.ts +25 -11
  266. package/dist/mjs/types/models/quote.d.ts.map +1 -1
  267. package/dist/mjs/types/models/quote.js +13 -1
  268. package/dist/mjs/types/models/quote.js.map +1 -1
  269. package/dist/mjs/types/models/review.d.ts +20 -14
  270. package/dist/mjs/types/models/review.d.ts.map +1 -1
  271. package/dist/mjs/types/models/search.d.ts +62 -4
  272. package/dist/mjs/types/models/search.d.ts.map +1 -1
  273. package/dist/mjs/types/models/search.js +50 -1
  274. package/dist/mjs/types/models/search.js.map +1 -1
  275. package/dist/mjs/types/models/shipping-method.d.ts +38 -21
  276. package/dist/mjs/types/models/shipping-method.d.ts.map +1 -1
  277. package/dist/mjs/types/models/shipping-method.js +6 -1
  278. package/dist/mjs/types/models/shipping-method.js.map +1 -1
  279. package/dist/mjs/types/models/shopping-list.d.ts +66 -28
  280. package/dist/mjs/types/models/shopping-list.d.ts.map +1 -1
  281. package/dist/mjs/types/models/staged-quote.d.ts +21 -10
  282. package/dist/mjs/types/models/staged-quote.d.ts.map +1 -1
  283. package/dist/mjs/types/models/staged-quote.js +10 -1
  284. package/dist/mjs/types/models/staged-quote.js.map +1 -1
  285. package/dist/mjs/types/models/standalone-price.d.ts +23 -17
  286. package/dist/mjs/types/models/standalone-price.d.ts.map +1 -1
  287. package/dist/mjs/types/models/state.d.ts +33 -13
  288. package/dist/mjs/types/models/state.d.ts.map +1 -1
  289. package/dist/mjs/types/models/state.js +24 -1
  290. package/dist/mjs/types/models/state.js.map +1 -1
  291. package/dist/mjs/types/models/store.d.ts +29 -23
  292. package/dist/mjs/types/models/store.d.ts.map +1 -1
  293. package/dist/mjs/types/models/subscription.d.ts +138 -18
  294. package/dist/mjs/types/models/subscription.d.ts.map +1 -1
  295. package/dist/mjs/types/models/subscription.js +94 -1
  296. package/dist/mjs/types/models/subscription.js.map +1 -1
  297. package/dist/mjs/types/models/tax-category.d.ts +15 -9
  298. package/dist/mjs/types/models/tax-category.d.ts.map +1 -1
  299. package/dist/mjs/types/models/type.d.ts +101 -29
  300. package/dist/mjs/types/models/type.d.ts.map +1 -1
  301. package/dist/mjs/types/models/type.js +75 -1
  302. package/dist/mjs/types/models/type.js.map +1 -1
  303. package/dist/mjs/types/models/warning.d.ts +15 -1
  304. package/dist/mjs/types/models/warning.d.ts.map +1 -1
  305. package/dist/mjs/types/models/zone.d.ts +14 -8
  306. package/dist/mjs/types/models/zone.d.ts.map +1 -1
  307. package/package.json +2 -2
@@ -3,7 +3,7 @@
3
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
4
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
5
  */
6
- import { AssociateDraft, AssociateRoleAssignmentDraft, BusinessUnitResourceIdentifier, BusinessUnitUpdateAction } from './business-unit.js';
6
+ import { AssociateDraft, AssociateRoleAssignmentDraft, BusinessUnitResourceIdentifier, BusinessUnitType, BusinessUnitUpdateAction } from './business-unit.js';
7
7
  import { CartReference, ExternalLineItemTotalPrice, ExternalTaxRateDraft, InventoryMode, ItemShippingDetailsDraft, ItemShippingTarget, ShippingMode, TaxMode } from './cart.js';
8
8
  import { ChannelResourceIdentifier } from './channel.js';
9
9
  import { BaseAddress, CentPrecisionMoney, LocalizedString, _BaseAddress, _Money } from './common.js';
@@ -37,6 +37,70 @@ export interface MyBusinessUnitAssociateDraft {
37
37
  readonly associateRoleAssignments: AssociateRoleAssignmentDraft[];
38
38
  }
39
39
  export type MyBusinessUnitDraft = MyCompanyDraft | MyDivisionDraft;
40
+ export interface IMyBusinessUnitDraft {
41
+ /**
42
+ * User-defined unique identifier for the BusinessUnit.
43
+ *
44
+ *
45
+ */
46
+ readonly key: string;
47
+ /**
48
+ * Type of the Business Unit indicating its position in a hierarchy.
49
+ *
50
+ *
51
+ */
52
+ readonly unitType: BusinessUnitType;
53
+ /**
54
+ * Name of the Business Unit.
55
+ *
56
+ *
57
+ */
58
+ readonly name: string;
59
+ /**
60
+ * Email address of the Business Unit.
61
+ *
62
+ *
63
+ */
64
+ readonly contactEmail?: string;
65
+ /**
66
+ * Custom Fields for the Business Unit.
67
+ *
68
+ *
69
+ */
70
+ readonly custom?: CustomFieldsDraft;
71
+ /**
72
+ * Addresses used by the Business Unit.
73
+ *
74
+ *
75
+ */
76
+ readonly addresses?: BaseAddress[];
77
+ /**
78
+ * Indexes of entries in `addresses` to set as shipping addresses.
79
+ * The `shippingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
80
+ *
81
+ *
82
+ */
83
+ readonly shippingAddresses?: number[];
84
+ /**
85
+ * Index of the entry in `addresses` to set as the default shipping address.
86
+ *
87
+ *
88
+ */
89
+ readonly defaultShippingAddress?: number;
90
+ /**
91
+ * Indexes of entries in `addresses` to set as billing addresses.
92
+ * The `billingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
93
+ *
94
+ *
95
+ */
96
+ readonly billingAddresses?: number[];
97
+ /**
98
+ * Index of the entry in `addresses` to set as the default billing address.
99
+ *
100
+ *
101
+ */
102
+ readonly defaultBillingAddress?: number;
103
+ }
40
104
  export interface MyBusinessUnitUpdate {
41
105
  /**
42
106
  * Expected version of the BusinessUnit on which the changes should be applied.
@@ -53,6 +117,12 @@ export interface MyBusinessUnitUpdate {
53
117
  readonly actions: BusinessUnitUpdateAction[];
54
118
  }
55
119
  export type MyBusinessUnitUpdateAction = MyBusinessUnitAddAddressAction | MyBusinessUnitAddBillingAddressIdAction | MyBusinessUnitAddShippingAddressIdAction | MyBusinessUnitChangeAddressAction | MyBusinessUnitChangeAssociateAction | MyBusinessUnitChangeNameAction | MyBusinessUnitChangeParentUnitAction | MyBusinessUnitRemoveAddressAction | MyBusinessUnitRemoveAssociateAction | MyBusinessUnitRemoveBillingAddressIdAction | MyBusinessUnitRemoveShippingAddressIdAction | MyBusinessUnitSetAddressCustomFieldAction | MyBusinessUnitSetAddressCustomTypeAction | MyBusinessUnitSetContactEmailAction | MyBusinessUnitSetCustomFieldAction | MyBusinessUnitSetCustomTypeAction | MyBusinessUnitSetDefaultBillingAddressAction | MyBusinessUnitSetDefaultShippingAddressAction;
120
+ export interface IMyBusinessUnitUpdateAction {
121
+ /**
122
+ *
123
+ */
124
+ readonly action: string;
125
+ }
56
126
  /**
57
127
  * The `customerId` is determined by a [password flow token](/../api/authorization#password-flow) and
58
128
  * automatically set on the resulting [Cart](ctp:api:type:Cart).
@@ -188,12 +258,18 @@ export interface MyCartUpdate {
188
258
  readonly actions: MyCartUpdateAction[];
189
259
  }
190
260
  export type MyCartUpdateAction = MyCartAddDiscountCodeAction | MyCartAddItemShippingAddressAction | MyCartAddLineItemAction | MyCartAddPaymentAction | MyCartApplyDeltaToLineItemShippingDetailsTargetsAction | MyCartChangeLineItemQuantityAction | MyCartChangeLineItemsOrderAction | MyCartChangeTaxModeAction | MyCartRecalculateAction | MyCartRemoveDiscountCodeAction | MyCartRemoveItemShippingAddressAction | MyCartRemoveLineItemAction | MyCartRemovePaymentAction | MyCartSetBillingAddressAction | MyCartSetBusinessUnitAction | MyCartSetCountryAction | MyCartSetCustomFieldAction | MyCartSetCustomTypeAction | MyCartSetCustomerEmailAction | MyCartSetDeleteDaysAfterLastModificationAction | MyCartSetLineItemCustomFieldAction | MyCartSetLineItemCustomTypeAction | MyCartSetLineItemDistributionChannelAction | MyCartSetLineItemShippingDetailsAction | MyCartSetLineItemSupplyChannelAction | MyCartSetLocaleAction | MyCartSetShippingAddressAction | MyCartSetShippingMethodAction | MyCartUpdateItemShippingAddressAction;
261
+ export interface IMyCartUpdateAction {
262
+ /**
263
+ *
264
+ */
265
+ readonly action: string;
266
+ }
191
267
  /**
192
268
  * Draft type to represent the top level of a business.
193
269
  * Contains the fields and values of the generic [MyBusinessUnitDraft](ctp:api:type:BusinessUnitDraft) that are used specifically for creating a [Company](ctp:api:type:Company).
194
270
  *
195
271
  */
196
- export interface MyCompanyDraft {
272
+ export interface MyCompanyDraft extends IMyBusinessUnitDraft {
197
273
  readonly unitType: 'Company';
198
274
  /**
199
275
  * User-defined unique identifier for the BusinessUnit.
@@ -369,12 +445,18 @@ export interface MyCustomerUpdate {
369
445
  readonly actions: MyCustomerUpdateAction[];
370
446
  }
371
447
  export type MyCustomerUpdateAction = MyCustomerAddAddressAction | MyCustomerAddBillingAddressIdAction | MyCustomerAddShippingAddressIdAction | MyCustomerChangeAddressAction | MyCustomerChangeEmailAction | MyCustomerRemoveAddressAction | MyCustomerRemoveBillingAddressIdAction | MyCustomerRemoveShippingAddressIdAction | MyCustomerSetCompanyNameAction | MyCustomerSetCustomFieldAction | MyCustomerSetCustomTypeAction | MyCustomerSetDateOfBirthAction | MyCustomerSetDefaultBillingAddressAction | MyCustomerSetDefaultShippingAddressAction | MyCustomerSetFirstNameAction | MyCustomerSetLastNameAction | MyCustomerSetLocaleAction | MyCustomerSetMiddleNameAction | MyCustomerSetSalutationAction | MyCustomerSetTitleAction | MyCustomerSetVatIdAction;
448
+ export interface IMyCustomerUpdateAction {
449
+ /**
450
+ *
451
+ */
452
+ readonly action: string;
453
+ }
372
454
  /**
373
455
  * Draft type to model divisions that are part of the [Company](ctp:api:type:Company) or a higher-order [Division](ctp:api:type:Division).
374
456
  * Contains the fields and values of the generic [MyBusinessUnitDraft](ctp:api:type:MyBusinessUnitDraft) that are used specifically for creating a Division.
375
457
  *
376
458
  */
377
- export interface MyDivisionDraft {
459
+ export interface MyDivisionDraft extends IMyBusinessUnitDraft {
378
460
  readonly unitType: 'Division';
379
461
  /**
380
462
  * User-defined unique identifier for the BusinessUnit.
@@ -682,6 +764,12 @@ export interface MyPaymentUpdate {
682
764
  readonly actions: MyPaymentUpdateAction[];
683
765
  }
684
766
  export type MyPaymentUpdateAction = MyPaymentAddTransactionAction | MyPaymentChangeAmountPlannedAction | MyPaymentSetCustomFieldAction | MyPaymentSetMethodInfoInterfaceAction | MyPaymentSetMethodInfoMethodAction | MyPaymentSetMethodInfoNameAction | MyPaymentSetTransactionCustomFieldAction;
767
+ export interface IMyPaymentUpdateAction {
768
+ /**
769
+ *
770
+ */
771
+ readonly action: string;
772
+ }
685
773
  export interface MyQuoteRequestDraft {
686
774
  /**
687
775
  * `id` of the Cart from which the Quote Request is created. Carts with [Discount Codes](ctp:api:type:DiscountCode) and Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode) are not supported.
@@ -712,10 +800,20 @@ export interface MyQuoteRequestUpdate {
712
800
  readonly actions: MyQuoteRequestUpdateAction[];
713
801
  }
714
802
  export type MyQuoteRequestUpdateAction = MyQuoteRequestCancelAction;
803
+ export interface IMyQuoteRequestUpdateAction {
804
+ /**
805
+ *
806
+ */
807
+ readonly action: string;
808
+ }
715
809
  /**
716
810
  * [QuoteStates](ctp:api:type:QuoteState) that can be set using the [Change My Quote State](ctp:api:type:MyQuoteChangeMyQuoteStateAction) update action.
717
811
  *
718
812
  */
813
+ export declare enum MyQuoteStateValues {
814
+ Accepted = "Accepted",
815
+ Declined = "Declined"
816
+ }
719
817
  export type MyQuoteState = 'Accepted' | 'Declined' | string;
720
818
  export interface MyQuoteUpdate {
721
819
  /**
@@ -733,6 +831,12 @@ export interface MyQuoteUpdate {
733
831
  readonly actions: MyQuoteUpdateAction[];
734
832
  }
735
833
  export type MyQuoteUpdateAction = MyQuoteChangeMyQuoteStateAction;
834
+ export interface IMyQuoteUpdateAction {
835
+ /**
836
+ *
837
+ */
838
+ readonly action: string;
839
+ }
736
840
  /**
737
841
  * A [MyShoppingListDraft](ctp:api:type:MyShoppingListDraft) is the object submitted as payload to the [Create MyShoppingList request](ctp:api:endpoint:/{projectKey}/me/shopping-lists:POST).
738
842
  * The `customer` field of [ShoppingList](ctp:api:type:ShoppingList) is automatically set with
@@ -801,6 +905,12 @@ export interface MyShoppingListUpdate {
801
905
  readonly actions: MyShoppingListUpdateAction[];
802
906
  }
803
907
  export type MyShoppingListUpdateAction = MyShoppingListAddLineItemAction | MyShoppingListAddTextLineItemAction | MyShoppingListChangeLineItemQuantityAction | MyShoppingListChangeLineItemsOrderAction | MyShoppingListChangeNameAction | MyShoppingListChangeTextLineItemNameAction | MyShoppingListChangeTextLineItemQuantityAction | MyShoppingListChangeTextLineItemsOrderAction | MyShoppingListRemoveLineItemAction | MyShoppingListRemoveTextLineItemAction | MyShoppingListSetCustomFieldAction | MyShoppingListSetCustomTypeAction | MyShoppingListSetDeleteDaysAfterLastModificationAction | MyShoppingListSetDescriptionAction | MyShoppingListSetLineItemCustomFieldAction | MyShoppingListSetLineItemCustomTypeAction | MyShoppingListSetTextLineItemCustomFieldAction | MyShoppingListSetTextLineItemCustomTypeAction | MyShoppingListSetTextLineItemDescriptionAction;
908
+ export interface IMyShoppingListUpdateAction {
909
+ /**
910
+ *
911
+ */
912
+ readonly action: string;
913
+ }
804
914
  export interface MyTransactionDraft {
805
915
  /**
806
916
  * Date and time (UTC) the Transaction took place.
@@ -847,7 +957,7 @@ export interface ReplicaMyCartDraft {
847
957
  * Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message.
848
958
  *
849
959
  */
850
- export interface MyBusinessUnitAddAddressAction {
960
+ export interface MyBusinessUnitAddAddressAction extends IMyBusinessUnitUpdateAction {
851
961
  readonly action: 'addAddress';
852
962
  /**
853
963
  * The address to add to `addresses`.
@@ -860,7 +970,7 @@ export interface MyBusinessUnitAddAddressAction {
860
970
  * Adding a billing address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressAdded](ctp:api:type:BusinessUnitBillingAddressAddedMessage) Message.
861
971
  *
862
972
  */
863
- export interface MyBusinessUnitAddBillingAddressIdAction {
973
+ export interface MyBusinessUnitAddBillingAddressIdAction extends IMyBusinessUnitUpdateAction {
864
974
  readonly action: 'addBillingAddressId';
865
975
  /**
866
976
  * ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
@@ -879,7 +989,7 @@ export interface MyBusinessUnitAddBillingAddressIdAction {
879
989
  * Adding a shipping address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressAdded](ctp:api:type:BusinessUnitShippingAddressAddedMessage) Message.
880
990
  *
881
991
  */
882
- export interface MyBusinessUnitAddShippingAddressIdAction {
992
+ export interface MyBusinessUnitAddShippingAddressIdAction extends IMyBusinessUnitUpdateAction {
883
993
  readonly action: 'addShippingAddressId';
884
994
  /**
885
995
  * ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
@@ -898,7 +1008,7 @@ export interface MyBusinessUnitAddShippingAddressIdAction {
898
1008
  * Changing the address on a Business Unit generates the [BusinessUnitAddressChanged](ctp:api:type:BusinessUnitAddressChangedMessage) Message.
899
1009
  *
900
1010
  */
901
- export interface MyBusinessUnitChangeAddressAction {
1011
+ export interface MyBusinessUnitChangeAddressAction extends IMyBusinessUnitUpdateAction {
902
1012
  readonly action: 'changeAddress';
903
1013
  /**
904
1014
  * ID of the address to change. Either `addressId` or `addressKey` is required.
@@ -923,7 +1033,7 @@ export interface MyBusinessUnitChangeAddressAction {
923
1033
  * Updating the [Associate](ctp:api:type:Associate) on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAssociateChanged](ctp:api:type:BusinessUnitAssociateChangedMessage) Message.
924
1034
  *
925
1035
  */
926
- export interface MyBusinessUnitChangeAssociateAction {
1036
+ export interface MyBusinessUnitChangeAssociateAction extends IMyBusinessUnitUpdateAction {
927
1037
  readonly action: 'changeAssociate';
928
1038
  /**
929
1039
  * The Associate to add.
@@ -936,7 +1046,7 @@ export interface MyBusinessUnitChangeAssociateAction {
936
1046
  * Updating the name on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitNameChanged](ctp:api:type:BusinessUnitNameChangedMessage) Message.
937
1047
  *
938
1048
  */
939
- export interface MyBusinessUnitChangeNameAction {
1049
+ export interface MyBusinessUnitChangeNameAction extends IMyBusinessUnitUpdateAction {
940
1050
  readonly action: 'changeName';
941
1051
  /**
942
1052
  * New name to set.
@@ -949,7 +1059,7 @@ export interface MyBusinessUnitChangeNameAction {
949
1059
  * Changing the parent of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitParentChanged](ctp:api:type:BusinessUnitParentChangedMessage) Message.
950
1060
  *
951
1061
  */
952
- export interface MyBusinessUnitChangeParentUnitAction {
1062
+ export interface MyBusinessUnitChangeParentUnitAction extends IMyBusinessUnitUpdateAction {
953
1063
  readonly action: 'changeParentUnit';
954
1064
  /**
955
1065
  * New parent unit of the [Business Unit](ctp:api:type:BusinessUnit). The new parent unit must have the same top-level unit as the old parent unit.
@@ -962,7 +1072,7 @@ export interface MyBusinessUnitChangeParentUnitAction {
962
1072
  * Removing the address from a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAddressRemoved](ctp:api:type:BusinessUnitAddressRemovedMessage) Message.
963
1073
  *
964
1074
  */
965
- export interface MyBusinessUnitRemoveAddressAction {
1075
+ export interface MyBusinessUnitRemoveAddressAction extends IMyBusinessUnitUpdateAction {
966
1076
  readonly action: 'removeAddress';
967
1077
  /**
968
1078
  * ID of the address to be removed. Either `addressId` or `addressKey` is required.
@@ -981,7 +1091,7 @@ export interface MyBusinessUnitRemoveAddressAction {
981
1091
  * Removing an [Associate](ctp:api:type:Associate) from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateRemoved](ctp:api:type:BusinessUnitAssociateRemovedMessage) Message.
982
1092
  *
983
1093
  */
984
- export interface MyBusinessUnitRemoveAssociateAction {
1094
+ export interface MyBusinessUnitRemoveAssociateAction extends IMyBusinessUnitUpdateAction {
985
1095
  readonly action: 'removeAssociate';
986
1096
  /**
987
1097
  * [Associate](ctp:api:type:Associate) to remove.
@@ -994,7 +1104,7 @@ export interface MyBusinessUnitRemoveAssociateAction {
994
1104
  * Removing a billing address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressRemoved](ctp:api:type:BusinessUnitBillingAddressRemovedMessage) Message.
995
1105
  *
996
1106
  */
997
- export interface MyBusinessUnitRemoveBillingAddressIdAction {
1107
+ export interface MyBusinessUnitRemoveBillingAddressIdAction extends IMyBusinessUnitUpdateAction {
998
1108
  readonly action: 'removeBillingAddressId';
999
1109
  /**
1000
1110
  * ID of the billing address to be removed. Either `addressId` or `addressKey` is required.
@@ -1013,7 +1123,7 @@ export interface MyBusinessUnitRemoveBillingAddressIdAction {
1013
1123
  * Removing a shipping address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressRemoved](ctp:api:type:BusinessUnitShippingAddressRemovedMessage) Message.
1014
1124
  *
1015
1125
  */
1016
- export interface MyBusinessUnitRemoveShippingAddressIdAction {
1126
+ export interface MyBusinessUnitRemoveShippingAddressIdAction extends IMyBusinessUnitUpdateAction {
1017
1127
  readonly action: 'removeShippingAddressId';
1018
1128
  /**
1019
1129
  * ID of the shipping address to be removed. Either `addressId` or `addressKey` is required.
@@ -1032,7 +1142,7 @@ export interface MyBusinessUnitRemoveShippingAddressIdAction {
1032
1142
  * Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message.
1033
1143
  *
1034
1144
  */
1035
- export interface MyBusinessUnitSetAddressCustomFieldAction {
1145
+ export interface MyBusinessUnitSetAddressCustomFieldAction extends IMyBusinessUnitUpdateAction {
1036
1146
  readonly action: 'setAddressCustomField';
1037
1147
  /**
1038
1148
  * ID of the `address` to be extended.
@@ -1059,7 +1169,7 @@ export interface MyBusinessUnitSetAddressCustomFieldAction {
1059
1169
  * Adding or updating a Custom Type to an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message.
1060
1170
  *
1061
1171
  */
1062
- export interface MyBusinessUnitSetAddressCustomTypeAction {
1172
+ export interface MyBusinessUnitSetAddressCustomTypeAction extends IMyBusinessUnitUpdateAction {
1063
1173
  readonly action: 'setAddressCustomType';
1064
1174
  /**
1065
1175
  * Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
@@ -1085,7 +1195,7 @@ export interface MyBusinessUnitSetAddressCustomTypeAction {
1085
1195
  * Setting the contact email on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitContactEmailSet](ctp:api:type:BusinessUnitContactEmailSetMessage) Message.
1086
1196
  *
1087
1197
  */
1088
- export interface MyBusinessUnitSetContactEmailAction {
1198
+ export interface MyBusinessUnitSetContactEmailAction extends IMyBusinessUnitUpdateAction {
1089
1199
  readonly action: 'setContactEmail';
1090
1200
  /**
1091
1201
  * Email to set.
@@ -1099,7 +1209,7 @@ export interface MyBusinessUnitSetContactEmailAction {
1099
1209
  * Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message.
1100
1210
  *
1101
1211
  */
1102
- export interface MyBusinessUnitSetCustomFieldAction {
1212
+ export interface MyBusinessUnitSetCustomFieldAction extends IMyBusinessUnitUpdateAction {
1103
1213
  readonly action: 'setCustomField';
1104
1214
  /**
1105
1215
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -1120,7 +1230,7 @@ export interface MyBusinessUnitSetCustomFieldAction {
1120
1230
  * Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message.
1121
1231
  *
1122
1232
  */
1123
- export interface MyBusinessUnitSetCustomTypeAction {
1233
+ export interface MyBusinessUnitSetCustomTypeAction extends IMyBusinessUnitUpdateAction {
1124
1234
  readonly action: 'setCustomType';
1125
1235
  /**
1126
1236
  * Defines the [Type](ctp:api:type:Type) that extends the BusinessUnit with [Custom Fields](/../api/projects/custom-fields).
@@ -1140,7 +1250,7 @@ export interface MyBusinessUnitSetCustomTypeAction {
1140
1250
  * Setting the default billing address on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitDefaultBillingAddressSet](ctp:api:type:BusinessUnitDefaultBillingAddressSetMessage) Message.
1141
1251
  *
1142
1252
  */
1143
- export interface MyBusinessUnitSetDefaultBillingAddressAction {
1253
+ export interface MyBusinessUnitSetDefaultBillingAddressAction extends IMyBusinessUnitUpdateAction {
1144
1254
  readonly action: 'setDefaultBillingAddress';
1145
1255
  /**
1146
1256
  * ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
@@ -1159,7 +1269,7 @@ export interface MyBusinessUnitSetDefaultBillingAddressAction {
1159
1269
  * Setting the default shipping address on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitDefaultShippingAddressSet](ctp:api:type:BusinessUnitDefaultShippingAddressSetMessage) Message.
1160
1270
  *
1161
1271
  */
1162
- export interface MyBusinessUnitSetDefaultShippingAddressAction {
1272
+ export interface MyBusinessUnitSetDefaultShippingAddressAction extends IMyBusinessUnitUpdateAction {
1163
1273
  readonly action: 'setDefaultShippingAddress';
1164
1274
  /**
1165
1275
  * ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
@@ -1184,7 +1294,7 @@ export interface MyBusinessUnitSetDefaultShippingAddressAction {
1184
1294
  * Specific Error Code: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError)
1185
1295
  *
1186
1296
  */
1187
- export interface MyCartAddDiscountCodeAction {
1297
+ export interface MyCartAddDiscountCodeAction extends IMyCartUpdateAction {
1188
1298
  readonly action: 'addDiscountCode';
1189
1299
  /**
1190
1300
  * `code` of a [DiscountCode](ctp:api:type:DiscountCode).
@@ -1197,12 +1307,12 @@ export interface MyCartAddDiscountCodeAction {
1197
1307
  * Adds an address to a Cart when shipping to multiple addresses is desired.
1198
1308
  *
1199
1309
  */
1200
- export interface MyCartAddItemShippingAddressAction {
1310
+ export interface MyCartAddItemShippingAddressAction extends IMyCartUpdateAction {
1201
1311
  readonly action: 'addItemShippingAddress';
1202
1312
  /**
1203
1313
  * Address to append to `itemShippingAddresses`.
1204
1314
  *
1205
- * The new address must have a key that is unique accross this Cart.
1315
+ * The new address must have a key that is unique across this Cart.
1206
1316
  *
1207
1317
  *
1208
1318
  */
@@ -1218,7 +1328,7 @@ export interface MyCartAddItemShippingAddressAction {
1218
1328
  * If the Line Items do not have a Price according to the [Product](ctp:api:type:Product) `priceMode` value for a selected currency and/or country, Customer Group, or Channel, a [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) error is returned.
1219
1329
  *
1220
1330
  */
1221
- export interface MyCartAddLineItemAction {
1331
+ export interface MyCartAddLineItemAction extends IMyCartUpdateAction {
1222
1332
  readonly action: 'addLineItem';
1223
1333
  /**
1224
1334
  * User-defined unique identifier of the LineItem.
@@ -1295,7 +1405,7 @@ export interface MyCartAddLineItemAction {
1295
1405
  */
1296
1406
  readonly custom?: CustomFieldsDraft;
1297
1407
  }
1298
- export interface MyCartAddPaymentAction {
1408
+ export interface MyCartAddPaymentAction extends IMyCartUpdateAction {
1299
1409
  readonly action: 'addPayment';
1300
1410
  /**
1301
1411
  * Payment to add to the Cart.
@@ -1309,7 +1419,7 @@ export interface MyCartAddPaymentAction {
1309
1419
  * To override the shipping details, see [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction).
1310
1420
  *
1311
1421
  */
1312
- export interface MyCartApplyDeltaToLineItemShippingDetailsTargetsAction {
1422
+ export interface MyCartApplyDeltaToLineItemShippingDetailsTargetsAction extends IMyCartUpdateAction {
1313
1423
  readonly action: 'applyDeltaToLineItemShippingDetailsTargets';
1314
1424
  /**
1315
1425
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1346,7 +1456,7 @@ export interface MyCartApplyDeltaToLineItemShippingDetailsTargetsAction {
1346
1456
  * The LineItem total will be calculated by the system instead, so that the `externalTotalPrice` will be dropped.
1347
1457
  *
1348
1458
  */
1349
- export interface MyCartChangeLineItemQuantityAction {
1459
+ export interface MyCartChangeLineItemQuantityAction extends IMyCartUpdateAction {
1350
1460
  readonly action: 'changeLineItemQuantity';
1351
1461
  /**
1352
1462
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1369,7 +1479,7 @@ export interface MyCartChangeLineItemQuantityAction {
1369
1479
  */
1370
1480
  readonly quantity: number;
1371
1481
  }
1372
- export interface MyCartChangeLineItemsOrderAction {
1482
+ export interface MyCartChangeLineItemsOrderAction extends IMyCartUpdateAction {
1373
1483
  readonly action: 'changeLineItemsOrder';
1374
1484
  /**
1375
1485
  * All existing [LineItem](ctp:api:type:LineItem) `id`s of the [Cart](ctp:api:type:Cart) in the desired new order.
@@ -1383,7 +1493,7 @@ export interface MyCartChangeLineItemsOrderAction {
1383
1493
  * - When set to `Platform`, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's `shippingAddress`.
1384
1494
  *
1385
1495
  */
1386
- export interface MyCartChangeTaxModeAction {
1496
+ export interface MyCartChangeTaxModeAction extends IMyCartUpdateAction {
1387
1497
  readonly action: 'changeTaxMode';
1388
1498
  /**
1389
1499
  * The new TaxMode.
@@ -1401,7 +1511,7 @@ export interface MyCartChangeTaxModeAction {
1401
1511
  * the updated `price` of that [LineItem](ctp:api:type:LineItem) may not correspond to a Price in the `variant.prices` anymore.
1402
1512
  *
1403
1513
  */
1404
- export interface MyCartRecalculateAction {
1514
+ export interface MyCartRecalculateAction extends IMyCartUpdateAction {
1405
1515
  readonly action: 'recalculate';
1406
1516
  /**
1407
1517
  * - Leave empty or set to `false` to only update the Prices and TaxRates of the Line Items.
@@ -1411,7 +1521,7 @@ export interface MyCartRecalculateAction {
1411
1521
  */
1412
1522
  readonly updateProductData?: boolean;
1413
1523
  }
1414
- export interface MyCartRemoveDiscountCodeAction {
1524
+ export interface MyCartRemoveDiscountCodeAction extends IMyCartUpdateAction {
1415
1525
  readonly action: 'removeDiscountCode';
1416
1526
  /**
1417
1527
  * Discount Code to remove from the Cart.
@@ -1424,7 +1534,7 @@ export interface MyCartRemoveDiscountCodeAction {
1424
1534
  * An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
1425
1535
  *
1426
1536
  */
1427
- export interface MyCartRemoveItemShippingAddressAction {
1537
+ export interface MyCartRemoveItemShippingAddressAction extends IMyCartUpdateAction {
1428
1538
  readonly action: 'removeItemShippingAddress';
1429
1539
  /**
1430
1540
  * `key` of the Address to remove from `itemShippingAddresses`.
@@ -1437,7 +1547,7 @@ export interface MyCartRemoveItemShippingAddressAction {
1437
1547
  * The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
1438
1548
  *
1439
1549
  */
1440
- export interface MyCartRemoveLineItemAction {
1550
+ export interface MyCartRemoveLineItemAction extends IMyCartUpdateAction {
1441
1551
  readonly action: 'removeLineItem';
1442
1552
  /**
1443
1553
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1477,7 +1587,7 @@ export interface MyCartRemoveLineItemAction {
1477
1587
  */
1478
1588
  readonly shippingDetailsToRemove?: ItemShippingDetailsDraft;
1479
1589
  }
1480
- export interface MyCartRemovePaymentAction {
1590
+ export interface MyCartRemovePaymentAction extends IMyCartUpdateAction {
1481
1591
  readonly action: 'removePayment';
1482
1592
  /**
1483
1593
  * Payment to remove from the Cart.
@@ -1486,7 +1596,7 @@ export interface MyCartRemovePaymentAction {
1486
1596
  */
1487
1597
  readonly payment: PaymentResourceIdentifier;
1488
1598
  }
1489
- export interface MyCartSetBillingAddressAction {
1599
+ export interface MyCartSetBillingAddressAction extends IMyCartUpdateAction {
1490
1600
  readonly action: 'setBillingAddress';
1491
1601
  /**
1492
1602
  * Value to set.
@@ -1500,7 +1610,7 @@ export interface MyCartSetBillingAddressAction {
1500
1610
  * Updates the Business Unit on the Cart. The Cart must have an existing Business Unit assigned already.
1501
1611
  *
1502
1612
  */
1503
- export interface MyCartSetBusinessUnitAction {
1613
+ export interface MyCartSetBusinessUnitAction extends IMyCartUpdateAction {
1504
1614
  readonly action: 'setBusinessUnit';
1505
1615
  /**
1506
1616
  * New Business Unit to assign to the Cart, which must have access to the [Store](/../api/projects/stores) that is set on the Cart.
@@ -1514,7 +1624,7 @@ export interface MyCartSetBusinessUnitAction {
1514
1624
  * Setting the country can lead to changes in the [LineItem](ctp:api:type:LineItem) prices.
1515
1625
  *
1516
1626
  */
1517
- export interface MyCartSetCountryAction {
1627
+ export interface MyCartSetCountryAction extends IMyCartUpdateAction {
1518
1628
  readonly action: 'setCountry';
1519
1629
  /**
1520
1630
  * Value to set.
@@ -1527,7 +1637,7 @@ export interface MyCartSetCountryAction {
1527
1637
  */
1528
1638
  readonly country?: string;
1529
1639
  }
1530
- export interface MyCartSetCustomFieldAction {
1640
+ export interface MyCartSetCustomFieldAction extends IMyCartUpdateAction {
1531
1641
  readonly action: 'setCustomField';
1532
1642
  /**
1533
1643
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -1544,7 +1654,7 @@ export interface MyCartSetCustomFieldAction {
1544
1654
  */
1545
1655
  readonly value?: any;
1546
1656
  }
1547
- export interface MyCartSetCustomTypeAction {
1657
+ export interface MyCartSetCustomTypeAction extends IMyCartUpdateAction {
1548
1658
  readonly action: 'setCustomType';
1549
1659
  /**
1550
1660
  * Defines the [Type](ctp:api:type:Type) that extends the Cart with [Custom Fields](/../api/projects/custom-fields).
@@ -1560,7 +1670,7 @@ export interface MyCartSetCustomTypeAction {
1560
1670
  */
1561
1671
  readonly fields?: FieldContainer;
1562
1672
  }
1563
- export interface MyCartSetCustomerEmailAction {
1673
+ export interface MyCartSetCustomerEmailAction extends IMyCartUpdateAction {
1564
1674
  readonly action: 'setCustomerEmail';
1565
1675
  /**
1566
1676
  * Value to set.
@@ -1576,7 +1686,7 @@ export interface MyCartSetCustomerEmailAction {
1576
1686
  * If a [ChangeSubscription](ctp:api:type:ChangeSubscription) exists for Carts, a [ResourceDeletedDeliveryPayload](ctp:api:type:ResourceDeletedDeliveryPayload) is sent.
1577
1687
  *
1578
1688
  */
1579
- export interface MyCartSetDeleteDaysAfterLastModificationAction {
1689
+ export interface MyCartSetDeleteDaysAfterLastModificationAction extends IMyCartUpdateAction {
1580
1690
  readonly action: 'setDeleteDaysAfterLastModification';
1581
1691
  /**
1582
1692
  * Value to set.
@@ -1586,7 +1696,7 @@ export interface MyCartSetDeleteDaysAfterLastModificationAction {
1586
1696
  */
1587
1697
  readonly deleteDaysAfterLastModification?: number;
1588
1698
  }
1589
- export interface MyCartSetLineItemCustomFieldAction {
1699
+ export interface MyCartSetLineItemCustomFieldAction extends IMyCartUpdateAction {
1590
1700
  readonly action: 'setLineItemCustomField';
1591
1701
  /**
1592
1702
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1615,7 +1725,7 @@ export interface MyCartSetLineItemCustomFieldAction {
1615
1725
  */
1616
1726
  readonly value?: any;
1617
1727
  }
1618
- export interface MyCartSetLineItemCustomTypeAction {
1728
+ export interface MyCartSetLineItemCustomTypeAction extends IMyCartUpdateAction {
1619
1729
  readonly action: 'setLineItemCustomType';
1620
1730
  /**
1621
1731
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1647,7 +1757,7 @@ export interface MyCartSetLineItemCustomTypeAction {
1647
1757
  * Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
1648
1758
  *
1649
1759
  */
1650
- export interface MyCartSetLineItemDistributionChannelAction {
1760
+ export interface MyCartSetLineItemDistributionChannelAction extends IMyCartUpdateAction {
1651
1761
  readonly action: 'setLineItemDistributionChannel';
1652
1762
  /**
1653
1763
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1670,7 +1780,7 @@ export interface MyCartSetLineItemDistributionChannelAction {
1670
1780
  */
1671
1781
  readonly distributionChannel?: ChannelResourceIdentifier;
1672
1782
  }
1673
- export interface MyCartSetLineItemShippingDetailsAction {
1783
+ export interface MyCartSetLineItemShippingDetailsAction extends IMyCartUpdateAction {
1674
1784
  readonly action: 'setLineItemShippingDetails';
1675
1785
  /**
1676
1786
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1696,7 +1806,7 @@ export interface MyCartSetLineItemShippingDetailsAction {
1696
1806
  * Performing this action has no impact on inventory that should be reserved.
1697
1807
  *
1698
1808
  */
1699
- export interface MyCartSetLineItemSupplyChannelAction {
1809
+ export interface MyCartSetLineItemSupplyChannelAction extends IMyCartUpdateAction {
1700
1810
  readonly action: 'setLineItemSupplyChannel';
1701
1811
  /**
1702
1812
  * `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -1719,7 +1829,7 @@ export interface MyCartSetLineItemSupplyChannelAction {
1719
1829
  */
1720
1830
  readonly supplyChannel?: ChannelResourceIdentifier;
1721
1831
  }
1722
- export interface MyCartSetLocaleAction {
1832
+ export interface MyCartSetLocaleAction extends IMyCartUpdateAction {
1723
1833
  readonly action: 'setLocale';
1724
1834
  /**
1725
1835
  * Value to set.
@@ -1741,7 +1851,7 @@ export interface MyCartSetLocaleAction {
1741
1851
  * the [Change CountryTaxRateFallbackEnabled](ctp:api:type:ProjectChangeCountryTaxRateFallbackEnabledAction) update action.
1742
1852
  *
1743
1853
  */
1744
- export interface MyCartSetShippingAddressAction {
1854
+ export interface MyCartSetShippingAddressAction extends IMyCartUpdateAction {
1745
1855
  readonly action: 'setShippingAddress';
1746
1856
  /**
1747
1857
  * Value to set.
@@ -1755,7 +1865,7 @@ export interface MyCartSetShippingAddressAction {
1755
1865
  * To set the Cart's Shipping Method the Cart must have the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
1756
1866
  *
1757
1867
  */
1758
- export interface MyCartSetShippingMethodAction {
1868
+ export interface MyCartSetShippingMethodAction extends IMyCartUpdateAction {
1759
1869
  readonly action: 'setShippingMethod';
1760
1870
  /**
1761
1871
  * Value to set.
@@ -1777,7 +1887,7 @@ export interface MyCartSetShippingMethodAction {
1777
1887
  * Updates an address in `itemShippingAddresses` by keeping the Address `key`.
1778
1888
  *
1779
1889
  */
1780
- export interface MyCartUpdateItemShippingAddressAction {
1890
+ export interface MyCartUpdateItemShippingAddressAction extends IMyCartUpdateAction {
1781
1891
  readonly action: 'updateItemShippingAddress';
1782
1892
  /**
1783
1893
  * The new Address with the same `key` as the Address it will replace.
@@ -1790,7 +1900,7 @@ export interface MyCartUpdateItemShippingAddressAction {
1790
1900
  * Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message.
1791
1901
  *
1792
1902
  */
1793
- export interface MyCustomerAddAddressAction {
1903
+ export interface MyCustomerAddAddressAction extends IMyCustomerUpdateAction {
1794
1904
  readonly action: 'addAddress';
1795
1905
  /**
1796
1906
  * Value to append to the `addresses` array.
@@ -1803,7 +1913,7 @@ export interface MyCustomerAddAddressAction {
1803
1913
  * Adds an address from the `addresses` array to `billingAddressIds`. Either `addressId` or `addressKey` is required.
1804
1914
  *
1805
1915
  */
1806
- export interface MyCustomerAddBillingAddressIdAction {
1916
+ export interface MyCustomerAddBillingAddressIdAction extends IMyCustomerUpdateAction {
1807
1917
  readonly action: 'addBillingAddressId';
1808
1918
  /**
1809
1919
  * `id` of the [Address](ctp:api:type:Address) to become a billing address.
@@ -1822,7 +1932,7 @@ export interface MyCustomerAddBillingAddressIdAction {
1822
1932
  * Adds an address from the `addresses` array to `shippingAddressIds`. Either `addressId` or `addressKey` is required.
1823
1933
  *
1824
1934
  */
1825
- export interface MyCustomerAddShippingAddressIdAction {
1935
+ export interface MyCustomerAddShippingAddressIdAction extends IMyCustomerUpdateAction {
1826
1936
  readonly action: 'addShippingAddressId';
1827
1937
  /**
1828
1938
  * `id` of the [Address](ctp:api:type:Address) to become a shipping address.
@@ -1843,7 +1953,7 @@ export interface MyCustomerAddShippingAddressIdAction {
1843
1953
  * Either `addressId` or `addressKey` is required.
1844
1954
  *
1845
1955
  */
1846
- export interface MyCustomerChangeAddressAction {
1956
+ export interface MyCustomerChangeAddressAction extends IMyCustomerUpdateAction {
1847
1957
  readonly action: 'changeAddress';
1848
1958
  /**
1849
1959
  * `id` of the [Address](ctp:api:type:Address) to change.
@@ -1868,7 +1978,7 @@ export interface MyCustomerChangeAddressAction {
1868
1978
  * Changing the email of the Customer produces the [CustomerEmailChanged](ctp:api:type:CustomerEmailChangedMessage) Message.
1869
1979
  *
1870
1980
  */
1871
- export interface MyCustomerChangeEmailAction {
1981
+ export interface MyCustomerChangeEmailAction extends IMyCustomerUpdateAction {
1872
1982
  readonly action: 'changeEmail';
1873
1983
  /**
1874
1984
  * New value to set.
@@ -1883,7 +1993,7 @@ export interface MyCustomerChangeEmailAction {
1883
1993
  * Either `addressId` or `addressKey` is required.
1884
1994
  *
1885
1995
  */
1886
- export interface MyCustomerRemoveAddressAction {
1996
+ export interface MyCustomerRemoveAddressAction extends IMyCustomerUpdateAction {
1887
1997
  readonly action: 'removeAddress';
1888
1998
  /**
1889
1999
  * `id` of the [Address](ctp:api:type:Address) to remove.
@@ -1903,7 +2013,7 @@ export interface MyCustomerRemoveAddressAction {
1903
2013
  * If the billing address is the default billing address, the `defaultBillingAddressId` is unset. Either `addressId` or `addressKey` is required.
1904
2014
  *
1905
2015
  */
1906
- export interface MyCustomerRemoveBillingAddressIdAction {
2016
+ export interface MyCustomerRemoveBillingAddressIdAction extends IMyCustomerUpdateAction {
1907
2017
  readonly action: 'removeBillingAddressId';
1908
2018
  /**
1909
2019
  * `id` of the [Address](ctp:api:type:Address) to remove from `billingAddressesIds`.
@@ -1923,7 +2033,7 @@ export interface MyCustomerRemoveBillingAddressIdAction {
1923
2033
  * If the shipping address is the default shipping address, the `defaultShippingAddressId` is unset. Either `addressId` or `addressKey` is required.
1924
2034
  *
1925
2035
  */
1926
- export interface MyCustomerRemoveShippingAddressIdAction {
2036
+ export interface MyCustomerRemoveShippingAddressIdAction extends IMyCustomerUpdateAction {
1927
2037
  readonly action: 'removeShippingAddressId';
1928
2038
  /**
1929
2039
  * `id` of the [Address](ctp:api:type:Address) to remove from `shippingAddressesIds`.
@@ -1942,7 +2052,7 @@ export interface MyCustomerRemoveShippingAddressIdAction {
1942
2052
  * Setting the `companyName` field on the Customer produces the [CustomerCompanyNameSet](ctp:api:type:CustomerCompanyNameSetMessage) Message.
1943
2053
  *
1944
2054
  */
1945
- export interface MyCustomerSetCompanyNameAction {
2055
+ export interface MyCustomerSetCompanyNameAction extends IMyCustomerUpdateAction {
1946
2056
  readonly action: 'setCompanyName';
1947
2057
  /**
1948
2058
  * Value to set.
@@ -1956,7 +2066,7 @@ export interface MyCustomerSetCompanyNameAction {
1956
2066
  * Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message.
1957
2067
  *
1958
2068
  */
1959
- export interface MyCustomerSetCustomFieldAction {
2069
+ export interface MyCustomerSetCustomFieldAction extends IMyCustomerUpdateAction {
1960
2070
  readonly action: 'setCustomField';
1961
2071
  /**
1962
2072
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -1977,7 +2087,7 @@ export interface MyCustomerSetCustomFieldAction {
1977
2087
  * Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message.
1978
2088
  *
1979
2089
  */
1980
- export interface MyCustomerSetCustomTypeAction {
2090
+ export interface MyCustomerSetCustomTypeAction extends IMyCustomerUpdateAction {
1981
2091
  readonly action: 'setCustomType';
1982
2092
  /**
1983
2093
  * Defines the [Type](ctp:api:type:Type) that extends the MyCustomer with [Custom Fields](/../api/projects/custom-fields).
@@ -1997,7 +2107,7 @@ export interface MyCustomerSetCustomTypeAction {
1997
2107
  * Setting the date of birth of the Customer produces the [CustomerDateOfBirthSet](ctp:api:type:CustomerDateOfBirthSetMessage) Message.
1998
2108
  *
1999
2109
  */
2000
- export interface MyCustomerSetDateOfBirthAction {
2110
+ export interface MyCustomerSetDateOfBirthAction extends IMyCustomerUpdateAction {
2001
2111
  readonly action: 'setDateOfBirth';
2002
2112
  /**
2003
2113
  * Value to set.
@@ -2012,7 +2122,7 @@ export interface MyCustomerSetDateOfBirthAction {
2012
2122
  * If the address is not currently a billing address, it is added to `billingAddressIds`. Either `addressId` or `addressKey` is required.
2013
2123
  *
2014
2124
  */
2015
- export interface MyCustomerSetDefaultBillingAddressAction {
2125
+ export interface MyCustomerSetDefaultBillingAddressAction extends IMyCustomerUpdateAction {
2016
2126
  readonly action: 'setDefaultBillingAddress';
2017
2127
  /**
2018
2128
  * `id` of the [Address](ctp:api:type:Address) to become the default billing address.
@@ -2032,7 +2142,7 @@ export interface MyCustomerSetDefaultBillingAddressAction {
2032
2142
  * If the address is not currently a shipping address, it is added to `shippingAddressIds`. Either `addressId` or `addressKey` is required.
2033
2143
  *
2034
2144
  */
2035
- export interface MyCustomerSetDefaultShippingAddressAction {
2145
+ export interface MyCustomerSetDefaultShippingAddressAction extends IMyCustomerUpdateAction {
2036
2146
  readonly action: 'setDefaultShippingAddress';
2037
2147
  /**
2038
2148
  * `id` of the [Address](ctp:api:type:Address) to become the default shipping address.
@@ -2051,7 +2161,7 @@ export interface MyCustomerSetDefaultShippingAddressAction {
2051
2161
  * Setting the first name of the Customer produces the [CustomerFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message.
2052
2162
  *
2053
2163
  */
2054
- export interface MyCustomerSetFirstNameAction {
2164
+ export interface MyCustomerSetFirstNameAction extends IMyCustomerUpdateAction {
2055
2165
  readonly action: 'setFirstName';
2056
2166
  /**
2057
2167
  * Value to set.
@@ -2065,7 +2175,7 @@ export interface MyCustomerSetFirstNameAction {
2065
2175
  * Setting the last name of the Customer produces the [CustomerLastNameSet](ctp:api:type:CustomerLastNameSetMessage) Message.
2066
2176
  *
2067
2177
  */
2068
- export interface MyCustomerSetLastNameAction {
2178
+ export interface MyCustomerSetLastNameAction extends IMyCustomerUpdateAction {
2069
2179
  readonly action: 'setLastName';
2070
2180
  /**
2071
2181
  * Value to set.
@@ -2075,7 +2185,7 @@ export interface MyCustomerSetLastNameAction {
2075
2185
  */
2076
2186
  readonly lastName?: string;
2077
2187
  }
2078
- export interface MyCustomerSetLocaleAction {
2188
+ export interface MyCustomerSetLocaleAction extends IMyCustomerUpdateAction {
2079
2189
  readonly action: 'setLocale';
2080
2190
  /**
2081
2191
  * Value to set.
@@ -2085,7 +2195,7 @@ export interface MyCustomerSetLocaleAction {
2085
2195
  */
2086
2196
  readonly locale?: string;
2087
2197
  }
2088
- export interface MyCustomerSetMiddleNameAction {
2198
+ export interface MyCustomerSetMiddleNameAction extends IMyCustomerUpdateAction {
2089
2199
  readonly action: 'setMiddleName';
2090
2200
  /**
2091
2201
  * Value to set.
@@ -2095,7 +2205,7 @@ export interface MyCustomerSetMiddleNameAction {
2095
2205
  */
2096
2206
  readonly middleName?: string;
2097
2207
  }
2098
- export interface MyCustomerSetSalutationAction {
2208
+ export interface MyCustomerSetSalutationAction extends IMyCustomerUpdateAction {
2099
2209
  readonly action: 'setSalutation';
2100
2210
  /**
2101
2211
  * Value to set.
@@ -2109,7 +2219,7 @@ export interface MyCustomerSetSalutationAction {
2109
2219
  * Setting the title of the Customer produces the [CustomerTitleSetMessage](ctp:api:type:CustomerTitleSetMessage).
2110
2220
  *
2111
2221
  */
2112
- export interface MyCustomerSetTitleAction {
2222
+ export interface MyCustomerSetTitleAction extends IMyCustomerUpdateAction {
2113
2223
  readonly action: 'setTitle';
2114
2224
  /**
2115
2225
  * Value to set.
@@ -2119,7 +2229,7 @@ export interface MyCustomerSetTitleAction {
2119
2229
  */
2120
2230
  readonly title?: string;
2121
2231
  }
2122
- export interface MyCustomerSetVatIdAction {
2232
+ export interface MyCustomerSetVatIdAction extends IMyCustomerUpdateAction {
2123
2233
  readonly action: 'setVatId';
2124
2234
  /**
2125
2235
  * Value to set.
@@ -2134,7 +2244,7 @@ export interface MyCustomerSetVatIdAction {
2134
2244
  * Once a Transaction is added to the Payment, it can no longer be updated or deleted using the My Payments API.
2135
2245
  *
2136
2246
  */
2137
- export interface MyPaymentAddTransactionAction {
2247
+ export interface MyPaymentAddTransactionAction extends IMyPaymentUpdateAction {
2138
2248
  readonly action: 'addTransaction';
2139
2249
  /**
2140
2250
  * Transaction to add to the Payment.
@@ -2147,7 +2257,7 @@ export interface MyPaymentAddTransactionAction {
2147
2257
  * Can be used to update the Payment if a customer changes the [Cart](ctp:api:type:Cart), or adds or removes a [CartDiscount](ctp:api:type:CartDiscount) during checkout.
2148
2258
  *
2149
2259
  */
2150
- export interface MyPaymentChangeAmountPlannedAction {
2260
+ export interface MyPaymentChangeAmountPlannedAction extends IMyPaymentUpdateAction {
2151
2261
  readonly action: 'changeAmountPlanned';
2152
2262
  /**
2153
2263
  * New value to set.
@@ -2156,7 +2266,7 @@ export interface MyPaymentChangeAmountPlannedAction {
2156
2266
  */
2157
2267
  readonly amount: _Money;
2158
2268
  }
2159
- export interface MyPaymentSetCustomFieldAction {
2269
+ export interface MyPaymentSetCustomFieldAction extends IMyPaymentUpdateAction {
2160
2270
  readonly action: 'setCustomField';
2161
2271
  /**
2162
2272
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -2173,7 +2283,7 @@ export interface MyPaymentSetCustomFieldAction {
2173
2283
  */
2174
2284
  readonly value?: any;
2175
2285
  }
2176
- export interface MyPaymentSetMethodInfoInterfaceAction {
2286
+ export interface MyPaymentSetMethodInfoInterfaceAction extends IMyPaymentUpdateAction {
2177
2287
  readonly action: 'setMethodInfoInterface';
2178
2288
  /**
2179
2289
  * Value to set.
@@ -2183,7 +2293,7 @@ export interface MyPaymentSetMethodInfoInterfaceAction {
2183
2293
  */
2184
2294
  readonly interface: string;
2185
2295
  }
2186
- export interface MyPaymentSetMethodInfoMethodAction {
2296
+ export interface MyPaymentSetMethodInfoMethodAction extends IMyPaymentUpdateAction {
2187
2297
  readonly action: 'setMethodInfoMethod';
2188
2298
  /**
2189
2299
  * Value to set.
@@ -2193,7 +2303,7 @@ export interface MyPaymentSetMethodInfoMethodAction {
2193
2303
  */
2194
2304
  readonly method?: string;
2195
2305
  }
2196
- export interface MyPaymentSetMethodInfoNameAction {
2306
+ export interface MyPaymentSetMethodInfoNameAction extends IMyPaymentUpdateAction {
2197
2307
  readonly action: 'setMethodInfoName';
2198
2308
  /**
2199
2309
  * Value to set.
@@ -2203,7 +2313,7 @@ export interface MyPaymentSetMethodInfoNameAction {
2203
2313
  */
2204
2314
  readonly name?: LocalizedString;
2205
2315
  }
2206
- export interface MyPaymentSetTransactionCustomFieldAction {
2316
+ export interface MyPaymentSetTransactionCustomFieldAction extends IMyPaymentUpdateAction {
2207
2317
  readonly action: 'setTransactionCustomField';
2208
2318
  /**
2209
2319
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -2223,7 +2333,7 @@ export interface MyPaymentSetTransactionCustomFieldAction {
2223
2333
  /**
2224
2334
  * When accepting, declining, or renegotiating [B2B Quotes](/../api/associates-overview#b2b-resources), the Customer must have the `AcceptMyQuotes`, `DeclineMyQuotes`, or `RenegotiateMyQuotes` [Permission](ctp:api:type:Permission), respectively. If the required [Permission](/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned.
2225
2335
  */
2226
- export interface MyQuoteChangeMyQuoteStateAction {
2336
+ export interface MyQuoteChangeMyQuoteStateAction extends IMyQuoteUpdateAction {
2227
2337
  readonly action: 'changeMyQuoteState';
2228
2338
  /**
2229
2339
  * New state to be set for the Quote.
@@ -2235,10 +2345,10 @@ export interface MyQuoteChangeMyQuoteStateAction {
2235
2345
  * Transitions the `quoteRequestState` of the Quote Request to `Cancelled`. Can only be used when the Quote Request is in state `Submitted`.
2236
2346
  *
2237
2347
  */
2238
- export interface MyQuoteRequestCancelAction {
2348
+ export interface MyQuoteRequestCancelAction extends IMyQuoteRequestUpdateAction {
2239
2349
  readonly action: 'cancelQuoteRequest';
2240
2350
  }
2241
- export interface MyShoppingListAddLineItemAction {
2351
+ export interface MyShoppingListAddLineItemAction extends IMyShoppingListUpdateAction {
2242
2352
  readonly action: 'addLineItem';
2243
2353
  /**
2244
2354
  * User-defined identifier of the ShoppingListLineItem. Must be unique per [ShoppingList](ctp:api:type:ShoppingList).
@@ -2282,7 +2392,7 @@ export interface MyShoppingListAddLineItemAction {
2282
2392
  */
2283
2393
  readonly custom?: CustomFieldsDraft;
2284
2394
  }
2285
- export interface MyShoppingListAddTextLineItemAction {
2395
+ export interface MyShoppingListAddTextLineItemAction extends IMyShoppingListUpdateAction {
2286
2396
  readonly action: 'addTextLineItem';
2287
2397
  /**
2288
2398
  * Name of the [TextLineItem](ctp:api:type:TextLineItem).
@@ -2321,7 +2431,7 @@ export interface MyShoppingListAddTextLineItemAction {
2321
2431
  */
2322
2432
  readonly custom?: CustomFieldsDraft;
2323
2433
  }
2324
- export interface MyShoppingListChangeLineItemQuantityAction {
2434
+ export interface MyShoppingListChangeLineItemQuantityAction extends IMyShoppingListUpdateAction {
2325
2435
  readonly action: 'changeLineItemQuantity';
2326
2436
  /**
2327
2437
  * `id` of the ShoppingListLineItem to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2342,7 +2452,7 @@ export interface MyShoppingListChangeLineItemQuantityAction {
2342
2452
  */
2343
2453
  readonly quantity: number;
2344
2454
  }
2345
- export interface MyShoppingListChangeLineItemsOrderAction {
2455
+ export interface MyShoppingListChangeLineItemsOrderAction extends IMyShoppingListUpdateAction {
2346
2456
  readonly action: 'changeLineItemsOrder';
2347
2457
  /**
2348
2458
  * All existing [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) `id`s of the [ShoppingList](ctp:api:type:ShoppingList) in the desired new order.
@@ -2351,7 +2461,7 @@ export interface MyShoppingListChangeLineItemsOrderAction {
2351
2461
  */
2352
2462
  readonly lineItemOrder: string[];
2353
2463
  }
2354
- export interface MyShoppingListChangeNameAction {
2464
+ export interface MyShoppingListChangeNameAction extends IMyShoppingListUpdateAction {
2355
2465
  readonly action: 'changeName';
2356
2466
  /**
2357
2467
  * New value to set. Must not be empty.
@@ -2360,7 +2470,7 @@ export interface MyShoppingListChangeNameAction {
2360
2470
  */
2361
2471
  readonly name: LocalizedString;
2362
2472
  }
2363
- export interface MyShoppingListChangeTextLineItemNameAction {
2473
+ export interface MyShoppingListChangeTextLineItemNameAction extends IMyShoppingListUpdateAction {
2364
2474
  readonly action: 'changeTextLineItemName';
2365
2475
  /**
2366
2476
  * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2381,7 +2491,7 @@ export interface MyShoppingListChangeTextLineItemNameAction {
2381
2491
  */
2382
2492
  readonly name: LocalizedString;
2383
2493
  }
2384
- export interface MyShoppingListChangeTextLineItemQuantityAction {
2494
+ export interface MyShoppingListChangeTextLineItemQuantityAction extends IMyShoppingListUpdateAction {
2385
2495
  readonly action: 'changeTextLineItemQuantity';
2386
2496
  /**
2387
2497
  * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2402,7 +2512,7 @@ export interface MyShoppingListChangeTextLineItemQuantityAction {
2402
2512
  */
2403
2513
  readonly quantity: number;
2404
2514
  }
2405
- export interface MyShoppingListChangeTextLineItemsOrderAction {
2515
+ export interface MyShoppingListChangeTextLineItemsOrderAction extends IMyShoppingListUpdateAction {
2406
2516
  readonly action: 'changeTextLineItemsOrder';
2407
2517
  /**
2408
2518
  * All existing [TextLineItem](ctp:api:type:TextLineItem) `id`s in the desired new order.
@@ -2411,7 +2521,7 @@ export interface MyShoppingListChangeTextLineItemsOrderAction {
2411
2521
  */
2412
2522
  readonly textLineItemOrder: string[];
2413
2523
  }
2414
- export interface MyShoppingListRemoveLineItemAction {
2524
+ export interface MyShoppingListRemoveLineItemAction extends IMyShoppingListUpdateAction {
2415
2525
  readonly action: 'removeLineItem';
2416
2526
  /**
2417
2527
  * The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2432,7 +2542,7 @@ export interface MyShoppingListRemoveLineItemAction {
2432
2542
  */
2433
2543
  readonly quantity?: number;
2434
2544
  }
2435
- export interface MyShoppingListRemoveTextLineItemAction {
2545
+ export interface MyShoppingListRemoveTextLineItemAction extends IMyShoppingListUpdateAction {
2436
2546
  readonly action: 'removeTextLineItem';
2437
2547
  /**
2438
2548
  * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2453,7 +2563,7 @@ export interface MyShoppingListRemoveTextLineItemAction {
2453
2563
  */
2454
2564
  readonly quantity?: number;
2455
2565
  }
2456
- export interface MyShoppingListSetCustomFieldAction {
2566
+ export interface MyShoppingListSetCustomFieldAction extends IMyShoppingListUpdateAction {
2457
2567
  readonly action: 'setCustomField';
2458
2568
  /**
2459
2569
  * Name of the [Custom Field](/../api/projects/custom-fields).
@@ -2470,7 +2580,7 @@ export interface MyShoppingListSetCustomFieldAction {
2470
2580
  */
2471
2581
  readonly value?: any;
2472
2582
  }
2473
- export interface MyShoppingListSetCustomTypeAction {
2583
+ export interface MyShoppingListSetCustomTypeAction extends IMyShoppingListUpdateAction {
2474
2584
  readonly action: 'setCustomType';
2475
2585
  /**
2476
2586
  * Defines the [Type](ctp:api:type:Type) that extends the MyShoppingList with [Custom Fields](/../api/projects/custom-fields).
@@ -2486,7 +2596,7 @@ export interface MyShoppingListSetCustomTypeAction {
2486
2596
  */
2487
2597
  readonly fields?: FieldContainer;
2488
2598
  }
2489
- export interface MyShoppingListSetDeleteDaysAfterLastModificationAction {
2599
+ export interface MyShoppingListSetDeleteDaysAfterLastModificationAction extends IMyShoppingListUpdateAction {
2490
2600
  readonly action: 'setDeleteDaysAfterLastModification';
2491
2601
  /**
2492
2602
  * Value to set. If empty, any existing value will be removed.
@@ -2495,7 +2605,7 @@ export interface MyShoppingListSetDeleteDaysAfterLastModificationAction {
2495
2605
  */
2496
2606
  readonly deleteDaysAfterLastModification?: number;
2497
2607
  }
2498
- export interface MyShoppingListSetDescriptionAction {
2608
+ export interface MyShoppingListSetDescriptionAction extends IMyShoppingListUpdateAction {
2499
2609
  readonly action: 'setDescription';
2500
2610
  /**
2501
2611
  * Value to set. If empty, any existing value will be removed.
@@ -2504,7 +2614,7 @@ export interface MyShoppingListSetDescriptionAction {
2504
2614
  */
2505
2615
  readonly description?: LocalizedString;
2506
2616
  }
2507
- export interface MyShoppingListSetLineItemCustomFieldAction {
2617
+ export interface MyShoppingListSetLineItemCustomFieldAction extends IMyShoppingListUpdateAction {
2508
2618
  readonly action: 'setLineItemCustomField';
2509
2619
  /**
2510
2620
  * Unique identifier of an the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem). Either `lineItemId` or `lineItemKey` is required.
@@ -2533,7 +2643,7 @@ export interface MyShoppingListSetLineItemCustomFieldAction {
2533
2643
  */
2534
2644
  readonly value?: any;
2535
2645
  }
2536
- export interface MyShoppingListSetLineItemCustomTypeAction {
2646
+ export interface MyShoppingListSetLineItemCustomTypeAction extends IMyShoppingListUpdateAction {
2537
2647
  readonly action: 'setLineItemCustomType';
2538
2648
  /**
2539
2649
  * Unique identifier of an existing [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) in the [ShoppingList](ctp:api:type:ShoppingList).
@@ -2555,7 +2665,7 @@ export interface MyShoppingListSetLineItemCustomTypeAction {
2555
2665
  */
2556
2666
  readonly fields?: FieldContainer;
2557
2667
  }
2558
- export interface MyShoppingListSetTextLineItemCustomFieldAction {
2668
+ export interface MyShoppingListSetTextLineItemCustomFieldAction extends IMyShoppingListUpdateAction {
2559
2669
  readonly action: 'setTextLineItemCustomField';
2560
2670
  /**
2561
2671
  * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2584,7 +2694,7 @@ export interface MyShoppingListSetTextLineItemCustomFieldAction {
2584
2694
  */
2585
2695
  readonly value?: any;
2586
2696
  }
2587
- export interface MyShoppingListSetTextLineItemCustomTypeAction {
2697
+ export interface MyShoppingListSetTextLineItemCustomTypeAction extends IMyShoppingListUpdateAction {
2588
2698
  readonly action: 'setTextLineItemCustomType';
2589
2699
  /**
2590
2700
  * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.
@@ -2612,7 +2722,7 @@ export interface MyShoppingListSetTextLineItemCustomTypeAction {
2612
2722
  */
2613
2723
  readonly fields?: FieldContainer;
2614
2724
  }
2615
- export interface MyShoppingListSetTextLineItemDescriptionAction {
2725
+ export interface MyShoppingListSetTextLineItemDescriptionAction extends IMyShoppingListUpdateAction {
2616
2726
  readonly action: 'setTextLineItemDescription';
2617
2727
  /**
2618
2728
  * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update. Either `lineItemId` or `lineItemKey` is required.