@gradientedge/commercetools-utils 5.18.2 → 5.19.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 (363) hide show
  1. package/dist/cjs/api/CommercetoolsApi.d.ts +11 -11
  2. package/dist/cjs/api/CommercetoolsApi.d.ts.map +1 -1
  3. package/dist/cjs/api/CommercetoolsApi.js +7 -7
  4. package/dist/cjs/api/CommercetoolsApi.js.map +1 -1
  5. package/dist/cjs/index.d.ts +0 -1
  6. package/dist/cjs/index.d.ts.map +1 -1
  7. package/dist/cjs/index.js +0 -1
  8. package/dist/cjs/index.js.map +1 -1
  9. package/dist/cjs/types.d.ts +1 -0
  10. package/dist/cjs/types.d.ts.map +1 -1
  11. package/dist/cjs/utils/get-attribute-value.d.ts +1 -1
  12. package/dist/cjs/utils/get-attribute-value.d.ts.map +1 -1
  13. package/dist/cjs/utils/get-attribute-value.js.map +1 -1
  14. package/dist/mjs/api/CommercetoolsApi.d.ts +11 -11
  15. package/dist/mjs/api/CommercetoolsApi.d.ts.map +1 -1
  16. package/dist/mjs/api/CommercetoolsApi.js +8 -8
  17. package/dist/mjs/api/CommercetoolsApi.js.map +1 -1
  18. package/dist/mjs/index.d.ts +0 -1
  19. package/dist/mjs/index.d.ts.map +1 -1
  20. package/dist/mjs/index.js +0 -1
  21. package/dist/mjs/index.js.map +1 -1
  22. package/dist/mjs/types.d.ts +1 -0
  23. package/dist/mjs/types.d.ts.map +1 -1
  24. package/dist/mjs/utils/get-attribute-value.d.ts +1 -1
  25. package/dist/mjs/utils/get-attribute-value.d.ts.map +1 -1
  26. package/dist/mjs/utils/get-attribute-value.js.map +1 -1
  27. package/package.json +2 -1
  28. package/dist/cjs/models/associate-role.d.ts +0 -319
  29. package/dist/cjs/models/associate-role.d.ts.map +0 -1
  30. package/dist/cjs/models/associate-role.js +0 -8
  31. package/dist/cjs/models/associate-role.js.map +0 -1
  32. package/dist/cjs/models/attribute-group.d.ts +0 -253
  33. package/dist/cjs/models/attribute-group.d.ts.map +0 -1
  34. package/dist/cjs/models/attribute-group.js +0 -8
  35. package/dist/cjs/models/attribute-group.js.map +0 -1
  36. package/dist/cjs/models/business-unit.d.ts +0 -1197
  37. package/dist/cjs/models/business-unit.d.ts.map +0 -1
  38. package/dist/cjs/models/business-unit.js +0 -8
  39. package/dist/cjs/models/business-unit.js.map +0 -1
  40. package/dist/cjs/models/cart-discount.d.ts +0 -716
  41. package/dist/cjs/models/cart-discount.d.ts.map +0 -1
  42. package/dist/cjs/models/cart-discount.js +0 -8
  43. package/dist/cjs/models/cart-discount.js.map +0 -1
  44. package/dist/cjs/models/cart.d.ts +0 -3366
  45. package/dist/cjs/models/cart.d.ts.map +0 -1
  46. package/dist/cjs/models/cart.js +0 -8
  47. package/dist/cjs/models/cart.js.map +0 -1
  48. package/dist/cjs/models/category.d.ts +0 -634
  49. package/dist/cjs/models/category.d.ts.map +0 -1
  50. package/dist/cjs/models/category.js +0 -8
  51. package/dist/cjs/models/category.js.map +0 -1
  52. package/dist/cjs/models/channel.d.ts +0 -379
  53. package/dist/cjs/models/channel.d.ts.map +0 -1
  54. package/dist/cjs/models/channel.js +0 -8
  55. package/dist/cjs/models/channel.js.map +0 -1
  56. package/dist/cjs/models/common.d.ts +0 -1096
  57. package/dist/cjs/models/common.d.ts.map +0 -1
  58. package/dist/cjs/models/common.js +0 -8
  59. package/dist/cjs/models/common.js.map +0 -1
  60. package/dist/cjs/models/custom-object.d.ts +0 -151
  61. package/dist/cjs/models/custom-object.d.ts.map +0 -1
  62. package/dist/cjs/models/custom-object.js +0 -8
  63. package/dist/cjs/models/custom-object.js.map +0 -1
  64. package/dist/cjs/models/customer-group.d.ts +0 -235
  65. package/dist/cjs/models/customer-group.d.ts.map +0 -1
  66. package/dist/cjs/models/customer-group.js +0 -8
  67. package/dist/cjs/models/customer-group.js.map +0 -1
  68. package/dist/cjs/models/customer.d.ts +0 -1221
  69. package/dist/cjs/models/customer.d.ts.map +0 -1
  70. package/dist/cjs/models/customer.js +0 -8
  71. package/dist/cjs/models/customer.js.map +0 -1
  72. package/dist/cjs/models/discount-code.d.ts +0 -439
  73. package/dist/cjs/models/discount-code.d.ts.map +0 -1
  74. package/dist/cjs/models/discount-code.js +0 -8
  75. package/dist/cjs/models/discount-code.js.map +0 -1
  76. package/dist/cjs/models/error.d.ts +0 -3062
  77. package/dist/cjs/models/error.d.ts.map +0 -1
  78. package/dist/cjs/models/error.js +0 -8
  79. package/dist/cjs/models/error.js.map +0 -1
  80. package/dist/cjs/models/extension.d.ts +0 -335
  81. package/dist/cjs/models/extension.d.ts.map +0 -1
  82. package/dist/cjs/models/extension.js +0 -8
  83. package/dist/cjs/models/extension.js.map +0 -1
  84. package/dist/cjs/models/graph-ql.d.ts +0 -63
  85. package/dist/cjs/models/graph-ql.d.ts.map +0 -1
  86. package/dist/cjs/models/graph-ql.js +0 -8
  87. package/dist/cjs/models/graph-ql.js.map +0 -1
  88. package/dist/cjs/models/index.d.ts +0 -42
  89. package/dist/cjs/models/index.d.ts.map +0 -1
  90. package/dist/cjs/models/index.js +0 -58
  91. package/dist/cjs/models/index.js.map +0 -1
  92. package/dist/cjs/models/inventory.d.ts +0 -327
  93. package/dist/cjs/models/inventory.d.ts.map +0 -1
  94. package/dist/cjs/models/inventory.js +0 -8
  95. package/dist/cjs/models/inventory.js.map +0 -1
  96. package/dist/cjs/models/me.d.ts +0 -2483
  97. package/dist/cjs/models/me.d.ts.map +0 -1
  98. package/dist/cjs/models/me.js +0 -8
  99. package/dist/cjs/models/me.js.map +0 -1
  100. package/dist/cjs/models/message.d.ts +0 -15095
  101. package/dist/cjs/models/message.d.ts.map +0 -1
  102. package/dist/cjs/models/message.js +0 -8
  103. package/dist/cjs/models/message.js.map +0 -1
  104. package/dist/cjs/models/order-edit.d.ts +0 -1645
  105. package/dist/cjs/models/order-edit.d.ts.map +0 -1
  106. package/dist/cjs/models/order-edit.js +0 -8
  107. package/dist/cjs/models/order-edit.js.map +0 -1
  108. package/dist/cjs/models/order.d.ts +0 -2157
  109. package/dist/cjs/models/order.d.ts.map +0 -1
  110. package/dist/cjs/models/order.js +0 -8
  111. package/dist/cjs/models/order.js.map +0 -1
  112. package/dist/cjs/models/payment.d.ts +0 -734
  113. package/dist/cjs/models/payment.d.ts.map +0 -1
  114. package/dist/cjs/models/payment.js +0 -8
  115. package/dist/cjs/models/payment.js.map +0 -1
  116. package/dist/cjs/models/product-discount.d.ts +0 -461
  117. package/dist/cjs/models/product-discount.d.ts.map +0 -1
  118. package/dist/cjs/models/product-discount.js +0 -8
  119. package/dist/cjs/models/product-discount.js.map +0 -1
  120. package/dist/cjs/models/product-selection.d.ts +0 -638
  121. package/dist/cjs/models/product-selection.d.ts.map +0 -1
  122. package/dist/cjs/models/product-selection.js +0 -8
  123. package/dist/cjs/models/product-selection.js.map +0 -1
  124. package/dist/cjs/models/product-type.d.ts +0 -774
  125. package/dist/cjs/models/product-type.d.ts.map +0 -1
  126. package/dist/cjs/models/product-type.js +0 -8
  127. package/dist/cjs/models/product-type.js.map +0 -1
  128. package/dist/cjs/models/product.d.ts +0 -2282
  129. package/dist/cjs/models/product.d.ts.map +0 -1
  130. package/dist/cjs/models/product.js +0 -8
  131. package/dist/cjs/models/product.js.map +0 -1
  132. package/dist/cjs/models/project.d.ts +0 -381
  133. package/dist/cjs/models/project.d.ts.map +0 -1
  134. package/dist/cjs/models/project.js +0 -8
  135. package/dist/cjs/models/project.js.map +0 -1
  136. package/dist/cjs/models/quote-request.d.ts +0 -430
  137. package/dist/cjs/models/quote-request.d.ts.map +0 -1
  138. package/dist/cjs/models/quote-request.js +0 -8
  139. package/dist/cjs/models/quote-request.js.map +0 -1
  140. package/dist/cjs/models/quote.d.ts +0 -458
  141. package/dist/cjs/models/quote.d.ts.map +0 -1
  142. package/dist/cjs/models/quote.js +0 -8
  143. package/dist/cjs/models/quote.js.map +0 -1
  144. package/dist/cjs/models/review.d.ts +0 -435
  145. package/dist/cjs/models/review.d.ts.map +0 -1
  146. package/dist/cjs/models/review.js +0 -8
  147. package/dist/cjs/models/review.js.map +0 -1
  148. package/dist/cjs/models/scalar-types.d.ts +0 -9
  149. package/dist/cjs/models/scalar-types.d.ts.map +0 -1
  150. package/dist/cjs/models/scalar-types.js +0 -8
  151. package/dist/cjs/models/scalar-types.js.map +0 -1
  152. package/dist/cjs/models/shipping-method.d.ts +0 -569
  153. package/dist/cjs/models/shipping-method.d.ts.map +0 -1
  154. package/dist/cjs/models/shipping-method.js +0 -8
  155. package/dist/cjs/models/shipping-method.js.map +0 -1
  156. package/dist/cjs/models/shopping-list.d.ts +0 -844
  157. package/dist/cjs/models/shopping-list.d.ts.map +0 -1
  158. package/dist/cjs/models/shopping-list.js +0 -8
  159. package/dist/cjs/models/shopping-list.js.map +0 -1
  160. package/dist/cjs/models/staged-quote.d.ts +0 -338
  161. package/dist/cjs/models/staged-quote.d.ts.map +0 -1
  162. package/dist/cjs/models/staged-quote.js +0 -8
  163. package/dist/cjs/models/staged-quote.js.map +0 -1
  164. package/dist/cjs/models/standalone-price.d.ts +0 -410
  165. package/dist/cjs/models/standalone-price.d.ts.map +0 -1
  166. package/dist/cjs/models/standalone-price.js +0 -8
  167. package/dist/cjs/models/standalone-price.js.map +0 -1
  168. package/dist/cjs/models/state.d.ts +0 -341
  169. package/dist/cjs/models/state.d.ts.map +0 -1
  170. package/dist/cjs/models/state.js +0 -8
  171. package/dist/cjs/models/state.js.map +0 -1
  172. package/dist/cjs/models/store-country.d.ts +0 -14
  173. package/dist/cjs/models/store-country.d.ts.map +0 -1
  174. package/dist/cjs/models/store-country.js +0 -8
  175. package/dist/cjs/models/store-country.js.map +0 -1
  176. package/dist/cjs/models/store.d.ts +0 -547
  177. package/dist/cjs/models/store.d.ts.map +0 -1
  178. package/dist/cjs/models/store.js +0 -8
  179. package/dist/cjs/models/store.js.map +0 -1
  180. package/dist/cjs/models/subscription.d.ts +0 -717
  181. package/dist/cjs/models/subscription.d.ts.map +0 -1
  182. package/dist/cjs/models/subscription.js +0 -8
  183. package/dist/cjs/models/subscription.js.map +0 -1
  184. package/dist/cjs/models/tax-category.d.ts +0 -376
  185. package/dist/cjs/models/tax-category.d.ts.map +0 -1
  186. package/dist/cjs/models/tax-category.js +0 -8
  187. package/dist/cjs/models/tax-category.js.map +0 -1
  188. package/dist/cjs/models/type.d.ts +0 -645
  189. package/dist/cjs/models/type.d.ts.map +0 -1
  190. package/dist/cjs/models/type.js +0 -8
  191. package/dist/cjs/models/type.js.map +0 -1
  192. package/dist/cjs/models/zone.d.ts +0 -234
  193. package/dist/cjs/models/zone.d.ts.map +0 -1
  194. package/dist/cjs/models/zone.js +0 -8
  195. package/dist/cjs/models/zone.js.map +0 -1
  196. package/dist/mjs/models/associate-role.d.ts +0 -319
  197. package/dist/mjs/models/associate-role.d.ts.map +0 -1
  198. package/dist/mjs/models/associate-role.js +0 -7
  199. package/dist/mjs/models/associate-role.js.map +0 -1
  200. package/dist/mjs/models/attribute-group.d.ts +0 -253
  201. package/dist/mjs/models/attribute-group.d.ts.map +0 -1
  202. package/dist/mjs/models/attribute-group.js +0 -7
  203. package/dist/mjs/models/attribute-group.js.map +0 -1
  204. package/dist/mjs/models/business-unit.d.ts +0 -1197
  205. package/dist/mjs/models/business-unit.d.ts.map +0 -1
  206. package/dist/mjs/models/business-unit.js +0 -7
  207. package/dist/mjs/models/business-unit.js.map +0 -1
  208. package/dist/mjs/models/cart-discount.d.ts +0 -716
  209. package/dist/mjs/models/cart-discount.d.ts.map +0 -1
  210. package/dist/mjs/models/cart-discount.js +0 -7
  211. package/dist/mjs/models/cart-discount.js.map +0 -1
  212. package/dist/mjs/models/cart.d.ts +0 -3366
  213. package/dist/mjs/models/cart.d.ts.map +0 -1
  214. package/dist/mjs/models/cart.js +0 -7
  215. package/dist/mjs/models/cart.js.map +0 -1
  216. package/dist/mjs/models/category.d.ts +0 -634
  217. package/dist/mjs/models/category.d.ts.map +0 -1
  218. package/dist/mjs/models/category.js +0 -7
  219. package/dist/mjs/models/category.js.map +0 -1
  220. package/dist/mjs/models/channel.d.ts +0 -379
  221. package/dist/mjs/models/channel.d.ts.map +0 -1
  222. package/dist/mjs/models/channel.js +0 -7
  223. package/dist/mjs/models/channel.js.map +0 -1
  224. package/dist/mjs/models/common.d.ts +0 -1096
  225. package/dist/mjs/models/common.d.ts.map +0 -1
  226. package/dist/mjs/models/common.js +0 -7
  227. package/dist/mjs/models/common.js.map +0 -1
  228. package/dist/mjs/models/custom-object.d.ts +0 -151
  229. package/dist/mjs/models/custom-object.d.ts.map +0 -1
  230. package/dist/mjs/models/custom-object.js +0 -7
  231. package/dist/mjs/models/custom-object.js.map +0 -1
  232. package/dist/mjs/models/customer-group.d.ts +0 -235
  233. package/dist/mjs/models/customer-group.d.ts.map +0 -1
  234. package/dist/mjs/models/customer-group.js +0 -7
  235. package/dist/mjs/models/customer-group.js.map +0 -1
  236. package/dist/mjs/models/customer.d.ts +0 -1221
  237. package/dist/mjs/models/customer.d.ts.map +0 -1
  238. package/dist/mjs/models/customer.js +0 -7
  239. package/dist/mjs/models/customer.js.map +0 -1
  240. package/dist/mjs/models/discount-code.d.ts +0 -439
  241. package/dist/mjs/models/discount-code.d.ts.map +0 -1
  242. package/dist/mjs/models/discount-code.js +0 -7
  243. package/dist/mjs/models/discount-code.js.map +0 -1
  244. package/dist/mjs/models/error.d.ts +0 -3062
  245. package/dist/mjs/models/error.d.ts.map +0 -1
  246. package/dist/mjs/models/error.js +0 -7
  247. package/dist/mjs/models/error.js.map +0 -1
  248. package/dist/mjs/models/extension.d.ts +0 -335
  249. package/dist/mjs/models/extension.d.ts.map +0 -1
  250. package/dist/mjs/models/extension.js +0 -7
  251. package/dist/mjs/models/extension.js.map +0 -1
  252. package/dist/mjs/models/graph-ql.d.ts +0 -63
  253. package/dist/mjs/models/graph-ql.d.ts.map +0 -1
  254. package/dist/mjs/models/graph-ql.js +0 -7
  255. package/dist/mjs/models/graph-ql.js.map +0 -1
  256. package/dist/mjs/models/index.d.ts +0 -42
  257. package/dist/mjs/models/index.d.ts.map +0 -1
  258. package/dist/mjs/models/index.js +0 -42
  259. package/dist/mjs/models/index.js.map +0 -1
  260. package/dist/mjs/models/inventory.d.ts +0 -327
  261. package/dist/mjs/models/inventory.d.ts.map +0 -1
  262. package/dist/mjs/models/inventory.js +0 -7
  263. package/dist/mjs/models/inventory.js.map +0 -1
  264. package/dist/mjs/models/me.d.ts +0 -2483
  265. package/dist/mjs/models/me.d.ts.map +0 -1
  266. package/dist/mjs/models/me.js +0 -7
  267. package/dist/mjs/models/me.js.map +0 -1
  268. package/dist/mjs/models/message.d.ts +0 -15095
  269. package/dist/mjs/models/message.d.ts.map +0 -1
  270. package/dist/mjs/models/message.js +0 -7
  271. package/dist/mjs/models/message.js.map +0 -1
  272. package/dist/mjs/models/order-edit.d.ts +0 -1645
  273. package/dist/mjs/models/order-edit.d.ts.map +0 -1
  274. package/dist/mjs/models/order-edit.js +0 -7
  275. package/dist/mjs/models/order-edit.js.map +0 -1
  276. package/dist/mjs/models/order.d.ts +0 -2157
  277. package/dist/mjs/models/order.d.ts.map +0 -1
  278. package/dist/mjs/models/order.js +0 -7
  279. package/dist/mjs/models/order.js.map +0 -1
  280. package/dist/mjs/models/payment.d.ts +0 -734
  281. package/dist/mjs/models/payment.d.ts.map +0 -1
  282. package/dist/mjs/models/payment.js +0 -7
  283. package/dist/mjs/models/payment.js.map +0 -1
  284. package/dist/mjs/models/product-discount.d.ts +0 -461
  285. package/dist/mjs/models/product-discount.d.ts.map +0 -1
  286. package/dist/mjs/models/product-discount.js +0 -7
  287. package/dist/mjs/models/product-discount.js.map +0 -1
  288. package/dist/mjs/models/product-selection.d.ts +0 -638
  289. package/dist/mjs/models/product-selection.d.ts.map +0 -1
  290. package/dist/mjs/models/product-selection.js +0 -7
  291. package/dist/mjs/models/product-selection.js.map +0 -1
  292. package/dist/mjs/models/product-type.d.ts +0 -774
  293. package/dist/mjs/models/product-type.d.ts.map +0 -1
  294. package/dist/mjs/models/product-type.js +0 -7
  295. package/dist/mjs/models/product-type.js.map +0 -1
  296. package/dist/mjs/models/product.d.ts +0 -2282
  297. package/dist/mjs/models/product.d.ts.map +0 -1
  298. package/dist/mjs/models/product.js +0 -7
  299. package/dist/mjs/models/product.js.map +0 -1
  300. package/dist/mjs/models/project.d.ts +0 -381
  301. package/dist/mjs/models/project.d.ts.map +0 -1
  302. package/dist/mjs/models/project.js +0 -7
  303. package/dist/mjs/models/project.js.map +0 -1
  304. package/dist/mjs/models/quote-request.d.ts +0 -430
  305. package/dist/mjs/models/quote-request.d.ts.map +0 -1
  306. package/dist/mjs/models/quote-request.js +0 -7
  307. package/dist/mjs/models/quote-request.js.map +0 -1
  308. package/dist/mjs/models/quote.d.ts +0 -458
  309. package/dist/mjs/models/quote.d.ts.map +0 -1
  310. package/dist/mjs/models/quote.js +0 -7
  311. package/dist/mjs/models/quote.js.map +0 -1
  312. package/dist/mjs/models/review.d.ts +0 -435
  313. package/dist/mjs/models/review.d.ts.map +0 -1
  314. package/dist/mjs/models/review.js +0 -7
  315. package/dist/mjs/models/review.js.map +0 -1
  316. package/dist/mjs/models/scalar-types.d.ts +0 -9
  317. package/dist/mjs/models/scalar-types.d.ts.map +0 -1
  318. package/dist/mjs/models/scalar-types.js +0 -7
  319. package/dist/mjs/models/scalar-types.js.map +0 -1
  320. package/dist/mjs/models/shipping-method.d.ts +0 -569
  321. package/dist/mjs/models/shipping-method.d.ts.map +0 -1
  322. package/dist/mjs/models/shipping-method.js +0 -7
  323. package/dist/mjs/models/shipping-method.js.map +0 -1
  324. package/dist/mjs/models/shopping-list.d.ts +0 -844
  325. package/dist/mjs/models/shopping-list.d.ts.map +0 -1
  326. package/dist/mjs/models/shopping-list.js +0 -7
  327. package/dist/mjs/models/shopping-list.js.map +0 -1
  328. package/dist/mjs/models/staged-quote.d.ts +0 -338
  329. package/dist/mjs/models/staged-quote.d.ts.map +0 -1
  330. package/dist/mjs/models/staged-quote.js +0 -7
  331. package/dist/mjs/models/staged-quote.js.map +0 -1
  332. package/dist/mjs/models/standalone-price.d.ts +0 -410
  333. package/dist/mjs/models/standalone-price.d.ts.map +0 -1
  334. package/dist/mjs/models/standalone-price.js +0 -7
  335. package/dist/mjs/models/standalone-price.js.map +0 -1
  336. package/dist/mjs/models/state.d.ts +0 -341
  337. package/dist/mjs/models/state.d.ts.map +0 -1
  338. package/dist/mjs/models/state.js +0 -7
  339. package/dist/mjs/models/state.js.map +0 -1
  340. package/dist/mjs/models/store-country.d.ts +0 -14
  341. package/dist/mjs/models/store-country.d.ts.map +0 -1
  342. package/dist/mjs/models/store-country.js +0 -7
  343. package/dist/mjs/models/store-country.js.map +0 -1
  344. package/dist/mjs/models/store.d.ts +0 -547
  345. package/dist/mjs/models/store.d.ts.map +0 -1
  346. package/dist/mjs/models/store.js +0 -7
  347. package/dist/mjs/models/store.js.map +0 -1
  348. package/dist/mjs/models/subscription.d.ts +0 -717
  349. package/dist/mjs/models/subscription.d.ts.map +0 -1
  350. package/dist/mjs/models/subscription.js +0 -7
  351. package/dist/mjs/models/subscription.js.map +0 -1
  352. package/dist/mjs/models/tax-category.d.ts +0 -376
  353. package/dist/mjs/models/tax-category.d.ts.map +0 -1
  354. package/dist/mjs/models/tax-category.js +0 -7
  355. package/dist/mjs/models/tax-category.js.map +0 -1
  356. package/dist/mjs/models/type.d.ts +0 -645
  357. package/dist/mjs/models/type.d.ts.map +0 -1
  358. package/dist/mjs/models/type.js +0 -7
  359. package/dist/mjs/models/type.js.map +0 -1
  360. package/dist/mjs/models/zone.d.ts +0 -234
  361. package/dist/mjs/models/zone.d.ts.map +0 -1
  362. package/dist/mjs/models/zone.js +0 -7
  363. package/dist/mjs/models/zone.js.map +0 -1
@@ -1,844 +0,0 @@
1
- /**
2
- * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
3
- * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
- * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
- */
6
- import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString } from './common.js';
7
- import { CustomerReference, CustomerResourceIdentifier } from './customer.js';
8
- import { ProductVariant } from './product.js';
9
- import { ProductTypeReference } from './product-type.js';
10
- import { StoreKeyReference, StoreResourceIdentifier } from './store.js';
11
- import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
12
- export interface ShoppingList extends BaseResource {
13
- /**
14
- * Unique identifier of the ShoppingList.
15
- *
16
- */
17
- readonly id: string;
18
- /**
19
- * Current version of the ShoppingList.
20
- *
21
- */
22
- readonly version: number;
23
- /**
24
- * Name of the ShoppingList.
25
- *
26
- *
27
- */
28
- readonly name: LocalizedString;
29
- /**
30
- * User-defined unique identifier of the ShoppingList.
31
- *
32
- */
33
- readonly key?: string;
34
- /**
35
- * Reference to a [Customer](ctp:api:type:Customer) associated with the ShoppingList.
36
- *
37
- *
38
- */
39
- readonly customer?: CustomerReference;
40
- /**
41
- * Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
42
- * Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages.
43
- * The slug must match the pattern `[a-zA-Z0-9_-]{2,256}`. For [good performance](/predicates/query#performance-considerations), indexes are provided for the first 15 `languages` set on the [Project](ctp:api:type:Project).
44
- *
45
- */
46
- readonly slug?: LocalizedString;
47
- /**
48
- * Description of the ShoppingList.
49
- *
50
- *
51
- */
52
- readonly description?: LocalizedString;
53
- /**
54
- * Line Items (containing Products) of the ShoppingList.
55
- *
56
- *
57
- */
58
- readonly lineItems: ShoppingListLineItem[];
59
- /**
60
- * Line Items (containing text values) of the ShoppingList.
61
- *
62
- *
63
- */
64
- readonly textLineItems: TextLineItem[];
65
- /**
66
- * Number of days after which the ShoppingList will be automatically deleted if it has not been modified.
67
- *
68
- */
69
- readonly deleteDaysAfterLastModification?: number;
70
- /**
71
- * Identifies ShoppingLists belonging to an [anonymous session](ctp:api:type:AnonymousSession).
72
- *
73
- */
74
- readonly anonymousId?: string;
75
- /**
76
- * Store to which the ShoppingList is assigned.
77
- *
78
- *
79
- */
80
- readonly store?: StoreKeyReference;
81
- /**
82
- * Custom Fields defined for the ShoppingList.
83
- *
84
- *
85
- */
86
- readonly custom?: CustomFields;
87
- /**
88
- * Date and time (UTC) the ShoppingList was initially created.
89
- *
90
- *
91
- */
92
- readonly createdAt: string;
93
- /**
94
- * Date and time (UTC) the ShoppingList was last updated.
95
- *
96
- *
97
- */
98
- readonly lastModifiedAt: string;
99
- /**
100
- * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
101
- *
102
- *
103
- */
104
- readonly lastModifiedBy?: LastModifiedBy;
105
- /**
106
- * Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
107
- *
108
- *
109
- */
110
- readonly createdBy?: CreatedBy;
111
- }
112
- export interface ShoppingListDraft {
113
- /**
114
- * Name of the ShoppingList.
115
- *
116
- *
117
- */
118
- readonly name: LocalizedString;
119
- /**
120
- * Human-readable identifiers usually used as deep-link URL to the related ShoppingList.
121
- * Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages.
122
- * The slug must match the pattern `[a-zA-Z0-9_-]{2,256}`.
123
- *
124
- */
125
- readonly slug?: LocalizedString;
126
- /**
127
- * The [Customer](ctp:api:type:Customer) the ShoppingList should be associated to.
128
- *
129
- *
130
- */
131
- readonly customer?: CustomerResourceIdentifier;
132
- /**
133
- * User-defined unique identifier for the ShoppingList.
134
- *
135
- *
136
- */
137
- readonly key?: string;
138
- /**
139
- * Description of the ShoppingList.
140
- *
141
- *
142
- */
143
- readonly description?: LocalizedString;
144
- /**
145
- * Identifies ShoppingLists belonging to an [anonymous session](ctp:api:type:AnonymousSession).
146
- *
147
- */
148
- readonly anonymousId?: string;
149
- /**
150
- * Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the [default value](ctp:api:type:ShoppingListsConfiguration) configured in the [Project](ctp:api:type:Project) is used.
151
- *
152
- *
153
- */
154
- readonly deleteDaysAfterLastModification?: number;
155
- /**
156
- * Line Items (containing Products) to add to the ShoppingList.
157
- *
158
- *
159
- */
160
- readonly lineItems?: ShoppingListLineItemDraft[];
161
- /**
162
- * Line Items (containing text values) to add to the ShoppingList.
163
- *
164
- *
165
- */
166
- readonly textLineItems?: TextLineItemDraft[];
167
- /**
168
- * Assigns the new ShoppingList to the [Store](ctp:api:type:Store).
169
- *
170
- *
171
- */
172
- readonly store?: StoreResourceIdentifier;
173
- /**
174
- * Custom Fields defined for the ShoppingList.
175
- *
176
- */
177
- readonly custom?: CustomFieldsDraft;
178
- }
179
- /**
180
- * ShoppingListLineItems are Line Items that contain references to [ProductVariants](ctp:api:type:ProductVariant) in a [Product](ctp:api:type:Product).
181
- *
182
- * In addition to standard [Reference Expansion](/general-concepts#reference-expansion), a ShoppingListLineItem offers expansion on `productSlug` and `variant`, defined with the query parameter `expand`.
183
- *
184
- */
185
- export interface ShoppingListLineItem {
186
- /**
187
- * Date and time (UTC) the ShoppingListLineItem was added to the ShoppingList.
188
- *
189
- *
190
- */
191
- readonly addedAt: string;
192
- /**
193
- * Custom Fields of the ShoppingListLineItem.
194
- *
195
- *
196
- */
197
- readonly custom?: CustomFields;
198
- /**
199
- * If the Product or Product Variant is deleted, `deactivatedAt` is the date and time (UTC) of deletion.
200
- *
201
- * This data is updated in an [eventual consistent manner](/general-concepts#eventual-consistency) when the Product Variant cannot be ordered anymore.
202
- *
203
- *
204
- */
205
- readonly deactivatedAt?: string;
206
- /**
207
- * Unique identifier of the ShoppingListLineItem.
208
- *
209
- */
210
- readonly id: string;
211
- /**
212
- * Name of the Product.
213
- *
214
- * This data is updated in an [eventual consistent manner](/general-concepts#eventual-consistency) when the Product's name changes.
215
- *
216
- *
217
- */
218
- readonly name: LocalizedString;
219
- /**
220
- * Unique identifier of a [Product](ctp:api:type:Product).
221
- *
222
- *
223
- */
224
- readonly productId: string;
225
- /**
226
- * The Product Type defining the Attributes of the [Product](ctp:api:type:Product).
227
- *
228
- *
229
- */
230
- readonly productType: ProductTypeReference;
231
- /**
232
- * Number of Products in the ShoppingListLineItem.
233
- *
234
- *
235
- */
236
- readonly quantity: number;
237
- /**
238
- * `id` of the [ProductVariant](ctp:api:type:ProductVariant) the ShoppingListLineItem refers to. If not set, the ShoppingListLineItem refers to the Master Variant.
239
- *
240
- *
241
- */
242
- readonly variantId?: number;
243
- /**
244
- * Data of the [ProductVariant](ctp:api:type:ProductVariant).
245
- *
246
- * Returned when expanded using `expand=lineItems[*].variant`. You cannot expand only a single element of the array.
247
- *
248
- *
249
- */
250
- readonly variant?: ProductVariant;
251
- /**
252
- * Slug of the current [ProductData](ctp:api:type:ProductData).
253
- *
254
- * Returned when expanded using `expand=lineItems[*].productSlug`. You cannot expand only a single element of the array.
255
- *
256
- *
257
- */
258
- readonly productSlug?: LocalizedString;
259
- }
260
- /**
261
- * The [ProductVariant](ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`.
262
- *
263
- */
264
- export interface ShoppingListLineItemDraft {
265
- /**
266
- * Unique identifier of a [Product](ctp:api:type:Product).
267
- *
268
- *
269
- */
270
- readonly productId?: string;
271
- /**
272
- * `id` of the [ProductVariant](ctp:api:type:ProductVariant). If not set, the ShoppingListLineItem refers to the Master Variant.
273
- *
274
- *
275
- */
276
- readonly variantId?: number;
277
- /**
278
- * `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
279
- *
280
- *
281
- */
282
- readonly sku?: string;
283
- /**
284
- * Date and time the ShoppingListLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
285
- *
286
- *
287
- */
288
- readonly addedAt?: string;
289
- /**
290
- * Custom Fields of the ShoppingListLineItem.
291
- *
292
- *
293
- */
294
- readonly custom?: CustomFieldsDraft;
295
- /**
296
- * Number of Products in the ShoppingListLineItem.
297
- *
298
- *
299
- */
300
- readonly quantity?: number;
301
- }
302
- export interface ShoppingListPagedQueryResponse {
303
- /**
304
- * Number of [results requested](/../api/general-concepts#limit).
305
- *
306
- *
307
- */
308
- readonly limit: number;
309
- /**
310
- * Actual number of results returned.
311
- *
312
- *
313
- */
314
- readonly count: number;
315
- /**
316
- * Total number of results matching the query.
317
- * This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
318
- * This field is returned by default.
319
- * For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
320
- * When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
321
- *
322
- *
323
- */
324
- readonly total?: number;
325
- /**
326
- * Number of [elements skipped](/../api/general-concepts#offset).
327
- *
328
- *
329
- */
330
- readonly offset: number;
331
- /**
332
- * [ShoppingLists](ctp:api:type:ShoppingList) matching the query.
333
- *
334
- *
335
- */
336
- readonly results: ShoppingList[];
337
- }
338
- /**
339
- * [Reference](ctp:api:type:Reference) to a [ShoppingList](ctp:api:type:ShoppingList).
340
- *
341
- */
342
- export interface ShoppingListReference {
343
- readonly typeId: 'shopping-list';
344
- /**
345
- * Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList).
346
- *
347
- *
348
- */
349
- readonly id: string;
350
- /**
351
- * Contains the representation of the expanded ShoppingList. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for ShoppingLists.
352
- *
353
- *
354
- */
355
- readonly obj?: ShoppingList;
356
- }
357
- /**
358
- * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList).
359
- *
360
- */
361
- export interface ShoppingListResourceIdentifier {
362
- readonly typeId: 'shopping-list';
363
- /**
364
- * Unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required.
365
- *
366
- *
367
- */
368
- readonly id?: string;
369
- /**
370
- * User-defined unique identifier of the referenced [ShoppingList](ctp:api:type:ShoppingList). Either `id` or `key` is required.
371
- *
372
- *
373
- */
374
- readonly key?: string;
375
- }
376
- export interface ShoppingListUpdate {
377
- /**
378
- * Expected version of the ShoppingList on which the changes should be applied. If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) will be returned.
379
- *
380
- *
381
- */
382
- readonly version: number;
383
- /**
384
- * List of update actions to be performed on the ShoppingList.
385
- *
386
- *
387
- */
388
- readonly actions: ShoppingListUpdateAction[];
389
- }
390
- export type ShoppingListUpdateAction = ShoppingListAddLineItemAction | ShoppingListAddTextLineItemAction | ShoppingListChangeLineItemQuantityAction | ShoppingListChangeLineItemsOrderAction | ShoppingListChangeNameAction | ShoppingListChangeTextLineItemNameAction | ShoppingListChangeTextLineItemQuantityAction | ShoppingListChangeTextLineItemsOrderAction | ShoppingListRemoveLineItemAction | ShoppingListRemoveTextLineItemAction | ShoppingListSetAnonymousIdAction | ShoppingListSetCustomFieldAction | ShoppingListSetCustomTypeAction | ShoppingListSetCustomerAction | ShoppingListSetDeleteDaysAfterLastModificationAction | ShoppingListSetDescriptionAction | ShoppingListSetKeyAction | ShoppingListSetLineItemCustomFieldAction | ShoppingListSetLineItemCustomTypeAction | ShoppingListSetSlugAction | ShoppingListSetStoreAction | ShoppingListSetTextLineItemCustomFieldAction | ShoppingListSetTextLineItemCustomTypeAction | ShoppingListSetTextLineItemDescriptionAction;
391
- /**
392
- * TextLineItems are Line Items that use text values instead of references to Products.
393
- *
394
- */
395
- export interface TextLineItem {
396
- /**
397
- * Date and time (UTC) the TextLineItem was added to the [ShoppingList](ctp:api:type:ShoppingList).
398
- *
399
- *
400
- */
401
- readonly addedAt: string;
402
- /**
403
- * Custom Fields of the TextLineItem.
404
- *
405
- *
406
- */
407
- readonly custom?: CustomFields;
408
- /**
409
- * Description of the TextLineItem.
410
- *
411
- *
412
- */
413
- readonly description?: LocalizedString;
414
- /**
415
- * Unique identifier of the TextLineItem.
416
- *
417
- */
418
- readonly id: string;
419
- /**
420
- * Name of the TextLineItem.
421
- *
422
- *
423
- */
424
- readonly name: LocalizedString;
425
- /**
426
- * Number of entries in the TextLineItem.
427
- *
428
- *
429
- */
430
- readonly quantity: number;
431
- }
432
- export interface TextLineItemDraft {
433
- /**
434
- * Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
435
- *
436
- *
437
- */
438
- readonly addedAt?: string;
439
- /**
440
- * Custom Fields for the TextLineItem.
441
- *
442
- *
443
- */
444
- readonly custom?: CustomFieldsDraft;
445
- /**
446
- * Description of the TextLineItem.
447
- *
448
- *
449
- */
450
- readonly description?: LocalizedString;
451
- /**
452
- * Name of the TextLineItem.
453
- *
454
- *
455
- */
456
- readonly name: LocalizedString;
457
- /**
458
- * Number of entries in the TextLineItem.
459
- *
460
- *
461
- */
462
- readonly quantity?: number;
463
- }
464
- /**
465
- * The [ProductVariant](ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`.
466
- * If the ShoppingList already contains a ShoppingListLineItem for the same Product Variant with the same Custom Fields, then only the quantity of the existing ShoppingListLineItem is increased.
467
- * A ShoppingListLineItem with an empty `variantId` is not considered the same as a ShoppingListLineItem with a `variantId` currently referring to the Master Variant.
468
- *
469
- */
470
- export interface ShoppingListAddLineItemAction {
471
- readonly action: 'addLineItem';
472
- /**
473
- * `sku` of the [ProductVariant](ctp:api:type:ProductVariant).
474
- *
475
- *
476
- */
477
- readonly sku?: string;
478
- /**
479
- * Unique identifier of a [Product](ctp:api:type:Product).
480
- *
481
- *
482
- */
483
- readonly productId?: string;
484
- /**
485
- * `id` of the [ProductVariant](ctp:api:type:ProductVariant). If not set, the ShoppingListLineItem refers to the Master Variant.
486
- *
487
- *
488
- */
489
- readonly variantId?: number;
490
- /**
491
- * Number of Products in the ShoppingListLineItem.
492
- *
493
- *
494
- */
495
- readonly quantity?: number;
496
- /**
497
- * Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
498
- *
499
- *
500
- */
501
- readonly addedAt?: string;
502
- /**
503
- * Custom Fields defined for the ShoppingListLineItem.
504
- *
505
- *
506
- */
507
- readonly custom?: CustomFieldsDraft;
508
- }
509
- export interface ShoppingListAddTextLineItemAction {
510
- readonly action: 'addTextLineItem';
511
- /**
512
- * Name of the TextLineItem.
513
- *
514
- *
515
- */
516
- readonly name: LocalizedString;
517
- /**
518
- * Description of the TextLineItem.
519
- *
520
- *
521
- */
522
- readonly description?: LocalizedString;
523
- /**
524
- * Number of entries in the TextLineItem.
525
- *
526
- *
527
- */
528
- readonly quantity?: number;
529
- /**
530
- * Date and time the TextLineItem is added to the [ShoppingList](ctp:api:type:ShoppingList). If not set, the current date and time (UTC) is used.
531
- *
532
- *
533
- */
534
- readonly addedAt?: string;
535
- /**
536
- * Custom Fields defined for the TextLineItem.
537
- *
538
- *
539
- */
540
- readonly custom?: CustomFieldsDraft;
541
- }
542
- export interface ShoppingListChangeLineItemQuantityAction {
543
- readonly action: 'changeLineItemQuantity';
544
- /**
545
- * The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update.
546
- *
547
- *
548
- */
549
- readonly lineItemId: string;
550
- /**
551
- * New value to set. If `0`, the ShoppingListLineItem is removed from the ShoppingList.
552
- *
553
- *
554
- */
555
- readonly quantity: number;
556
- }
557
- export interface ShoppingListChangeLineItemsOrderAction {
558
- readonly action: 'changeLineItemsOrder';
559
- /**
560
- * All existing ShoppingListLineItem `id`s in the desired new order.
561
- *
562
- *
563
- */
564
- readonly lineItemOrder: string[];
565
- }
566
- export interface ShoppingListChangeNameAction {
567
- readonly action: 'changeName';
568
- /**
569
- * New value to set. Must not be empty.
570
- *
571
- *
572
- */
573
- readonly name: LocalizedString;
574
- }
575
- export interface ShoppingListChangeTextLineItemNameAction {
576
- readonly action: 'changeTextLineItemName';
577
- /**
578
- * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
579
- *
580
- *
581
- */
582
- readonly textLineItemId: string;
583
- /**
584
- * New value to set. Must not be empty.
585
- *
586
- *
587
- */
588
- readonly name: LocalizedString;
589
- }
590
- export interface ShoppingListChangeTextLineItemQuantityAction {
591
- readonly action: 'changeTextLineItemQuantity';
592
- /**
593
- * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
594
- *
595
- *
596
- */
597
- readonly textLineItemId: string;
598
- /**
599
- * New value to set. If `0`, the TextLineItem is removed from the ShoppingList.
600
- *
601
- *
602
- */
603
- readonly quantity: number;
604
- }
605
- export interface ShoppingListChangeTextLineItemsOrderAction {
606
- readonly action: 'changeTextLineItemsOrder';
607
- /**
608
- * Must contain all existing [TextLineItem](ctp:api:type:TextLineItem) `id`s in the desired new order.
609
- *
610
- *
611
- */
612
- readonly textLineItemOrder: string[];
613
- }
614
- export interface ShoppingListRemoveLineItemAction {
615
- readonly action: 'removeLineItem';
616
- /**
617
- * The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update.
618
- *
619
- *
620
- */
621
- readonly lineItemId: string;
622
- /**
623
- * Amount to remove from the `quantity` of the ShoppingListLineItem. If not set, the ShoppingListLineItem is removed from the ShoppingList. If this value matches or exceeds the current `quantity` of the ShoppingListLineItem, the ShoppingListLineItem is removed from the ShoppingList.
624
- *
625
- *
626
- */
627
- readonly quantity?: number;
628
- }
629
- export interface ShoppingListRemoveTextLineItemAction {
630
- readonly action: 'removeTextLineItem';
631
- /**
632
- * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
633
- *
634
- *
635
- */
636
- readonly textLineItemId: string;
637
- /**
638
- * Amount to remove from the `quantity` of the TextLineItem. If not set, the TextLineItem is removed from the ShoppingList. If this value matches or exceeds the current `quantity` of the TextLineItem, the TextLineItem is removed from the ShoppingList.
639
- *
640
- *
641
- */
642
- readonly quantity?: number;
643
- }
644
- export interface ShoppingListSetAnonymousIdAction {
645
- readonly action: 'setAnonymousId';
646
- /**
647
- * Value to set. If empty, any existing value will be removed.
648
- *
649
- *
650
- */
651
- readonly anonymousId?: string;
652
- }
653
- export interface ShoppingListSetCustomFieldAction {
654
- readonly action: 'setCustomField';
655
- /**
656
- * Name of the [Custom Field](/../api/projects/custom-fields).
657
- *
658
- *
659
- */
660
- readonly name: string;
661
- /**
662
- * If `value` is absent or `null`, this field will be removed if it exists.
663
- * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
664
- * If `value` is provided, it is set for the field defined by `name`.
665
- *
666
- *
667
- */
668
- readonly value?: any;
669
- }
670
- export interface ShoppingListSetCustomTypeAction {
671
- readonly action: 'setCustomType';
672
- /**
673
- * Defines the [Type](ctp:api:type:Type) that extends the ShoppingList with [Custom Fields](/../api/projects/custom-fields).
674
- * If absent, any existing Type and Custom Fields are removed from the ShoppingList.
675
- *
676
- *
677
- */
678
- readonly type?: TypeResourceIdentifier;
679
- /**
680
- * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ShoppingList.
681
- *
682
- *
683
- */
684
- readonly fields?: FieldContainer;
685
- }
686
- export interface ShoppingListSetCustomerAction {
687
- readonly action: 'setCustomer';
688
- /**
689
- * The [Customer](ctp:api:type:Customer) the ShoppingList should be associated to. If empty, any existing value will be removed.
690
- *
691
- *
692
- */
693
- readonly customer?: CustomerResourceIdentifier;
694
- }
695
- export interface ShoppingListSetDeleteDaysAfterLastModificationAction {
696
- readonly action: 'setDeleteDaysAfterLastModification';
697
- /**
698
- * Value to set. If empty, any existing value will be removed.
699
- *
700
- *
701
- */
702
- readonly deleteDaysAfterLastModification?: number;
703
- }
704
- export interface ShoppingListSetDescriptionAction {
705
- readonly action: 'setDescription';
706
- /**
707
- * Value to set. If empty, any existing value will be removed.
708
- *
709
- *
710
- */
711
- readonly description?: LocalizedString;
712
- }
713
- export interface ShoppingListSetKeyAction {
714
- readonly action: 'setKey';
715
- /**
716
- * Value to set. If empty, any existing value will be removed.
717
- *
718
- */
719
- readonly key?: string;
720
- }
721
- export interface ShoppingListSetLineItemCustomFieldAction {
722
- readonly action: 'setLineItemCustomField';
723
- /**
724
- * The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update.
725
- *
726
- *
727
- */
728
- readonly lineItemId: string;
729
- /**
730
- * Name of the [Custom Field](/../api/projects/custom-fields).
731
- *
732
- *
733
- */
734
- readonly name: string;
735
- /**
736
- * If `value` is absent or `null`, this field will be removed if it exists.
737
- * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
738
- * If `value` is provided, it is set for the field defined by `name`.
739
- *
740
- *
741
- */
742
- readonly value?: any;
743
- }
744
- export interface ShoppingListSetLineItemCustomTypeAction {
745
- readonly action: 'setLineItemCustomType';
746
- /**
747
- * The `id` of the [ShoppingListLineItem](ctp:api:type:ShoppingListLineItem) to update.
748
- *
749
- *
750
- */
751
- readonly lineItemId: string;
752
- /**
753
- * Defines the [Type](ctp:api:type:Type) that extends the ShoppingListLineItem with [Custom Fields](/../api/projects/custom-fields).
754
- * If absent, any existing Type and Custom Fields are removed from the ShoppingListLineItem.
755
- *
756
- *
757
- */
758
- readonly type?: TypeResourceIdentifier;
759
- /**
760
- * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ShoppingListLineItem.
761
- *
762
- *
763
- */
764
- readonly fields?: FieldContainer;
765
- }
766
- export interface ShoppingListSetSlugAction {
767
- readonly action: 'setSlug';
768
- /**
769
- * Value to set. If empty, any existing value will be removed. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. Must match the pattern `^[A-Za-z0-9_-]{2,256}+$`
770
- *
771
- *
772
- */
773
- readonly slug?: LocalizedString;
774
- }
775
- export interface ShoppingListSetStoreAction {
776
- readonly action: 'setStore';
777
- /**
778
- * The [Store](ctp:api:type:Store) the ShoppingList should be assigned to. If empty, any existing value will be removed.
779
- *
780
- *
781
- */
782
- readonly store?: StoreResourceIdentifier;
783
- }
784
- export interface ShoppingListSetTextLineItemCustomFieldAction {
785
- readonly action: 'setTextLineItemCustomField';
786
- /**
787
- * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
788
- *
789
- *
790
- */
791
- readonly textLineItemId: string;
792
- /**
793
- * Name of the [Custom Field](/../api/projects/custom-fields).
794
- *
795
- *
796
- */
797
- readonly name: string;
798
- /**
799
- * If `value` is absent or `null`, this field will be removed if it exists.
800
- * Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
801
- * If `value` is provided, it is set for the field defined by `name`.
802
- *
803
- *
804
- */
805
- readonly value?: any;
806
- }
807
- export interface ShoppingListSetTextLineItemCustomTypeAction {
808
- readonly action: 'setTextLineItemCustomType';
809
- /**
810
- * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
811
- *
812
- *
813
- */
814
- readonly textLineItemId: string;
815
- /**
816
- * Defines the [Type](ctp:api:type:Type) that extends the TextLineItem with [Custom Fields](/../api/projects/custom-fields).
817
- * If absent, any existing Type and Custom Fields are removed from the TextLineItem.
818
- *
819
- *
820
- */
821
- readonly type?: TypeResourceIdentifier;
822
- /**
823
- * Sets the [Custom Fields](/../api/projects/custom-fields) fields for the TextLineItem.
824
- *
825
- *
826
- */
827
- readonly fields?: FieldContainer;
828
- }
829
- export interface ShoppingListSetTextLineItemDescriptionAction {
830
- readonly action: 'setTextLineItemDescription';
831
- /**
832
- * The `id` of the [TextLineItem](ctp:api:type:TextLineItem) to update.
833
- *
834
- *
835
- */
836
- readonly textLineItemId: string;
837
- /**
838
- * Value to set. If empty, any existing value will be removed.
839
- *
840
- *
841
- */
842
- readonly description?: LocalizedString;
843
- }
844
- //# sourceMappingURL=shopping-list.d.ts.map