@gradientedge/commercetools-utils 5.30.0 → 5.32.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/api/CommercetoolsApi.d.ts +3 -4
  2. package/dist/cjs/api/CommercetoolsApi.d.ts.map +1 -1
  3. package/dist/cjs/api/CommercetoolsApi.js +2 -7
  4. package/dist/cjs/api/CommercetoolsApi.js.map +1 -1
  5. package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -1
  6. package/dist/cjs/types/models/approval-flow.d.ts +15 -4
  7. package/dist/cjs/types/models/approval-flow.d.ts.map +1 -1
  8. package/dist/cjs/types/models/approval-flow.js +11 -0
  9. package/dist/cjs/types/models/approval-flow.js.map +1 -1
  10. package/dist/cjs/types/models/approval-rule.d.ts +19 -9
  11. package/dist/cjs/types/models/approval-rule.d.ts.map +1 -1
  12. package/dist/cjs/types/models/approval-rule.js +10 -0
  13. package/dist/cjs/types/models/approval-rule.js.map +1 -1
  14. package/dist/cjs/types/models/associate-role.d.ts +58 -11
  15. package/dist/cjs/types/models/associate-role.d.ts.map +1 -1
  16. package/dist/cjs/types/models/associate-role.js +47 -0
  17. package/dist/cjs/types/models/associate-role.js.map +1 -1
  18. package/dist/cjs/types/models/attribute-group.d.ts +15 -9
  19. package/dist/cjs/types/models/attribute-group.d.ts.map +1 -1
  20. package/dist/cjs/types/models/business-unit-search.d.ts +114 -0
  21. package/dist/cjs/types/models/business-unit-search.d.ts.map +1 -0
  22. package/dist/cjs/types/models/business-unit-search.js +8 -0
  23. package/dist/cjs/types/models/business-unit-search.js.map +1 -0
  24. package/dist/cjs/types/models/business-unit.d.ts +349 -35
  25. package/dist/cjs/types/models/business-unit.d.ts.map +1 -1
  26. package/dist/cjs/types/models/business-unit.js +55 -0
  27. package/dist/cjs/types/models/business-unit.js.map +1 -1
  28. package/dist/cjs/types/models/cart-discount.d.ts +218 -36
  29. package/dist/cjs/types/models/cart-discount.d.ts.map +1 -1
  30. package/dist/cjs/types/models/cart-discount.js +29 -0
  31. package/dist/cjs/types/models/cart-discount.js.map +1 -1
  32. package/dist/cjs/types/models/cart.d.ts +178 -88
  33. package/dist/cjs/types/models/cart.d.ts.map +1 -1
  34. package/dist/cjs/types/models/cart.js +127 -0
  35. package/dist/cjs/types/models/cart.js.map +1 -1
  36. package/dist/cjs/types/models/category.d.ts +32 -26
  37. package/dist/cjs/types/models/category.d.ts.map +1 -1
  38. package/dist/cjs/types/models/channel.d.ts +28 -15
  39. package/dist/cjs/types/models/channel.d.ts.map +1 -1
  40. package/dist/cjs/types/models/channel.js +13 -0
  41. package/dist/cjs/types/models/channel.js.map +1 -1
  42. package/dist/cjs/types/models/common.d.ts +167 -5
  43. package/dist/cjs/types/models/common.d.ts.map +1 -1
  44. package/dist/cjs/types/models/common.js +61 -0
  45. package/dist/cjs/types/models/common.js.map +1 -1
  46. package/dist/cjs/types/models/custom-object.d.ts +2 -2
  47. package/dist/cjs/types/models/custom-object.d.ts.map +1 -1
  48. package/dist/cjs/types/models/customer-group.d.ts +13 -7
  49. package/dist/cjs/types/models/customer-group.d.ts.map +1 -1
  50. package/dist/cjs/types/models/customer.d.ts +53 -39
  51. package/dist/cjs/types/models/customer.d.ts.map +1 -1
  52. package/dist/cjs/types/models/customer.js +11 -0
  53. package/dist/cjs/types/models/customer.js.map +1 -1
  54. package/dist/cjs/types/models/discount-code.d.ts +24 -18
  55. package/dist/cjs/types/models/discount-code.d.ts.map +1 -1
  56. package/dist/cjs/types/models/error.d.ts +193 -167
  57. package/dist/cjs/types/models/error.d.ts.map +1 -1
  58. package/dist/cjs/types/models/extension.d.ts +43 -9
  59. package/dist/cjs/types/models/extension.d.ts.map +1 -1
  60. package/dist/cjs/types/models/extension.js +27 -0
  61. package/dist/cjs/types/models/extension.js.map +1 -1
  62. package/dist/cjs/types/models/index.d.ts +1 -0
  63. package/dist/cjs/types/models/index.d.ts.map +1 -1
  64. package/dist/cjs/types/models/index.js +1 -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/api/CommercetoolsApi.d.ts +3 -4
  155. package/dist/mjs/api/CommercetoolsApi.d.ts.map +1 -1
  156. package/dist/mjs/api/CommercetoolsApi.js +2 -7
  157. package/dist/mjs/api/CommercetoolsApi.js.map +1 -1
  158. package/dist/mjs/tsconfig.tsbuildinfo +1 -1
  159. package/dist/mjs/types/models/approval-flow.d.ts +15 -4
  160. package/dist/mjs/types/models/approval-flow.d.ts.map +1 -1
  161. package/dist/mjs/types/models/approval-flow.js +10 -1
  162. package/dist/mjs/types/models/approval-flow.js.map +1 -1
  163. package/dist/mjs/types/models/approval-rule.d.ts +19 -9
  164. package/dist/mjs/types/models/approval-rule.d.ts.map +1 -1
  165. package/dist/mjs/types/models/approval-rule.js +9 -1
  166. package/dist/mjs/types/models/approval-rule.js.map +1 -1
  167. package/dist/mjs/types/models/associate-role.d.ts +58 -11
  168. package/dist/mjs/types/models/associate-role.d.ts.map +1 -1
  169. package/dist/mjs/types/models/associate-role.js +46 -1
  170. package/dist/mjs/types/models/associate-role.js.map +1 -1
  171. package/dist/mjs/types/models/attribute-group.d.ts +15 -9
  172. package/dist/mjs/types/models/attribute-group.d.ts.map +1 -1
  173. package/dist/mjs/types/models/business-unit-search.d.ts +114 -0
  174. package/dist/mjs/types/models/business-unit-search.d.ts.map +1 -0
  175. package/dist/mjs/types/models/business-unit-search.js +7 -0
  176. package/dist/mjs/types/models/business-unit-search.js.map +1 -0
  177. package/dist/mjs/types/models/business-unit.d.ts +349 -35
  178. package/dist/mjs/types/models/business-unit.d.ts.map +1 -1
  179. package/dist/mjs/types/models/business-unit.js +54 -1
  180. package/dist/mjs/types/models/business-unit.js.map +1 -1
  181. package/dist/mjs/types/models/cart-discount.d.ts +218 -36
  182. package/dist/mjs/types/models/cart-discount.d.ts.map +1 -1
  183. package/dist/mjs/types/models/cart-discount.js +28 -1
  184. package/dist/mjs/types/models/cart-discount.js.map +1 -1
  185. package/dist/mjs/types/models/cart.d.ts +178 -88
  186. package/dist/mjs/types/models/cart.d.ts.map +1 -1
  187. package/dist/mjs/types/models/cart.js +126 -1
  188. package/dist/mjs/types/models/cart.js.map +1 -1
  189. package/dist/mjs/types/models/category.d.ts +32 -26
  190. package/dist/mjs/types/models/category.d.ts.map +1 -1
  191. package/dist/mjs/types/models/channel.d.ts +28 -15
  192. package/dist/mjs/types/models/channel.d.ts.map +1 -1
  193. package/dist/mjs/types/models/channel.js +12 -1
  194. package/dist/mjs/types/models/channel.js.map +1 -1
  195. package/dist/mjs/types/models/common.d.ts +167 -5
  196. package/dist/mjs/types/models/common.d.ts.map +1 -1
  197. package/dist/mjs/types/models/common.js +60 -1
  198. package/dist/mjs/types/models/common.js.map +1 -1
  199. package/dist/mjs/types/models/custom-object.d.ts +2 -2
  200. package/dist/mjs/types/models/custom-object.d.ts.map +1 -1
  201. package/dist/mjs/types/models/customer-group.d.ts +13 -7
  202. package/dist/mjs/types/models/customer-group.d.ts.map +1 -1
  203. package/dist/mjs/types/models/customer.d.ts +53 -39
  204. package/dist/mjs/types/models/customer.d.ts.map +1 -1
  205. package/dist/mjs/types/models/customer.js +10 -1
  206. package/dist/mjs/types/models/customer.js.map +1 -1
  207. package/dist/mjs/types/models/discount-code.d.ts +24 -18
  208. package/dist/mjs/types/models/discount-code.d.ts.map +1 -1
  209. package/dist/mjs/types/models/error.d.ts +193 -167
  210. package/dist/mjs/types/models/error.d.ts.map +1 -1
  211. package/dist/mjs/types/models/extension.d.ts +43 -9
  212. package/dist/mjs/types/models/extension.d.ts.map +1 -1
  213. package/dist/mjs/types/models/extension.js +26 -1
  214. package/dist/mjs/types/models/extension.js.map +1 -1
  215. package/dist/mjs/types/models/index.d.ts +1 -0
  216. package/dist/mjs/types/models/index.d.ts.map +1 -1
  217. package/dist/mjs/types/models/index.js +1 -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
@@ -4,7 +4,7 @@
4
4
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
5
  */
6
6
  import { AssociateRoleKeyReference, AssociateRoleResourceIdentifier } from './associate-role.js';
7
- import { Address, BaseAddress, CreatedBy, LastModifiedBy, _BaseAddress } from './common.js';
7
+ import { Address, BaseAddress, CreatedBy, IKeyReference, IReference, IResourceIdentifier, LastModifiedBy, _BaseAddress } from './common.js';
8
8
  import { CustomerReference, CustomerResourceIdentifier } from './customer.js';
9
9
  import { StoreKeyReference, StoreResourceIdentifier } from './store.js';
10
10
  import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
@@ -68,32 +68,316 @@ export interface AssociateRoleAssignmentDraft {
68
68
  * Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units.
69
69
  *
70
70
  */
71
+ export declare enum AssociateRoleInheritanceModeValues {
72
+ Disabled = "Disabled",
73
+ Enabled = "Enabled"
74
+ }
71
75
  export type AssociateRoleInheritanceMode = 'Disabled' | 'Enabled' | string;
72
76
  /**
73
77
  * Generic type to model the fields that all types of Business Units have in common.
74
78
  *
75
79
  */
76
80
  export type BusinessUnit = Company | Division;
81
+ export interface IBusinessUnit {
82
+ /**
83
+ * Unique identifier of the Business Unit.
84
+ *
85
+ *
86
+ */
87
+ readonly id: string;
88
+ /**
89
+ * Current version of the Business Unit.
90
+ *
91
+ *
92
+ */
93
+ readonly version: number;
94
+ /**
95
+ * Date and time (UTC) the Business Unit was initially created.
96
+ *
97
+ *
98
+ */
99
+ readonly createdAt: string;
100
+ /**
101
+ * Date and time (UTC) the Business Unit was last updated.
102
+ *
103
+ *
104
+ */
105
+ readonly lastModifiedAt: string;
106
+ /**
107
+ * IDs and references that last modified the BusinessUnit.
108
+ *
109
+ *
110
+ */
111
+ readonly lastModifiedBy?: LastModifiedBy;
112
+ /**
113
+ * IDs and references that created the BusinessUnit.
114
+ *
115
+ *
116
+ */
117
+ readonly createdBy?: CreatedBy;
118
+ /**
119
+ * User-defined unique and immutable identifier of the Business Unit.
120
+ *
121
+ *
122
+ */
123
+ readonly key: string;
124
+ /**
125
+ * Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders).
126
+ *
127
+ *
128
+ */
129
+ readonly status: BusinessUnitStatus;
130
+ /**
131
+ * References to [Stores](ctp:api:type:Store) the Business Unit is associated with. Only present when `storeMode` is `Explicit`.
132
+ *
133
+ * If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores.
134
+ *
135
+ * If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.
136
+ *
137
+ *
138
+ */
139
+ readonly stores?: StoreKeyReference[];
140
+ /**
141
+ * Stores that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `storeMode` is set to `FromParent`.
142
+ *
143
+ *
144
+ */
145
+ readonly inheritedStores?: StoreKeyReference[];
146
+ /**
147
+ * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.
148
+ *
149
+ *
150
+ */
151
+ readonly storeMode: BusinessUnitStoreMode;
152
+ /**
153
+ * Type of the Business Unit indicating its position in a hierarchy.
154
+ *
155
+ *
156
+ */
157
+ readonly unitType: BusinessUnitType;
158
+ /**
159
+ * Name of the Business Unit.
160
+ *
161
+ *
162
+ */
163
+ readonly name: string;
164
+ /**
165
+ * Email address of the Business Unit.
166
+ *
167
+ *
168
+ */
169
+ readonly contactEmail?: string;
170
+ /**
171
+ * Custom Fields for the Business Unit.
172
+ *
173
+ *
174
+ */
175
+ readonly custom?: CustomFields;
176
+ /**
177
+ * Addresses used by the Business Unit.
178
+ *
179
+ *
180
+ */
181
+ readonly addresses: Address[];
182
+ /**
183
+ * Unique identifiers of addresses used as shipping addresses.
184
+ *
185
+ *
186
+ */
187
+ readonly shippingAddressIds?: string[];
188
+ /**
189
+ * Unique identifier of the address used as the default shipping address.
190
+ *
191
+ *
192
+ */
193
+ readonly defaultShippingAddressId?: string;
194
+ /**
195
+ * Unique identifiers of addresses used as billing addresses.
196
+ *
197
+ *
198
+ */
199
+ readonly billingAddressIds?: string[];
200
+ /**
201
+ * Unique identifier of the address used as the default billing address.
202
+ *
203
+ *
204
+ */
205
+ readonly defaultBillingAddressId?: string;
206
+ /**
207
+ * Set to `Explicit` to prevent the Business Unit inheriting Associates from a parent, set to `ExplicitAndFromParent` to enable inheritance.
208
+ *
209
+ *
210
+ */
211
+ readonly associateMode: BusinessUnitAssociateMode;
212
+ /**
213
+ * Associates that are part of the Business Unit in specific [roles](ctp:api:type:AssociateRole).
214
+ *
215
+ *
216
+ */
217
+ readonly associates: Associate[];
218
+ /**
219
+ * Associates that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `associateMode` is set to `ExplicitAndFromParent`.
220
+ *
221
+ *
222
+ */
223
+ readonly inheritedAssociates?: InheritedAssociate[];
224
+ /**
225
+ * Parent unit of the Business Unit. Only present when the `unitType` is `Division`.
226
+ *
227
+ *
228
+ */
229
+ readonly parentUnit?: BusinessUnitKeyReference;
230
+ /**
231
+ * Top-level unit of the Business Unit. The top-level unit is of `unitType` `Company`.
232
+ *
233
+ *
234
+ */
235
+ readonly topLevelUnit: BusinessUnitKeyReference;
236
+ /**
237
+ * Determines whether the Business Unit can inherit Approval Rules from a parent.
238
+ * Always `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and defaults to `ExplicitAndFromParent` for [Divisions](ctp:api:type:BusinessUnitType).
239
+ *
240
+ *
241
+ */
242
+ readonly approvalRuleMode: BusinessUnitApprovalRuleMode;
243
+ }
77
244
  /**
78
245
  * Determines whether a Business Unit can inherit [Approval Rules](/projects/approval-rules) from a parent. Only Business Units of type `Division` can use `ExplicitAndFromParent`.
79
246
  *
80
247
  */
248
+ export declare enum BusinessUnitApprovalRuleModeValues {
249
+ Explicit = "Explicit",
250
+ ExplicitAndFromParent = "ExplicitAndFromParent"
251
+ }
81
252
  export type BusinessUnitApprovalRuleMode = 'Explicit' | 'ExplicitAndFromParent' | string;
82
253
  /**
83
254
  * Determines whether a Business Unit can inherit Associates from a parent.
84
255
  *
85
256
  */
257
+ export declare enum BusinessUnitAssociateModeValues {
258
+ Explicit = "Explicit",
259
+ ExplicitAndFromParent = "ExplicitAndFromParent"
260
+ }
86
261
  export type BusinessUnitAssociateMode = 'Explicit' | 'ExplicitAndFromParent' | string;
87
262
  /**
88
263
  * Generic draft type to model those fields all Business Units have in common. The additional fields required for creating a [Company](ctp:api:type:Company) or [Division](ctp:api:type:Division) are represented on [CompanyDraft](ctp:api:type:CompanyDraft) and [DivisionDraft](ctp:api:type:DivisionDraft).
89
264
  *
90
265
  */
91
266
  export type BusinessUnitDraft = CompanyDraft | DivisionDraft;
267
+ export interface IBusinessUnitDraft {
268
+ /**
269
+ * User-defined unique and immutable identifier for the Business Unit.
270
+ *
271
+ *
272
+ */
273
+ readonly key: string;
274
+ /**
275
+ * Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders).
276
+ *
277
+ *
278
+ */
279
+ readonly status?: BusinessUnitStatus;
280
+ /**
281
+ * Sets the [Stores](ctp:api:type:Store) the Business Unit is associated with. Can only be set when `storeMode` is `Explicit`.
282
+ * Defaults to empty for [Companies](ctp:api:type:BusinessUnitType) and not set for [Divisions](ctp:api:type:BusinessUnitType).
283
+ *
284
+ * If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores.
285
+ *
286
+ * If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.
287
+ *
288
+ *
289
+ */
290
+ readonly stores?: StoreResourceIdentifier[];
291
+ /**
292
+ * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.
293
+ * `storeMode` is always `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and defaults to `FromParent` for [Divisions](ctp:api:type:BusinessUnitType).
294
+ *
295
+ *
296
+ */
297
+ readonly storeMode?: BusinessUnitStoreMode;
298
+ /**
299
+ * Type of the Business Unit indicating its position in a hierarchy.
300
+ *
301
+ *
302
+ */
303
+ readonly unitType: BusinessUnitType;
304
+ /**
305
+ * Name of the Business Unit.
306
+ *
307
+ *
308
+ */
309
+ readonly name: string;
310
+ /**
311
+ * Email address of the Business Unit.
312
+ *
313
+ *
314
+ */
315
+ readonly contactEmail?: string;
316
+ /**
317
+ * Determines whether the Business Unit can inherit Associates from a parent.
318
+ * Always `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and defaults to `ExplicitAndFromParent` for [Divisions](ctp:api:type:BusinessUnitType).
319
+ *
320
+ *
321
+ */
322
+ readonly associateMode?: BusinessUnitAssociateMode;
323
+ /**
324
+ * List of members that are part of the Business Unit in specific [roles](ctp:api:type:AssociateRole).
325
+ *
326
+ *
327
+ */
328
+ readonly associates?: AssociateDraft[];
329
+ /**
330
+ * Determines whether the Business Unit can inherit Approval Rules from a parent.
331
+ * For [Companies](ctp:api:type:BusinessUnitType), the value of this field is always `Explicit`.
332
+ * For [Divisions](ctp:api:type:BusinessUnitType), the default value is `ExplicitAndFromParent`.
333
+ *
334
+ *
335
+ */
336
+ readonly approvalRuleMode?: BusinessUnitApprovalRuleMode;
337
+ /**
338
+ * Addresses used by the Business Unit.
339
+ *
340
+ *
341
+ */
342
+ readonly addresses?: BaseAddress[];
343
+ /**
344
+ * Indexes of entries in `addresses` to set as shipping addresses.
345
+ * The `shippingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
346
+ *
347
+ *
348
+ */
349
+ readonly shippingAddresses?: number[];
350
+ /**
351
+ * Index of the entry in `addresses` to set as the default shipping address.
352
+ *
353
+ *
354
+ */
355
+ readonly defaultShippingAddress?: number;
356
+ /**
357
+ * Indexes of entries in `addresses` to set as billing addresses.
358
+ * The `billingAddressIds` of the [Customer](ctp:api:type:Customer) will be replaced by these addresses.
359
+ *
360
+ *
361
+ */
362
+ readonly billingAddresses?: number[];
363
+ /**
364
+ * Index of the entry in `addresses` to set as the default billing address.
365
+ *
366
+ *
367
+ */
368
+ readonly defaultBillingAddress?: number;
369
+ /**
370
+ * Custom Fields for the Business Unit.
371
+ *
372
+ *
373
+ */
374
+ readonly custom?: CustomFieldsDraft;
375
+ }
92
376
  /**
93
377
  * [KeyReference](ctp:api:type:KeyReference) to a [BusinessUnit](ctp:api:type:BusinessUnit).
94
378
  *
95
379
  */
96
- export interface BusinessUnitKeyReference {
380
+ export interface BusinessUnitKeyReference extends IKeyReference {
97
381
  readonly typeId: 'business-unit';
98
382
  /**
99
383
  * Unique and immutable key of the referenced [BusinessUnit](ctp:api:type:BusinessUnit).
@@ -146,7 +430,7 @@ export interface BusinessUnitPagedQueryResponse {
146
430
  * [Reference](ctp:api:type:Reference) to a [BusinessUnit](ctp:api:type:BusinessUnit).
147
431
  *
148
432
  */
149
- export interface BusinessUnitReference {
433
+ export interface BusinessUnitReference extends IReference {
150
434
  readonly typeId: 'business-unit';
151
435
  /**
152
436
  * Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit).
@@ -165,7 +449,7 @@ export interface BusinessUnitReference {
165
449
  * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
166
450
  *
167
451
  */
168
- export interface BusinessUnitResourceIdentifier {
452
+ export interface BusinessUnitResourceIdentifier extends IResourceIdentifier {
169
453
  readonly typeId: 'business-unit';
170
454
  /**
171
455
  * Unique identifier of the referenced [BusinessUnit](ctp:api:type:BusinessUnit). Required if `key` is absent.
@@ -184,16 +468,28 @@ export interface BusinessUnitResourceIdentifier {
184
468
  * Indicates whether the Business Unit can be edited and used in [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), or [Quotes](ctp:api:type:Quote).
185
469
  *
186
470
  */
471
+ export declare enum BusinessUnitStatusValues {
472
+ Active = "Active",
473
+ Inactive = "Inactive"
474
+ }
187
475
  export type BusinessUnitStatus = 'Active' | 'Inactive' | string;
188
476
  /**
189
477
  * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.
190
478
  *
191
479
  */
480
+ export declare enum BusinessUnitStoreModeValues {
481
+ Explicit = "Explicit",
482
+ FromParent = "FromParent"
483
+ }
192
484
  export type BusinessUnitStoreMode = 'Explicit' | 'FromParent' | string;
193
485
  /**
194
486
  * The type of the Business Unit indicating its position in a hierarchy.
195
487
  *
196
488
  */
489
+ export declare enum BusinessUnitTypeValues {
490
+ Company = "Company",
491
+ Division = "Division"
492
+ }
197
493
  export type BusinessUnitType = 'Company' | 'Division' | string;
198
494
  export interface BusinessUnitUpdate {
199
495
  /**
@@ -211,12 +507,18 @@ export interface BusinessUnitUpdate {
211
507
  readonly actions: BusinessUnitUpdateAction[];
212
508
  }
213
509
  export type BusinessUnitUpdateAction = BusinessUnitAddAddressAction | BusinessUnitAddAssociateAction | BusinessUnitAddBillingAddressIdAction | BusinessUnitAddShippingAddressIdAction | BusinessUnitAddStoreAction | BusinessUnitChangeAddressAction | BusinessUnitChangeApprovalRuleModeAction | BusinessUnitChangeAssociateAction | BusinessUnitChangeAssociateModeAction | BusinessUnitChangeNameAction | BusinessUnitChangeParentUnitAction | BusinessUnitChangeStatusAction | BusinessUnitRemoveAddressAction | BusinessUnitRemoveAssociateAction | BusinessUnitRemoveBillingAddressIdAction | BusinessUnitRemoveShippingAddressIdAction | BusinessUnitRemoveStoreAction | BusinessUnitSetAddressCustomFieldAction | BusinessUnitSetAddressCustomTypeAction | BusinessUnitSetAssociatesAction | BusinessUnitSetContactEmailAction | BusinessUnitSetCustomFieldAction | BusinessUnitSetCustomTypeAction | BusinessUnitSetDefaultBillingAddressAction | BusinessUnitSetDefaultShippingAddressAction | BusinessUnitSetStoreModeAction | BusinessUnitSetStoresAction;
510
+ export interface IBusinessUnitUpdateAction {
511
+ /**
512
+ *
513
+ */
514
+ readonly action: string;
515
+ }
214
516
  /**
215
517
  * Business Unit type to represent the top level of a business.
216
518
  * Contains specific fields and values that differentiate a Company from the generic [BusinessUnit](ctp:api:type:BusinessUnit).
217
519
  *
218
520
  */
219
- export interface Company {
521
+ export interface Company extends IBusinessUnit {
220
522
  readonly unitType: 'Company';
221
523
  /**
222
524
  * Unique identifier of the Business Unit.
@@ -276,6 +578,12 @@ export interface Company {
276
578
  *
277
579
  */
278
580
  readonly stores?: StoreKeyReference[];
581
+ /**
582
+ * Stores that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `storeMode` is set to `FromParent`.
583
+ *
584
+ *
585
+ */
586
+ readonly inheritedStores?: StoreKeyReference[];
279
587
  /**
280
588
  * The value of this field is always `Explicit` because a Company cannot have a parent Business Unit that Stores can be inherited from.
281
589
  *
@@ -371,7 +679,7 @@ export interface Company {
371
679
  * Draft type to represent the top level of a business. Contains the fields and values of the generic [BusinessUnitDraft](ctp:api:type:BusinessUnitDraft) that are used specifically for creating a [Company](ctp:api:type:Company).
372
680
  *
373
681
  */
374
- export interface CompanyDraft {
682
+ export interface CompanyDraft extends IBusinessUnitDraft {
375
683
  readonly unitType: 'Company';
376
684
  /**
377
685
  * User-defined unique and immutable identifier for the Business Unit.
@@ -480,7 +788,7 @@ export interface CompanyDraft {
480
788
  * Contains specific fields and values that differentiate a Division from the generic [BusinessUnit](ctp:api:type:BusinessUnit).
481
789
  *
482
790
  */
483
- export interface Division {
791
+ export interface Division extends IBusinessUnit {
484
792
  readonly unitType: 'Division';
485
793
  /**
486
794
  * Unique identifier of the Business Unit.
@@ -540,6 +848,12 @@ export interface Division {
540
848
  *
541
849
  */
542
850
  readonly stores?: StoreKeyReference[];
851
+ /**
852
+ * Stores that are inherited from a parent Business Unit. The value of this field is [eventually consistent](/../api/general-concepts#eventual-consistency) and is only present when the `storeMode` is set to `FromParent`.
853
+ *
854
+ *
855
+ */
856
+ readonly inheritedStores?: StoreKeyReference[];
543
857
  /**
544
858
  * Defines whether the Stores of the Division are set explicitly or inherited from a parent Business Unit.
545
859
  *
@@ -636,7 +950,7 @@ export interface Division {
636
950
  * Contains the fields and values of the generic [BusinessUnitDraft](ctp:api:type:BusinessUnitDraft) that are used specifically for creating a Division.
637
951
  *
638
952
  */
639
- export interface DivisionDraft {
953
+ export interface DivisionDraft extends IBusinessUnitDraft {
640
954
  readonly unitType: 'Division';
641
955
  /**
642
956
  * User-defined unique and immutable identifier for the Business Unit.
@@ -775,7 +1089,7 @@ export interface InheritedAssociateRoleAssignment {
775
1089
  * Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message.
776
1090
  *
777
1091
  */
778
- export interface BusinessUnitAddAddressAction {
1092
+ export interface BusinessUnitAddAddressAction extends IBusinessUnitUpdateAction {
779
1093
  readonly action: 'addAddress';
780
1094
  /**
781
1095
  * Address to add to the addresses of the [Business Unit](ctp:api:type:BusinessUnit).
@@ -788,7 +1102,7 @@ export interface BusinessUnitAddAddressAction {
788
1102
  * Adding an Associate to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateAdded](ctp:api:type:BusinessUnitAssociateAddedMessage) Message.
789
1103
  *
790
1104
  */
791
- export interface BusinessUnitAddAssociateAction {
1105
+ export interface BusinessUnitAddAssociateAction extends IBusinessUnitUpdateAction {
792
1106
  readonly action: 'addAssociate';
793
1107
  /**
794
1108
  * The Associate to add.
@@ -801,7 +1115,7 @@ export interface BusinessUnitAddAssociateAction {
801
1115
  * Adding a billing address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressAdded](ctp:api:type:BusinessUnitBillingAddressAddedMessage) Message.
802
1116
  *
803
1117
  */
804
- export interface BusinessUnitAddBillingAddressIdAction {
1118
+ export interface BusinessUnitAddBillingAddressIdAction extends IBusinessUnitUpdateAction {
805
1119
  readonly action: 'addBillingAddressId';
806
1120
  /**
807
1121
  * ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
@@ -820,7 +1134,7 @@ export interface BusinessUnitAddBillingAddressIdAction {
820
1134
  * Adding a shipping address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressAdded](ctp:api:type:BusinessUnitShippingAddressAddedMessage) Message.
821
1135
  *
822
1136
  */
823
- export interface BusinessUnitAddShippingAddressIdAction {
1137
+ export interface BusinessUnitAddShippingAddressIdAction extends IBusinessUnitUpdateAction {
824
1138
  readonly action: 'addShippingAddressId';
825
1139
  /**
826
1140
  * ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
@@ -840,7 +1154,7 @@ export interface BusinessUnitAddShippingAddressIdAction {
840
1154
  * Only applicable when `storeMode` is `Explicit`.
841
1155
  *
842
1156
  */
843
- export interface BusinessUnitAddStoreAction {
1157
+ export interface BusinessUnitAddStoreAction extends IBusinessUnitUpdateAction {
844
1158
  readonly action: 'addStore';
845
1159
  /**
846
1160
  * [Store](ctp:api:type:Store) to add.
@@ -853,7 +1167,7 @@ export interface BusinessUnitAddStoreAction {
853
1167
  * Changing the address on a Business Unit generates the [BusinessUnitAddressChanged](ctp:api:type:BusinessUnitAddressChangedMessage) Message.
854
1168
  *
855
1169
  */
856
- export interface BusinessUnitChangeAddressAction {
1170
+ export interface BusinessUnitChangeAddressAction extends IBusinessUnitUpdateAction {
857
1171
  readonly action: 'changeAddress';
858
1172
  /**
859
1173
  * ID of the address to change. Either `addressId` or `addressKey` is required.
@@ -882,7 +1196,7 @@ export interface BusinessUnitChangeAddressAction {
882
1196
  * This update action generates a [BusinessUnitApprovalRuleModeChanged](ctp:api:type:BusinessUnitApprovalRuleModeChangedMessage) Message.
883
1197
  *
884
1198
  */
885
- export interface BusinessUnitChangeApprovalRuleModeAction {
1199
+ export interface BusinessUnitChangeApprovalRuleModeAction extends IBusinessUnitUpdateAction {
886
1200
  readonly action: 'changeApprovalRuleMode';
887
1201
  /**
888
1202
  * The new value for `approvalRuleMode`.
@@ -895,7 +1209,7 @@ export interface BusinessUnitChangeApprovalRuleModeAction {
895
1209
  * Updating the [Associate](ctp:api:type:Associate) on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAssociateChanged](ctp:api:type:BusinessUnitAssociateChangedMessage) Message.
896
1210
  *
897
1211
  */
898
- export interface BusinessUnitChangeAssociateAction {
1212
+ export interface BusinessUnitChangeAssociateAction extends IBusinessUnitUpdateAction {
899
1213
  readonly action: 'changeAssociate';
900
1214
  /**
901
1215
  * New version of an existing Associate.
@@ -909,7 +1223,7 @@ export interface BusinessUnitChangeAssociateAction {
909
1223
  * This update action generates a [BusinessUnitAssociateModeChanged](ctp:api:type:BusinessUnitAssociateModeChangedMessage) Message.
910
1224
  *
911
1225
  */
912
- export interface BusinessUnitChangeAssociateModeAction {
1226
+ export interface BusinessUnitChangeAssociateModeAction extends IBusinessUnitUpdateAction {
913
1227
  readonly action: 'changeAssociateMode';
914
1228
  /**
915
1229
  * The new value for `associateMode`.
@@ -922,7 +1236,7 @@ export interface BusinessUnitChangeAssociateModeAction {
922
1236
  * Updating the name on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitNameChanged](ctp:api:type:BusinessUnitNameChangedMessage) Message.
923
1237
  *
924
1238
  */
925
- export interface BusinessUnitChangeNameAction {
1239
+ export interface BusinessUnitChangeNameAction extends IBusinessUnitUpdateAction {
926
1240
  readonly action: 'changeName';
927
1241
  /**
928
1242
  * New name to set.
@@ -935,7 +1249,7 @@ export interface BusinessUnitChangeNameAction {
935
1249
  * Changing the parent of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitParentChanged](ctp:api:type:BusinessUnitParentChangedMessage) Message.
936
1250
  *
937
1251
  */
938
- export interface BusinessUnitChangeParentUnitAction {
1252
+ export interface BusinessUnitChangeParentUnitAction extends IBusinessUnitUpdateAction {
939
1253
  readonly action: 'changeParentUnit';
940
1254
  /**
941
1255
  * 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.
@@ -948,7 +1262,7 @@ export interface BusinessUnitChangeParentUnitAction {
948
1262
  * Changing the status of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitStatusChanged](ctp:api:type:BusinessUnitStatusChangedMessage) Message.
949
1263
  *
950
1264
  */
951
- export interface BusinessUnitChangeStatusAction {
1265
+ export interface BusinessUnitChangeStatusAction extends IBusinessUnitUpdateAction {
952
1266
  readonly action: 'changeStatus';
953
1267
  /**
954
1268
  * New status to set.
@@ -961,7 +1275,7 @@ export interface BusinessUnitChangeStatusAction {
961
1275
  * Removing the address from a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAddressRemoved](ctp:api:type:BusinessUnitAddressRemovedMessage) Message.
962
1276
  *
963
1277
  */
964
- export interface BusinessUnitRemoveAddressAction {
1278
+ export interface BusinessUnitRemoveAddressAction extends IBusinessUnitUpdateAction {
965
1279
  readonly action: 'removeAddress';
966
1280
  /**
967
1281
  * ID of the address to be removed. Either `addressId` or `addressKey` is required.
@@ -980,7 +1294,7 @@ export interface BusinessUnitRemoveAddressAction {
980
1294
  * Removing an [Associate](ctp:api:type:Associate) from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateRemoved](ctp:api:type:BusinessUnitAssociateRemovedMessage) Message.
981
1295
  *
982
1296
  */
983
- export interface BusinessUnitRemoveAssociateAction {
1297
+ export interface BusinessUnitRemoveAssociateAction extends IBusinessUnitUpdateAction {
984
1298
  readonly action: 'removeAssociate';
985
1299
  /**
986
1300
  * [Associate](ctp:api:type:Associate) to remove.
@@ -993,7 +1307,7 @@ export interface BusinessUnitRemoveAssociateAction {
993
1307
  * Removing a billing address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressRemoved](ctp:api:type:BusinessUnitBillingAddressRemovedMessage) Message.
994
1308
  *
995
1309
  */
996
- export interface BusinessUnitRemoveBillingAddressIdAction {
1310
+ export interface BusinessUnitRemoveBillingAddressIdAction extends IBusinessUnitUpdateAction {
997
1311
  readonly action: 'removeBillingAddressId';
998
1312
  /**
999
1313
  * ID of the address to be removed from `billingAddressIds`. Either `addressId` or `addressKey` is required.
@@ -1012,7 +1326,7 @@ export interface BusinessUnitRemoveBillingAddressIdAction {
1012
1326
  * Removing a shipping address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressRemoved](ctp:api:type:BusinessUnitShippingAddressRemovedMessage) Message.
1013
1327
  *
1014
1328
  */
1015
- export interface BusinessUnitRemoveShippingAddressIdAction {
1329
+ export interface BusinessUnitRemoveShippingAddressIdAction extends IBusinessUnitUpdateAction {
1016
1330
  readonly action: 'removeShippingAddressId';
1017
1331
  /**
1018
1332
  * ID of the address to be removed from `shippingAddressIds`. Either `addressId` or `addressKey` is required.
@@ -1036,7 +1350,7 @@ export interface BusinessUnitRemoveShippingAddressIdAction {
1036
1350
  * Only applicable when `storeMode` is `Explicit`.
1037
1351
  *
1038
1352
  */
1039
- export interface BusinessUnitRemoveStoreAction {
1353
+ export interface BusinessUnitRemoveStoreAction extends IBusinessUnitUpdateAction {
1040
1354
  readonly action: 'removeStore';
1041
1355
  /**
1042
1356
  * [Store](ctp:api:type:Store) to remove.
@@ -1049,7 +1363,7 @@ export interface BusinessUnitRemoveStoreAction {
1049
1363
  * 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.
1050
1364
  *
1051
1365
  */
1052
- export interface BusinessUnitSetAddressCustomFieldAction {
1366
+ export interface BusinessUnitSetAddressCustomFieldAction extends IBusinessUnitUpdateAction {
1053
1367
  readonly action: 'setAddressCustomField';
1054
1368
  /**
1055
1369
  * ID of the address to be extended.
@@ -1076,7 +1390,7 @@ export interface BusinessUnitSetAddressCustomFieldAction {
1076
1390
  * Adding or updating a Custom Type on 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.
1077
1391
  *
1078
1392
  */
1079
- export interface BusinessUnitSetAddressCustomTypeAction {
1393
+ export interface BusinessUnitSetAddressCustomTypeAction extends IBusinessUnitUpdateAction {
1080
1394
  readonly action: 'setAddressCustomType';
1081
1395
  /**
1082
1396
  * Defines the [Type](ctp:api:type:Type) that extends the `address` with [Custom Fields](/../api/projects/custom-fields).
@@ -1102,7 +1416,7 @@ export interface BusinessUnitSetAddressCustomTypeAction {
1102
1416
  * Changes the Associates of a [Business Unit](ctp:api:type:BusinessUnit), generates a [BusinessUnitAssociatesSet](ctp:api:type:BusinessUnitAssociatesSetMessage) Message.
1103
1417
  *
1104
1418
  */
1105
- export interface BusinessUnitSetAssociatesAction {
1419
+ export interface BusinessUnitSetAssociatesAction extends IBusinessUnitUpdateAction {
1106
1420
  readonly action: 'setAssociates';
1107
1421
  /**
1108
1422
  * The new list of Associates. If empty, existing values will be removed.
@@ -1115,7 +1429,7 @@ export interface BusinessUnitSetAssociatesAction {
1115
1429
  * Setting the contact email on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitContactEmailSet](ctp:api:type:BusinessUnitContactEmailSetMessage) Message.
1116
1430
  *
1117
1431
  */
1118
- export interface BusinessUnitSetContactEmailAction {
1432
+ export interface BusinessUnitSetContactEmailAction extends IBusinessUnitUpdateAction {
1119
1433
  readonly action: 'setContactEmail';
1120
1434
  /**
1121
1435
  * Email to set.
@@ -1129,7 +1443,7 @@ export interface BusinessUnitSetContactEmailAction {
1129
1443
  * 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.
1130
1444
  *
1131
1445
  */
1132
- export interface BusinessUnitSetCustomFieldAction {
1446
+ export interface BusinessUnitSetCustomFieldAction extends IBusinessUnitUpdateAction {
1133
1447
  readonly action: 'setCustomField';
1134
1448
  /**
1135
1449
  * Name of the [Custom Field](/../api/projects/custom-fields) to add, update, or remove.
@@ -1150,7 +1464,7 @@ export interface BusinessUnitSetCustomFieldAction {
1150
1464
  * 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.
1151
1465
  *
1152
1466
  */
1153
- export interface BusinessUnitSetCustomTypeAction {
1467
+ export interface BusinessUnitSetCustomTypeAction extends IBusinessUnitUpdateAction {
1154
1468
  readonly action: 'setCustomType';
1155
1469
  /**
1156
1470
  * Defines the [Type](ctp:api:type:Type) that extends the BusinessUnit with [Custom Fields](ctp:api:type:CustomFields).
@@ -1170,7 +1484,7 @@ export interface BusinessUnitSetCustomTypeAction {
1170
1484
  * Setting the default billing address on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitDefaultBillingAddressSet](ctp:api:type:BusinessUnitDefaultBillingAddressSetMessage) Message.
1171
1485
  *
1172
1486
  */
1173
- export interface BusinessUnitSetDefaultBillingAddressAction {
1487
+ export interface BusinessUnitSetDefaultBillingAddressAction extends IBusinessUnitUpdateAction {
1174
1488
  readonly action: 'setDefaultBillingAddress';
1175
1489
  /**
1176
1490
  * ID of the address to add as a billing address. Either `addressId` or `addressKey` is required.
@@ -1189,7 +1503,7 @@ export interface BusinessUnitSetDefaultBillingAddressAction {
1189
1503
  * Setting the default shipping address on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitDefaultShippingAddressSet](ctp:api:type:BusinessUnitDefaultShippingAddressSetMessage) Message.
1190
1504
  *
1191
1505
  */
1192
- export interface BusinessUnitSetDefaultShippingAddressAction {
1506
+ export interface BusinessUnitSetDefaultShippingAddressAction extends IBusinessUnitUpdateAction {
1193
1507
  readonly action: 'setDefaultShippingAddress';
1194
1508
  /**
1195
1509
  * ID of the address to add as a shipping address. Either `addressId` or `addressKey` is required.
@@ -1209,7 +1523,7 @@ export interface BusinessUnitSetDefaultShippingAddressAction {
1209
1523
  * This update action generates a [BusinessUnitStoreModeChanged](ctp:api:type:BusinessUnitStoreModeChangedMessage) Message.
1210
1524
  *
1211
1525
  */
1212
- export interface BusinessUnitSetStoreModeAction {
1526
+ export interface BusinessUnitSetStoreModeAction extends IBusinessUnitUpdateAction {
1213
1527
  readonly action: 'setStoreMode';
1214
1528
  /**
1215
1529
  * Set to `Explicit` to specify Stores for the Business Unit. Set to `FromParent` to inherit Stores from a parent.
@@ -1232,7 +1546,7 @@ export interface BusinessUnitSetStoreModeAction {
1232
1546
  * Setting the Stores on a Business Unit generates a [BusinessUnitStoresSet](ctp:api:type:BusinessUnitStoresSetMessage) Message.
1233
1547
  *
1234
1548
  */
1235
- export interface BusinessUnitSetStoresAction {
1549
+ export interface BusinessUnitSetStoresAction extends IBusinessUnitUpdateAction {
1236
1550
  readonly action: 'setStores';
1237
1551
  /**
1238
1552
  * [Stores](ctp:api:type:Store) to set. Overrides the current list of Stores.