@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,539 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class global
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.global](TopLevel.global.md)
6
-
7
- The global object is a pre-defined object that serves as a placeholder for the global
8
- properties and functions of JavaScript. All other predefined objects, functions, and
9
- properties are accessible through the global object.
10
-
11
-
12
-
13
- ## Constant Summary
14
-
15
- | Constant | Description |
16
- | --- | --- |
17
- | [Infinity](#infinity): [Number](TopLevel.Number.md) | representation for Infinity as an Integer |
18
- | [NaN](#nan): [Number](TopLevel.Number.md) | representation for Not a Number as an Integer |
19
- | [PIPELET_ERROR](#pipelet_error): [Number](TopLevel.Number.md) | represents an error during pipelet execution |
20
- | [PIPELET_NEXT](#pipelet_next): [Number](TopLevel.Number.md) | represents the next pipelet to fire |
21
- | [slotcontent](#slotcontent): [Object](TopLevel.Object.md) | Provides access to the SlotContent object. |
22
- | [undefined](#undefined): [Object](TopLevel.Object.md) | representation for undefined |
23
- | [webreferences2](#webreferences2): [Object](TopLevel.Object.md) | Provides access to WSDL definition files in a Cartridge's webreferences2 folder. |
24
-
25
- ## Property Summary
26
-
27
- | Property | Description |
28
- | --- | --- |
29
- | [customer](#customer): [Customer](dw.customer.Customer.md) | The current customer or null if this request is not associated with any customer. |
30
- | [exports](#exports): [Object](TopLevel.Object.md) | References the [module.exports](TopLevel.Module.md#exports) property of the current module. |
31
- | [globalThis](#globalthis): [Object](TopLevel.Object.md) | Provides access to the global scope object containing all built-in functions and classes. |
32
- | [module](#module): [Module](TopLevel.Module.md) | An object representing the current module. |
33
- | [request](#request): [Request](dw.system.Request.md) | The current request. |
34
- | [response](#response): [Response](dw.system.Response.md) | The current response. |
35
- | [session](#session): [Session](dw.system.Session.md) | The current session. |
36
-
37
- ## Constructor Summary
38
-
39
- This class does not have a constructor, so you cannot create it directly.
40
- ## Method Summary
41
-
42
- | Method | Description |
43
- | --- | --- |
44
- | static [decodeURI](TopLevel.global.md#decodeuristring)([String](TopLevel.String.md)) | Unescapes characters in a URI component. |
45
- | static [decodeURIComponent](TopLevel.global.md#decodeuricomponentstring)([String](TopLevel.String.md)) | Unescapes characters in a URI component. |
46
- | static [empty](TopLevel.global.md#emptyobject)([Object](TopLevel.Object.md)) | The method tests, whether the given object is empty. |
47
- | static [encodeURI](TopLevel.global.md#encodeuristring)([String](TopLevel.String.md)) | Escapes characters in a URI. |
48
- | static [encodeURIComponent](TopLevel.global.md#encodeuricomponentstring)([String](TopLevel.String.md)) | Escapes characters in a URI component. |
49
- | static [escape](TopLevel.global.md#escapestring)([String](TopLevel.String.md)) | Encodes a String. |
50
- | ~~static [eval](TopLevel.global.md#evalstring)([String](TopLevel.String.md))~~ | Execute JavaScript code from a String. |
51
- | static [importClass](TopLevel.global.md#importclassobject)([Object](TopLevel.Object.md)) | Import the specified class and make it available at the top level. |
52
- | static [importPackage](TopLevel.global.md#importpackageobject)([Object](TopLevel.Object.md)) | Import all the classes in the specified package available at the top level. |
53
- | static [importScript](TopLevel.global.md#importscriptstring)([String](TopLevel.String.md)) | Imports all functions from the specified script. |
54
- | static [isFinite](TopLevel.global.md#isfinitenumber)([Number](TopLevel.Number.md)) | Returns true if the specified Number is finite. |
55
- | static [isNaN](TopLevel.global.md#isnanobject)([Object](TopLevel.Object.md)) | Test the specified value to determine if it is not a Number. |
56
- | static [isXMLName](TopLevel.global.md#isxmlnamestring)([String](TopLevel.String.md)) | Determines whether the specified string is a valid name for an XML element or attribute. |
57
- | static [parseFloat](TopLevel.global.md#parsefloatstring)([String](TopLevel.String.md)) | Parses a String into an float Number. |
58
- | static [parseInt](TopLevel.global.md#parseintstring-number)([String](TopLevel.String.md), [Number](TopLevel.Number.md)) | Parses a String into an integer Number using the specified radix. |
59
- | static [parseInt](TopLevel.global.md#parseintstring---variant-1)([String](TopLevel.String.md)) | Parses a String into an integer Number. This function is a short form for the call to [parseInt(String, Number)](TopLevel.global.md#parseintstring-number) with automatic determination of the radix. |
60
- | static [parseInt](TopLevel.global.md#parseintstring---variant-2)([String](TopLevel.String.md)) | Parses a String into an integer Number. |
61
- | static [require](TopLevel.global.md#requirestring)([String](TopLevel.String.md)) | The require() function supports loading of modules in JavaScript. |
62
- | static [trace](TopLevel.global.md#tracestring-object)([String](TopLevel.String.md), [Object...](TopLevel.Object.md)) | Formats and prints the message using the specified params and returns the formatted message. |
63
- | static [unescape](TopLevel.global.md#unescapestring)([String](TopLevel.String.md)) | Decode an escaped String. |
64
-
65
- ### Methods inherited from class Object
66
-
67
- [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)
68
- ## Constant Details
69
-
70
- ### Infinity
71
-
72
- - Infinity: [Number](TopLevel.Number.md)
73
- - : representation for Infinity as an Integer
74
-
75
-
76
- ---
77
-
78
- ### NaN
79
-
80
- - NaN: [Number](TopLevel.Number.md)
81
- - : representation for Not a Number as an Integer
82
-
83
-
84
- ---
85
-
86
- ### PIPELET_ERROR
87
-
88
- - PIPELET_ERROR: [Number](TopLevel.Number.md)
89
- - : represents an error during pipelet execution
90
-
91
-
92
- ---
93
-
94
- ### PIPELET_NEXT
95
-
96
- - PIPELET_NEXT: [Number](TopLevel.Number.md)
97
- - : represents the next pipelet to fire
98
-
99
-
100
- ---
101
-
102
- ### slotcontent
103
-
104
- - slotcontent: [Object](TopLevel.Object.md)
105
- - : Provides access to the SlotContent object. Available only in ISML
106
- templates that are defined as the Slot's template. For example,
107
- <isprint value="${slotcontent.callout}"> will print out the callout message
108
- of the active Slot.
109
-
110
-
111
- **See Also:**
112
- - [SlotContent](dw.campaign.SlotContent.md)
113
-
114
-
115
- ---
116
-
117
- ### undefined
118
-
119
- - undefined: [Object](TopLevel.Object.md)
120
- - : representation for undefined
121
-
122
-
123
- ---
124
-
125
- ### webreferences2
126
-
127
- - webreferences2: [Object](TopLevel.Object.md)
128
- - : Provides access to WSDL definition files in a Cartridge's webreferences2
129
- folder. For example, webreferences2.mywebservice loads the
130
- mywebservice.wsdl file and returns an instance of dw.ws.WebReference2.
131
- The WebReference2 instance enables you to access the actual web service
132
- via the WebReference2.getDefaultService() method.
133
-
134
-
135
- **See Also:**
136
- - [WebReference2](dw.ws.WebReference2.md)
137
-
138
-
139
- ---
140
-
141
- ## Property Details
142
-
143
- ### customer
144
- - customer: [Customer](dw.customer.Customer.md)
145
- - : The current customer or null if this request is not associated with any customer.
146
-
147
-
148
- ---
149
-
150
- ### exports
151
- - exports: [Object](TopLevel.Object.md)
152
- - : References the [module.exports](TopLevel.Module.md#exports) property of the current module. Available only in scripts that were loaded
153
- as CommonJS module using the [require(String)](TopLevel.global.md#requirestring) function.
154
-
155
-
156
- **See Also:**
157
- - [Module.exports](TopLevel.Module.md#exports)
158
-
159
-
160
- ---
161
-
162
- ### globalThis
163
- - globalThis: [Object](TopLevel.Object.md)
164
- - : Provides access to the global scope object containing all built-in functions and classes.
165
-
166
-
167
- ---
168
-
169
- ### module
170
- - module: [Module](TopLevel.Module.md)
171
- - : An object representing the current module. Available only in scripts that were loaded
172
- as CommonJS module using the [require(String)](TopLevel.global.md#requirestring) function.
173
-
174
-
175
- **See Also:**
176
- - [Module](TopLevel.Module.md)
177
-
178
-
179
- ---
180
-
181
- ### request
182
- - request: [Request](dw.system.Request.md)
183
- - : The current request.
184
-
185
-
186
- ---
187
-
188
- ### response
189
- - response: [Response](dw.system.Response.md)
190
- - : The current response.
191
-
192
-
193
- ---
194
-
195
- ### session
196
- - session: [Session](dw.system.Session.md)
197
- - : The current session.
198
-
199
-
200
- ---
201
-
202
- ## Method Details
203
-
204
- ### decodeURI(String)
205
- - static decodeURI(uri: [String](TopLevel.String.md)): [String](TopLevel.String.md)
206
- - : Unescapes characters in a URI component.
207
-
208
- **Parameters:**
209
- - uri - a string that contains an encoded URI or other text to be decoded.
210
-
211
- **Returns:**
212
- - A copy of _uri_ with any hexadecimal escape sequences replaced with the
213
- characters they represent
214
-
215
-
216
-
217
- ---
218
-
219
- ### decodeURIComponent(String)
220
- - static decodeURIComponent(uriComponent: [String](TopLevel.String.md)): [String](TopLevel.String.md)
221
- - : Unescapes characters in a URI component.
222
-
223
- **Parameters:**
224
- - uriComponent - a string that contains an encoded URI component or other text to be decoded.
225
-
226
- **Returns:**
227
- - A copy of _uriComponent_ with any hexadecimal escape sequences replaced with the
228
- characters they represent
229
-
230
-
231
-
232
- ---
233
-
234
- ### empty(Object)
235
- - static empty(obj: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
236
- - : The method tests, whether the given object is empty. The interpretation
237
- of empty is the following.
238
- - null is always empty
239
- - undefined is always empty
240
- - a string with zero length is empty
241
- - an array with no elements is empty
242
- - a collection with no elements is empty
243
-
244
-
245
- **Parameters:**
246
- - obj - the object to be thested
247
-
248
- **Returns:**
249
- - true if the object is interpreted as being empty
250
-
251
-
252
- ---
253
-
254
- ### encodeURI(String)
255
- - static encodeURI(uri: [String](TopLevel.String.md)): [String](TopLevel.String.md)
256
- - : Escapes characters in a URI.
257
-
258
- **Parameters:**
259
- - uri - a String that contains the URI or other text to be encoded.
260
-
261
- **Returns:**
262
- - a copy of _uri_ with certain characters replaced by
263
- hexadecimal escape sequences.
264
-
265
-
266
-
267
- ---
268
-
269
- ### encodeURIComponent(String)
270
- - static encodeURIComponent(uriComponent: [String](TopLevel.String.md)): [String](TopLevel.String.md)
271
- - : Escapes characters in a URI component.
272
-
273
- **Parameters:**
274
- - uriComponent - a String that contains a portion of a URI or other text to be encoded.
275
-
276
- **Returns:**
277
- - a copy of _uriComponent_ with certain characters replaced by
278
- hexadecimal escape sequences.
279
-
280
-
281
-
282
- ---
283
-
284
- ### escape(String)
285
- - static escape(s: [String](TopLevel.String.md)): [String](TopLevel.String.md)
286
- - : Encodes a String.
287
-
288
- **Parameters:**
289
- - s - the String to be encoded.
290
-
291
- **Returns:**
292
- - a copy of _s_ where characters have been replace by
293
- hexadecimal escape sequences.
294
-
295
-
296
-
297
- ---
298
-
299
- ### eval(String)
300
- - ~~static eval(code: [String](TopLevel.String.md)): [Object](TopLevel.Object.md)~~
301
- - : Execute JavaScript code from a String.
302
-
303
- **Parameters:**
304
- - code - a String that contains the JavaScript expression to be evaluated or the statements to be executed.
305
-
306
- **Returns:**
307
- - the value of the executed call or null.
308
-
309
- **Deprecated:**
310
- :::warning
311
- The eval() function is deprecated, because it's potential security risk for server side code injection.
312
- :::
313
-
314
- ---
315
-
316
- ### importClass(Object)
317
- - static importClass(classPath: [Object](TopLevel.Object.md)): void
318
- - : Import the specified class and make it
319
- available at the top level. It's equivalent in effect to the
320
- Java import declaration.
321
-
322
-
323
- **Parameters:**
324
- - classPath - the fully qualified class path.
325
-
326
-
327
- ---
328
-
329
- ### importPackage(Object)
330
- - static importPackage(packagePath: [Object](TopLevel.Object.md)): void
331
- - : Import all the classes in the specified package
332
- available at the top level. It's equivalent in effect to the
333
- Java import declaration.
334
-
335
-
336
- **Parameters:**
337
- - packagePath - the fully qualified package path.
338
-
339
-
340
- ---
341
-
342
- ### importScript(String)
343
- - static importScript(scriptPath: [String](TopLevel.String.md)): void
344
- - : Imports all functions from the specified script. Variables are not imported
345
- from the script and must be accessed through helper functions.
346
-
347
- The script path has the following syntax: \[cartridgename:\]scriptname, where
348
- cartridgename identifies a cartridge where the script file is located. If
349
- cartridgename is omitted the script file is loaded from the same cartridge
350
- in which the importing component is located.
351
-
352
- Examples:
353
- importScript( 'example.ds' ) imports the script file example.ds from the same cartridge
354
- importScript( 'abc:example.ds' ) imports the script file example.ds from the cartridge 'abc'
355
-
356
-
357
- **Parameters:**
358
- - scriptPath - the path to the script.
359
-
360
-
361
- ---
362
-
363
- ### isFinite(Number)
364
- - static isFinite(number: [Number](TopLevel.Number.md)): [Boolean](TopLevel.Boolean.md)
365
- - : Returns true if the specified Number is finite.
366
-
367
- **Parameters:**
368
- - number - the Number to test.
369
-
370
- **Returns:**
371
- - true if the specified Number is finite,
372
- false otherwise.
373
-
374
-
375
-
376
- ---
377
-
378
- ### isNaN(Object)
379
- - static isNaN(object: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
380
- - : Test the specified value to determine if it
381
- is not a Number.
382
-
383
-
384
- **Parameters:**
385
- - object - the Object to be tested as a number
386
-
387
- **Returns:**
388
- - True if the object is not a number
389
-
390
-
391
- ---
392
-
393
- ### isXMLName(String)
394
- - static isXMLName(name: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
395
- - : Determines whether the specified string is a valid name for an
396
- XML element or attribute.
397
-
398
-
399
- **Parameters:**
400
- - name - the String specified
401
-
402
- **Returns:**
403
- - True if the string is a valid name
404
-
405
-
406
- ---
407
-
408
- ### parseFloat(String)
409
- - static parseFloat(s: [String](TopLevel.String.md)): [Number](TopLevel.Number.md)
410
- - : Parses a String into an float Number.
411
-
412
- **Parameters:**
413
- - s - the String to parse.
414
-
415
- **Returns:**
416
- - Returns the float as a Number.
417
-
418
-
419
- ---
420
-
421
- ### parseInt(String, Number)
422
- - static parseInt(s: [String](TopLevel.String.md), radix: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
423
- - : Parses a String into an integer Number using the
424
- specified radix.
425
-
426
-
427
- **Parameters:**
428
- - s - the String to parse.
429
- - radix - the radix to use.
430
-
431
- **Returns:**
432
- - Returns the integer as a Number.
433
-
434
-
435
- ---
436
-
437
- ### parseInt(String) - Variant 1
438
- - static parseInt(s: [String](TopLevel.String.md)): [Number](TopLevel.Number.md)
439
- - : Parses a String into an integer Number.
440
-
441
- This function is a short form for the call to [parseInt(String, Number)](TopLevel.global.md#parseintstring-number) with automatic determination of the radix.
442
- If the string starts with "0x" or "0X" then the radix is 16. If the string starts with "0" the the radix is 8. In all other cases the radix is 10.
443
-
444
-
445
- **Parameters:**
446
- - s - the String to parse.
447
-
448
- **Returns:**
449
- - Returns the integer as a Number.
450
-
451
- **API Version:**
452
- :::note
453
- No longer available as of version 16.1.
454
- :::
455
-
456
- ---
457
-
458
- ### parseInt(String) - Variant 2
459
- - static parseInt(s: [String](TopLevel.String.md)): [Number](TopLevel.Number.md)
460
- - : Parses a String into an integer Number.
461
- This function is a short form for the call to [parseInt(String, Number)](TopLevel.global.md#parseintstring-number) with automatic determination of the radix.
462
- If the string starts with "0x" or "0X" then the radix is 16. In all other cases the radix is 10.
463
-
464
-
465
- **Parameters:**
466
- - s - the String to parse.
467
-
468
- **Returns:**
469
- - Returns the integer as a Number.
470
-
471
- **API Version:**
472
- :::note
473
- Available from version 16.1.
474
- ECMAScript 5 compliance: removed support for octal numbers.
475
- :::
476
-
477
- ---
478
-
479
- ### require(String)
480
- - static require(path: [String](TopLevel.String.md)): [Module](TopLevel.Module.md)
481
- - : The require() function supports loading of modules in JavaScript. The function works similar to the require() function
482
- in CommonJS. The general module loading works the same way, but the exact path lookup is slightly different
483
- and better fits into Demandware concepts. Here are the details for the lookup:
484
-
485
- - If the module name starts with "./" or "../" then load it relative to the current module. The module can be a file or a directory. A file extension is acknowledged, but not required. If it's a directory a 'package.json' or a 'main' file is expected. If the 'package.json' does not contain a main entry, then default to main file in the directory. Access to parent files can't go beyond the cartridges directory. Access to other cartridges is explicitly allowed.
486
- - If the module name starts with "~/" it's a path relative to the current cartridge.
487
- - If the module name starts with "&#42;/" try to find the module in all cartridges that are assigned to the current site.
488
- - A module with the name "dw" or which starts with "dw/" references Demandware built-in functions and classes. For example `var u = require( 'dw/util' );`loads the classes in the util package, which can be then used like `var h = new u.HashMap();`
489
- - A module, which doesn't start with "./" or "../" is resolved as top level module.
490
- - The module name is used to find a folder in the top cartridge directory, typically a cartridge itself, but it can also be a simple folder.
491
- - If nothing is found, the module name is used to look into a special folder called "modules" in the top cartridge directory. That folder can be used by a developer to manage different modules. For example a developer could drop a module like "less.js" just into that folder.
492
-
493
- If the require function is used to reference a file then an optional file extension is used to determine the content of the file. Currently
494
- supported are the extensions ordered by priority:
495
-
496
- - js - JavaScript file
497
- - ds - Demandware Script file
498
- - json - JSON file
499
-
500
-
501
- **Parameters:**
502
- - path - the path to the JavaScript module.
503
-
504
- **Returns:**
505
- - an object with the exported functions and properties.
506
-
507
-
508
- ---
509
-
510
- ### trace(String, Object...)
511
- - static trace(msg: [String](TopLevel.String.md), params: [Object...](TopLevel.Object.md)): void
512
- - : Formats and prints the message using the specified params and returns
513
- the formatted message. The format message is a Java MessageFormat
514
- expression. Printing happens in the script log output.
515
-
516
-
517
- **Parameters:**
518
- - msg - the message to format.
519
- - params - one, or multiple parameters that are used to format the message.
520
-
521
-
522
- ---
523
-
524
- ### unescape(String)
525
- - static unescape(string: [String](TopLevel.String.md)): [String](TopLevel.String.md)
526
- - : Decode an escaped String.
527
-
528
- **Parameters:**
529
- - string - the String to decode.
530
-
531
- **Returns:**
532
- - a copy of the String where hexadecimal character sequences
533
- are replace by Unicode characters.
534
-
535
-
536
-
537
- ---
538
-
539
- <!-- prettier-ignore-end -->
@@ -1,58 +0,0 @@
1
- # Package TopLevel
2
-
3
- ## Classes
4
- | Class | Description |
5
- | --- | --- |
6
- | [APIException](TopLevel.APIException.md) | This error indicates an exceptional outcome of some business logic. |
7
- | [arguments](TopLevel.arguments.md) | The arguments of a function. |
8
- | [Array](TopLevel.Array.md) | An Array of items. |
9
- | [ArrayBuffer](TopLevel.ArrayBuffer.md) | The ArrayBuffer represents a generic array of bytes with fixed length. |
10
- | [BigInt](TopLevel.BigInt.md) | A BigInt object is a wrapper for a primitive `bigint` value. |
11
- | [Boolean](TopLevel.Boolean.md) | Provides support for boolean values. |
12
- | [ConversionError](TopLevel.ConversionError.md) | Represents a conversion error. |
13
- | [DataView](TopLevel.DataView.md) | The DataView provides low level access to [ArrayBuffer](TopLevel.ArrayBuffer.md). |
14
- | [Date](TopLevel.Date.md) | A Date object contains a number indicating a particular instant in time to within a millisecond. |
15
- | [Error](TopLevel.Error.md) | Error represents a generic exception. |
16
- | [ES6Iterator](TopLevel.ES6Iterator.md) | This isn't a built-in type. |
17
- | [EvalError](TopLevel.EvalError.md) | Represents an evaluation error. |
18
- | [Fault](TopLevel.Fault.md) | This error indicates an RPC related error in the system. |
19
- | [Float32Array](TopLevel.Float32Array.md) | An optimized array to store 32-bit floating point numbers. |
20
- | [Float64Array](TopLevel.Float64Array.md) | An optimized array to store 64-bit floating point numbers. |
21
- | [Function](TopLevel.Function.md) | The Function class represent a JavaScript function. |
22
- | [Generator](TopLevel.Generator.md) | A generator is a special type of function that works as a factory for iterators and it allows you to define an iterative algorithm by writing a single function which can maintain its own state. |
23
- | [global](TopLevel.global.md) | The global object is a pre-defined object that serves as a placeholder for the global properties and functions of JavaScript. |
24
- | [Int16Array](TopLevel.Int16Array.md) | An optimized array to store 16-bit signed integer numbers. |
25
- | [Int32Array](TopLevel.Int32Array.md) | An optimized array to store 32-bit signed integer numbers. |
26
- | [Int8Array](TopLevel.Int8Array.md) | An optimized array to store 8-bit signed integer numbers. |
27
- | [InternalError](TopLevel.InternalError.md) | Represents the an internal error. |
28
- | [IOError](TopLevel.IOError.md) | This error indicates an I/O related error in the system. |
29
- | [Iterable](TopLevel.Iterable.md) | All objects containing the property @@iterator with a function returning an [ES6Iterator](TopLevel.ES6Iterator.md) are said to be an Iterable. |
30
- | [Iterator](TopLevel.Iterator.md) | An Iterator is a special object that lets you access items from a collection one at a time, while keeping track of its current position within that sequence. |
31
- | [JSON](TopLevel.JSON.md) | The JSON object is a single object that contains two functions, parse and stringify, that are used to parse and construct JSON texts. |
32
- | [Map](TopLevel.Map.md) | Map objects are collections of key/value pairs where both the keys and values may be arbitrary ECMAScript language values. |
33
- | [Math](TopLevel.Math.md) | Mathematical functions and constants. |
34
- | [Module](TopLevel.Module.md) | CommonJS modules are JavaScript files that are loaded using the [require(String)](TopLevel.global.md#requirestring) function. |
35
- | [Namespace](TopLevel.Namespace.md) | Namespace objects represent XML namespaces and provide an association between a namespace prefix and a Unique Resource Identifier (URI). |
36
- | [Number](TopLevel.Number.md) | A Number object represents any numerical value, whether it is an integer or floating-point number. |
37
- | [Object](TopLevel.Object.md) | The _Object_ object is the foundation of all native JavaScript objects. |
38
- | [QName](TopLevel.QName.md) | QName objects are used to represent qualified names of XML elements and attributes. |
39
- | [RangeError](TopLevel.RangeError.md) | Represents a range error. |
40
- | [ReferenceError](TopLevel.ReferenceError.md) | Represents a reference error. |
41
- | [RegExp](TopLevel.RegExp.md) | The RegExp object is a static object that generates instances of a regular expression for pattern matching and monitors all regular expressions in the current window or frame. |
42
- | [Set](TopLevel.Set.md) | A Set can store any kind of element and ensures that no duplicates exist. |
43
- | [StopIteration](TopLevel.StopIteration.md) | A special type of exception that is thrown when an Iterator or Generator sequence is exhausted. |
44
- | [String](TopLevel.String.md) | The String object represents any sequence of zero or more characters that are to be treated strictly as text. |
45
- | [Symbol](TopLevel.Symbol.md) | Symbol is a primitive data type that can serve as object properties. |
46
- | [SyntaxError](TopLevel.SyntaxError.md) | Represents a syntax error. |
47
- | [SystemError](TopLevel.SystemError.md) | This error indicates an error in the system, which doesn't fall into any of the other error categories like for example IOError. |
48
- | [TypeError](TopLevel.TypeError.md) | Represents a type error. |
49
- | [Uint16Array](TopLevel.Uint16Array.md) | An optimized array to store 16-bit unsigned integer numbers. |
50
- | [Uint32Array](TopLevel.Uint32Array.md) | An optimized array to store 32-bit unsigned integer numbers. |
51
- | [Uint8Array](TopLevel.Uint8Array.md) | An optimized array to store 8-bit unsigned integer numbers. |
52
- | [Uint8ClampedArray](TopLevel.Uint8ClampedArray.md) | An optimized array to store 8-bit unsigned integer numbers. |
53
- | [URIError](TopLevel.URIError.md) | Represents a URI error. |
54
- | [WeakMap](TopLevel.WeakMap.md) | The WeakMap is map whose entries are subject to garbage collection if there are no more references to the keys. |
55
- | [WeakSet](TopLevel.WeakSet.md) | The WeakSet is set whose elements are subject to garbage collection if there are no more references to the elements. |
56
- | [XML](TopLevel.XML.md) | The XML object contains functions and properties for working with XML instances. |
57
- | [XMLList](TopLevel.XMLList.md) | An XMLList object is an ordered collection of properties. |
58
- | [XMLStreamError](TopLevel.XMLStreamError.md) | This error indicates an XML streaming related error in the system. |