@salesforce/b2c-tooling-sdk 1.19.0 → 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 (589) 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/discovery/detector.d.ts +1 -0
  28. package/dist/esm/discovery/detector.js +3 -1
  29. package/dist/esm/discovery/detector.js.map +1 -1
  30. package/dist/esm/discovery/index.d.ts +1 -1
  31. package/dist/esm/discovery/patterns/cartridges.js +4 -2
  32. package/dist/esm/discovery/patterns/cartridges.js.map +1 -1
  33. package/dist/esm/discovery/patterns/sfra.js +10 -5
  34. package/dist/esm/discovery/patterns/sfra.js.map +1 -1
  35. package/dist/esm/discovery/types.d.ts +20 -1
  36. package/dist/esm/docs/content-cache.d.ts +70 -0
  37. package/dist/esm/docs/content-cache.js +186 -0
  38. package/dist/esm/docs/content-cache.js.map +1 -0
  39. package/dist/esm/docs/index.d.ts +1 -0
  40. package/dist/esm/docs/index.js +2 -0
  41. package/dist/esm/docs/index.js.map +1 -1
  42. package/dist/esm/docs/search.js +34 -6
  43. package/dist/esm/docs/search.js.map +1 -1
  44. package/dist/esm/docs/types.d.ts +6 -1
  45. package/dist/esm/docs/types.js +1 -0
  46. package/dist/esm/docs/types.js.map +1 -1
  47. package/dist/esm/index.d.ts +2 -2
  48. package/dist/esm/index.js +1 -1
  49. package/dist/esm/index.js.map +1 -1
  50. package/dist/esm/operations/code/cartridges.d.ts +18 -0
  51. package/dist/esm/operations/code/cartridges.js +31 -20
  52. package/dist/esm/operations/code/cartridges.js.map +1 -1
  53. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  54. package/dist/esm/operations/jobs/discover.js +87 -0
  55. package/dist/esm/operations/jobs/discover.js.map +1 -0
  56. package/dist/esm/operations/jobs/index.d.ts +2 -0
  57. package/dist/esm/operations/jobs/index.js +2 -0
  58. package/dist/esm/operations/jobs/index.js.map +1 -1
  59. package/dist/esm/operations/jobs/run.js +4 -3
  60. package/dist/esm/operations/jobs/run.js.map +1 -1
  61. package/package.json +5 -3
  62. package/specs/preferences-v1.yaml +2095 -0
  63. package/data/script-api/TopLevel.APIException.md +0 -119
  64. package/data/script-api/TopLevel.Array.md +0 -732
  65. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  66. package/data/script-api/TopLevel.BigInt.md +0 -154
  67. package/data/script-api/TopLevel.Boolean.md +0 -83
  68. package/data/script-api/TopLevel.ConversionError.md +0 -51
  69. package/data/script-api/TopLevel.DataView.md +0 -271
  70. package/data/script-api/TopLevel.Date.md +0 -688
  71. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  72. package/data/script-api/TopLevel.Error.md +0 -124
  73. package/data/script-api/TopLevel.EvalError.md +0 -47
  74. package/data/script-api/TopLevel.Fault.md +0 -133
  75. package/data/script-api/TopLevel.Float32Array.md +0 -186
  76. package/data/script-api/TopLevel.Float64Array.md +0 -186
  77. package/data/script-api/TopLevel.Function.md +0 -114
  78. package/data/script-api/TopLevel.Generator.md +0 -132
  79. package/data/script-api/TopLevel.IOError.md +0 -98
  80. package/data/script-api/TopLevel.Int16Array.md +0 -186
  81. package/data/script-api/TopLevel.Int32Array.md +0 -186
  82. package/data/script-api/TopLevel.Int8Array.md +0 -186
  83. package/data/script-api/TopLevel.InternalError.md +0 -47
  84. package/data/script-api/TopLevel.Iterable.md +0 -44
  85. package/data/script-api/TopLevel.Iterator.md +0 -89
  86. package/data/script-api/TopLevel.JSON.md +0 -173
  87. package/data/script-api/TopLevel.Map.md +0 -189
  88. package/data/script-api/TopLevel.Math.md +0 -948
  89. package/data/script-api/TopLevel.Module.md +0 -152
  90. package/data/script-api/TopLevel.Namespace.md +0 -152
  91. package/data/script-api/TopLevel.Number.md +0 -404
  92. package/data/script-api/TopLevel.Object.md +0 -472
  93. package/data/script-api/TopLevel.QName.md +0 -147
  94. package/data/script-api/TopLevel.RangeError.md +0 -47
  95. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  96. package/data/script-api/TopLevel.RegExp.md +0 -155
  97. package/data/script-api/TopLevel.Set.md +0 -150
  98. package/data/script-api/TopLevel.StopIteration.md +0 -36
  99. package/data/script-api/TopLevel.String.md +0 -1060
  100. package/data/script-api/TopLevel.Symbol.md +0 -196
  101. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  102. package/data/script-api/TopLevel.SystemError.md +0 -99
  103. package/data/script-api/TopLevel.TypeError.md +0 -47
  104. package/data/script-api/TopLevel.URIError.md +0 -47
  105. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  106. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  107. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  108. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  109. package/data/script-api/TopLevel.WeakMap.md +0 -135
  110. package/data/script-api/TopLevel.WeakSet.md +0 -96
  111. package/data/script-api/TopLevel.XML.md +0 -922
  112. package/data/script-api/TopLevel.XMLList.md +0 -418
  113. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  114. package/data/script-api/TopLevel.arguments.md +0 -56
  115. package/data/script-api/TopLevel.global.md +0 -539
  116. package/data/script-api/TopLevel.md +0 -58
  117. package/data/script-api/dw.alert.Alert.md +0 -175
  118. package/data/script-api/dw.alert.Alerts.md +0 -256
  119. package/data/script-api/dw.alert.md +0 -7
  120. package/data/script-api/dw.campaign.ABTest.md +0 -63
  121. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  122. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  123. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  124. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  125. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  126. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  127. package/data/script-api/dw.campaign.Campaign.md +0 -346
  128. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  129. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  130. package/data/script-api/dw.campaign.Coupon.md +0 -324
  131. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  132. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  133. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  134. package/data/script-api/dw.campaign.Discount.md +0 -271
  135. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  136. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  137. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  138. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  139. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  140. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  141. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  142. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  143. package/data/script-api/dw.campaign.Promotion.md +0 -939
  144. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  145. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  146. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  147. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  148. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  149. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  150. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  151. package/data/script-api/dw.campaign.md +0 -36
  152. package/data/script-api/dw.catalog.Catalog.md +0 -158
  153. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  154. package/data/script-api/dw.catalog.Category.md +0 -1212
  155. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  156. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  157. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  158. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  159. package/data/script-api/dw.catalog.Product.md +0 -2492
  160. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  161. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  162. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  163. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  164. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  165. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  166. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  167. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  168. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  169. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  170. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  171. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  172. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  173. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  174. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  175. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  176. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  177. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  178. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  179. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  180. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  181. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  182. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  183. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  184. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  185. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  186. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  187. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  188. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  189. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  190. package/data/script-api/dw.catalog.Store.md +0 -484
  191. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  192. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  193. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  194. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  195. package/data/script-api/dw.catalog.Variant.md +0 -1000
  196. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  197. package/data/script-api/dw.catalog.md +0 -50
  198. package/data/script-api/dw.content.Content.md +0 -481
  199. package/data/script-api/dw.content.ContentMgr.md +0 -147
  200. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  201. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  202. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  203. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  204. package/data/script-api/dw.content.Folder.md +0 -432
  205. package/data/script-api/dw.content.Library.md +0 -124
  206. package/data/script-api/dw.content.MarkupText.md +0 -150
  207. package/data/script-api/dw.content.MediaFile.md +0 -367
  208. package/data/script-api/dw.content.md +0 -15
  209. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  210. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  211. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  212. package/data/script-api/dw.crypto.Encoding.md +0 -193
  213. package/data/script-api/dw.crypto.JWE.md +0 -245
  214. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  215. package/data/script-api/dw.crypto.JWS.md +0 -260
  216. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  217. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  218. package/data/script-api/dw.crypto.Mac.md +0 -191
  219. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  220. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  221. package/data/script-api/dw.crypto.Signature.md +0 -241
  222. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  223. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  224. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  225. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  226. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  227. package/data/script-api/dw.crypto.md +0 -23
  228. package/data/script-api/dw.customer.AddressBook.md +0 -158
  229. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  230. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  231. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  232. package/data/script-api/dw.customer.Credentials.md +0 -524
  233. package/data/script-api/dw.customer.Customer.md +0 -488
  234. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  235. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  236. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  237. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  238. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  239. package/data/script-api/dw.customer.CustomerList.md +0 -76
  240. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  241. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  242. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  243. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  244. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  245. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  246. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  247. package/data/script-api/dw.customer.ProductList.md +0 -870
  248. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  249. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  250. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  251. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  252. package/data/script-api/dw.customer.Profile.md +0 -940
  253. package/data/script-api/dw.customer.Wallet.md +0 -136
  254. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  255. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  256. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  257. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  258. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  259. package/data/script-api/dw.customer.consent.md +0 -10
  260. package/data/script-api/dw.customer.md +0 -31
  261. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  262. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  263. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  264. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  265. package/data/script-api/dw.customer.oauth.md +0 -9
  266. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  267. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  268. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  269. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  270. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  271. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  272. package/data/script-api/dw.experience.Component.md +0 -166
  273. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  274. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  275. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  276. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  277. package/data/script-api/dw.experience.Page.md +0 -467
  278. package/data/script-api/dw.experience.PageMgr.md +0 -549
  279. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  280. package/data/script-api/dw.experience.Region.md +0 -119
  281. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  282. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  283. package/data/script-api/dw.experience.cms.md +0 -6
  284. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  285. package/data/script-api/dw.experience.image.Image.md +0 -101
  286. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  287. package/data/script-api/dw.experience.image.md +0 -8
  288. package/data/script-api/dw.experience.md +0 -16
  289. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  290. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  291. package/data/script-api/dw.extensions.applepay.md +0 -7
  292. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  293. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  294. package/data/script-api/dw.extensions.facebook.md +0 -7
  295. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  296. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  297. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  298. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  299. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  300. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  301. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  302. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  303. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  304. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  305. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  306. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  307. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  308. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  309. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  310. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  312. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  313. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  314. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  315. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  316. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  317. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  318. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  319. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  320. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  321. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  322. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  323. package/data/script-api/dw.extensions.payments.md +0 -28
  324. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  325. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  326. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  327. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  328. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  329. package/data/script-api/dw.extensions.pinterest.md +0 -10
  330. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  331. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  332. package/data/script-api/dw.io.File.md +0 -729
  333. package/data/script-api/dw.io.FileReader.md +0 -70
  334. package/data/script-api/dw.io.FileWriter.md +0 -159
  335. package/data/script-api/dw.io.InputStream.md +0 -35
  336. package/data/script-api/dw.io.OutputStream.md +0 -38
  337. package/data/script-api/dw.io.PrintWriter.md +0 -66
  338. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  339. package/data/script-api/dw.io.Reader.md +0 -284
  340. package/data/script-api/dw.io.StringWriter.md +0 -89
  341. package/data/script-api/dw.io.Writer.md +0 -96
  342. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  343. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  344. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  345. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  346. package/data/script-api/dw.io.md +0 -21
  347. package/data/script-api/dw.job.JobExecution.md +0 -111
  348. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  349. package/data/script-api/dw.job.md +0 -7
  350. package/data/script-api/dw.net.FTPClient.md +0 -621
  351. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  352. package/data/script-api/dw.net.HTTPClient.md +0 -775
  353. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  354. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  355. package/data/script-api/dw.net.Mail.md +0 -487
  356. package/data/script-api/dw.net.SFTPClient.md +0 -535
  357. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  358. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  359. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  360. package/data/script-api/dw.net.md +0 -15
  361. package/data/script-api/dw.object.ActiveData.md +0 -86
  362. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  363. package/data/script-api/dw.object.CustomObject.md +0 -82
  364. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  365. package/data/script-api/dw.object.Extensible.md +0 -71
  366. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  367. package/data/script-api/dw.object.Note.md +0 -118
  368. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  369. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  370. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  371. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  372. package/data/script-api/dw.object.PersistentObject.md +0 -92
  373. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  374. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  375. package/data/script-api/dw.object.md +0 -19
  376. package/data/script-api/dw.order.AbstractItem.md +0 -220
  377. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  378. package/data/script-api/dw.order.Appeasement.md +0 -398
  379. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  380. package/data/script-api/dw.order.Basket.md +0 -868
  381. package/data/script-api/dw.order.BasketMgr.md +0 -673
  382. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  383. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  384. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  385. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  386. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  387. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  388. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  389. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  390. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  391. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  392. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  393. package/data/script-api/dw.order.Invoice.md +0 -571
  394. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  395. package/data/script-api/dw.order.LineItem.md +0 -577
  396. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  397. package/data/script-api/dw.order.LineItemTax.md +0 -142
  398. package/data/script-api/dw.order.Order.md +0 -2770
  399. package/data/script-api/dw.order.OrderAddress.md +0 -624
  400. package/data/script-api/dw.order.OrderItem.md +0 -613
  401. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  402. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  403. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  404. package/data/script-api/dw.order.PaymentCard.md +0 -220
  405. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  406. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  407. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  408. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  409. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  410. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  411. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  412. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  413. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  414. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  415. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  416. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  417. package/data/script-api/dw.order.Return.md +0 -396
  418. package/data/script-api/dw.order.ReturnCase.md +0 -463
  419. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  420. package/data/script-api/dw.order.ReturnItem.md +0 -335
  421. package/data/script-api/dw.order.Shipment.md +0 -1132
  422. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  423. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  424. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  425. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  426. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  427. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  428. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  429. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  430. package/data/script-api/dw.order.SumItem.md +0 -158
  431. package/data/script-api/dw.order.TaxGroup.md +0 -128
  432. package/data/script-api/dw.order.TaxItem.md +0 -74
  433. package/data/script-api/dw.order.TaxMgr.md +0 -314
  434. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  435. package/data/script-api/dw.order.TrackingRef.md +0 -108
  436. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  437. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  438. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  439. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  440. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  441. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  442. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  443. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  444. package/data/script-api/dw.order.hooks.md +0 -13
  445. package/data/script-api/dw.order.md +0 -65
  446. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  447. package/data/script-api/dw.rpc.Stub.md +0 -373
  448. package/data/script-api/dw.rpc.WebReference.md +0 -133
  449. package/data/script-api/dw.rpc.md +0 -8
  450. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  451. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  452. package/data/script-api/dw.sitemap.md +0 -7
  453. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  454. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  455. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  456. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  457. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  458. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  459. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  460. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  461. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  462. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  463. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  464. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  465. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  466. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  467. package/data/script-api/dw.suggest.md +0 -19
  468. package/data/script-api/dw.svc.FTPService.md +0 -140
  469. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  470. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  471. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  472. package/data/script-api/dw.svc.HTTPService.md +0 -370
  473. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  474. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  475. package/data/script-api/dw.svc.Result.md +0 -320
  476. package/data/script-api/dw.svc.SOAPService.md +0 -104
  477. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  478. package/data/script-api/dw.svc.Service.md +0 -276
  479. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  480. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  481. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  482. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  483. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  484. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  485. package/data/script-api/dw.svc.md +0 -22
  486. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  487. package/data/script-api/dw.system.Cache.md +0 -126
  488. package/data/script-api/dw.system.CacheMgr.md +0 -70
  489. package/data/script-api/dw.system.HookMgr.md +0 -78
  490. package/data/script-api/dw.system.InternalObject.md +0 -47
  491. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  492. package/data/script-api/dw.system.Log.md +0 -198
  493. package/data/script-api/dw.system.LogNDC.md +0 -75
  494. package/data/script-api/dw.system.Logger.md +0 -216
  495. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  496. package/data/script-api/dw.system.Pipeline.md +0 -94
  497. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  498. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  499. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  500. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  501. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  502. package/data/script-api/dw.system.Request.md +0 -785
  503. package/data/script-api/dw.system.RequestHooks.md +0 -112
  504. package/data/script-api/dw.system.Response.md +0 -612
  505. package/data/script-api/dw.system.SearchStatus.md +0 -187
  506. package/data/script-api/dw.system.Session.md +0 -469
  507. package/data/script-api/dw.system.Site.md +0 -570
  508. package/data/script-api/dw.system.SitePreferences.md +0 -90
  509. package/data/script-api/dw.system.Status.md +0 -330
  510. package/data/script-api/dw.system.StatusItem.md +0 -273
  511. package/data/script-api/dw.system.System.md +0 -224
  512. package/data/script-api/dw.system.Transaction.md +0 -107
  513. package/data/script-api/dw.system.md +0 -32
  514. package/data/script-api/dw.template.ISML.md +0 -127
  515. package/data/script-api/dw.template.Velocity.md +0 -168
  516. package/data/script-api/dw.template.md +0 -7
  517. package/data/script-api/dw.util.ArrayList.md +0 -99
  518. package/data/script-api/dw.util.Assert.md +0 -370
  519. package/data/script-api/dw.util.BigInteger.md +0 -283
  520. package/data/script-api/dw.util.Bytes.md +0 -278
  521. package/data/script-api/dw.util.Calendar.md +0 -1051
  522. package/data/script-api/dw.util.Collection.md +0 -272
  523. package/data/script-api/dw.util.Currency.md +0 -147
  524. package/data/script-api/dw.util.DateUtils.md +0 -82
  525. package/data/script-api/dw.util.Decimal.md +0 -386
  526. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  527. package/data/script-api/dw.util.Geolocation.md +0 -293
  528. package/data/script-api/dw.util.HashMap.md +0 -50
  529. package/data/script-api/dw.util.HashSet.md +0 -65
  530. package/data/script-api/dw.util.Iterator.md +0 -86
  531. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  532. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  533. package/data/script-api/dw.util.List.md +0 -429
  534. package/data/script-api/dw.util.Locale.md +0 -277
  535. package/data/script-api/dw.util.Map.md +0 -251
  536. package/data/script-api/dw.util.MapEntry.md +0 -68
  537. package/data/script-api/dw.util.MappingKey.md +0 -96
  538. package/data/script-api/dw.util.MappingMgr.md +0 -113
  539. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  540. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  541. package/data/script-api/dw.util.SecureFilter.md +0 -572
  542. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  543. package/data/script-api/dw.util.Set.md +0 -39
  544. package/data/script-api/dw.util.SortedMap.md +0 -148
  545. package/data/script-api/dw.util.SortedSet.md +0 -173
  546. package/data/script-api/dw.util.StringUtils.md +0 -655
  547. package/data/script-api/dw.util.Template.md +0 -141
  548. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  549. package/data/script-api/dw.util.md +0 -37
  550. package/data/script-api/dw.value.EnumValue.md +0 -105
  551. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  552. package/data/script-api/dw.value.Money.md +0 -526
  553. package/data/script-api/dw.value.Quantity.md +0 -299
  554. package/data/script-api/dw.value.md +0 -9
  555. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  556. package/data/script-api/dw.web.ClickStream.md +0 -177
  557. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  558. package/data/script-api/dw.web.Cookie.md +0 -431
  559. package/data/script-api/dw.web.Cookies.md +0 -59
  560. package/data/script-api/dw.web.Form.md +0 -84
  561. package/data/script-api/dw.web.FormAction.md +0 -195
  562. package/data/script-api/dw.web.FormElement.md +0 -211
  563. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  564. package/data/script-api/dw.web.FormField.md +0 -642
  565. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  566. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  567. package/data/script-api/dw.web.FormGroup.md +0 -222
  568. package/data/script-api/dw.web.FormList.md +0 -134
  569. package/data/script-api/dw.web.FormListItem.md +0 -57
  570. package/data/script-api/dw.web.Forms.md +0 -25
  571. package/data/script-api/dw.web.HttpParameter.md +0 -462
  572. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  573. package/data/script-api/dw.web.LoopIterator.md +0 -231
  574. package/data/script-api/dw.web.PageMetaData.md +0 -197
  575. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  576. package/data/script-api/dw.web.PagingModel.md +0 -407
  577. package/data/script-api/dw.web.Resource.md +0 -147
  578. package/data/script-api/dw.web.URL.md +0 -174
  579. package/data/script-api/dw.web.URLAction.md +0 -95
  580. package/data/script-api/dw.web.URLParameter.md +0 -52
  581. package/data/script-api/dw.web.URLRedirect.md +0 -72
  582. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  583. package/data/script-api/dw.web.URLUtils.md +0 -1357
  584. package/data/script-api/dw.web.md +0 -34
  585. package/data/script-api/dw.ws.Port.md +0 -126
  586. package/data/script-api/dw.ws.WSUtil.md +0 -728
  587. package/data/script-api/dw.ws.WebReference2.md +0 -137
  588. package/data/script-api/dw.ws.md +0 -8
  589. package/data/script-api/index.md +0 -40
@@ -1,175 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Alert
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.alert.Alert](dw.alert.Alert.md)
6
-
7
- This class represents a single system alert to be shown to a Business Manager user.
8
-
9
-
10
- ## Constant Summary
11
-
12
- | Constant | Description |
13
- | --- | --- |
14
- | [PRIORITY_ACTION](#priority_action): [String](TopLevel.String.md) = "ACTION" | String constant to denote the 'action required' priority. |
15
- | [PRIORITY_INFO](#priority_info): [String](TopLevel.String.md) = "INFO" | String constant to denote the 'informational' priority. |
16
- | [PRIORITY_WARN](#priority_warn): [String](TopLevel.String.md) = "WARN" | String constant to denote the 'warning' priority. |
17
-
18
- ## Property Summary
19
-
20
- | Property | Description |
21
- | --- | --- |
22
- | [alertDescriptorID](#alertdescriptorid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the referenced alert description. |
23
- | [contextObjectID](#contextobjectid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the referenced context object (or null, if no context object is assigned to this alert). |
24
- | [displayMessage](#displaymessage): [String](TopLevel.String.md) `(read-only)` | Resolves the display message to be shown. |
25
- | [priority](#priority): [String](TopLevel.String.md) `(read-only)` | Returns the priority assigned to the message. |
26
- | [remediationURL](#remediationurl): [String](TopLevel.String.md) `(read-only)` | The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file. |
27
-
28
- ## Constructor Summary
29
-
30
- This class does not have a constructor, so you cannot create it directly.
31
- ## Method Summary
32
-
33
- | Method | Description |
34
- | --- | --- |
35
- | [getAlertDescriptorID](dw.alert.Alert.md#getalertdescriptorid)() | Returns the ID of the referenced alert description. |
36
- | [getContextObjectID](dw.alert.Alert.md#getcontextobjectid)() | Returns the ID of the referenced context object (or null, if no context object is assigned to this alert). |
37
- | [getDisplayMessage](dw.alert.Alert.md#getdisplaymessage)() | Resolves the display message to be shown. |
38
- | [getPriority](dw.alert.Alert.md#getpriority)() | Returns the priority assigned to the message. |
39
- | [getRemediationURL](dw.alert.Alert.md#getremediationurl)() | The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file. |
40
-
41
- ### Methods inherited from class Object
42
-
43
- [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)
44
- ## Constant Details
45
-
46
- ### PRIORITY_ACTION
47
-
48
- - PRIORITY_ACTION: [String](TopLevel.String.md) = "ACTION"
49
- - : String constant to denote the 'action required' priority.
50
-
51
-
52
- ---
53
-
54
- ### PRIORITY_INFO
55
-
56
- - PRIORITY_INFO: [String](TopLevel.String.md) = "INFO"
57
- - : String constant to denote the 'informational' priority.
58
-
59
-
60
- ---
61
-
62
- ### PRIORITY_WARN
63
-
64
- - PRIORITY_WARN: [String](TopLevel.String.md) = "WARN"
65
- - : String constant to denote the 'warning' priority.
66
-
67
-
68
- ---
69
-
70
- ## Property Details
71
-
72
- ### alertDescriptorID
73
- - alertDescriptorID: [String](TopLevel.String.md) `(read-only)`
74
- - : Returns the ID of the referenced alert description.
75
-
76
-
77
- ---
78
-
79
- ### contextObjectID
80
- - contextObjectID: [String](TopLevel.String.md) `(read-only)`
81
- - : Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).
82
-
83
-
84
- ---
85
-
86
- ### displayMessage
87
- - displayMessage: [String](TopLevel.String.md) `(read-only)`
88
- - : Resolves the display message to be shown.
89
- It refers to the message resource ID specified in the alert descriptor file ("message-resource-id") and the message provided
90
- by the 'alerts.properties' resource bundle.
91
- When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.
92
-
93
-
94
-
95
- ---
96
-
97
- ### priority
98
- - priority: [String](TopLevel.String.md) `(read-only)`
99
- - : Returns the priority assigned to the message.
100
- One of the string constants defined in this class (PRIORITY\_INFO, PRIORITY\_WARN, PRIORITY\_ACTION).
101
-
102
-
103
-
104
- ---
105
-
106
- ### remediationURL
107
- - remediationURL: [String](TopLevel.String.md) `(read-only)`
108
- - : The URL of the page where the user can resolve the alert, as provided in the
109
- 'alerts.json' descriptor file.
110
-
111
-
112
-
113
- ---
114
-
115
- ## Method Details
116
-
117
- ### getAlertDescriptorID()
118
- - getAlertDescriptorID(): [String](TopLevel.String.md)
119
- - : Returns the ID of the referenced alert description.
120
-
121
- **Returns:**
122
- - the ID of the referenced alert description
123
-
124
-
125
- ---
126
-
127
- ### getContextObjectID()
128
- - getContextObjectID(): [String](TopLevel.String.md)
129
- - : Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).
130
-
131
- **Returns:**
132
- - the ID of the referenced context object
133
-
134
-
135
- ---
136
-
137
- ### getDisplayMessage()
138
- - getDisplayMessage(): [String](TopLevel.String.md)
139
- - : Resolves the display message to be shown.
140
- It refers to the message resource ID specified in the alert descriptor file ("message-resource-id") and the message provided
141
- by the 'alerts.properties' resource bundle.
142
- When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.
143
-
144
-
145
- **Returns:**
146
- - the display message
147
-
148
-
149
- ---
150
-
151
- ### getPriority()
152
- - getPriority(): [String](TopLevel.String.md)
153
- - : Returns the priority assigned to the message.
154
- One of the string constants defined in this class (PRIORITY\_INFO, PRIORITY\_WARN, PRIORITY\_ACTION).
155
-
156
-
157
- **Returns:**
158
- - the priority
159
-
160
-
161
- ---
162
-
163
- ### getRemediationURL()
164
- - getRemediationURL(): [String](TopLevel.String.md)
165
- - : The URL of the page where the user can resolve the alert, as provided in the
166
- 'alerts.json' descriptor file.
167
-
168
-
169
- **Returns:**
170
- - the remediation URL
171
-
172
-
173
- ---
174
-
175
- <!-- prettier-ignore-end -->
@@ -1,256 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Alerts
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.alert.Alerts](dw.alert.Alerts.md)
6
-
7
-
8
- Allow creation, removal, re-validation and retrieval of alerts that might get visible to Business Manager users.
9
-
10
-
11
- The alerts have to be registered by the 'alerts.json' descriptor file in a cartridge assigned to the Business Manager site.
12
- The descriptor file itself has to be defined in 'package.json' of that cartridge using a property 'alerts' and providing its path
13
- that is relative to the 'package.json'.
14
- The 'alert.json' descriptor files contain the 'alert descriptions', which are referenced by their ID throughout the API.
15
-
16
-
17
- For example, the 'alerts.json' file could have the following content:
18
-
19
-
20
- ```
21
- {
22
- "alerts": [
23
- {
24
- "alert-id": "missing_org_config",
25
- "menu-action": "global-prefs_custom_prefs",
26
- "message-resource-id": "global.missing_org_config",
27
- "priority": "ACTION",
28
- "remediation": {
29
- "pipeline":"GlobalCustomPreferences",
30
- "start-node":"View"
31
- }
32
- },
33
- {
34
- "alert-id":"promo_in_past",
35
- "menu-action":"marketing_promotions",
36
- "context-object-type":"Promotion",
37
- "message-resource-id":"promotion.in_the_past",
38
- "priority":"WARN",
39
- "remediation": {
40
- "pipeline":"ViewApplication",
41
- "start-node":"BM",
42
- "parameter":"screen=Promotion"
43
- }
44
- }
45
- ]
46
- }
47
- ```
48
-
49
- The referenced menu actions can be found in the 'bm\_extensions.xml' file of a Business manager extension cartridge
50
- (a sample file containing all current menu entries is provided when creating a new extension cartridge in Studio).
51
-
52
-
53
-
54
- ## Constructor Summary
55
-
56
- This class does not have a constructor, so you cannot create it directly.
57
- ## Method Summary
58
-
59
- | Method | Description |
60
- | --- | --- |
61
- | static [addAlert](dw.alert.Alerts.md#addalertstring-persistentobject-string)([String](TopLevel.String.md), [PersistentObject](dw.object.PersistentObject.md), [String\[\]](TopLevel.String.md)) | Creates a new alert for the given ID and context object. |
62
- | static [addAlert](dw.alert.Alerts.md#addalertstring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String\[\]](TopLevel.String.md)) | Creates a new alert for the given ID and ID of the context object. |
63
- | static [addAlert](dw.alert.Alerts.md#addalertstring-string)([String](TopLevel.String.md), [String\[\]](TopLevel.String.md)) | Creates a new alert for the given ID. |
64
- | static [getAlerts](dw.alert.Alerts.md#getalertsstring)([String...](TopLevel.String.md)) | Retrieves all alerts for a set of alert descriptor ID. |
65
- | static [getAlertsForContextObject](dw.alert.Alerts.md#getalertsforcontextobjectpersistentobject-string)([PersistentObject](dw.object.PersistentObject.md), [String...](TopLevel.String.md)) | Retrieves all alerts for a set of alert descriptor ID and the given context object. |
66
- | static [getAlertsForContextObject](dw.alert.Alerts.md#getalertsforcontextobjectstring-string)([String](TopLevel.String.md), [String...](TopLevel.String.md)) | Retrieves all alerts for a set of alert descriptor ID and the given context object ID. |
67
- | static [removeAlert](dw.alert.Alerts.md#removealertstring)([String](TopLevel.String.md)) | Removes all alerts for the given alert descriptor ID. |
68
- | static [removeAlert](dw.alert.Alerts.md#removealertstring-persistentobject)([String](TopLevel.String.md), [PersistentObject](dw.object.PersistentObject.md)) | Removes the alert for the given alert description and context object. |
69
- | static [removeAlert](dw.alert.Alerts.md#removealertstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Removes the alert for the given alert description and context object ID. |
70
- | static [revalidateAlert](dw.alert.Alerts.md#revalidatealertstring-function-string)([String](TopLevel.String.md), [Function](TopLevel.Function.md), [String\[\]](TopLevel.String.md)) | Re-evaluates the process function, and creates or removes the respective alert. |
71
- | static [revalidateAlert](dw.alert.Alerts.md#revalidatealertstring-persistentobject-function-string)([String](TopLevel.String.md), [PersistentObject](dw.object.PersistentObject.md), [Function](TopLevel.Function.md), [String\[\]](TopLevel.String.md)) | Re-evaluates the process function, and creates or removes the respective alert. |
72
- | static [revalidateAlert](dw.alert.Alerts.md#revalidatealertstring-object-string-function-string)([String](TopLevel.String.md), [Object](TopLevel.Object.md), [String](TopLevel.String.md), [Function](TopLevel.Function.md), [String\[\]](TopLevel.String.md)) | Re-evaluates the process function, and creates or removes the respective alert. |
73
-
74
- ### Methods inherited from class Object
75
-
76
- [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)
77
- ## Method Details
78
-
79
- ### addAlert(String, PersistentObject, String[])
80
- - static addAlert(alertDescriptorID: [String](TopLevel.String.md), contextObject: [PersistentObject](dw.object.PersistentObject.md), params: [String\[\]](TopLevel.String.md)): void
81
- - : Creates a new alert for the given ID and context object.
82
- If such an alert already exists, no new one is created, and the existing one is not modified.
83
- Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.
84
- To refer to the same alert afterwards (e.g. to remove the alert) the same object must be provided.
85
-
86
-
87
- **Parameters:**
88
- - alertDescriptorID - the ID of the referenced alert description
89
- - contextObject - the context object
90
- - params - parameters which may be shown in the alert message
91
-
92
-
93
- ---
94
-
95
- ### addAlert(String, String, String[])
96
- - static addAlert(alertDescriptorID: [String](TopLevel.String.md), contextObjectID: [String](TopLevel.String.md), params: [String\[\]](TopLevel.String.md)): void
97
- - : Creates a new alert for the given ID and ID of the context object.
98
- If such an alert already exists, no new one is created, and the existing one is not modified.
99
- Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.
100
- To refer to the same alert afterwards (e.g. to remove it) the same object ID must be provided.
101
-
102
- Use this method when the alerts refers to an object which is not a PersistentObject.
103
-
104
-
105
- **Parameters:**
106
- - alertDescriptorID - the ID of the referenced alert description
107
- - contextObjectID - the ID of the referenced object
108
- - params - parameters which may be shown in the alert message
109
-
110
-
111
- ---
112
-
113
- ### addAlert(String, String[])
114
- - static addAlert(alertDescriptorID: [String](TopLevel.String.md), params: [String\[\]](TopLevel.String.md)): void
115
- - : Creates a new alert for the given ID.
116
- If such an alert already exists, no new one is created, and the existing one is not modified.
117
-
118
-
119
- **Parameters:**
120
- - alertDescriptorID - the ID of the referenced alert description
121
- - params - parameters which may be shown in the alert message
122
-
123
-
124
- ---
125
-
126
- ### getAlerts(String...)
127
- - static getAlerts(alertDescriptorIDs: [String...](TopLevel.String.md)): [List](dw.util.List.md)
128
- - : Retrieves all alerts for a set of alert descriptor ID.
129
-
130
- **Parameters:**
131
- - alertDescriptorIDs - the IDs of the referenced alert descriptions
132
-
133
- **Returns:**
134
- - the list of alerts (of type Alert)
135
-
136
-
137
- ---
138
-
139
- ### getAlertsForContextObject(PersistentObject, String...)
140
- - static getAlertsForContextObject(contextObject: [PersistentObject](dw.object.PersistentObject.md), alertDescriptorIDs: [String...](TopLevel.String.md)): [List](dw.util.List.md)
141
- - : Retrieves all alerts for a set of alert descriptor ID and the given context object.
142
-
143
- **Parameters:**
144
- - contextObject - the context object
145
- - alertDescriptorIDs - the IDs of the referenced alert descriptions
146
-
147
- **Returns:**
148
- - the list of alerts (of type Alert)
149
-
150
-
151
- ---
152
-
153
- ### getAlertsForContextObject(String, String...)
154
- - static getAlertsForContextObject(contextObjectID: [String](TopLevel.String.md), alertDescriptorIDs: [String...](TopLevel.String.md)): [List](dw.util.List.md)
155
- - : Retrieves all alerts for a set of alert descriptor ID and the given context object ID.
156
-
157
- **Parameters:**
158
- - contextObjectID - the ID of the referenced object
159
- - alertDescriptorIDs - the IDs of the referenced alert descriptions
160
-
161
- **Returns:**
162
- - the list of alerts (of type Alert)
163
-
164
-
165
- ---
166
-
167
- ### removeAlert(String)
168
- - static removeAlert(alertDescriptorID: [String](TopLevel.String.md)): void
169
- - : Removes all alerts for the given alert descriptor ID. This method will remove also alert referencing
170
- context objects, as long as they reference the same alert description.
171
-
172
-
173
- **Parameters:**
174
- - alertDescriptorID - the ID of the referenced alert description
175
-
176
-
177
- ---
178
-
179
- ### removeAlert(String, PersistentObject)
180
- - static removeAlert(alertDescriptorID: [String](TopLevel.String.md), contextObject: [PersistentObject](dw.object.PersistentObject.md)): void
181
- - : Removes the alert for the given alert description and context object.
182
-
183
- **Parameters:**
184
- - alertDescriptorID - the ID of the referenced alert description
185
- - contextObject - the context object
186
-
187
-
188
- ---
189
-
190
- ### removeAlert(String, String)
191
- - static removeAlert(alertDescriptorID: [String](TopLevel.String.md), contextObjectID: [String](TopLevel.String.md)): void
192
- - : Removes the alert for the given alert description and context object ID.
193
-
194
- **Parameters:**
195
- - alertDescriptorID - the ID of the referenced alert description
196
- - contextObjectID - the context object ID
197
-
198
-
199
- ---
200
-
201
- ### revalidateAlert(String, Function, String[])
202
- - static revalidateAlert(alertDescriptorID: [String](TopLevel.String.md), processFunction: [Function](TopLevel.Function.md), params: [String\[\]](TopLevel.String.md)): void
203
- - : Re-evaluates the process function, and creates or removes the respective alert.
204
- The process function must return true when the alert should be created, and false when it should be removed.
205
- When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing
206
- alert is updated with the supplied parameters.
207
-
208
-
209
- **Parameters:**
210
- - alertDescriptorID - the ID of the referenced alert description
211
- - processFunction - the validation function. Must return true when the alert needs to be created.
212
- - params - parameters which may be shown in the alert message
213
-
214
-
215
- ---
216
-
217
- ### revalidateAlert(String, PersistentObject, Function, String[])
218
- - static revalidateAlert(alertDescriptorID: [String](TopLevel.String.md), contextObject: [PersistentObject](dw.object.PersistentObject.md), processFunction: [Function](TopLevel.Function.md), params: [String\[\]](TopLevel.String.md)): void
219
- - : Re-evaluates the process function, and creates or removes the respective alert. The context object is handed as the only parameter to the process function.
220
- The process function must return true when the alert should be created, and false when it should be removed.
221
- When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing
222
- alert is updated with the supplied parameters.
223
-
224
-
225
- **Parameters:**
226
- - alertDescriptorID - the ID of the referenced alert description
227
- - contextObject - the context object for which the validation is done, might be null
228
- - processFunction - the validation function. Must return true when the alert needs to be created.
229
- - params - parameters which may be shown in the alert message
230
-
231
-
232
- ---
233
-
234
- ### revalidateAlert(String, Object, String, Function, String[])
235
- - static revalidateAlert(alertDescriptorID: [String](TopLevel.String.md), contextObject: [Object](TopLevel.Object.md), contextObjectID: [String](TopLevel.String.md), processFunction: [Function](TopLevel.Function.md), params: [String\[\]](TopLevel.String.md)): void
236
- - : Re-evaluates the process function, and creates or removes the respective alert. When the optional
237
- context object is supplied, it is handed as the only parameter to the process function (if its not supplied,
238
- no parameter is given to the function).
239
- The process function must return true when the alert should be created, and false when it should be removed.
240
- When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing
241
- alert is updated with the supplied parameters.
242
- Use this variant of the function when the context object is not a persistent object. In this case the ID to be assigned
243
- to the alert must be supplied as an additional parameter. (Either both the context object and the ID must be provided, or none of them)
244
-
245
-
246
- **Parameters:**
247
- - alertDescriptorID - the ID of the referenced alert description
248
- - contextObject - the context object for which the validation is done
249
- - contextObjectID - the id of the context object for which the validation is done (and which is used to add / remove the alert object)
250
- - processFunction - the validation function. Must return true when the alert needs to be created.
251
- - params - parameters which may be shown in the alert message
252
-
253
-
254
- ---
255
-
256
- <!-- prettier-ignore-end -->
@@ -1,7 +0,0 @@
1
- # Package dw.alert
2
-
3
- ## Classes
4
- | Class | Description |
5
- | --- | --- |
6
- | [Alert](dw.alert.Alert.md) | This class represents a single system alert to be shown to a Business Manager user. |
7
- | [Alerts](dw.alert.Alerts.md) | <p>Allow creation, removal, re-validation and retrieval of alerts that might get visible to Business Manager users. |
@@ -1,63 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ABTest
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.object.PersistentObject](dw.object.PersistentObject.md)
6
- - [dw.campaign.ABTest](dw.campaign.ABTest.md)
7
-
8
- Object representing an AB-test in Commerce Cloud Digital.
9
-
10
-
11
- AB-tests provide the merchant the ability to compare one set of storefront
12
- "experiences" - promotions, sorting rules, and slot configurations in
13
- particular - against another set. The merchant configures different AB-test
14
- segments which define the sets of experiences that the merchant wishes to
15
- test. AB-tests run for a configured period of time, and customers are
16
- randomly assigned by the platform to the test segments according to
17
- allocation percentages defined by the merchant.
18
-
19
-
20
-
21
- ## Property Summary
22
-
23
- | Property | Description |
24
- | --- | --- |
25
- | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Get the test ID for this AB-test. |
26
-
27
- ## Constructor Summary
28
-
29
- This class does not have a constructor, so you cannot create it directly.
30
- ## Method Summary
31
-
32
- | Method | Description |
33
- | --- | --- |
34
- | [getID](dw.campaign.ABTest.md#getid)() | Get the test ID for this AB-test. |
35
-
36
- ### Methods inherited from class PersistentObject
37
-
38
- [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
39
- ### Methods inherited from class Object
40
-
41
- [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)
42
- ## Property Details
43
-
44
- ### ID
45
- - ID: [String](TopLevel.String.md) `(read-only)`
46
- - : Get the test ID for this AB-test.
47
-
48
-
49
- ---
50
-
51
- ## Method Details
52
-
53
- ### getID()
54
- - getID(): [String](TopLevel.String.md)
55
- - : Get the test ID for this AB-test.
56
-
57
- **Returns:**
58
- - the test ID for this AB-test.
59
-
60
-
61
- ---
62
-
63
- <!-- prettier-ignore-end -->
@@ -1,76 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ABTestMgr
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.campaign.ABTestMgr](dw.campaign.ABTestMgr.md)
6
-
7
- Manager class used to access AB-test information in the storefront.
8
-
9
-
10
- ## Property Summary
11
-
12
- | Property | Description |
13
- | --- | --- |
14
- | [assignedTestSegments](#assignedtestsegments): [Collection](dw.util.Collection.md) `(read-only)` | Return the AB-test segments to which the current customer is assigned. |
15
-
16
- ## Constructor Summary
17
-
18
- This class does not have a constructor, so you cannot create it directly.
19
- ## Method Summary
20
-
21
- | Method | Description |
22
- | --- | --- |
23
- | static [getAssignedTestSegments](dw.campaign.ABTestMgr.md#getassignedtestsegments)() | Return the AB-test segments to which the current customer is assigned. |
24
- | static [isParticipant](dw.campaign.ABTestMgr.md#isparticipantstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Test whether the current customer is a member of the specified AB-test segment. |
25
-
26
- ### Methods inherited from class Object
27
-
28
- [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)
29
- ## Property Details
30
-
31
- ### assignedTestSegments
32
- - assignedTestSegments: [Collection](dw.util.Collection.md) `(read-only)`
33
- - : Return the AB-test segments to which the current customer is assigned.
34
- AB-test segments deleted in the meantime will not be returned.
35
-
36
-
37
-
38
- ---
39
-
40
- ## Method Details
41
-
42
- ### getAssignedTestSegments()
43
- - static getAssignedTestSegments(): [Collection](dw.util.Collection.md)
44
- - : Return the AB-test segments to which the current customer is assigned.
45
- AB-test segments deleted in the meantime will not be returned.
46
-
47
-
48
- **Returns:**
49
- - unordered collection of ABTestSegment instances representing the
50
- AB-test segments to which the current customer is assigned.
51
-
52
-
53
-
54
- ---
55
-
56
- ### isParticipant(String, String)
57
- - static isParticipant(testID: [String](TopLevel.String.md), segmentID: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
58
- - : Test whether the current customer is a member of the specified AB-test
59
- segment. This method can be used to customize the storefront experience
60
- in ways that are not supported using Business Manager configuration
61
- alone.
62
-
63
-
64
- **Parameters:**
65
- - testID - The ID of the AB-test, must not be null.
66
- - segmentID - The ID of the segment within the AB-test, must not be null.
67
-
68
- **Returns:**
69
- - true if the current customer is a member of the specified AB-test
70
- segment, false otherwise.
71
-
72
-
73
-
74
- ---
75
-
76
- <!-- prettier-ignore-end -->