@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,50 +0,0 @@
1
- # Package dw.catalog
2
-
3
- ## Classes
4
- | Class | Description |
5
- | --- | --- |
6
- | [Catalog](dw.catalog.Catalog.md) | Represents a Commerce Cloud Digital Catalog. |
7
- | [CatalogMgr](dw.catalog.CatalogMgr.md) | Provides helper methods for getting categories. |
8
- | [Category](dw.catalog.Category.md) | Represents a category in a product catalog. |
9
- | [CategoryAssignment](dw.catalog.CategoryAssignment.md) | Represents a category assignment in Commerce Cloud Digital. |
10
- | [CategoryLink](dw.catalog.CategoryLink.md) | A CategoryLink represents a directed relationship between two catalog categories. |
11
- | [PriceBook](dw.catalog.PriceBook.md) | Represents a price book. |
12
- | [PriceBookMgr](dw.catalog.PriceBookMgr.md) | Price book manager provides methods to access price books. |
13
- | [Product](dw.catalog.Product.md) | Represents a product in Commerce Cloud Digital. |
14
- | [ProductActiveData](dw.catalog.ProductActiveData.md) | Represents the active data for a [Product](dw.catalog.Product.md) in Commerce Cloud Digital. |
15
- | [ProductAttributeModel](dw.catalog.ProductAttributeModel.md) | Class representing the complete attribute model for products in the system. |
16
- | [ProductAvailabilityLevels](dw.catalog.ProductAvailabilityLevels.md) | Encapsulates the quantity of items available for each availability status. |
17
- | [ProductAvailabilityModel](dw.catalog.ProductAvailabilityModel.md) | The ProductAvailabilityModel provides methods for retrieving all information on availability of a single product. |
18
- | [ProductInventoryList](dw.catalog.ProductInventoryList.md) | The ProductInventoryList provides access to ID, description and defaultInStockFlag of the list. |
19
- | [ProductInventoryMgr](dw.catalog.ProductInventoryMgr.md) | This manager provides access to inventory-related objects. |
20
- | [ProductInventoryRecord](dw.catalog.ProductInventoryRecord.md) | The ProductInventoryRecord holds information about a Product's inventory, and availability. |
21
- | [ProductLink](dw.catalog.ProductLink.md) | The class represents a link between two products. |
22
- | [ProductMgr](dw.catalog.ProductMgr.md) | Provides helper methods for getting products based on Product ID or [Catalog](dw.catalog.Catalog.md). |
23
- | [ProductOption](dw.catalog.ProductOption.md) | Represents a product option. |
24
- | [ProductOptionModel](dw.catalog.ProductOptionModel.md) | This class represents the option model of a specific product and for a specific currency. |
25
- | [ProductOptionValue](dw.catalog.ProductOptionValue.md) | Represents the value of a product option. |
26
- | [ProductPriceInfo](dw.catalog.ProductPriceInfo.md) | Simple class representing a product price point. |
27
- | [ProductPriceModel](dw.catalog.ProductPriceModel.md) | ProductPriceModel provides methods to access all the [PriceBook](dw.catalog.PriceBook.md) information of a product. |
28
- | [ProductPriceTable](dw.catalog.ProductPriceTable.md) | A ProductPriceTable is a map of quantities to prices representing the potentially tiered prices of a product in Commerce Cloud Digital. |
29
- | [ProductSearchHit](dw.catalog.ProductSearchHit.md) | ProductSearchHit is the result of a executed search query and wraps the actual product found by the search. |
30
- | [ProductSearchModel](dw.catalog.ProductSearchModel.md) | The class is the central interface to a product search result and a product search refinement. |
31
- | [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) | This class provides an interface to refinement options for the product search. |
32
- | [ProductSearchRefinements](dw.catalog.ProductSearchRefinements.md) | This class provides an interface to refinement options for the product search. |
33
- | [ProductSearchRefinementValue](dw.catalog.ProductSearchRefinementValue.md) | Represents the value of a product search refinement. |
34
- | [ProductVariationAttribute](dw.catalog.ProductVariationAttribute.md) | Represents a product variation attribute |
35
- | [ProductVariationAttributeValue](dw.catalog.ProductVariationAttributeValue.md) | Represents a product variation attribute |
36
- | [ProductVariationModel](dw.catalog.ProductVariationModel.md) | Class representing the complete variation information for a master product in the system. |
37
- | [Recommendation](dw.catalog.Recommendation.md) | Represents a recommendation in Commerce Cloud Digital. |
38
- | [SearchModel](dw.catalog.SearchModel.md) | Common search model base class. |
39
- | [SearchRefinementDefinition](dw.catalog.SearchRefinementDefinition.md) | Common search refinement definition base class. |
40
- | [SearchRefinements](dw.catalog.SearchRefinements.md) | Common search refinements base class. |
41
- | [SearchRefinementValue](dw.catalog.SearchRefinementValue.md) | Represents the value of a product or content search refinement. |
42
- | [SortingOption](dw.catalog.SortingOption.md) | Represents an option for how to sort products in storefront search results. |
43
- | [SortingRule](dw.catalog.SortingRule.md) | Represents a product sorting rule for use with the [ProductSearchModel](dw.catalog.ProductSearchModel.md). |
44
- | [Store](dw.catalog.Store.md) | Represents a store in Commerce Cloud Digital. |
45
- | [StoreGroup](dw.catalog.StoreGroup.md) | Represents a store group. |
46
- | [StoreInventoryFilter](dw.catalog.StoreInventoryFilter.md) | <p> This class represents a store inventory filter, which can be used at [ProductSearchModel.setStoreInventoryFilter(StoreInventoryFilter)](dw.catalog.ProductSearchModel.md#setstoreinventoryfilterstoreinventoryfilter) to filter the search result by one or more store inventories. |
47
- | [StoreInventoryFilterValue](dw.catalog.StoreInventoryFilterValue.md) | <p> This class represents a store inventory filter value, which can be used for a [StoreInventoryFilter](dw.catalog.StoreInventoryFilter.md) to filter the search result by one or more store inventory list IDs via [ProductSearchModel.setStoreInventoryFilter(StoreInventoryFilter)](dw.catalog.ProductSearchModel.md#setstoreinventoryfilterstoreinventoryfilter). |
48
- | [StoreMgr](dw.catalog.StoreMgr.md) | Provides helper methods for getting stores based on id and querying for stores based on geolocation. |
49
- | [Variant](dw.catalog.Variant.md) | Represents a variant of a product variation. |
50
- | [VariationGroup](dw.catalog.VariationGroup.md) | Class representing a group of variants within a master product who share a common value for one or more variation attribute values. |
@@ -1,481 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Content
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.object.PersistentObject](dw.object.PersistentObject.md)
6
- - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
7
- - [dw.content.Content](dw.content.Content.md)
8
-
9
- Class representing a Content asset in Commerce Cloud Digital.
10
-
11
-
12
- ## Property Summary
13
-
14
- | Property | Description |
15
- | --- | --- |
16
- | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the content asset. |
17
- | [classificationFolder](#classificationfolder): [Folder](dw.content.Folder.md) `(read-only)` | Returns the Folder associated with this Content. |
18
- | [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the description in the current locale or null. |
19
- | [folders](#folders): [Collection](dw.util.Collection.md) `(read-only)` | Returns all folders to which this content is assigned. |
20
- | [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of the content asset. |
21
- | [online](#online): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status of the content. |
22
- | [onlineFlag](#onlineflag): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status flag of the content. |
23
- | [page](#page): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns if the content is a [Page](dw.experience.Page.md) or not. |
24
- | [pageDescription](#pagedescription): [String](TopLevel.String.md) `(read-only)` | Returns the page description for the content in the current locale or null if there is no page description. |
25
- | [pageKeywords](#pagekeywords): [String](TopLevel.String.md) `(read-only)` | Returns the page keywords for the content in the current locale or null if there is no page title. |
26
- | [pageMetaTags](#pagemetatags): [Array](TopLevel.Array.md) `(read-only)` | Returns all page meta tags, defined for this instance for which content can be generated. |
27
- | [pageTitle](#pagetitle): [String](TopLevel.String.md) `(read-only)` | Returns the page title for the content in the current locale or null if there is no page title. |
28
- | [pageURL](#pageurl): [String](TopLevel.String.md) `(read-only)` | Returns the page URL for the content in the current locale or null if there is no page URL. |
29
- | [searchable](#searchable): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the search status of the content. |
30
- | [searchableFlag](#searchableflag): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status flag of the content. |
31
- | [siteMapChangeFrequency](#sitemapchangefrequency): [String](TopLevel.String.md) `(read-only)` | Returns the contents change frequency needed for the sitemap creation. |
32
- | [siteMapIncluded](#sitemapincluded): [Number](TopLevel.Number.md) `(read-only)` | Returns the status if the content is included into the sitemap. |
33
- | [siteMapPriority](#sitemappriority): [Number](TopLevel.Number.md) `(read-only)` | Returns the contents priority needed for the sitemap creation. |
34
- | [template](#template): [String](TopLevel.String.md) `(read-only)` | Returns the value of attribute 'template'. |
35
-
36
- ## Constructor Summary
37
-
38
- This class does not have a constructor, so you cannot create it directly.
39
- ## Method Summary
40
-
41
- | Method | Description |
42
- | --- | --- |
43
- | [getClassificationFolder](dw.content.Content.md#getclassificationfolder)() | Returns the Folder associated with this Content. |
44
- | [getDescription](dw.content.Content.md#getdescription)() | Returns the description in the current locale or null. |
45
- | [getFolders](dw.content.Content.md#getfolders)() | Returns all folders to which this content is assigned. |
46
- | [getID](dw.content.Content.md#getid)() | Returns the ID of the content asset. |
47
- | [getName](dw.content.Content.md#getname)() | Returns the name of the content asset. |
48
- | [getOnlineFlag](dw.content.Content.md#getonlineflag)() | Returns the online status flag of the content. |
49
- | [getPageDescription](dw.content.Content.md#getpagedescription)() | Returns the page description for the content in the current locale or null if there is no page description. |
50
- | [getPageKeywords](dw.content.Content.md#getpagekeywords)() | Returns the page keywords for the content in the current locale or null if there is no page title. |
51
- | [getPageMetaTag](dw.content.Content.md#getpagemetatagstring)([String](TopLevel.String.md)) | Returns the page meta tag for the specified id. |
52
- | [getPageMetaTags](dw.content.Content.md#getpagemetatags)() | Returns all page meta tags, defined for this instance for which content can be generated. |
53
- | [getPageTitle](dw.content.Content.md#getpagetitle)() | Returns the page title for the content in the current locale or null if there is no page title. |
54
- | [getPageURL](dw.content.Content.md#getpageurl)() | Returns the page URL for the content in the current locale or null if there is no page URL. |
55
- | [getSearchableFlag](dw.content.Content.md#getsearchableflag)() | Returns the online status flag of the content. |
56
- | [getSiteMapChangeFrequency](dw.content.Content.md#getsitemapchangefrequency)() | Returns the contents change frequency needed for the sitemap creation. |
57
- | [getSiteMapIncluded](dw.content.Content.md#getsitemapincluded)() | Returns the status if the content is included into the sitemap. |
58
- | [getSiteMapPriority](dw.content.Content.md#getsitemappriority)() | Returns the contents priority needed for the sitemap creation. |
59
- | [getTemplate](dw.content.Content.md#gettemplate)() | Returns the value of attribute 'template'. |
60
- | [isOnline](dw.content.Content.md#isonline)() | Returns the online status of the content. |
61
- | [isPage](dw.content.Content.md#ispage)() | Returns if the content is a [Page](dw.experience.Page.md) or not. |
62
- | [isSearchable](dw.content.Content.md#issearchable)() | Returns the search status of the content. |
63
- | [toPage](dw.content.Content.md#topage)() | Converts the content into the [Page](dw.experience.Page.md) representation if [isPage()](dw.content.Content.md#ispage) yields true. |
64
-
65
- ### Methods inherited from class ExtensibleObject
66
-
67
- [describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
68
- ### Methods inherited from class PersistentObject
69
-
70
- [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
71
- ### Methods inherited from class Object
72
-
73
- [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)
74
- ## Property Details
75
-
76
- ### ID
77
- - ID: [String](TopLevel.String.md) `(read-only)`
78
- - : Returns the ID of the content asset.
79
-
80
-
81
- ---
82
-
83
- ### classificationFolder
84
- - classificationFolder: [Folder](dw.content.Folder.md) `(read-only)`
85
- - : Returns the Folder associated with this Content. The folder is
86
- used to determine the classification of the content.
87
-
88
-
89
-
90
- ---
91
-
92
- ### description
93
- - description: [String](TopLevel.String.md) `(read-only)`
94
- - : Returns the description in the current locale or null.
95
-
96
-
97
- ---
98
-
99
- ### folders
100
- - folders: [Collection](dw.util.Collection.md) `(read-only)`
101
- - : Returns all folders to which this content is assigned.
102
-
103
-
104
- ---
105
-
106
- ### name
107
- - name: [String](TopLevel.String.md) `(read-only)`
108
- - : Returns the name of the content asset.
109
-
110
-
111
- ---
112
-
113
- ### online
114
- - online: [Boolean](TopLevel.Boolean.md) `(read-only)`
115
- - : Returns the online status of the content.
116
-
117
-
118
- ---
119
-
120
- ### onlineFlag
121
- - onlineFlag: [Boolean](TopLevel.Boolean.md) `(read-only)`
122
- - : Returns the online status flag of the content.
123
-
124
-
125
- ---
126
-
127
- ### page
128
- - page: [Boolean](TopLevel.Boolean.md) `(read-only)`
129
- - : Returns if the content is a [Page](dw.experience.Page.md) or not.
130
-
131
-
132
- ---
133
-
134
- ### pageDescription
135
- - pageDescription: [String](TopLevel.String.md) `(read-only)`
136
- - : Returns the page description for the content in the current locale
137
- or null if there is no page description.
138
-
139
-
140
-
141
- ---
142
-
143
- ### pageKeywords
144
- - pageKeywords: [String](TopLevel.String.md) `(read-only)`
145
- - : Returns the page keywords for the content in the current locale
146
- or null if there is no page title.
147
-
148
-
149
-
150
- ---
151
-
152
- ### pageMetaTags
153
- - pageMetaTags: [Array](TopLevel.Array.md) `(read-only)`
154
- - : Returns all page meta tags, defined for this instance for which content can be generated.
155
-
156
-
157
- The meta tag content is generated based on the content detail page meta tag context and rules.
158
- The rules are obtained from the current content or inherited from the default folder,
159
- up to the root folder.
160
-
161
-
162
-
163
- ---
164
-
165
- ### pageTitle
166
- - pageTitle: [String](TopLevel.String.md) `(read-only)`
167
- - : Returns the page title for the content in the current locale
168
- or null if there is no page title.
169
-
170
-
171
-
172
- ---
173
-
174
- ### pageURL
175
- - pageURL: [String](TopLevel.String.md) `(read-only)`
176
- - : Returns the page URL for the content in the current locale
177
- or null if there is no page URL.
178
-
179
-
180
-
181
- ---
182
-
183
- ### searchable
184
- - searchable: [Boolean](TopLevel.Boolean.md) `(read-only)`
185
- - : Returns the search status of the content.
186
-
187
-
188
- ---
189
-
190
- ### searchableFlag
191
- - searchableFlag: [Boolean](TopLevel.Boolean.md) `(read-only)`
192
- - : Returns the online status flag of the content.
193
-
194
-
195
- ---
196
-
197
- ### siteMapChangeFrequency
198
- - siteMapChangeFrequency: [String](TopLevel.String.md) `(read-only)`
199
- - : Returns the contents change frequency needed for the sitemap creation.
200
-
201
-
202
- ---
203
-
204
- ### siteMapIncluded
205
- - siteMapIncluded: [Number](TopLevel.Number.md) `(read-only)`
206
- - : Returns the status if the content is included into the sitemap.
207
-
208
-
209
- ---
210
-
211
- ### siteMapPriority
212
- - siteMapPriority: [Number](TopLevel.Number.md) `(read-only)`
213
- - : Returns the contents priority needed for the sitemap creation.
214
- If no priority is defined, the method returns 0.0.
215
-
216
-
217
-
218
- ---
219
-
220
- ### template
221
- - template: [String](TopLevel.String.md) `(read-only)`
222
- - : Returns the value of attribute 'template'.
223
-
224
-
225
- ---
226
-
227
- ## Method Details
228
-
229
- ### getClassificationFolder()
230
- - getClassificationFolder(): [Folder](dw.content.Folder.md)
231
- - : Returns the Folder associated with this Content. The folder is
232
- used to determine the classification of the content.
233
-
234
-
235
- **Returns:**
236
- - the classification Folder.
237
-
238
-
239
- ---
240
-
241
- ### getDescription()
242
- - getDescription(): [String](TopLevel.String.md)
243
- - : Returns the description in the current locale or null.
244
-
245
- **Returns:**
246
- - the description in the current locale or null.
247
-
248
-
249
- ---
250
-
251
- ### getFolders()
252
- - getFolders(): [Collection](dw.util.Collection.md)
253
- - : Returns all folders to which this content is assigned.
254
-
255
- **Returns:**
256
- - Collection of Folder objects.
257
-
258
-
259
- ---
260
-
261
- ### getID()
262
- - getID(): [String](TopLevel.String.md)
263
- - : Returns the ID of the content asset.
264
-
265
- **Returns:**
266
- - the ID of the content asset.
267
-
268
-
269
- ---
270
-
271
- ### getName()
272
- - getName(): [String](TopLevel.String.md)
273
- - : Returns the name of the content asset.
274
-
275
- **Returns:**
276
- - the name of the content asset.
277
-
278
-
279
- ---
280
-
281
- ### getOnlineFlag()
282
- - getOnlineFlag(): [Boolean](TopLevel.Boolean.md)
283
- - : Returns the online status flag of the content.
284
-
285
- **Returns:**
286
- - true if the content is online, false otherwise.
287
-
288
-
289
- ---
290
-
291
- ### getPageDescription()
292
- - getPageDescription(): [String](TopLevel.String.md)
293
- - : Returns the page description for the content in the current locale
294
- or null if there is no page description.
295
-
296
-
297
- **Returns:**
298
- - the page description for the content in the current locale
299
- or null if there is no page description.
300
-
301
-
302
-
303
- ---
304
-
305
- ### getPageKeywords()
306
- - getPageKeywords(): [String](TopLevel.String.md)
307
- - : Returns the page keywords for the content in the current locale
308
- or null if there is no page title.
309
-
310
-
311
- **Returns:**
312
- - the page keywords for the content in the current locale
313
- or null if there is no page title.
314
-
315
-
316
-
317
- ---
318
-
319
- ### getPageMetaTag(String)
320
- - getPageMetaTag(id: [String](TopLevel.String.md)): [PageMetaTag](dw.web.PageMetaTag.md)
321
- - : Returns the page meta tag for the specified id.
322
-
323
-
324
- The meta tag content is generated based on the content detail page meta tag context and rule.
325
- The rule is obtained from the current content or inherited from the default folder,
326
- up to the root folder.
327
-
328
-
329
- Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the
330
- current context, or if the rule resolves to an empty string.
331
-
332
-
333
- **Parameters:**
334
- - id - the ID to get the page meta tag for
335
-
336
- **Returns:**
337
- - page meta tag containing content generated based on rules
338
-
339
-
340
- ---
341
-
342
- ### getPageMetaTags()
343
- - getPageMetaTags(): [Array](TopLevel.Array.md)
344
- - : Returns all page meta tags, defined for this instance for which content can be generated.
345
-
346
-
347
- The meta tag content is generated based on the content detail page meta tag context and rules.
348
- The rules are obtained from the current content or inherited from the default folder,
349
- up to the root folder.
350
-
351
-
352
- **Returns:**
353
- - page meta tags defined for this instance, containing content generated based on rules
354
-
355
-
356
- ---
357
-
358
- ### getPageTitle()
359
- - getPageTitle(): [String](TopLevel.String.md)
360
- - : Returns the page title for the content in the current locale
361
- or null if there is no page title.
362
-
363
-
364
- **Returns:**
365
- - the page title for the content in the current locale
366
- or null if there is no page title.
367
-
368
-
369
-
370
- ---
371
-
372
- ### getPageURL()
373
- - getPageURL(): [String](TopLevel.String.md)
374
- - : Returns the page URL for the content in the current locale
375
- or null if there is no page URL.
376
-
377
-
378
- **Returns:**
379
- - the page URL for the content in the current locale
380
- or null if there is no page URL.
381
-
382
-
383
-
384
- ---
385
-
386
- ### getSearchableFlag()
387
- - getSearchableFlag(): [Boolean](TopLevel.Boolean.md)
388
- - : Returns the online status flag of the content.
389
-
390
- **Returns:**
391
- - true if the content is searchable, false otherwise.
392
-
393
-
394
- ---
395
-
396
- ### getSiteMapChangeFrequency()
397
- - getSiteMapChangeFrequency(): [String](TopLevel.String.md)
398
- - : Returns the contents change frequency needed for the sitemap creation.
399
-
400
- **Returns:**
401
- - The contents sitemap change frequency.
402
-
403
-
404
- ---
405
-
406
- ### getSiteMapIncluded()
407
- - getSiteMapIncluded(): [Number](TopLevel.Number.md)
408
- - : Returns the status if the content is included into the sitemap.
409
-
410
- **Returns:**
411
- - the value of the attribute 'siteMapIncluded'
412
-
413
-
414
- ---
415
-
416
- ### getSiteMapPriority()
417
- - getSiteMapPriority(): [Number](TopLevel.Number.md)
418
- - : Returns the contents priority needed for the sitemap creation.
419
- If no priority is defined, the method returns 0.0.
420
-
421
-
422
- **Returns:**
423
- - The contents sitemap priority.
424
-
425
-
426
- ---
427
-
428
- ### getTemplate()
429
- - getTemplate(): [String](TopLevel.String.md)
430
- - : Returns the value of attribute 'template'.
431
-
432
- **Returns:**
433
- - the value of the attribute 'template'
434
-
435
-
436
- ---
437
-
438
- ### isOnline()
439
- - isOnline(): [Boolean](TopLevel.Boolean.md)
440
- - : Returns the online status of the content.
441
-
442
- **Returns:**
443
- - true if the content is online, false otherwise.
444
-
445
-
446
- ---
447
-
448
- ### isPage()
449
- - isPage(): [Boolean](TopLevel.Boolean.md)
450
- - : Returns if the content is a [Page](dw.experience.Page.md) or not.
451
-
452
- **Returns:**
453
- - true if the content is a [Page](dw.experience.Page.md), false otherwise.
454
-
455
-
456
- ---
457
-
458
- ### isSearchable()
459
- - isSearchable(): [Boolean](TopLevel.Boolean.md)
460
- - : Returns the search status of the content.
461
-
462
- **Returns:**
463
- - true if the content is searchable, false otherwise.
464
-
465
-
466
- ---
467
-
468
- ### toPage()
469
- - toPage(): [Page](dw.experience.Page.md)
470
- - : Converts the content into the [Page](dw.experience.Page.md) representation if [isPage()](dw.content.Content.md#ispage) yields true.
471
-
472
- **Returns:**
473
- - the [Page](dw.experience.Page.md) representation of the content if it is a page, `null` otherwise.
474
-
475
- **See Also:**
476
- - [PageMgr.getPage(String)](dw.experience.PageMgr.md#getpagestring)
477
-
478
-
479
- ---
480
-
481
- <!-- prettier-ignore-end -->
@@ -1,147 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ContentMgr
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.content.ContentMgr](dw.content.ContentMgr.md)
6
-
7
- Provides helper methods for getting content assets, library folders and the
8
- content library of the current site.
9
-
10
-
11
-
12
- ## Constant Summary
13
-
14
- | Constant | Description |
15
- | --- | --- |
16
- | [PRIVATE_LIBRARY](#private_library): [String](TopLevel.String.md) = "PrivateLibrary" | The input string to identify that the library is a private site library when invoking [getLibrary(String)](dw.content.ContentMgr.md#getlibrarystring). |
17
-
18
- ## Property Summary
19
-
20
- | Property | Description |
21
- | --- | --- |
22
- | [siteLibrary](#sitelibrary): [Library](dw.content.Library.md) `(read-only)` | Returns the content library of the current site. |
23
-
24
- ## Constructor Summary
25
-
26
- This class does not have a constructor, so you cannot create it directly.
27
- ## Method Summary
28
-
29
- | Method | Description |
30
- | --- | --- |
31
- | static [getContent](dw.content.ContentMgr.md#getcontentlibrary-string)([Library](dw.content.Library.md), [String](TopLevel.String.md)) | Returns the content with the corresponding identifier within the specified library. |
32
- | static [getContent](dw.content.ContentMgr.md#getcontentstring)([String](TopLevel.String.md)) | Returns the content with the corresponding identifier within the current site's site library. |
33
- | static [getFolder](dw.content.ContentMgr.md#getfolderlibrary-string)([Library](dw.content.Library.md), [String](TopLevel.String.md)) | Returns the folder identified by the specified id within the specified library. |
34
- | static [getFolder](dw.content.ContentMgr.md#getfolderstring)([String](TopLevel.String.md)) | Returns the folder identified by the specified id within the current site's site library. |
35
- | static [getLibrary](dw.content.ContentMgr.md#getlibrarystring)([String](TopLevel.String.md)) | Returns the content library specified by the given id. |
36
- | static [getSiteLibrary](dw.content.ContentMgr.md#getsitelibrary)() | Returns the content library of the current site. |
37
-
38
- ### Methods inherited from class Object
39
-
40
- [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)
41
- ## Constant Details
42
-
43
- ### PRIVATE_LIBRARY
44
-
45
- - PRIVATE_LIBRARY: [String](TopLevel.String.md) = "PrivateLibrary"
46
- - : The input string to identify that the library is a private site library when invoking [getLibrary(String)](dw.content.ContentMgr.md#getlibrarystring).
47
-
48
-
49
- ---
50
-
51
- ## Property Details
52
-
53
- ### siteLibrary
54
- - siteLibrary: [Library](dw.content.Library.md) `(read-only)`
55
- - : Returns the content library of the current site.
56
-
57
-
58
- ---
59
-
60
- ## Method Details
61
-
62
- ### getContent(Library, String)
63
- - static getContent(library: [Library](dw.content.Library.md), id: [String](TopLevel.String.md)): [Content](dw.content.Content.md)
64
- - : Returns the content with the corresponding identifier within the specified library.
65
-
66
- **Parameters:**
67
- - library - the content library to look for the content in
68
- - id - the ID of the content asset to find.
69
-
70
- **Returns:**
71
- - the content if found, or null if not found.
72
-
73
-
74
- ---
75
-
76
- ### getContent(String)
77
- - static getContent(id: [String](TopLevel.String.md)): [Content](dw.content.Content.md)
78
- - : Returns the content with the corresponding identifier within the current
79
- site's site library.
80
-
81
-
82
- **Parameters:**
83
- - id - the ID of the content asset to find.
84
-
85
- **Returns:**
86
- - the content if found, or null if not found.
87
-
88
-
89
- ---
90
-
91
- ### getFolder(Library, String)
92
- - static getFolder(library: [Library](dw.content.Library.md), id: [String](TopLevel.String.md)): [Folder](dw.content.Folder.md)
93
- - : Returns the folder identified by the specified id within the specified library.
94
-
95
- **Parameters:**
96
- - library - the content library to look for the folder in
97
- - id - the ID of the folder to find.
98
-
99
- **Returns:**
100
- - the folder, or null if not found.
101
-
102
-
103
- ---
104
-
105
- ### getFolder(String)
106
- - static getFolder(id: [String](TopLevel.String.md)): [Folder](dw.content.Folder.md)
107
- - : Returns the folder identified by the specified id within the current
108
- site's site library.
109
-
110
-
111
- **Parameters:**
112
- - id - the ID of the folder to find.
113
-
114
- **Returns:**
115
- - the folder, or null if not found.
116
-
117
-
118
- ---
119
-
120
- ### getLibrary(String)
121
- - static getLibrary(libraryId: [String](TopLevel.String.md)): [Library](dw.content.Library.md)
122
- - : Returns the content library specified by the given id. If [PRIVATE_LIBRARY](dw.content.ContentMgr.md#private_library) is used, then the current
123
- site's private library will be returned.
124
-
125
-
126
- **Parameters:**
127
- - libraryId - the id of the library to return.
128
-
129
- **Returns:**
130
- - the library for the passed id. Returns null if there is no content library with that id.
131
-
132
-
133
- ---
134
-
135
- ### getSiteLibrary()
136
- - static getSiteLibrary(): [Library](dw.content.Library.md)
137
- - : Returns the content library of the current site.
138
-
139
- **Returns:**
140
- - the content library of the current site, or null if there is not
141
- content library assigned to the current site.
142
-
143
-
144
-
145
- ---
146
-
147
- <!-- prettier-ignore-end -->