@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,118 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Note
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.object.Note](dw.object.Note.md)
6
-
7
- Represents a note that can be attached to any persistent object
8
- that supports this feature.
9
-
10
-
11
-
12
- ## Property Summary
13
-
14
- | Property | Description |
15
- | --- | --- |
16
- | [createdBy](#createdby): [String](TopLevel.String.md) `(read-only)` | Return the login ID of user that is stored in the session at the time the note is created. |
17
- | [creationDate](#creationdate): [Date](TopLevel.Date.md) `(read-only)` | Return the date and time that the note was created. |
18
- | [subject](#subject): [String](TopLevel.String.md) `(read-only)` | Return the subject of the note. |
19
- | [text](#text): [String](TopLevel.String.md) `(read-only)` | Return the text of the note. |
20
-
21
- ## Constructor Summary
22
-
23
- This class does not have a constructor, so you cannot create it directly.
24
- ## Method Summary
25
-
26
- | Method | Description |
27
- | --- | --- |
28
- | [getCreatedBy](dw.object.Note.md#getcreatedby)() | Return the login ID of user that is stored in the session at the time the note is created. |
29
- | [getCreationDate](dw.object.Note.md#getcreationdate)() | Return the date and time that the note was created. |
30
- | [getSubject](dw.object.Note.md#getsubject)() | Return the subject of the note. |
31
- | [getText](dw.object.Note.md#gettext)() | Return the text of the note. |
32
-
33
- ### Methods inherited from class Object
34
-
35
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
36
- ## Property Details
37
-
38
- ### createdBy
39
- - createdBy: [String](TopLevel.String.md) `(read-only)`
40
- - : Return the login ID of user that is stored in the session at the time
41
- the note is created.
42
-
43
-
44
-
45
- ---
46
-
47
- ### creationDate
48
- - creationDate: [Date](TopLevel.Date.md) `(read-only)`
49
- - : Return the date and time that the note was created. This is usually
50
- set by the system, but may be specified if the note is generated
51
- via an import.
52
-
53
-
54
-
55
- ---
56
-
57
- ### subject
58
- - subject: [String](TopLevel.String.md) `(read-only)`
59
- - : Return the subject of the note.
60
-
61
-
62
- ---
63
-
64
- ### text
65
- - text: [String](TopLevel.String.md) `(read-only)`
66
- - : Return the text of the note.
67
-
68
-
69
- ---
70
-
71
- ## Method Details
72
-
73
- ### getCreatedBy()
74
- - getCreatedBy(): [String](TopLevel.String.md)
75
- - : Return the login ID of user that is stored in the session at the time
76
- the note is created.
77
-
78
-
79
- **Returns:**
80
- - the username.
81
-
82
-
83
- ---
84
-
85
- ### getCreationDate()
86
- - getCreationDate(): [Date](TopLevel.Date.md)
87
- - : Return the date and time that the note was created. This is usually
88
- set by the system, but may be specified if the note is generated
89
- via an import.
90
-
91
-
92
- **Returns:**
93
- - the creation date.
94
-
95
-
96
- ---
97
-
98
- ### getSubject()
99
- - getSubject(): [String](TopLevel.String.md)
100
- - : Return the subject of the note.
101
-
102
- **Returns:**
103
- - the subject.
104
-
105
-
106
- ---
107
-
108
- ### getText()
109
- - getText(): [String](TopLevel.String.md)
110
- - : Return the text of the note.
111
-
112
- **Returns:**
113
- - the text.
114
-
115
-
116
- ---
117
-
118
- <!-- prettier-ignore-end -->
@@ -1,542 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ObjectAttributeDefinition
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.object.ObjectAttributeDefinition](dw.object.ObjectAttributeDefinition.md)
6
-
7
- Represents the definition of an object's attribute.
8
-
9
-
10
- ## Constant Summary
11
-
12
- | Constant | Description |
13
- | --- | --- |
14
- | [VALUE_TYPE_BOOLEAN](#value_type_boolean): [Number](TopLevel.Number.md) = 8 | Boolean value type. |
15
- | [VALUE_TYPE_DATE](#value_type_date): [Number](TopLevel.Number.md) = 6 | Date value type. |
16
- | [VALUE_TYPE_DATETIME](#value_type_datetime): [Number](TopLevel.Number.md) = 11 | Date and Time value type. |
17
- | [VALUE_TYPE_EMAIL](#value_type_email): [Number](TopLevel.Number.md) = 12 | Email value type. |
18
- | [VALUE_TYPE_ENUM_OF_INT](#value_type_enum_of_int): [Number](TopLevel.Number.md) = 31 | Enum of int value type. |
19
- | [VALUE_TYPE_ENUM_OF_STRING](#value_type_enum_of_string): [Number](TopLevel.Number.md) = 33 | Enum of String value type. |
20
- | [VALUE_TYPE_HTML](#value_type_html): [Number](TopLevel.Number.md) = 5 | HTML value type. |
21
- | [VALUE_TYPE_IMAGE](#value_type_image): [Number](TopLevel.Number.md) = 7 | Image value type. |
22
- | [VALUE_TYPE_INT](#value_type_int): [Number](TopLevel.Number.md) = 1 | int value type. |
23
- | [VALUE_TYPE_MONEY](#value_type_money): [Number](TopLevel.Number.md) = 9 | Money value type. |
24
- | [VALUE_TYPE_NUMBER](#value_type_number): [Number](TopLevel.Number.md) = 2 | Number value type. |
25
- | [VALUE_TYPE_PASSWORD](#value_type_password): [Number](TopLevel.Number.md) = 13 | Password value type. |
26
- | [VALUE_TYPE_QUANTITY](#value_type_quantity): [Number](TopLevel.Number.md) = 10 | Quantity value type. |
27
- | [VALUE_TYPE_SET_OF_INT](#value_type_set_of_int): [Number](TopLevel.Number.md) = 21 | Set of int value type. |
28
- | [VALUE_TYPE_SET_OF_NUMBER](#value_type_set_of_number): [Number](TopLevel.Number.md) = 22 | Set of Number value type. |
29
- | [VALUE_TYPE_SET_OF_STRING](#value_type_set_of_string): [Number](TopLevel.Number.md) = 23 | Set of String value type. |
30
- | [VALUE_TYPE_STRING](#value_type_string): [Number](TopLevel.Number.md) = 3 | String value type. |
31
- | [VALUE_TYPE_TEXT](#value_type_text): [Number](TopLevel.Number.md) = 4 | Text value type. |
32
-
33
- ## Property Summary
34
-
35
- | Property | Description |
36
- | --- | --- |
37
- | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the attribute definition. |
38
- | [attributeGroups](#attributegroups): [Collection](dw.util.Collection.md) `(read-only)` | Returns all attribute groups the attribute is assigned to. |
39
- | [defaultValue](#defaultvalue): [ObjectAttributeValueDefinition](dw.object.ObjectAttributeValueDefinition.md) `(read-only)` | Return the default value for the attribute or null if none is defined. |
40
- | [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the display name for the attribute, which can be used in the user interface. |
41
- | [key](#key): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the attribute represents the primary key of the object. |
42
- | [mandatory](#mandatory): [Boolean](TopLevel.Boolean.md) `(read-only)` | Checks if this attribute is mandatory. |
43
- | [multiValueType](#multivaluetype): [Boolean](TopLevel.Boolean.md) `(read-only)` | <p>Returns `true` if the attribute can have multiple values. |
44
- | [objectTypeDefinition](#objecttypedefinition): [ObjectTypeDefinition](dw.object.ObjectTypeDefinition.md) `(read-only)` | Returns the object type definition in which this attribute is defined. |
45
- | ~~[setValueType](#setvaluetype): [Boolean](TopLevel.Boolean.md)~~ `(read-only)` | Returns `true` if the attribute is of type 'Set of'. |
46
- | [system](#system): [Boolean](TopLevel.Boolean.md) `(read-only)` | Indicates if the attribute is a pre-defined system attribute or a custom attribute. |
47
- | [unit](#unit): [String](TopLevel.String.md) `(read-only)` | Returns the attribute's unit representation such as inches for length or pounds for weight. |
48
- | [valueTypeCode](#valuetypecode): [Number](TopLevel.Number.md) `(read-only)` | Returns a code for the data type stored in the attribute. |
49
- | [values](#values): [Collection](dw.util.Collection.md) `(read-only)` | Returns the list of attribute values. |
50
-
51
- ## Constructor Summary
52
-
53
- This class does not have a constructor, so you cannot create it directly.
54
- ## Method Summary
55
-
56
- | Method | Description |
57
- | --- | --- |
58
- | [getAttributeGroups](dw.object.ObjectAttributeDefinition.md#getattributegroups)() | Returns all attribute groups the attribute is assigned to. |
59
- | [getDefaultValue](dw.object.ObjectAttributeDefinition.md#getdefaultvalue)() | Return the default value for the attribute or null if none is defined. |
60
- | [getDisplayName](dw.object.ObjectAttributeDefinition.md#getdisplayname)() | Returns the display name for the attribute, which can be used in the user interface. |
61
- | [getID](dw.object.ObjectAttributeDefinition.md#getid)() | Returns the ID of the attribute definition. |
62
- | [getObjectTypeDefinition](dw.object.ObjectAttributeDefinition.md#getobjecttypedefinition)() | Returns the object type definition in which this attribute is defined. |
63
- | [getUnit](dw.object.ObjectAttributeDefinition.md#getunit)() | Returns the attribute's unit representation such as inches for length or pounds for weight. |
64
- | [getValueTypeCode](dw.object.ObjectAttributeDefinition.md#getvaluetypecode)() | Returns a code for the data type stored in the attribute. |
65
- | [getValues](dw.object.ObjectAttributeDefinition.md#getvalues)() | Returns the list of attribute values. |
66
- | [isKey](dw.object.ObjectAttributeDefinition.md#iskey)() | Identifies if the attribute represents the primary key of the object. |
67
- | [isMandatory](dw.object.ObjectAttributeDefinition.md#ismandatory)() | Checks if this attribute is mandatory. |
68
- | [isMultiValueType](dw.object.ObjectAttributeDefinition.md#ismultivaluetype)() | <p>Returns `true` if the attribute can have multiple values. |
69
- | ~~[isSetValueType](dw.object.ObjectAttributeDefinition.md#issetvaluetype)()~~ | Returns `true` if the attribute is of type 'Set of'. |
70
- | [isSystem](dw.object.ObjectAttributeDefinition.md#issystem)() | Indicates if the attribute is a pre-defined system attribute or a custom attribute. |
71
- | [requiresEncoding](dw.object.ObjectAttributeDefinition.md#requiresencoding)() | Returns a boolean flag indicating whether or not values of this attribute definition should be encoded using the encoding="off" flag in ISML templates. |
72
-
73
- ### Methods inherited from class Object
74
-
75
- [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)
76
- ## Constant Details
77
-
78
- ### VALUE_TYPE_BOOLEAN
79
-
80
- - VALUE_TYPE_BOOLEAN: [Number](TopLevel.Number.md) = 8
81
- - : Boolean value type.
82
-
83
-
84
- ---
85
-
86
- ### VALUE_TYPE_DATE
87
-
88
- - VALUE_TYPE_DATE: [Number](TopLevel.Number.md) = 6
89
- - : Date value type.
90
-
91
-
92
- ---
93
-
94
- ### VALUE_TYPE_DATETIME
95
-
96
- - VALUE_TYPE_DATETIME: [Number](TopLevel.Number.md) = 11
97
- - : Date and Time value type.
98
-
99
-
100
- ---
101
-
102
- ### VALUE_TYPE_EMAIL
103
-
104
- - VALUE_TYPE_EMAIL: [Number](TopLevel.Number.md) = 12
105
- - : Email value type.
106
-
107
-
108
- ---
109
-
110
- ### VALUE_TYPE_ENUM_OF_INT
111
-
112
- - VALUE_TYPE_ENUM_OF_INT: [Number](TopLevel.Number.md) = 31
113
- - : Enum of int value type.
114
-
115
-
116
- ---
117
-
118
- ### VALUE_TYPE_ENUM_OF_STRING
119
-
120
- - VALUE_TYPE_ENUM_OF_STRING: [Number](TopLevel.Number.md) = 33
121
- - : Enum of String value type.
122
-
123
-
124
- ---
125
-
126
- ### VALUE_TYPE_HTML
127
-
128
- - VALUE_TYPE_HTML: [Number](TopLevel.Number.md) = 5
129
- - : HTML value type.
130
-
131
-
132
- ---
133
-
134
- ### VALUE_TYPE_IMAGE
135
-
136
- - VALUE_TYPE_IMAGE: [Number](TopLevel.Number.md) = 7
137
- - : Image value type.
138
-
139
-
140
- ---
141
-
142
- ### VALUE_TYPE_INT
143
-
144
- - VALUE_TYPE_INT: [Number](TopLevel.Number.md) = 1
145
- - : int value type.
146
-
147
-
148
- ---
149
-
150
- ### VALUE_TYPE_MONEY
151
-
152
- - VALUE_TYPE_MONEY: [Number](TopLevel.Number.md) = 9
153
- - : Money value type.
154
-
155
-
156
- ---
157
-
158
- ### VALUE_TYPE_NUMBER
159
-
160
- - VALUE_TYPE_NUMBER: [Number](TopLevel.Number.md) = 2
161
- - : Number value type.
162
-
163
-
164
- ---
165
-
166
- ### VALUE_TYPE_PASSWORD
167
-
168
- - VALUE_TYPE_PASSWORD: [Number](TopLevel.Number.md) = 13
169
- - : Password value type.
170
-
171
-
172
- ---
173
-
174
- ### VALUE_TYPE_QUANTITY
175
-
176
- - VALUE_TYPE_QUANTITY: [Number](TopLevel.Number.md) = 10
177
- - : Quantity value type.
178
-
179
-
180
- ---
181
-
182
- ### VALUE_TYPE_SET_OF_INT
183
-
184
- - VALUE_TYPE_SET_OF_INT: [Number](TopLevel.Number.md) = 21
185
- - : Set of int value type.
186
-
187
-
188
- ---
189
-
190
- ### VALUE_TYPE_SET_OF_NUMBER
191
-
192
- - VALUE_TYPE_SET_OF_NUMBER: [Number](TopLevel.Number.md) = 22
193
- - : Set of Number value type.
194
-
195
-
196
- ---
197
-
198
- ### VALUE_TYPE_SET_OF_STRING
199
-
200
- - VALUE_TYPE_SET_OF_STRING: [Number](TopLevel.Number.md) = 23
201
- - : Set of String value type.
202
-
203
-
204
- ---
205
-
206
- ### VALUE_TYPE_STRING
207
-
208
- - VALUE_TYPE_STRING: [Number](TopLevel.Number.md) = 3
209
- - : String value type.
210
-
211
-
212
- ---
213
-
214
- ### VALUE_TYPE_TEXT
215
-
216
- - VALUE_TYPE_TEXT: [Number](TopLevel.Number.md) = 4
217
- - : Text value type.
218
-
219
-
220
- ---
221
-
222
- ## Property Details
223
-
224
- ### ID
225
- - ID: [String](TopLevel.String.md) `(read-only)`
226
- - : Returns the ID of the attribute definition.
227
-
228
-
229
- ---
230
-
231
- ### attributeGroups
232
- - attributeGroups: [Collection](dw.util.Collection.md) `(read-only)`
233
- - : Returns all attribute groups the attribute is assigned to.
234
-
235
-
236
- ---
237
-
238
- ### defaultValue
239
- - defaultValue: [ObjectAttributeValueDefinition](dw.object.ObjectAttributeValueDefinition.md) `(read-only)`
240
- - : Return the default value for the attribute or null if none is defined.
241
-
242
-
243
- ---
244
-
245
- ### displayName
246
- - displayName: [String](TopLevel.String.md) `(read-only)`
247
- - : Returns the display name for the attribute, which can be used in the
248
- user interface.
249
-
250
-
251
-
252
- ---
253
-
254
- ### key
255
- - key: [Boolean](TopLevel.Boolean.md) `(read-only)`
256
- - : Identifies if the attribute represents the primary key of the object.
257
-
258
-
259
- ---
260
-
261
- ### mandatory
262
- - mandatory: [Boolean](TopLevel.Boolean.md) `(read-only)`
263
- - : Checks if this attribute is mandatory.
264
-
265
-
266
- ---
267
-
268
- ### multiValueType
269
- - multiValueType: [Boolean](TopLevel.Boolean.md) `(read-only)`
270
- - :
271
- Returns `true` if the attribute can have multiple values.
272
-
273
-
274
- Attributes of the following types are multi-value capable:
275
-
276
-
277
- - [VALUE_TYPE_SET_OF_INT](dw.object.ObjectAttributeDefinition.md#value_type_set_of_int)
278
- - [VALUE_TYPE_SET_OF_NUMBER](dw.object.ObjectAttributeDefinition.md#value_type_set_of_number)
279
- - [VALUE_TYPE_SET_OF_STRING](dw.object.ObjectAttributeDefinition.md#value_type_set_of_string)
280
-
281
-
282
- Additionally, attributes of the following types can be multi-value
283
- enabled:
284
-
285
-
286
- - [VALUE_TYPE_ENUM_OF_INT](dw.object.ObjectAttributeDefinition.md#value_type_enum_of_int)
287
- - [VALUE_TYPE_ENUM_OF_STRING](dw.object.ObjectAttributeDefinition.md#value_type_enum_of_string)
288
-
289
-
290
-
291
- ---
292
-
293
- ### objectTypeDefinition
294
- - objectTypeDefinition: [ObjectTypeDefinition](dw.object.ObjectTypeDefinition.md) `(read-only)`
295
- - : Returns the object type definition in which this attribute is defined.
296
-
297
-
298
- ---
299
-
300
- ### setValueType
301
- - ~~setValueType: [Boolean](TopLevel.Boolean.md)~~ `(read-only)`
302
- - : Returns `true` if the attribute is of type 'Set of'.
303
-
304
- **Deprecated:**
305
- :::warning
306
- Use [isMultiValueType()](dw.object.ObjectAttributeDefinition.md#ismultivaluetype) instead.
307
- :::
308
-
309
- ---
310
-
311
- ### system
312
- - system: [Boolean](TopLevel.Boolean.md) `(read-only)`
313
- - : Indicates if the attribute is a pre-defined system attribute
314
- or a custom attribute.
315
-
316
-
317
-
318
- ---
319
-
320
- ### unit
321
- - unit: [String](TopLevel.String.md) `(read-only)`
322
- - : Returns the attribute's unit representation such as
323
- inches for length or pounds for weight. The value returned by
324
- this method is based on the attribute itself.
325
-
326
-
327
-
328
- ---
329
-
330
- ### valueTypeCode
331
- - valueTypeCode: [Number](TopLevel.Number.md) `(read-only)`
332
- - : Returns a code for the data type stored in the attribute. See constants
333
- defined in this class.
334
-
335
-
336
-
337
- ---
338
-
339
- ### values
340
- - values: [Collection](dw.util.Collection.md) `(read-only)`
341
- - : Returns the list of attribute values. In the user interface only the
342
- values specified in this list should be offered as valid input values.
343
-
344
- The collection contains instances of ObjectAttributeValueDefinition.
345
-
346
-
347
-
348
- ---
349
-
350
- ## Method Details
351
-
352
- ### getAttributeGroups()
353
- - getAttributeGroups(): [Collection](dw.util.Collection.md)
354
- - : Returns all attribute groups the attribute is assigned to.
355
-
356
- **Returns:**
357
- - all attribute groups the attribute is assigned to.
358
-
359
-
360
- ---
361
-
362
- ### getDefaultValue()
363
- - getDefaultValue(): [ObjectAttributeValueDefinition](dw.object.ObjectAttributeValueDefinition.md)
364
- - : Return the default value for the attribute or null if none is defined.
365
-
366
- **Returns:**
367
- - the default value for the attribute or null if none is defined.
368
-
369
-
370
- ---
371
-
372
- ### getDisplayName()
373
- - getDisplayName(): [String](TopLevel.String.md)
374
- - : Returns the display name for the attribute, which can be used in the
375
- user interface.
376
-
377
-
378
- **Returns:**
379
- - the display name for the attribute, which can be used in the
380
- user interface.
381
-
382
-
383
-
384
- ---
385
-
386
- ### getID()
387
- - getID(): [String](TopLevel.String.md)
388
- - : Returns the ID of the attribute definition.
389
-
390
- **Returns:**
391
- - the ID of the attribute definition.
392
-
393
-
394
- ---
395
-
396
- ### getObjectTypeDefinition()
397
- - getObjectTypeDefinition(): [ObjectTypeDefinition](dw.object.ObjectTypeDefinition.md)
398
- - : Returns the object type definition in which this attribute is defined.
399
-
400
- **Returns:**
401
- - the object type definition in which this attribute is defined.
402
-
403
-
404
- ---
405
-
406
- ### getUnit()
407
- - getUnit(): [String](TopLevel.String.md)
408
- - : Returns the attribute's unit representation such as
409
- inches for length or pounds for weight. The value returned by
410
- this method is based on the attribute itself.
411
-
412
-
413
- **Returns:**
414
- - the attribute's unit representation such as
415
- inches for length or pounds for weight.
416
-
417
-
418
-
419
- ---
420
-
421
- ### getValueTypeCode()
422
- - getValueTypeCode(): [Number](TopLevel.Number.md)
423
- - : Returns a code for the data type stored in the attribute. See constants
424
- defined in this class.
425
-
426
-
427
- **Returns:**
428
- - a code for the data type stored in the attribute. See constants
429
- defined in this class.
430
-
431
-
432
-
433
- ---
434
-
435
- ### getValues()
436
- - getValues(): [Collection](dw.util.Collection.md)
437
- - : Returns the list of attribute values. In the user interface only the
438
- values specified in this list should be offered as valid input values.
439
-
440
- The collection contains instances of ObjectAttributeValueDefinition.
441
-
442
-
443
- **Returns:**
444
- - a collection of ObjectAttributeValueDefinition instances representing
445
- the list of attribute values, or null if no values are specified.
446
-
447
-
448
-
449
- ---
450
-
451
- ### isKey()
452
- - isKey(): [Boolean](TopLevel.Boolean.md)
453
- - : Identifies if the attribute represents the primary key of the object.
454
-
455
- **Returns:**
456
- - true if the attribute represents the primary key, false otherwise.
457
-
458
-
459
- ---
460
-
461
- ### isMandatory()
462
- - isMandatory(): [Boolean](TopLevel.Boolean.md)
463
- - : Checks if this attribute is mandatory.
464
-
465
- **Returns:**
466
- - true, if this attribute is mandatory
467
-
468
-
469
- ---
470
-
471
- ### isMultiValueType()
472
- - isMultiValueType(): [Boolean](TopLevel.Boolean.md)
473
- - :
474
- Returns `true` if the attribute can have multiple values.
475
-
476
-
477
- Attributes of the following types are multi-value capable:
478
-
479
-
480
- - [VALUE_TYPE_SET_OF_INT](dw.object.ObjectAttributeDefinition.md#value_type_set_of_int)
481
- - [VALUE_TYPE_SET_OF_NUMBER](dw.object.ObjectAttributeDefinition.md#value_type_set_of_number)
482
- - [VALUE_TYPE_SET_OF_STRING](dw.object.ObjectAttributeDefinition.md#value_type_set_of_string)
483
-
484
-
485
- Additionally, attributes of the following types can be multi-value
486
- enabled:
487
-
488
-
489
- - [VALUE_TYPE_ENUM_OF_INT](dw.object.ObjectAttributeDefinition.md#value_type_enum_of_int)
490
- - [VALUE_TYPE_ENUM_OF_STRING](dw.object.ObjectAttributeDefinition.md#value_type_enum_of_string)
491
-
492
-
493
- **Returns:**
494
- - `true` if attributes can have multiple values,
495
- otherwise `false`
496
-
497
-
498
-
499
- ---
500
-
501
- ### isSetValueType()
502
- - ~~isSetValueType(): [Boolean](TopLevel.Boolean.md)~~
503
- - : Returns `true` if the attribute is of type 'Set of'.
504
-
505
- **Deprecated:**
506
- :::warning
507
- Use [isMultiValueType()](dw.object.ObjectAttributeDefinition.md#ismultivaluetype) instead.
508
- :::
509
-
510
- ---
511
-
512
- ### isSystem()
513
- - isSystem(): [Boolean](TopLevel.Boolean.md)
514
- - : Indicates if the attribute is a pre-defined system attribute
515
- or a custom attribute.
516
-
517
-
518
- **Returns:**
519
- - true if the the attribute is a pre-defined system attribute,
520
- false if it is a custom attribute.
521
-
522
-
523
-
524
- ---
525
-
526
- ### requiresEncoding()
527
- - requiresEncoding(): [Boolean](TopLevel.Boolean.md)
528
- - : Returns a boolean flag indicating whether or not values of this attribute
529
- definition should be encoded using the encoding="off" flag in ISML
530
- templates.
531
-
532
-
533
- **Returns:**
534
- - a boolean flag indicating whether or not values of this attribute
535
- definition should be encoded using the encoding="off" flag in ISML
536
- templates.
537
-
538
-
539
-
540
- ---
541
-
542
- <!-- prettier-ignore-end -->