@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.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 (577) hide show
  1. package/data/help/index.json +9685 -0
  2. package/data/script-api/index.json +1 -528
  3. package/data/tooling/index.json +4 -4
  4. package/data/xsd/index.json +1 -1
  5. package/dist/esm/cli/base-command.js +5 -0
  6. package/dist/esm/cli/base-command.js.map +1 -1
  7. package/dist/esm/clients/index.d.ts +2 -0
  8. package/dist/esm/clients/index.js +1 -0
  9. package/dist/esm/clients/index.js.map +1 -1
  10. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  11. package/dist/esm/clients/middleware-registry.js.map +1 -1
  12. package/dist/esm/clients/preferences.d.ts +83 -0
  13. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  14. package/dist/esm/clients/preferences.generated.js +6 -0
  15. package/dist/esm/clients/preferences.generated.js.map +1 -0
  16. package/dist/esm/clients/preferences.js +64 -0
  17. package/dist/esm/clients/preferences.js.map +1 -0
  18. package/dist/esm/config/dw-json.d.ts +2 -0
  19. package/dist/esm/config/dw-json.js.map +1 -1
  20. package/dist/esm/config/mapping.js +4 -0
  21. package/dist/esm/config/mapping.js.map +1 -1
  22. package/dist/esm/config/sources/dw-json-source.js +17 -4
  23. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  24. package/dist/esm/config/sources/env-source.js +2 -0
  25. package/dist/esm/config/sources/env-source.js.map +1 -1
  26. package/dist/esm/config/types.d.ts +14 -0
  27. package/dist/esm/docs/content-cache.d.ts +70 -0
  28. package/dist/esm/docs/content-cache.js +186 -0
  29. package/dist/esm/docs/content-cache.js.map +1 -0
  30. package/dist/esm/docs/index.d.ts +1 -0
  31. package/dist/esm/docs/index.js +2 -0
  32. package/dist/esm/docs/index.js.map +1 -1
  33. package/dist/esm/docs/search.js +34 -6
  34. package/dist/esm/docs/search.js.map +1 -1
  35. package/dist/esm/docs/types.d.ts +6 -1
  36. package/dist/esm/docs/types.js +1 -0
  37. package/dist/esm/docs/types.js.map +1 -1
  38. package/dist/esm/index.d.ts +2 -2
  39. package/dist/esm/index.js +1 -1
  40. package/dist/esm/index.js.map +1 -1
  41. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  42. package/dist/esm/operations/jobs/discover.js +87 -0
  43. package/dist/esm/operations/jobs/discover.js.map +1 -0
  44. package/dist/esm/operations/jobs/index.d.ts +2 -0
  45. package/dist/esm/operations/jobs/index.js +2 -0
  46. package/dist/esm/operations/jobs/index.js.map +1 -1
  47. package/dist/esm/operations/jobs/run.js +4 -3
  48. package/dist/esm/operations/jobs/run.js.map +1 -1
  49. package/package.json +5 -3
  50. package/specs/preferences-v1.yaml +2095 -0
  51. package/data/script-api/TopLevel.APIException.md +0 -119
  52. package/data/script-api/TopLevel.Array.md +0 -732
  53. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  54. package/data/script-api/TopLevel.BigInt.md +0 -154
  55. package/data/script-api/TopLevel.Boolean.md +0 -83
  56. package/data/script-api/TopLevel.ConversionError.md +0 -51
  57. package/data/script-api/TopLevel.DataView.md +0 -271
  58. package/data/script-api/TopLevel.Date.md +0 -688
  59. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  60. package/data/script-api/TopLevel.Error.md +0 -124
  61. package/data/script-api/TopLevel.EvalError.md +0 -47
  62. package/data/script-api/TopLevel.Fault.md +0 -133
  63. package/data/script-api/TopLevel.Float32Array.md +0 -186
  64. package/data/script-api/TopLevel.Float64Array.md +0 -186
  65. package/data/script-api/TopLevel.Function.md +0 -114
  66. package/data/script-api/TopLevel.Generator.md +0 -132
  67. package/data/script-api/TopLevel.IOError.md +0 -98
  68. package/data/script-api/TopLevel.Int16Array.md +0 -186
  69. package/data/script-api/TopLevel.Int32Array.md +0 -186
  70. package/data/script-api/TopLevel.Int8Array.md +0 -186
  71. package/data/script-api/TopLevel.InternalError.md +0 -47
  72. package/data/script-api/TopLevel.Iterable.md +0 -44
  73. package/data/script-api/TopLevel.Iterator.md +0 -89
  74. package/data/script-api/TopLevel.JSON.md +0 -173
  75. package/data/script-api/TopLevel.Map.md +0 -189
  76. package/data/script-api/TopLevel.Math.md +0 -948
  77. package/data/script-api/TopLevel.Module.md +0 -152
  78. package/data/script-api/TopLevel.Namespace.md +0 -152
  79. package/data/script-api/TopLevel.Number.md +0 -404
  80. package/data/script-api/TopLevel.Object.md +0 -472
  81. package/data/script-api/TopLevel.QName.md +0 -147
  82. package/data/script-api/TopLevel.RangeError.md +0 -47
  83. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  84. package/data/script-api/TopLevel.RegExp.md +0 -155
  85. package/data/script-api/TopLevel.Set.md +0 -150
  86. package/data/script-api/TopLevel.StopIteration.md +0 -36
  87. package/data/script-api/TopLevel.String.md +0 -1060
  88. package/data/script-api/TopLevel.Symbol.md +0 -196
  89. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  90. package/data/script-api/TopLevel.SystemError.md +0 -99
  91. package/data/script-api/TopLevel.TypeError.md +0 -47
  92. package/data/script-api/TopLevel.URIError.md +0 -47
  93. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  94. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  95. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  96. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  97. package/data/script-api/TopLevel.WeakMap.md +0 -135
  98. package/data/script-api/TopLevel.WeakSet.md +0 -96
  99. package/data/script-api/TopLevel.XML.md +0 -922
  100. package/data/script-api/TopLevel.XMLList.md +0 -418
  101. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  102. package/data/script-api/TopLevel.arguments.md +0 -56
  103. package/data/script-api/TopLevel.global.md +0 -539
  104. package/data/script-api/TopLevel.md +0 -58
  105. package/data/script-api/dw.alert.Alert.md +0 -175
  106. package/data/script-api/dw.alert.Alerts.md +0 -256
  107. package/data/script-api/dw.alert.md +0 -7
  108. package/data/script-api/dw.campaign.ABTest.md +0 -63
  109. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  110. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  111. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  112. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  113. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  114. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  115. package/data/script-api/dw.campaign.Campaign.md +0 -346
  116. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  117. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  118. package/data/script-api/dw.campaign.Coupon.md +0 -324
  119. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  120. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  121. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  122. package/data/script-api/dw.campaign.Discount.md +0 -271
  123. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  124. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  125. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  126. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  127. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  128. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  129. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  130. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  131. package/data/script-api/dw.campaign.Promotion.md +0 -939
  132. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  133. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  134. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  135. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  136. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  137. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  138. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  139. package/data/script-api/dw.campaign.md +0 -36
  140. package/data/script-api/dw.catalog.Catalog.md +0 -158
  141. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  142. package/data/script-api/dw.catalog.Category.md +0 -1212
  143. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  144. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  145. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  146. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  147. package/data/script-api/dw.catalog.Product.md +0 -2492
  148. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  149. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  150. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  151. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  152. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  153. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  154. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  155. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  156. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  157. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  158. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  159. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  160. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  161. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  162. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  163. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  164. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  165. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  166. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  167. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  168. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  169. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  170. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  171. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  172. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  173. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  174. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  175. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  176. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  177. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  178. package/data/script-api/dw.catalog.Store.md +0 -484
  179. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  180. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  181. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  182. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  183. package/data/script-api/dw.catalog.Variant.md +0 -1000
  184. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  185. package/data/script-api/dw.catalog.md +0 -50
  186. package/data/script-api/dw.content.Content.md +0 -481
  187. package/data/script-api/dw.content.ContentMgr.md +0 -147
  188. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  189. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  190. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  191. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  192. package/data/script-api/dw.content.Folder.md +0 -432
  193. package/data/script-api/dw.content.Library.md +0 -124
  194. package/data/script-api/dw.content.MarkupText.md +0 -150
  195. package/data/script-api/dw.content.MediaFile.md +0 -367
  196. package/data/script-api/dw.content.md +0 -15
  197. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  198. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  199. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  200. package/data/script-api/dw.crypto.Encoding.md +0 -193
  201. package/data/script-api/dw.crypto.JWE.md +0 -245
  202. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  203. package/data/script-api/dw.crypto.JWS.md +0 -260
  204. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  205. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  206. package/data/script-api/dw.crypto.Mac.md +0 -191
  207. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  208. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  209. package/data/script-api/dw.crypto.Signature.md +0 -241
  210. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  211. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  212. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  213. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  214. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  215. package/data/script-api/dw.crypto.md +0 -23
  216. package/data/script-api/dw.customer.AddressBook.md +0 -158
  217. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  218. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  219. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  220. package/data/script-api/dw.customer.Credentials.md +0 -524
  221. package/data/script-api/dw.customer.Customer.md +0 -488
  222. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  223. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  224. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  225. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  226. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  227. package/data/script-api/dw.customer.CustomerList.md +0 -76
  228. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  229. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  230. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  231. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  232. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  233. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  234. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  235. package/data/script-api/dw.customer.ProductList.md +0 -870
  236. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  237. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  238. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  239. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  240. package/data/script-api/dw.customer.Profile.md +0 -940
  241. package/data/script-api/dw.customer.Wallet.md +0 -136
  242. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  243. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  244. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  245. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  246. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  247. package/data/script-api/dw.customer.consent.md +0 -10
  248. package/data/script-api/dw.customer.md +0 -31
  249. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  250. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  251. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  252. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  253. package/data/script-api/dw.customer.oauth.md +0 -9
  254. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  255. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  256. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  257. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  258. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  259. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  260. package/data/script-api/dw.experience.Component.md +0 -166
  261. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  262. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  263. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  264. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  265. package/data/script-api/dw.experience.Page.md +0 -467
  266. package/data/script-api/dw.experience.PageMgr.md +0 -549
  267. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  268. package/data/script-api/dw.experience.Region.md +0 -119
  269. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  270. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  271. package/data/script-api/dw.experience.cms.md +0 -6
  272. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  273. package/data/script-api/dw.experience.image.Image.md +0 -101
  274. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  275. package/data/script-api/dw.experience.image.md +0 -8
  276. package/data/script-api/dw.experience.md +0 -16
  277. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  278. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  279. package/data/script-api/dw.extensions.applepay.md +0 -7
  280. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  281. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  282. package/data/script-api/dw.extensions.facebook.md +0 -7
  283. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  284. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  285. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  286. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  287. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  288. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  289. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  290. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  291. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  292. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  293. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  294. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  295. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  296. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  297. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  298. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  299. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  300. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  301. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  302. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  303. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  304. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  305. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  306. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  307. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  308. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  309. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  310. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.md +0 -28
  312. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  313. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  314. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  315. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  316. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  317. package/data/script-api/dw.extensions.pinterest.md +0 -10
  318. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  319. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  320. package/data/script-api/dw.io.File.md +0 -729
  321. package/data/script-api/dw.io.FileReader.md +0 -70
  322. package/data/script-api/dw.io.FileWriter.md +0 -159
  323. package/data/script-api/dw.io.InputStream.md +0 -35
  324. package/data/script-api/dw.io.OutputStream.md +0 -38
  325. package/data/script-api/dw.io.PrintWriter.md +0 -66
  326. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  327. package/data/script-api/dw.io.Reader.md +0 -284
  328. package/data/script-api/dw.io.StringWriter.md +0 -89
  329. package/data/script-api/dw.io.Writer.md +0 -96
  330. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  331. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  332. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  333. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  334. package/data/script-api/dw.io.md +0 -21
  335. package/data/script-api/dw.job.JobExecution.md +0 -111
  336. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  337. package/data/script-api/dw.job.md +0 -7
  338. package/data/script-api/dw.net.FTPClient.md +0 -621
  339. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  340. package/data/script-api/dw.net.HTTPClient.md +0 -775
  341. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  342. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  343. package/data/script-api/dw.net.Mail.md +0 -487
  344. package/data/script-api/dw.net.SFTPClient.md +0 -535
  345. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  346. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  347. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  348. package/data/script-api/dw.net.md +0 -15
  349. package/data/script-api/dw.object.ActiveData.md +0 -86
  350. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  351. package/data/script-api/dw.object.CustomObject.md +0 -82
  352. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  353. package/data/script-api/dw.object.Extensible.md +0 -71
  354. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  355. package/data/script-api/dw.object.Note.md +0 -118
  356. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  357. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  358. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  359. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  360. package/data/script-api/dw.object.PersistentObject.md +0 -92
  361. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  362. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  363. package/data/script-api/dw.object.md +0 -19
  364. package/data/script-api/dw.order.AbstractItem.md +0 -220
  365. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  366. package/data/script-api/dw.order.Appeasement.md +0 -398
  367. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  368. package/data/script-api/dw.order.Basket.md +0 -868
  369. package/data/script-api/dw.order.BasketMgr.md +0 -673
  370. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  371. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  372. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  373. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  374. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  375. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  376. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  377. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  378. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  379. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  380. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  381. package/data/script-api/dw.order.Invoice.md +0 -571
  382. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  383. package/data/script-api/dw.order.LineItem.md +0 -577
  384. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  385. package/data/script-api/dw.order.LineItemTax.md +0 -142
  386. package/data/script-api/dw.order.Order.md +0 -2770
  387. package/data/script-api/dw.order.OrderAddress.md +0 -624
  388. package/data/script-api/dw.order.OrderItem.md +0 -613
  389. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  390. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  391. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  392. package/data/script-api/dw.order.PaymentCard.md +0 -220
  393. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  394. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  395. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  396. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  397. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  398. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  399. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  400. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  401. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  402. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  403. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  404. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  405. package/data/script-api/dw.order.Return.md +0 -396
  406. package/data/script-api/dw.order.ReturnCase.md +0 -463
  407. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  408. package/data/script-api/dw.order.ReturnItem.md +0 -335
  409. package/data/script-api/dw.order.Shipment.md +0 -1132
  410. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  411. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  412. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  413. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  414. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  415. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  416. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  417. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  418. package/data/script-api/dw.order.SumItem.md +0 -158
  419. package/data/script-api/dw.order.TaxGroup.md +0 -128
  420. package/data/script-api/dw.order.TaxItem.md +0 -74
  421. package/data/script-api/dw.order.TaxMgr.md +0 -314
  422. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  423. package/data/script-api/dw.order.TrackingRef.md +0 -108
  424. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  425. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  426. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  427. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  428. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  429. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  430. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  431. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  432. package/data/script-api/dw.order.hooks.md +0 -13
  433. package/data/script-api/dw.order.md +0 -65
  434. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  435. package/data/script-api/dw.rpc.Stub.md +0 -373
  436. package/data/script-api/dw.rpc.WebReference.md +0 -133
  437. package/data/script-api/dw.rpc.md +0 -8
  438. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  439. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  440. package/data/script-api/dw.sitemap.md +0 -7
  441. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  442. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  443. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  444. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  445. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  446. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  447. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  448. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  449. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  450. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  451. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  452. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  453. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  454. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  455. package/data/script-api/dw.suggest.md +0 -19
  456. package/data/script-api/dw.svc.FTPService.md +0 -140
  457. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  458. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  459. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  460. package/data/script-api/dw.svc.HTTPService.md +0 -370
  461. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  462. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  463. package/data/script-api/dw.svc.Result.md +0 -320
  464. package/data/script-api/dw.svc.SOAPService.md +0 -104
  465. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  466. package/data/script-api/dw.svc.Service.md +0 -276
  467. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  468. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  469. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  470. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  471. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  472. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  473. package/data/script-api/dw.svc.md +0 -22
  474. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  475. package/data/script-api/dw.system.Cache.md +0 -126
  476. package/data/script-api/dw.system.CacheMgr.md +0 -70
  477. package/data/script-api/dw.system.HookMgr.md +0 -78
  478. package/data/script-api/dw.system.InternalObject.md +0 -47
  479. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  480. package/data/script-api/dw.system.Log.md +0 -198
  481. package/data/script-api/dw.system.LogNDC.md +0 -75
  482. package/data/script-api/dw.system.Logger.md +0 -216
  483. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  484. package/data/script-api/dw.system.Pipeline.md +0 -94
  485. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  486. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  487. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  488. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  489. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  490. package/data/script-api/dw.system.Request.md +0 -785
  491. package/data/script-api/dw.system.RequestHooks.md +0 -112
  492. package/data/script-api/dw.system.Response.md +0 -612
  493. package/data/script-api/dw.system.SearchStatus.md +0 -187
  494. package/data/script-api/dw.system.Session.md +0 -469
  495. package/data/script-api/dw.system.Site.md +0 -570
  496. package/data/script-api/dw.system.SitePreferences.md +0 -90
  497. package/data/script-api/dw.system.Status.md +0 -330
  498. package/data/script-api/dw.system.StatusItem.md +0 -273
  499. package/data/script-api/dw.system.System.md +0 -224
  500. package/data/script-api/dw.system.Transaction.md +0 -107
  501. package/data/script-api/dw.system.md +0 -32
  502. package/data/script-api/dw.template.ISML.md +0 -127
  503. package/data/script-api/dw.template.Velocity.md +0 -168
  504. package/data/script-api/dw.template.md +0 -7
  505. package/data/script-api/dw.util.ArrayList.md +0 -99
  506. package/data/script-api/dw.util.Assert.md +0 -370
  507. package/data/script-api/dw.util.BigInteger.md +0 -283
  508. package/data/script-api/dw.util.Bytes.md +0 -278
  509. package/data/script-api/dw.util.Calendar.md +0 -1051
  510. package/data/script-api/dw.util.Collection.md +0 -272
  511. package/data/script-api/dw.util.Currency.md +0 -147
  512. package/data/script-api/dw.util.DateUtils.md +0 -82
  513. package/data/script-api/dw.util.Decimal.md +0 -386
  514. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  515. package/data/script-api/dw.util.Geolocation.md +0 -293
  516. package/data/script-api/dw.util.HashMap.md +0 -50
  517. package/data/script-api/dw.util.HashSet.md +0 -65
  518. package/data/script-api/dw.util.Iterator.md +0 -86
  519. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  520. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  521. package/data/script-api/dw.util.List.md +0 -429
  522. package/data/script-api/dw.util.Locale.md +0 -277
  523. package/data/script-api/dw.util.Map.md +0 -251
  524. package/data/script-api/dw.util.MapEntry.md +0 -68
  525. package/data/script-api/dw.util.MappingKey.md +0 -96
  526. package/data/script-api/dw.util.MappingMgr.md +0 -113
  527. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  528. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  529. package/data/script-api/dw.util.SecureFilter.md +0 -572
  530. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  531. package/data/script-api/dw.util.Set.md +0 -39
  532. package/data/script-api/dw.util.SortedMap.md +0 -148
  533. package/data/script-api/dw.util.SortedSet.md +0 -173
  534. package/data/script-api/dw.util.StringUtils.md +0 -655
  535. package/data/script-api/dw.util.Template.md +0 -141
  536. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  537. package/data/script-api/dw.util.md +0 -37
  538. package/data/script-api/dw.value.EnumValue.md +0 -105
  539. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  540. package/data/script-api/dw.value.Money.md +0 -526
  541. package/data/script-api/dw.value.Quantity.md +0 -299
  542. package/data/script-api/dw.value.md +0 -9
  543. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  544. package/data/script-api/dw.web.ClickStream.md +0 -177
  545. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  546. package/data/script-api/dw.web.Cookie.md +0 -431
  547. package/data/script-api/dw.web.Cookies.md +0 -59
  548. package/data/script-api/dw.web.Form.md +0 -84
  549. package/data/script-api/dw.web.FormAction.md +0 -195
  550. package/data/script-api/dw.web.FormElement.md +0 -211
  551. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  552. package/data/script-api/dw.web.FormField.md +0 -642
  553. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  554. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  555. package/data/script-api/dw.web.FormGroup.md +0 -222
  556. package/data/script-api/dw.web.FormList.md +0 -134
  557. package/data/script-api/dw.web.FormListItem.md +0 -57
  558. package/data/script-api/dw.web.Forms.md +0 -25
  559. package/data/script-api/dw.web.HttpParameter.md +0 -462
  560. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  561. package/data/script-api/dw.web.LoopIterator.md +0 -231
  562. package/data/script-api/dw.web.PageMetaData.md +0 -197
  563. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  564. package/data/script-api/dw.web.PagingModel.md +0 -407
  565. package/data/script-api/dw.web.Resource.md +0 -147
  566. package/data/script-api/dw.web.URL.md +0 -174
  567. package/data/script-api/dw.web.URLAction.md +0 -95
  568. package/data/script-api/dw.web.URLParameter.md +0 -52
  569. package/data/script-api/dw.web.URLRedirect.md +0 -72
  570. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  571. package/data/script-api/dw.web.URLUtils.md +0 -1357
  572. package/data/script-api/dw.web.md +0 -34
  573. package/data/script-api/dw.ws.Port.md +0 -126
  574. package/data/script-api/dw.ws.WSUtil.md +0 -728
  575. package/data/script-api/dw.ws.WebReference2.md +0 -137
  576. package/data/script-api/dw.ws.md +0 -8
  577. package/data/script-api/index.md +0 -40
@@ -1,436 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class CampaignMgr
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.campaign.CampaignMgr](dw.campaign.CampaignMgr.md)
6
-
7
- CampaignMgr provides static methods for managing campaign-specific operations
8
- such as accessing promotions or updating promotion line items.
9
-
10
-
11
- **Deprecated:**
12
- :::warning
13
- Use [PromotionMgr](dw.campaign.PromotionMgr.md) instead.
14
- :::
15
-
16
- ## Property Summary
17
-
18
- | Property | Description |
19
- | --- | --- |
20
- | ~~[applicablePromotions](#applicablepromotions): [Collection](dw.util.Collection.md)~~ `(read-only)` | Returns the enabled promotions of active campaigns applicable for the current customer and source code. |
21
-
22
- ## Constructor Summary
23
-
24
- This class does not have a constructor, so you cannot create it directly.
25
- ## Method Summary
26
-
27
- | Method | Description |
28
- | --- | --- |
29
- | ~~static [applyBonusPromotions](dw.campaign.CampaignMgr.md#applybonuspromotionslineitemctnr-collection)([LineItemCtnr](dw.order.LineItemCtnr.md), [Collection](dw.util.Collection.md))~~ | This method has been deprecated and should not be used anymore. |
30
- | ~~static [applyOrderPromotions](dw.campaign.CampaignMgr.md#applyorderpromotionslineitemctnr-collection)([LineItemCtnr](dw.order.LineItemCtnr.md), [Collection](dw.util.Collection.md))~~ | Applies the applicable order promotions in the specified collection to the specified line item container. |
31
- | ~~static [applyProductPromotions](dw.campaign.CampaignMgr.md#applyproductpromotionslineitemctnr-collection)([LineItemCtnr](dw.order.LineItemCtnr.md), [Collection](dw.util.Collection.md))~~ | Applies all applicable product promotions in the specified collection to the specified line item container. |
32
- | ~~static [applyShippingPromotions](dw.campaign.CampaignMgr.md#applyshippingpromotionslineitemctnr-collection)([LineItemCtnr](dw.order.LineItemCtnr.md), [Collection](dw.util.Collection.md))~~ | Applies all applicable shipping promotions in the specified collection to the specified line item container. |
33
- | ~~static [getApplicableConditionalPromotions](dw.campaign.CampaignMgr.md#getapplicableconditionalpromotionsproduct)([Product](dw.catalog.Product.md))~~ | Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a qualifiying product. |
34
- | ~~static [getApplicablePromotions](dw.campaign.CampaignMgr.md#getapplicablepromotions)()~~ | Returns the enabled promotions of active campaigns applicable for the current customer and source code. |
35
- | ~~static [getApplicablePromotions](dw.campaign.CampaignMgr.md#getapplicablepromotionsproduct)([Product](dw.catalog.Product.md))~~ | Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a discounted product. |
36
- | ~~static [getApplicablePromotions](dw.campaign.CampaignMgr.md#getapplicablepromotionslineitemctnr)([LineItemCtnr](dw.order.LineItemCtnr.md))~~ | Returns the enabled promotions of active campaigns applicable for the current customer, source code and any coupon contained in the specified line item container. |
37
- | ~~static [getCampaignByID](dw.campaign.CampaignMgr.md#getcampaignbyidstring)([String](TopLevel.String.md))~~ | Returns the campaign identified by the specified ID. |
38
- | ~~static [getConditionalPromotions](dw.campaign.CampaignMgr.md#getconditionalpromotionsproduct)([Product](dw.catalog.Product.md))~~ | Returns the enabled promotions of active campaigns for which the specified product is a qualifiying product. |
39
- | ~~static [getPromotion](dw.campaign.CampaignMgr.md#getpromotionstring)([String](TopLevel.String.md))~~ | Returns the promotion associated with the specified coupon code. |
40
- | ~~static [getPromotionByCouponCode](dw.campaign.CampaignMgr.md#getpromotionbycouponcodestring)([String](TopLevel.String.md))~~ | Returns the promotion associated with the specified coupon code. |
41
- | ~~static [getPromotionByID](dw.campaign.CampaignMgr.md#getpromotionbyidstring)([String](TopLevel.String.md))~~ | Returns the promotion identified by the specified ID. |
42
- | ~~static [getPromotions](dw.campaign.CampaignMgr.md#getpromotionsproduct)([Product](dw.catalog.Product.md))~~ | Returns the enabled promotions of active campaigns for which the specified product is a discounted product. |
43
-
44
- ### Methods inherited from class Object
45
-
46
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
47
- ## Property Details
48
-
49
- ### applicablePromotions
50
- - ~~applicablePromotions: [Collection](dw.util.Collection.md)~~ `(read-only)`
51
- - : Returns the enabled promotions of active campaigns applicable for the
52
- current customer and source code.
53
-
54
-
55
- Note that this method does not return any coupon-based promotions.
56
-
57
-
58
- **Deprecated:**
59
- :::warning
60
- Use [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
61
- [PromotionPlan.getPromotions()](dw.campaign.PromotionPlan.md#getpromotions)
62
-
63
- :::
64
-
65
- ---
66
-
67
- ## Method Details
68
-
69
- ### applyBonusPromotions(LineItemCtnr, Collection)
70
- - ~~static applyBonusPromotions(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md), promotions: [Collection](dw.util.Collection.md)): [Boolean](TopLevel.Boolean.md)~~
71
- - : This method has been deprecated and should not be used anymore.
72
- Instead, use [PromotionMgr](dw.campaign.PromotionMgr.md) to apply promotions to
73
- line item containers.
74
-
75
-
76
- The method does nothing, since bonus promotions are applied as product
77
- or order promotions using methods
78
- [applyProductPromotions(LineItemCtnr, Collection)](dw.campaign.CampaignMgr.md#applyproductpromotionslineitemctnr-collection) and
79
- [applyOrderPromotions(LineItemCtnr, Collection)](dw.campaign.CampaignMgr.md#applyorderpromotionslineitemctnr-collection).
80
-
81
-
82
- The method returns 'true' if any the line item container contains
83
- any bonus product line items, and otherwise false.
84
-
85
-
86
- **Parameters:**
87
- - lineItemCtnr - Basket or order
88
- - promotions - Parameter not used, can be null
89
-
90
- **Returns:**
91
- - True if line item container contains bonus product line items, else false
92
-
93
- **Deprecated:**
94
- :::warning
95
- Use [PromotionMgr](dw.campaign.PromotionMgr.md) instead.
96
- :::
97
-
98
- ---
99
-
100
- ### applyOrderPromotions(LineItemCtnr, Collection)
101
- - ~~static applyOrderPromotions(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md), promotions: [Collection](dw.util.Collection.md)): [Boolean](TopLevel.Boolean.md)~~
102
- - : Applies the applicable order promotions in the specified collection to the
103
- specified line item container.
104
-
105
-
106
- This method has been deprecated and should not be used anymore.
107
- Instead, use [PromotionMgr](dw.campaign.PromotionMgr.md) to apply promotions to
108
- line item containers.
109
-
110
-
111
- Note that the method does also apply any bonus discounts defined
112
- as order promotions (see also [applyBonusPromotions(LineItemCtnr, Collection)](dw.campaign.CampaignMgr.md#applybonuspromotionslineitemctnr-collection)).
113
-
114
-
115
- **Parameters:**
116
- - lineItemCtnr - basket or order
117
- - promotions - list of all promotions to be applied
118
-
119
- **Returns:**
120
- - true if changes were made to the line item container, false otherwise.
121
-
122
- **Deprecated:**
123
- :::warning
124
- Use [PromotionMgr](dw.campaign.PromotionMgr.md)
125
- :::
126
-
127
- ---
128
-
129
- ### applyProductPromotions(LineItemCtnr, Collection)
130
- - ~~static applyProductPromotions(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md), promotions: [Collection](dw.util.Collection.md)): [Boolean](TopLevel.Boolean.md)~~
131
- - : Applies all applicable product promotions in the specified collection to the
132
- specified line item container.
133
-
134
-
135
- This method has been deprecated and should not be used anymore.
136
- Instead, use [PromotionMgr](dw.campaign.PromotionMgr.md) to apply promotions to
137
- line item containers.
138
-
139
-
140
- Note that the method does also apply any bonus discounts defined
141
- as product promotions (see also [applyBonusPromotions(LineItemCtnr, Collection)](dw.campaign.CampaignMgr.md#applybonuspromotionslineitemctnr-collection)).
142
-
143
-
144
- **Parameters:**
145
- - lineItemCtnr - basket or order
146
- - promotions - list of all promotions to be applied
147
-
148
- **Returns:**
149
- - true if changes were made to the line item container, false otherwise.
150
-
151
- **Deprecated:**
152
- :::warning
153
- Use [PromotionMgr](dw.campaign.PromotionMgr.md)
154
- :::
155
-
156
- ---
157
-
158
- ### applyShippingPromotions(LineItemCtnr, Collection)
159
- - ~~static applyShippingPromotions(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md), promotions: [Collection](dw.util.Collection.md)): [Boolean](TopLevel.Boolean.md)~~
160
- - : Applies all applicable shipping promotions in the specified collection to
161
- the specified line item container.
162
-
163
-
164
- This method has been deprecated and should not be used anymore.
165
- Instead, use [PromotionMgr](dw.campaign.PromotionMgr.md) to apply promotions to
166
- line item containers.
167
-
168
-
169
- **Parameters:**
170
- - lineItemCtnr - basket or order
171
- - promotions - list of all promotions to be applied
172
-
173
- **Returns:**
174
- - true if changes were made to the line item container, false otherwise.
175
-
176
- **Deprecated:**
177
- :::warning
178
- Use [PromotionMgr](dw.campaign.PromotionMgr.md)
179
- :::
180
-
181
- ---
182
-
183
- ### getApplicableConditionalPromotions(Product)
184
- - ~~static getApplicableConditionalPromotions(product: [Product](dw.catalog.Product.md)): [Collection](dw.util.Collection.md)~~
185
- - : Returns the enabled promotions of active campaigns applicable for the
186
- current customer and source code for which the specified product
187
- is a qualifiying product.
188
-
189
-
190
- As a replacement of this deprecated method, use
191
- [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
192
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct).
193
- Unlike [getApplicableConditionalPromotions(Product)](dw.campaign.CampaignMgr.md#getapplicableconditionalpromotionsproduct),
194
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
195
- returns all promotions related to the specified product, regardless
196
- of whether the product is qualifying, discounted, or both, and
197
- also returns promotions where the product is a bonus product.
198
-
199
-
200
- **Parameters:**
201
- - product - Qualifying product
202
-
203
- **Returns:**
204
- - List of active promotions
205
-
206
- **Deprecated:**
207
- :::warning
208
- Use [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
209
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
210
-
211
- :::
212
-
213
- ---
214
-
215
- ### getApplicablePromotions()
216
- - ~~static getApplicablePromotions(): [Collection](dw.util.Collection.md)~~
217
- - : Returns the enabled promotions of active campaigns applicable for the
218
- current customer and source code.
219
-
220
-
221
- Note that this method does not return any coupon-based promotions.
222
-
223
-
224
- **Returns:**
225
- - List of active promotions
226
-
227
- **Deprecated:**
228
- :::warning
229
- Use [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
230
- [PromotionPlan.getPromotions()](dw.campaign.PromotionPlan.md#getpromotions)
231
-
232
- :::
233
-
234
- ---
235
-
236
- ### getApplicablePromotions(Product)
237
- - ~~static getApplicablePromotions(product: [Product](dw.catalog.Product.md)): [Collection](dw.util.Collection.md)~~
238
- - : Returns the enabled promotions of active campaigns applicable for the
239
- current customer and source code for which the specified product is
240
- a discounted product.
241
-
242
-
243
- Note that this method does not return any coupon-based promotions.
244
-
245
-
246
- As a replacement of this deprecated method, use
247
- [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
248
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct).
249
- Unlike [getApplicablePromotions(Product)](dw.campaign.CampaignMgr.md#getapplicablepromotionsproduct),
250
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
251
- returns all promotions related to the specified product, regardless
252
- of whether the product is qualifying, discounted, or both, and
253
- also returns promotions where the product is a bonus product.
254
-
255
-
256
- **Parameters:**
257
- - product - The product whose promotions are returned.
258
-
259
- **Returns:**
260
- - A list of promotions
261
-
262
- **Deprecated:**
263
- :::warning
264
- Use [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
265
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
266
-
267
- :::
268
-
269
- ---
270
-
271
- ### getApplicablePromotions(LineItemCtnr)
272
- - ~~static getApplicablePromotions(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md)): [Collection](dw.util.Collection.md)~~
273
- - : Returns the enabled promotions of active campaigns applicable for the
274
- current customer, source code and any coupon contained in the specified
275
- line item container.
276
-
277
-
278
- Note that although the method has been deprecated, no replacement
279
- method is provided.
280
-
281
-
282
- **Parameters:**
283
- - lineItemCtnr - the basket or order
284
-
285
- **Returns:**
286
- - list of all applicable promotion for the given basket or order
287
-
288
- **Deprecated:**
289
- :::warning
290
- There is no replacement for this method.
291
- :::
292
-
293
- ---
294
-
295
- ### getCampaignByID(String)
296
- - ~~static getCampaignByID(id: [String](TopLevel.String.md)): [Campaign](dw.campaign.Campaign.md)~~
297
- - : Returns the campaign identified by the specified ID.
298
-
299
- **Parameters:**
300
- - id - Campaign ID
301
-
302
- **Returns:**
303
- - Campaign or null if not found
304
-
305
- **Deprecated:**
306
- :::warning
307
- Use [PromotionMgr.getCampaign(String)](dw.campaign.PromotionMgr.md#getcampaignstring)
308
- :::
309
-
310
- ---
311
-
312
- ### getConditionalPromotions(Product)
313
- - ~~static getConditionalPromotions(product: [Product](dw.catalog.Product.md)): [Collection](dw.util.Collection.md)~~
314
- - : Returns the enabled promotions of active campaigns for which the
315
- specified product is a qualifiying product.
316
-
317
- Note that the method also returns coupon-based promotions.
318
-
319
-
320
- As a replacement of this deprecated method, use
321
- [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
322
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct).
323
- Unlike [getConditionalPromotions(Product)](dw.campaign.CampaignMgr.md#getconditionalpromotionsproduct),
324
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
325
- returns all promotions related to the specified product, regardless
326
- of whether the product is qualifying, discounted, or both, and
327
- also returns promotions where the product is a bonus product.
328
-
329
-
330
- **Parameters:**
331
- - product - The product whose conditional promotions are returned.
332
-
333
- **Returns:**
334
- - A list of promotions
335
-
336
- **Deprecated:**
337
- :::warning
338
- Use [PromotionMgr.getActivePromotions()](dw.campaign.PromotionMgr.md#getactivepromotions) and
339
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
340
-
341
- :::
342
-
343
- ---
344
-
345
- ### getPromotion(String)
346
- - ~~static getPromotion(couponCode: [String](TopLevel.String.md)): [Promotion](dw.campaign.Promotion.md)~~
347
- - : Returns the promotion associated with the specified coupon code.
348
-
349
- **Parameters:**
350
- - couponCode - The coupon code used to lookup the promotion
351
-
352
- **Returns:**
353
- - The resolved promotion object or null if none was found
354
-
355
- **Deprecated:**
356
- :::warning
357
- Coupons are now related to multiple promotions. Method
358
- returns the first promotion associated with the coupon
359
- code in case of multiple assigned promotions.
360
-
361
- :::
362
-
363
- ---
364
-
365
- ### getPromotionByCouponCode(String)
366
- - ~~static getPromotionByCouponCode(couponCode: [String](TopLevel.String.md)): [Promotion](dw.campaign.Promotion.md)~~
367
- - : Returns the promotion associated with the specified coupon code.
368
-
369
- **Parameters:**
370
- - couponCode - Coupon code
371
-
372
- **Returns:**
373
- - The associated promotion or null
374
-
375
- **Deprecated:**
376
- :::warning
377
- Coupons are now related to multiple promotions. Method
378
- returns the first promotion associated with the coupon
379
- in case of multiple assigned promotions
380
-
381
- :::
382
-
383
- ---
384
-
385
- ### getPromotionByID(String)
386
- - ~~static getPromotionByID(id: [String](TopLevel.String.md)): [Promotion](dw.campaign.Promotion.md)~~
387
- - : Returns the promotion identified by the specified ID.
388
-
389
- **Parameters:**
390
- - id - Promotion ID
391
-
392
- **Returns:**
393
- - Promotion or null if not found
394
-
395
- **Deprecated:**
396
- :::warning
397
- Use [PromotionMgr.getPromotion(String)](dw.campaign.PromotionMgr.md#getpromotionstring)
398
- :::
399
-
400
- ---
401
-
402
- ### getPromotions(Product)
403
- - ~~static getPromotions(product: [Product](dw.catalog.Product.md)): [Collection](dw.util.Collection.md)~~
404
- - : Returns the enabled promotions of active campaigns for which the
405
- specified product is a discounted product.
406
-
407
- Note that method does only return promotions based on customer groups
408
- or source codes.
409
-
410
-
411
- As a replacement of this deprecated method, use
412
- [PromotionMgr.getActiveCustomerPromotions()](dw.campaign.PromotionMgr.md#getactivecustomerpromotions) and
413
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct).
414
- Unlike [getPromotions(Product)](dw.campaign.CampaignMgr.md#getpromotionsproduct),
415
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
416
- returns all promotions related to the specified product, regardless
417
- of whether the product is qualifying, discounted, or both, and
418
- also returns promotions where the product is a bonus product.
419
-
420
-
421
- **Parameters:**
422
- - product - Discounted product
423
-
424
- **Returns:**
425
- - List of promotions
426
-
427
- **Deprecated:**
428
- :::warning
429
- Use [PromotionMgr.getActivePromotions()](dw.campaign.PromotionMgr.md#getactivepromotions) and
430
- [PromotionPlan.getProductPromotions(Product)](dw.campaign.PromotionPlan.md#getproductpromotionsproduct)
431
-
432
- :::
433
-
434
- ---
435
-
436
- <!-- prettier-ignore-end -->
@@ -1,103 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class CampaignStatusCodes
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.campaign.CampaignStatusCodes](dw.campaign.CampaignStatusCodes.md)
6
-
7
- Deprecated. Formerly used to contain the various statuses that a coupon may
8
- be in.
9
-
10
-
11
- **Deprecated:**
12
- :::warning
13
- Use [CouponStatusCodes](dw.campaign.CouponStatusCodes.md) instead.
14
- :::
15
-
16
- ## Constant Summary
17
-
18
- | Constant | Description |
19
- | --- | --- |
20
- | ~~[COUPON_ALREADY_APPLIED](#coupon_already_applied): [String](TopLevel.String.md) = "COUPON_ALREADY_APPLIED"~~ | Indicates that the coupon has already been applied to the basket. |
21
- | ~~[COUPON_ALREADY_REDEEMED](#coupon_already_redeemed): [String](TopLevel.String.md) = "COUPON_ALREADY_REDEEMED"~~ | Indicates that the coupon has already been redeemed. |
22
- | ~~[COUPON_NOT_REDEEMABLE](#coupon_not_redeemable): [String](TopLevel.String.md) = "COUPON_NOT_REDEEMABLE"~~ | Indicates that the coupon is not currently redeemable. |
23
- | ~~[COUPON_UNKNOWN](#coupon_unknown): [String](TopLevel.String.md) = "COUPON_UNKNOWN"~~ | Indicates that the coupon code is not valid. |
24
-
25
- ## Constructor Summary
26
-
27
- | Constructor | Description |
28
- | --- | --- |
29
- | [CampaignStatusCodes](#campaignstatuscodes)() | |
30
-
31
- ## Method Summary
32
-
33
- ### Methods inherited from class Object
34
-
35
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
36
- ## Constant Details
37
-
38
- ### COUPON_ALREADY_APPLIED
39
-
40
- - ~~COUPON_ALREADY_APPLIED: [String](TopLevel.String.md) = "COUPON_ALREADY_APPLIED"~~
41
- - : Indicates that the coupon has already been applied to the basket.
42
-
43
- **Deprecated:**
44
- :::warning
45
- Use [CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET](dw.campaign.CouponStatusCodes.md#coupon_code_already_in_basket),
46
- [CouponStatusCodes.COUPON_ALREADY_IN_BASKET](dw.campaign.CouponStatusCodes.md#coupon_already_in_basket) instead.
47
-
48
- :::
49
-
50
- ---
51
-
52
- ### COUPON_ALREADY_REDEEMED
53
-
54
- - ~~COUPON_ALREADY_REDEEMED: [String](TopLevel.String.md) = "COUPON_ALREADY_REDEEMED"~~
55
- - : Indicates that the coupon has already been redeemed.
56
-
57
- **Deprecated:**
58
- :::warning
59
- Use [CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED](dw.campaign.CouponStatusCodes.md#coupon_code_already_redeemed) instead.
60
- :::
61
-
62
- ---
63
-
64
- ### COUPON_NOT_REDEEMABLE
65
-
66
- - ~~COUPON_NOT_REDEEMABLE: [String](TopLevel.String.md) = "COUPON_NOT_REDEEMABLE"~~
67
- - : Indicates that the coupon is not currently redeemable.
68
-
69
- **Deprecated:**
70
- :::warning
71
- Use [CouponStatusCodes.COUPON_DISABLED](dw.campaign.CouponStatusCodes.md#coupon_disabled),
72
- [CouponStatusCodes.COUPON_CODE_UNKNOWN](dw.campaign.CouponStatusCodes.md#coupon_code_unknown),
73
- [CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED](dw.campaign.CouponStatusCodes.md#redemption_limit_exceeded),
74
- [CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED](dw.campaign.CouponStatusCodes.md#customer_redemption_limit_exceeded),
75
- [CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED](dw.campaign.CouponStatusCodes.md#timeframe_redemption_limit_exceeded) or
76
- [CouponStatusCodes.NO_APPLICABLE_PROMOTION](dw.campaign.CouponStatusCodes.md#no_applicable_promotion)
77
-
78
- :::
79
-
80
- ---
81
-
82
- ### COUPON_UNKNOWN
83
-
84
- - ~~COUPON_UNKNOWN: [String](TopLevel.String.md) = "COUPON_UNKNOWN"~~
85
- - : Indicates that the coupon code is not valid.
86
-
87
- **Deprecated:**
88
- :::warning
89
- Use [CouponStatusCodes.COUPON_CODE_UNKNOWN](dw.campaign.CouponStatusCodes.md#coupon_code_unknown) instead
90
- :::
91
-
92
- ---
93
-
94
- ## Constructor Details
95
-
96
- ### CampaignStatusCodes()
97
- - CampaignStatusCodes()
98
- - :
99
-
100
-
101
- ---
102
-
103
- <!-- prettier-ignore-end -->