@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

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 (1106) hide show
  1. package/README.md +158 -29
  2. package/data/script-api/TopLevel.APIException.md +119 -0
  3. package/data/script-api/TopLevel.Array.md +732 -0
  4. package/data/script-api/TopLevel.ArrayBuffer.md +97 -0
  5. package/data/script-api/TopLevel.BigInt.md +154 -0
  6. package/data/script-api/TopLevel.Boolean.md +83 -0
  7. package/data/script-api/TopLevel.ConversionError.md +51 -0
  8. package/data/script-api/TopLevel.DataView.md +271 -0
  9. package/data/script-api/TopLevel.Date.md +688 -0
  10. package/data/script-api/TopLevel.ES6Iterator.md +47 -0
  11. package/data/script-api/TopLevel.Error.md +124 -0
  12. package/data/script-api/TopLevel.EvalError.md +47 -0
  13. package/data/script-api/TopLevel.Fault.md +133 -0
  14. package/data/script-api/TopLevel.Float32Array.md +186 -0
  15. package/data/script-api/TopLevel.Float64Array.md +186 -0
  16. package/data/script-api/TopLevel.Function.md +114 -0
  17. package/data/script-api/TopLevel.Generator.md +132 -0
  18. package/data/script-api/TopLevel.IOError.md +98 -0
  19. package/data/script-api/TopLevel.Int16Array.md +186 -0
  20. package/data/script-api/TopLevel.Int32Array.md +186 -0
  21. package/data/script-api/TopLevel.Int8Array.md +186 -0
  22. package/data/script-api/TopLevel.InternalError.md +47 -0
  23. package/data/script-api/TopLevel.Iterable.md +44 -0
  24. package/data/script-api/TopLevel.Iterator.md +89 -0
  25. package/data/script-api/TopLevel.JSON.md +173 -0
  26. package/data/script-api/TopLevel.Map.md +189 -0
  27. package/data/script-api/TopLevel.Math.md +948 -0
  28. package/data/script-api/TopLevel.Module.md +152 -0
  29. package/data/script-api/TopLevel.Namespace.md +152 -0
  30. package/data/script-api/TopLevel.Number.md +404 -0
  31. package/data/script-api/TopLevel.Object.md +472 -0
  32. package/data/script-api/TopLevel.QName.md +147 -0
  33. package/data/script-api/TopLevel.RangeError.md +47 -0
  34. package/data/script-api/TopLevel.ReferenceError.md +47 -0
  35. package/data/script-api/TopLevel.RegExp.md +155 -0
  36. package/data/script-api/TopLevel.Set.md +150 -0
  37. package/data/script-api/TopLevel.StopIteration.md +36 -0
  38. package/data/script-api/TopLevel.String.md +1060 -0
  39. package/data/script-api/TopLevel.Symbol.md +196 -0
  40. package/data/script-api/TopLevel.SyntaxError.md +47 -0
  41. package/data/script-api/TopLevel.SystemError.md +99 -0
  42. package/data/script-api/TopLevel.TypeError.md +47 -0
  43. package/data/script-api/TopLevel.URIError.md +47 -0
  44. package/data/script-api/TopLevel.Uint16Array.md +186 -0
  45. package/data/script-api/TopLevel.Uint32Array.md +186 -0
  46. package/data/script-api/TopLevel.Uint8Array.md +186 -0
  47. package/data/script-api/TopLevel.Uint8ClampedArray.md +186 -0
  48. package/data/script-api/TopLevel.WeakMap.md +135 -0
  49. package/data/script-api/TopLevel.WeakSet.md +96 -0
  50. package/data/script-api/TopLevel.XML.md +922 -0
  51. package/data/script-api/TopLevel.XMLList.md +418 -0
  52. package/data/script-api/TopLevel.XMLStreamError.md +115 -0
  53. package/data/script-api/TopLevel.arguments.md +56 -0
  54. package/data/script-api/TopLevel.global.md +539 -0
  55. package/data/script-api/TopLevel.md +58 -0
  56. package/data/script-api/dw.alert.Alert.md +175 -0
  57. package/data/script-api/dw.alert.Alerts.md +256 -0
  58. package/data/script-api/dw.alert.md +7 -0
  59. package/data/script-api/dw.campaign.ABTest.md +63 -0
  60. package/data/script-api/dw.campaign.ABTestMgr.md +76 -0
  61. package/data/script-api/dw.campaign.ABTestSegment.md +107 -0
  62. package/data/script-api/dw.campaign.AmountDiscount.md +70 -0
  63. package/data/script-api/dw.campaign.ApproachingDiscount.md +157 -0
  64. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +190 -0
  65. package/data/script-api/dw.campaign.BonusDiscount.md +59 -0
  66. package/data/script-api/dw.campaign.Campaign.md +346 -0
  67. package/data/script-api/dw.campaign.CampaignMgr.md +436 -0
  68. package/data/script-api/dw.campaign.CampaignStatusCodes.md +103 -0
  69. package/data/script-api/dw.campaign.Coupon.md +324 -0
  70. package/data/script-api/dw.campaign.CouponMgr.md +137 -0
  71. package/data/script-api/dw.campaign.CouponRedemption.md +87 -0
  72. package/data/script-api/dw.campaign.CouponStatusCodes.md +130 -0
  73. package/data/script-api/dw.campaign.Discount.md +271 -0
  74. package/data/script-api/dw.campaign.DiscountPlan.md +322 -0
  75. package/data/script-api/dw.campaign.FixedPriceDiscount.md +74 -0
  76. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +74 -0
  77. package/data/script-api/dw.campaign.FreeDiscount.md +24 -0
  78. package/data/script-api/dw.campaign.FreeShippingDiscount.md +24 -0
  79. package/data/script-api/dw.campaign.PercentageDiscount.md +74 -0
  80. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +59 -0
  81. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +56 -0
  82. package/data/script-api/dw.campaign.Promotion.md +939 -0
  83. package/data/script-api/dw.campaign.PromotionMgr.md +478 -0
  84. package/data/script-api/dw.campaign.PromotionPlan.md +378 -0
  85. package/data/script-api/dw.campaign.SlotContent.md +131 -0
  86. package/data/script-api/dw.campaign.SourceCodeGroup.md +83 -0
  87. package/data/script-api/dw.campaign.SourceCodeInfo.md +167 -0
  88. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +61 -0
  89. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +56 -0
  90. package/data/script-api/dw.campaign.md +36 -0
  91. package/data/script-api/dw.catalog.Catalog.md +158 -0
  92. package/data/script-api/dw.catalog.CatalogMgr.md +155 -0
  93. package/data/script-api/dw.catalog.Category.md +1212 -0
  94. package/data/script-api/dw.catalog.CategoryAssignment.md +179 -0
  95. package/data/script-api/dw.catalog.CategoryLink.md +142 -0
  96. package/data/script-api/dw.catalog.PriceBook.md +215 -0
  97. package/data/script-api/dw.catalog.PriceBookMgr.md +176 -0
  98. package/data/script-api/dw.catalog.Product.md +2492 -0
  99. package/data/script-api/dw.catalog.ProductActiveData.md +1244 -0
  100. package/data/script-api/dw.catalog.ProductAttributeModel.md +409 -0
  101. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +125 -0
  102. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +516 -0
  103. package/data/script-api/dw.catalog.ProductInventoryList.md +136 -0
  104. package/data/script-api/dw.catalog.ProductInventoryMgr.md +132 -0
  105. package/data/script-api/dw.catalog.ProductInventoryRecord.md +638 -0
  106. package/data/script-api/dw.catalog.ProductLink.md +166 -0
  107. package/data/script-api/dw.catalog.ProductMgr.md +136 -0
  108. package/data/script-api/dw.catalog.ProductOption.md +189 -0
  109. package/data/script-api/dw.catalog.ProductOptionModel.md +209 -0
  110. package/data/script-api/dw.catalog.ProductOptionValue.md +132 -0
  111. package/data/script-api/dw.catalog.ProductPriceInfo.md +170 -0
  112. package/data/script-api/dw.catalog.ProductPriceModel.md +988 -0
  113. package/data/script-api/dw.catalog.ProductPriceTable.md +121 -0
  114. package/data/script-api/dw.catalog.ProductSearchHit.md +702 -0
  115. package/data/script-api/dw.catalog.ProductSearchModel.md +1894 -0
  116. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +99 -0
  117. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +80 -0
  118. package/data/script-api/dw.catalog.ProductSearchRefinements.md +265 -0
  119. package/data/script-api/dw.catalog.ProductVariationAttribute.md +107 -0
  120. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +215 -0
  121. package/data/script-api/dw.catalog.ProductVariationModel.md +1010 -0
  122. package/data/script-api/dw.catalog.Recommendation.md +327 -0
  123. package/data/script-api/dw.catalog.SearchModel.md +769 -0
  124. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +145 -0
  125. package/data/script-api/dw.catalog.SearchRefinementValue.md +194 -0
  126. package/data/script-api/dw.catalog.SearchRefinements.md +238 -0
  127. package/data/script-api/dw.catalog.SortingOption.md +120 -0
  128. package/data/script-api/dw.catalog.SortingRule.md +53 -0
  129. package/data/script-api/dw.catalog.Store.md +484 -0
  130. package/data/script-api/dw.catalog.StoreGroup.md +95 -0
  131. package/data/script-api/dw.catalog.StoreInventoryFilter.md +112 -0
  132. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +111 -0
  133. package/data/script-api/dw.catalog.StoreMgr.md +223 -0
  134. package/data/script-api/dw.catalog.Variant.md +1000 -0
  135. package/data/script-api/dw.catalog.VariationGroup.md +869 -0
  136. package/data/script-api/dw.catalog.md +50 -0
  137. package/data/script-api/dw.content.Content.md +481 -0
  138. package/data/script-api/dw.content.ContentMgr.md +147 -0
  139. package/data/script-api/dw.content.ContentSearchModel.md +618 -0
  140. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +61 -0
  141. package/data/script-api/dw.content.ContentSearchRefinementValue.md +22 -0
  142. package/data/script-api/dw.content.ContentSearchRefinements.md +218 -0
  143. package/data/script-api/dw.content.Folder.md +432 -0
  144. package/data/script-api/dw.content.Library.md +124 -0
  145. package/data/script-api/dw.content.MarkupText.md +150 -0
  146. package/data/script-api/dw.content.MediaFile.md +367 -0
  147. package/data/script-api/dw.content.md +15 -0
  148. package/data/script-api/dw.crypto.CertificateRef.md +59 -0
  149. package/data/script-api/dw.crypto.CertificateUtils.md +162 -0
  150. package/data/script-api/dw.crypto.Cipher.md +1230 -0
  151. package/data/script-api/dw.crypto.Encoding.md +193 -0
  152. package/data/script-api/dw.crypto.JWE.md +245 -0
  153. package/data/script-api/dw.crypto.JWEHeader.md +147 -0
  154. package/data/script-api/dw.crypto.JWS.md +260 -0
  155. package/data/script-api/dw.crypto.JWSHeader.md +128 -0
  156. package/data/script-api/dw.crypto.KeyRef.md +77 -0
  157. package/data/script-api/dw.crypto.Mac.md +191 -0
  158. package/data/script-api/dw.crypto.MessageDigest.md +243 -0
  159. package/data/script-api/dw.crypto.SecureRandom.md +161 -0
  160. package/data/script-api/dw.crypto.Signature.md +241 -0
  161. package/data/script-api/dw.crypto.WeakCipher.md +725 -0
  162. package/data/script-api/dw.crypto.WeakMac.md +163 -0
  163. package/data/script-api/dw.crypto.WeakMessageDigest.md +220 -0
  164. package/data/script-api/dw.crypto.WeakSignature.md +208 -0
  165. package/data/script-api/dw.crypto.X509Certificate.md +180 -0
  166. package/data/script-api/dw.crypto.md +23 -0
  167. package/data/script-api/dw.customer.AddressBook.md +158 -0
  168. package/data/script-api/dw.customer.AgentUserMgr.md +94 -0
  169. package/data/script-api/dw.customer.AgentUserStatusCodes.md +164 -0
  170. package/data/script-api/dw.customer.AuthenticationStatus.md +157 -0
  171. package/data/script-api/dw.customer.Credentials.md +524 -0
  172. package/data/script-api/dw.customer.Customer.md +488 -0
  173. package/data/script-api/dw.customer.CustomerActiveData.md +563 -0
  174. package/data/script-api/dw.customer.CustomerAddress.md +666 -0
  175. package/data/script-api/dw.customer.CustomerCDPData.md +70 -0
  176. package/data/script-api/dw.customer.CustomerContextMgr.md +62 -0
  177. package/data/script-api/dw.customer.CustomerGroup.md +146 -0
  178. package/data/script-api/dw.customer.CustomerList.md +76 -0
  179. package/data/script-api/dw.customer.CustomerMgr.md +1046 -0
  180. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +125 -0
  181. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +161 -0
  182. package/data/script-api/dw.customer.CustomerStatusCodes.md +55 -0
  183. package/data/script-api/dw.customer.EncryptedObject.md +34 -0
  184. package/data/script-api/dw.customer.ExternalProfile.md +154 -0
  185. package/data/script-api/dw.customer.OrderHistory.md +167 -0
  186. package/data/script-api/dw.customer.ProductList.md +870 -0
  187. package/data/script-api/dw.customer.ProductListItem.md +469 -0
  188. package/data/script-api/dw.customer.ProductListItemPurchase.md +139 -0
  189. package/data/script-api/dw.customer.ProductListMgr.md +350 -0
  190. package/data/script-api/dw.customer.ProductListRegistrant.md +165 -0
  191. package/data/script-api/dw.customer.Profile.md +895 -0
  192. package/data/script-api/dw.customer.Wallet.md +136 -0
  193. package/data/script-api/dw.customer.md +31 -0
  194. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +171 -0
  195. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +75 -0
  196. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +165 -0
  197. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +84 -0
  198. package/data/script-api/dw.customer.oauth.md +9 -0
  199. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +369 -0
  200. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +111 -0
  201. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +77 -0
  202. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +209 -0
  203. package/data/script-api/dw.customer.shoppercontext.md +9 -0
  204. package/data/script-api/dw.experience.AspectAttributeValidationException.md +25 -0
  205. package/data/script-api/dw.experience.Component.md +166 -0
  206. package/data/script-api/dw.experience.ComponentRenderSettings.md +130 -0
  207. package/data/script-api/dw.experience.ComponentScriptContext.md +148 -0
  208. package/data/script-api/dw.experience.CustomEditor.md +146 -0
  209. package/data/script-api/dw.experience.CustomEditorResources.md +100 -0
  210. package/data/script-api/dw.experience.Page.md +467 -0
  211. package/data/script-api/dw.experience.PageMgr.md +549 -0
  212. package/data/script-api/dw.experience.PageScriptContext.md +200 -0
  213. package/data/script-api/dw.experience.Region.md +119 -0
  214. package/data/script-api/dw.experience.RegionRenderSettings.md +207 -0
  215. package/data/script-api/dw.experience.cms.CMSRecord.md +125 -0
  216. package/data/script-api/dw.experience.cms.md +6 -0
  217. package/data/script-api/dw.experience.image.FocalPoint.md +71 -0
  218. package/data/script-api/dw.experience.image.Image.md +101 -0
  219. package/data/script-api/dw.experience.image.ImageMetaData.md +71 -0
  220. package/data/script-api/dw.experience.image.md +8 -0
  221. package/data/script-api/dw.experience.md +16 -0
  222. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +254 -0
  223. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +572 -0
  224. package/data/script-api/dw.extensions.applepay.md +7 -0
  225. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +102 -0
  226. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +1343 -0
  227. package/data/script-api/dw.extensions.facebook.md +7 -0
  228. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +136 -0
  229. package/data/script-api/dw.extensions.paymentapi.md +6 -0
  230. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +149 -0
  231. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +356 -0
  232. package/data/script-api/dw.extensions.paymentrequest.md +7 -0
  233. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +134 -0
  234. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +283 -0
  235. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +88 -0
  236. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +107 -0
  237. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +63 -0
  238. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +63 -0
  239. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +63 -0
  240. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +263 -0
  241. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +171 -0
  242. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +110 -0
  243. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +88 -0
  244. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +83 -0
  245. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +273 -0
  246. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +368 -0
  247. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +1077 -0
  248. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +166 -0
  249. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +151 -0
  250. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +98 -0
  251. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +941 -0
  252. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +126 -0
  253. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +393 -0
  254. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +63 -0
  255. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +88 -0
  256. package/data/script-api/dw.extensions.payments.md +28 -0
  257. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +85 -0
  258. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +118 -0
  259. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +263 -0
  260. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +89 -0
  261. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +677 -0
  262. package/data/script-api/dw.extensions.pinterest.md +10 -0
  263. package/data/script-api/dw.io.CSVStreamReader.md +128 -0
  264. package/data/script-api/dw.io.CSVStreamWriter.md +92 -0
  265. package/data/script-api/dw.io.File.md +729 -0
  266. package/data/script-api/dw.io.FileReader.md +70 -0
  267. package/data/script-api/dw.io.FileWriter.md +159 -0
  268. package/data/script-api/dw.io.InputStream.md +35 -0
  269. package/data/script-api/dw.io.OutputStream.md +38 -0
  270. package/data/script-api/dw.io.PrintWriter.md +66 -0
  271. package/data/script-api/dw.io.RandomAccessFileReader.md +183 -0
  272. package/data/script-api/dw.io.Reader.md +284 -0
  273. package/data/script-api/dw.io.StringWriter.md +89 -0
  274. package/data/script-api/dw.io.Writer.md +96 -0
  275. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +121 -0
  276. package/data/script-api/dw.io.XMLStreamConstants.md +172 -0
  277. package/data/script-api/dw.io.XMLStreamReader.md +1181 -0
  278. package/data/script-api/dw.io.XMLStreamWriter.md +478 -0
  279. package/data/script-api/dw.io.md +21 -0
  280. package/data/script-api/dw.job.JobExecution.md +111 -0
  281. package/data/script-api/dw.job.JobStepExecution.md +136 -0
  282. package/data/script-api/dw.job.md +7 -0
  283. package/data/script-api/dw.net.FTPClient.md +621 -0
  284. package/data/script-api/dw.net.FTPFileInfo.md +132 -0
  285. package/data/script-api/dw.net.HTTPClient.md +775 -0
  286. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +363 -0
  287. package/data/script-api/dw.net.HTTPRequestPart.md +296 -0
  288. package/data/script-api/dw.net.Mail.md +487 -0
  289. package/data/script-api/dw.net.SFTPClient.md +535 -0
  290. package/data/script-api/dw.net.SFTPFileInfo.md +128 -0
  291. package/data/script-api/dw.net.WebDAVClient.md +762 -0
  292. package/data/script-api/dw.net.WebDAVFileInfo.md +163 -0
  293. package/data/script-api/dw.net.md +15 -0
  294. package/data/script-api/dw.object.ActiveData.md +86 -0
  295. package/data/script-api/dw.object.CustomAttributes.md +122 -0
  296. package/data/script-api/dw.object.CustomObject.md +82 -0
  297. package/data/script-api/dw.object.CustomObjectMgr.md +478 -0
  298. package/data/script-api/dw.object.Extensible.md +71 -0
  299. package/data/script-api/dw.object.ExtensibleObject.md +85 -0
  300. package/data/script-api/dw.object.Note.md +118 -0
  301. package/data/script-api/dw.object.ObjectAttributeDefinition.md +542 -0
  302. package/data/script-api/dw.object.ObjectAttributeGroup.md +160 -0
  303. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +78 -0
  304. package/data/script-api/dw.object.ObjectTypeDefinition.md +239 -0
  305. package/data/script-api/dw.object.PersistentObject.md +92 -0
  306. package/data/script-api/dw.object.SimpleExtensible.md +53 -0
  307. package/data/script-api/dw.object.SystemObjectMgr.md +520 -0
  308. package/data/script-api/dw.object.md +19 -0
  309. package/data/script-api/dw.order.AbstractItem.md +220 -0
  310. package/data/script-api/dw.order.AbstractItemCtnr.md +219 -0
  311. package/data/script-api/dw.order.Appeasement.md +398 -0
  312. package/data/script-api/dw.order.AppeasementItem.md +104 -0
  313. package/data/script-api/dw.order.Basket.md +867 -0
  314. package/data/script-api/dw.order.BasketMgr.md +673 -0
  315. package/data/script-api/dw.order.BonusDiscountLineItem.md +309 -0
  316. package/data/script-api/dw.order.CouponLineItem.md +289 -0
  317. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +35 -0
  318. package/data/script-api/dw.order.CreateBasketFromOrderException.md +54 -0
  319. package/data/script-api/dw.order.CreateCouponLineItemException.md +67 -0
  320. package/data/script-api/dw.order.CreateOrderException.md +23 -0
  321. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +35 -0
  322. package/data/script-api/dw.order.GiftCertificate.md +530 -0
  323. package/data/script-api/dw.order.GiftCertificateLineItem.md +292 -0
  324. package/data/script-api/dw.order.GiftCertificateMgr.md +228 -0
  325. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +108 -0
  326. package/data/script-api/dw.order.Invoice.md +571 -0
  327. package/data/script-api/dw.order.InvoiceItem.md +199 -0
  328. package/data/script-api/dw.order.LineItem.md +489 -0
  329. package/data/script-api/dw.order.LineItemCtnr.md +2399 -0
  330. package/data/script-api/dw.order.Order.md +2770 -0
  331. package/data/script-api/dw.order.OrderAddress.md +624 -0
  332. package/data/script-api/dw.order.OrderItem.md +613 -0
  333. package/data/script-api/dw.order.OrderMgr.md +1494 -0
  334. package/data/script-api/dw.order.OrderPaymentInstrument.md +231 -0
  335. package/data/script-api/dw.order.OrderProcessStatusCodes.md +146 -0
  336. package/data/script-api/dw.order.PaymentCard.md +220 -0
  337. package/data/script-api/dw.order.PaymentInstrument.md +1416 -0
  338. package/data/script-api/dw.order.PaymentMethod.md +257 -0
  339. package/data/script-api/dw.order.PaymentMgr.md +138 -0
  340. package/data/script-api/dw.order.PaymentProcessor.md +106 -0
  341. package/data/script-api/dw.order.PaymentStatusCodes.md +70 -0
  342. package/data/script-api/dw.order.PaymentTransaction.md +291 -0
  343. package/data/script-api/dw.order.PriceAdjustment.md +745 -0
  344. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +61 -0
  345. package/data/script-api/dw.order.ProductLineItem.md +1749 -0
  346. package/data/script-api/dw.order.ProductShippingCost.md +101 -0
  347. package/data/script-api/dw.order.ProductShippingLineItem.md +336 -0
  348. package/data/script-api/dw.order.ProductShippingModel.md +143 -0
  349. package/data/script-api/dw.order.Return.md +396 -0
  350. package/data/script-api/dw.order.ReturnCase.md +463 -0
  351. package/data/script-api/dw.order.ReturnCaseItem.md +372 -0
  352. package/data/script-api/dw.order.ReturnItem.md +335 -0
  353. package/data/script-api/dw.order.Shipment.md +1124 -0
  354. package/data/script-api/dw.order.ShipmentShippingCost.md +54 -0
  355. package/data/script-api/dw.order.ShipmentShippingModel.md +203 -0
  356. package/data/script-api/dw.order.ShippingLineItem.md +315 -0
  357. package/data/script-api/dw.order.ShippingLocation.md +313 -0
  358. package/data/script-api/dw.order.ShippingMethod.md +251 -0
  359. package/data/script-api/dw.order.ShippingMgr.md +173 -0
  360. package/data/script-api/dw.order.ShippingOrder.md +630 -0
  361. package/data/script-api/dw.order.ShippingOrderItem.md +425 -0
  362. package/data/script-api/dw.order.SumItem.md +158 -0
  363. package/data/script-api/dw.order.TaxGroup.md +128 -0
  364. package/data/script-api/dw.order.TaxItem.md +74 -0
  365. package/data/script-api/dw.order.TaxMgr.md +260 -0
  366. package/data/script-api/dw.order.TrackingInfo.md +261 -0
  367. package/data/script-api/dw.order.TrackingRef.md +108 -0
  368. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +87 -0
  369. package/data/script-api/dw.order.hooks.CalculateHooks.md +139 -0
  370. package/data/script-api/dw.order.hooks.CheckoutHooks.md +88 -0
  371. package/data/script-api/dw.order.hooks.OrderHooks.md +96 -0
  372. package/data/script-api/dw.order.hooks.PaymentHooks.md +325 -0
  373. package/data/script-api/dw.order.hooks.ReturnHooks.md +395 -0
  374. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +426 -0
  375. package/data/script-api/dw.order.hooks.md +12 -0
  376. package/data/script-api/dw.order.md +64 -0
  377. package/data/script-api/dw.rpc.SOAPUtil.md +736 -0
  378. package/data/script-api/dw.rpc.Stub.md +373 -0
  379. package/data/script-api/dw.rpc.WebReference.md +133 -0
  380. package/data/script-api/dw.rpc.md +8 -0
  381. package/data/script-api/dw.sitemap.SitemapFile.md +137 -0
  382. package/data/script-api/dw.sitemap.SitemapMgr.md +142 -0
  383. package/data/script-api/dw.sitemap.md +7 -0
  384. package/data/script-api/dw.suggest.BrandSuggestions.md +34 -0
  385. package/data/script-api/dw.suggest.CategorySuggestions.md +76 -0
  386. package/data/script-api/dw.suggest.ContentSuggestions.md +76 -0
  387. package/data/script-api/dw.suggest.CustomSuggestions.md +34 -0
  388. package/data/script-api/dw.suggest.ProductSuggestions.md +76 -0
  389. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +126 -0
  390. package/data/script-api/dw.suggest.SuggestModel.md +471 -0
  391. package/data/script-api/dw.suggest.SuggestedCategory.md +51 -0
  392. package/data/script-api/dw.suggest.SuggestedContent.md +51 -0
  393. package/data/script-api/dw.suggest.SuggestedPhrase.md +70 -0
  394. package/data/script-api/dw.suggest.SuggestedProduct.md +55 -0
  395. package/data/script-api/dw.suggest.SuggestedTerm.md +143 -0
  396. package/data/script-api/dw.suggest.SuggestedTerms.md +144 -0
  397. package/data/script-api/dw.suggest.Suggestions.md +206 -0
  398. package/data/script-api/dw.suggest.md +19 -0
  399. package/data/script-api/dw.svc.FTPService.md +140 -0
  400. package/data/script-api/dw.svc.FTPServiceDefinition.md +97 -0
  401. package/data/script-api/dw.svc.HTTPFormService.md +32 -0
  402. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +36 -0
  403. package/data/script-api/dw.svc.HTTPService.md +370 -0
  404. package/data/script-api/dw.svc.HTTPServiceDefinition.md +290 -0
  405. package/data/script-api/dw.svc.LocalServiceRegistry.md +63 -0
  406. package/data/script-api/dw.svc.Result.md +320 -0
  407. package/data/script-api/dw.svc.SOAPService.md +104 -0
  408. package/data/script-api/dw.svc.SOAPServiceDefinition.md +32 -0
  409. package/data/script-api/dw.svc.Service.md +276 -0
  410. package/data/script-api/dw.svc.ServiceCallback.md +282 -0
  411. package/data/script-api/dw.svc.ServiceConfig.md +114 -0
  412. package/data/script-api/dw.svc.ServiceCredential.md +162 -0
  413. package/data/script-api/dw.svc.ServiceDefinition.md +211 -0
  414. package/data/script-api/dw.svc.ServiceProfile.md +152 -0
  415. package/data/script-api/dw.svc.ServiceRegistry.md +118 -0
  416. package/data/script-api/dw.svc.md +22 -0
  417. package/data/script-api/dw.system.AgentUserStatusCodes.md +41 -0
  418. package/data/script-api/dw.system.Cache.md +126 -0
  419. package/data/script-api/dw.system.CacheMgr.md +70 -0
  420. package/data/script-api/dw.system.HookMgr.md +78 -0
  421. package/data/script-api/dw.system.InternalObject.md +47 -0
  422. package/data/script-api/dw.system.JobProcessMonitor.md +103 -0
  423. package/data/script-api/dw.system.Log.md +198 -0
  424. package/data/script-api/dw.system.LogNDC.md +75 -0
  425. package/data/script-api/dw.system.Logger.md +216 -0
  426. package/data/script-api/dw.system.OrganizationPreferences.md +53 -0
  427. package/data/script-api/dw.system.Pipeline.md +94 -0
  428. package/data/script-api/dw.system.PipelineDictionary.md +42 -0
  429. package/data/script-api/dw.system.RESTErrorResponse.md +102 -0
  430. package/data/script-api/dw.system.RESTResponseMgr.md +243 -0
  431. package/data/script-api/dw.system.RESTSuccessResponse.md +62 -0
  432. package/data/script-api/dw.system.RemoteInclude.md +146 -0
  433. package/data/script-api/dw.system.Request.md +781 -0
  434. package/data/script-api/dw.system.RequestHooks.md +112 -0
  435. package/data/script-api/dw.system.Response.md +612 -0
  436. package/data/script-api/dw.system.SearchStatus.md +187 -0
  437. package/data/script-api/dw.system.Session.md +469 -0
  438. package/data/script-api/dw.system.Site.md +570 -0
  439. package/data/script-api/dw.system.SitePreferences.md +90 -0
  440. package/data/script-api/dw.system.Status.md +330 -0
  441. package/data/script-api/dw.system.StatusItem.md +273 -0
  442. package/data/script-api/dw.system.System.md +224 -0
  443. package/data/script-api/dw.system.Transaction.md +107 -0
  444. package/data/script-api/dw.system.md +32 -0
  445. package/data/script-api/dw.template.ISML.md +127 -0
  446. package/data/script-api/dw.template.Velocity.md +168 -0
  447. package/data/script-api/dw.template.md +7 -0
  448. package/data/script-api/dw.util.ArrayList.md +99 -0
  449. package/data/script-api/dw.util.Assert.md +341 -0
  450. package/data/script-api/dw.util.BigInteger.md +283 -0
  451. package/data/script-api/dw.util.Bytes.md +278 -0
  452. package/data/script-api/dw.util.Calendar.md +1051 -0
  453. package/data/script-api/dw.util.Collection.md +272 -0
  454. package/data/script-api/dw.util.Currency.md +147 -0
  455. package/data/script-api/dw.util.DateUtils.md +82 -0
  456. package/data/script-api/dw.util.Decimal.md +386 -0
  457. package/data/script-api/dw.util.FilteringCollection.md +140 -0
  458. package/data/script-api/dw.util.Geolocation.md +293 -0
  459. package/data/script-api/dw.util.HashMap.md +50 -0
  460. package/data/script-api/dw.util.HashSet.md +65 -0
  461. package/data/script-api/dw.util.Iterator.md +86 -0
  462. package/data/script-api/dw.util.LinkedHashMap.md +52 -0
  463. package/data/script-api/dw.util.LinkedHashSet.md +68 -0
  464. package/data/script-api/dw.util.List.md +429 -0
  465. package/data/script-api/dw.util.Locale.md +274 -0
  466. package/data/script-api/dw.util.Map.md +251 -0
  467. package/data/script-api/dw.util.MapEntry.md +68 -0
  468. package/data/script-api/dw.util.MappingKey.md +96 -0
  469. package/data/script-api/dw.util.MappingMgr.md +113 -0
  470. package/data/script-api/dw.util.PropertyComparator.md +122 -0
  471. package/data/script-api/dw.util.SecureEncoder.md +582 -0
  472. package/data/script-api/dw.util.SecureFilter.md +572 -0
  473. package/data/script-api/dw.util.SeekableIterator.md +187 -0
  474. package/data/script-api/dw.util.Set.md +39 -0
  475. package/data/script-api/dw.util.SortedMap.md +148 -0
  476. package/data/script-api/dw.util.SortedSet.md +173 -0
  477. package/data/script-api/dw.util.StringUtils.md +655 -0
  478. package/data/script-api/dw.util.Template.md +141 -0
  479. package/data/script-api/dw.util.UUIDUtils.md +34 -0
  480. package/data/script-api/dw.util.md +37 -0
  481. package/data/script-api/dw.value.EnumValue.md +105 -0
  482. package/data/script-api/dw.value.MimeEncodedText.md +131 -0
  483. package/data/script-api/dw.value.Money.md +526 -0
  484. package/data/script-api/dw.value.Quantity.md +299 -0
  485. package/data/script-api/dw.value.md +9 -0
  486. package/data/script-api/dw.web.CSRFProtection.md +105 -0
  487. package/data/script-api/dw.web.ClickStream.md +177 -0
  488. package/data/script-api/dw.web.ClickStreamEntry.md +255 -0
  489. package/data/script-api/dw.web.Cookie.md +360 -0
  490. package/data/script-api/dw.web.Cookies.md +59 -0
  491. package/data/script-api/dw.web.Form.md +84 -0
  492. package/data/script-api/dw.web.FormAction.md +195 -0
  493. package/data/script-api/dw.web.FormElement.md +211 -0
  494. package/data/script-api/dw.web.FormElementValidationResult.md +170 -0
  495. package/data/script-api/dw.web.FormField.md +642 -0
  496. package/data/script-api/dw.web.FormFieldOption.md +211 -0
  497. package/data/script-api/dw.web.FormFieldOptions.md +49 -0
  498. package/data/script-api/dw.web.FormGroup.md +222 -0
  499. package/data/script-api/dw.web.FormList.md +134 -0
  500. package/data/script-api/dw.web.FormListItem.md +57 -0
  501. package/data/script-api/dw.web.Forms.md +25 -0
  502. package/data/script-api/dw.web.HttpParameter.md +462 -0
  503. package/data/script-api/dw.web.HttpParameterMap.md +194 -0
  504. package/data/script-api/dw.web.LoopIterator.md +231 -0
  505. package/data/script-api/dw.web.PageMetaData.md +197 -0
  506. package/data/script-api/dw.web.PageMetaTag.md +149 -0
  507. package/data/script-api/dw.web.PagingModel.md +407 -0
  508. package/data/script-api/dw.web.Resource.md +147 -0
  509. package/data/script-api/dw.web.URL.md +174 -0
  510. package/data/script-api/dw.web.URLAction.md +95 -0
  511. package/data/script-api/dw.web.URLParameter.md +52 -0
  512. package/data/script-api/dw.web.URLRedirect.md +72 -0
  513. package/data/script-api/dw.web.URLRedirectMgr.md +86 -0
  514. package/data/script-api/dw.web.URLUtils.md +1357 -0
  515. package/data/script-api/dw.web.md +34 -0
  516. package/data/script-api/dw.ws.Port.md +126 -0
  517. package/data/script-api/dw.ws.WSUtil.md +728 -0
  518. package/data/script-api/dw.ws.WebReference2.md +137 -0
  519. package/data/script-api/dw.ws.md +8 -0
  520. package/data/script-api/index.json +3085 -0
  521. package/data/script-api/index.md +39 -0
  522. package/data/xsd/abtest.xsd +347 -0
  523. package/data/xsd/abtestparticipants.xsd +58 -0
  524. package/data/xsd/assignment.xsd +158 -0
  525. package/data/xsd/bmext.xsd +262 -0
  526. package/data/xsd/cachesettings.xsd +75 -0
  527. package/data/xsd/catalog.xsd +1363 -0
  528. package/data/xsd/coupon.xsd +206 -0
  529. package/data/xsd/couponredemption.xsd +58 -0
  530. package/data/xsd/csrfwhitelists.xsd +81 -0
  531. package/data/xsd/customer.xsd +411 -0
  532. package/data/xsd/customeractivedata.xsd +75 -0
  533. package/data/xsd/customercdnsettings.xsd +36 -0
  534. package/data/xsd/customergroup.xsd +276 -0
  535. package/data/xsd/customerlist.xsd +72 -0
  536. package/data/xsd/customerlist2.xsd +52 -0
  537. package/data/xsd/customerpaymentinstrument.xsd +189 -0
  538. package/data/xsd/customobject.xsd +68 -0
  539. package/data/xsd/dcext.xsd +391 -0
  540. package/data/xsd/feed.xsd +76 -0
  541. package/data/xsd/form.xsd +262 -0
  542. package/data/xsd/geolocation.xsd +68 -0
  543. package/data/xsd/giftcertificate.xsd +186 -0
  544. package/data/xsd/index.json +222 -0
  545. package/data/xsd/inventory.xsd +174 -0
  546. package/data/xsd/jobs.xsd +408 -0
  547. package/data/xsd/library.xsd +547 -0
  548. package/data/xsd/locales.xsd +172 -0
  549. package/data/xsd/metadata.xsd +315 -0
  550. package/data/xsd/oauth.xsd +60 -0
  551. package/data/xsd/order.xsd +1253 -0
  552. package/data/xsd/pagemetatag.xsd +110 -0
  553. package/data/xsd/paymentmethod.xsd +216 -0
  554. package/data/xsd/paymentprocessor.xsd +86 -0
  555. package/data/xsd/preferences.xsd +74 -0
  556. package/data/xsd/priceadjustmentlimits.xsd +74 -0
  557. package/data/xsd/pricebook.xsd +166 -0
  558. package/data/xsd/productlist.xsd +246 -0
  559. package/data/xsd/promotion.xsd +1019 -0
  560. package/data/xsd/redirecturl.xsd +120 -0
  561. package/data/xsd/returnimportfeed.xsd +82 -0
  562. package/data/xsd/schedules.xsd +246 -0
  563. package/data/xsd/search.xsd +333 -0
  564. package/data/xsd/search2.xsd +439 -0
  565. package/data/xsd/services.xsd +139 -0
  566. package/data/xsd/shipping.xsd +487 -0
  567. package/data/xsd/shippingorderupdatefeed.xsd +125 -0
  568. package/data/xsd/site.xsd +89 -0
  569. package/data/xsd/sitemapconfiguration.xsd +230 -0
  570. package/data/xsd/slot.xsd +292 -0
  571. package/data/xsd/sort.xsd +298 -0
  572. package/data/xsd/sourcecode.xsd +188 -0
  573. package/data/xsd/store.xsd +194 -0
  574. package/data/xsd/tax.xsd +112 -0
  575. package/data/xsd/urlrules.xsd +273 -0
  576. package/data/xsd/xml.xsd +54 -0
  577. package/dist/cjs/auth/api-key.d.ts +28 -0
  578. package/dist/cjs/auth/api-key.js +44 -0
  579. package/dist/cjs/auth/api-key.js.map +1 -0
  580. package/dist/cjs/auth/basic.d.ts +7 -0
  581. package/dist/cjs/auth/basic.js +18 -0
  582. package/dist/cjs/auth/basic.js.map +1 -0
  583. package/dist/cjs/auth/index.d.ts +65 -0
  584. package/dist/cjs/auth/index.js +69 -0
  585. package/dist/cjs/auth/index.js.map +1 -0
  586. package/dist/cjs/auth/oauth-implicit.d.ts +74 -0
  587. package/dist/cjs/auth/oauth-implicit.js +330 -0
  588. package/dist/cjs/auth/oauth-implicit.js.map +1 -0
  589. package/dist/cjs/auth/oauth.d.ts +48 -0
  590. package/dist/cjs/auth/oauth.js +178 -0
  591. package/dist/cjs/auth/oauth.js.map +1 -0
  592. package/dist/cjs/auth/resolve.d.ts +100 -0
  593. package/dist/cjs/auth/resolve.js +173 -0
  594. package/dist/cjs/auth/resolve.js.map +1 -0
  595. package/dist/cjs/auth/types.d.ts +101 -0
  596. package/dist/cjs/auth/types.js +3 -0
  597. package/dist/cjs/auth/types.js.map +1 -0
  598. package/dist/cjs/cli/base-command.d.ts +98 -0
  599. package/dist/cjs/cli/base-command.js +331 -0
  600. package/dist/cjs/cli/base-command.js.map +1 -0
  601. package/dist/cjs/cli/cartridge-command.d.ts +65 -0
  602. package/dist/cjs/cli/cartridge-command.js +142 -0
  603. package/dist/cjs/cli/cartridge-command.js.map +1 -0
  604. package/dist/cjs/cli/cartridge-providers.d.ts +149 -0
  605. package/dist/cjs/cli/cartridge-providers.js +103 -0
  606. package/dist/cjs/cli/cartridge-providers.js.map +1 -0
  607. package/dist/cjs/cli/config.d.ts +75 -0
  608. package/dist/cjs/cli/config.js +65 -0
  609. package/dist/cjs/cli/config.js.map +1 -0
  610. package/dist/cjs/cli/hooks.d.ts +231 -0
  611. package/dist/cjs/cli/hooks.js +3 -0
  612. package/dist/cjs/cli/hooks.js.map +1 -0
  613. package/dist/cjs/cli/index.d.ts +103 -0
  614. package/dist/cjs/cli/index.js +106 -0
  615. package/dist/cjs/cli/index.js.map +1 -0
  616. package/dist/cjs/cli/instance-command.d.ts +121 -0
  617. package/dist/cjs/cli/instance-command.js +213 -0
  618. package/dist/cjs/cli/instance-command.js.map +1 -0
  619. package/dist/cjs/cli/job-command.d.ts +32 -0
  620. package/dist/cjs/cli/job-command.js +60 -0
  621. package/dist/cjs/cli/job-command.js.map +1 -0
  622. package/dist/cjs/cli/lifecycle.d.ts +189 -0
  623. package/dist/cjs/cli/lifecycle.js +130 -0
  624. package/dist/cjs/cli/lifecycle.js.map +1 -0
  625. package/dist/cjs/cli/mrt-command.d.ts +61 -0
  626. package/dist/cjs/cli/mrt-command.js +113 -0
  627. package/dist/cjs/cli/mrt-command.js.map +1 -0
  628. package/dist/cjs/cli/oauth-command.d.ts +70 -0
  629. package/dist/cjs/cli/oauth-command.js +173 -0
  630. package/dist/cjs/cli/oauth-command.js.map +1 -0
  631. package/dist/cjs/cli/ods-command.d.ts +70 -0
  632. package/dist/cjs/cli/ods-command.js +79 -0
  633. package/dist/cjs/cli/ods-command.js.map +1 -0
  634. package/dist/cjs/cli/table.d.ts +113 -0
  635. package/dist/cjs/cli/table.js +175 -0
  636. package/dist/cjs/cli/table.js.map +1 -0
  637. package/dist/cjs/cli/webdav-command.d.ts +100 -0
  638. package/dist/cjs/cli/webdav-command.js +106 -0
  639. package/dist/cjs/cli/webdav-command.js.map +1 -0
  640. package/dist/cjs/clients/custom-apis.d.ts +137 -0
  641. package/dist/cjs/clients/custom-apis.generated.d.ts +202 -0
  642. package/dist/cjs/clients/custom-apis.generated.js +6 -0
  643. package/dist/cjs/clients/custom-apis.generated.js.map +1 -0
  644. package/dist/cjs/clients/custom-apis.js +124 -0
  645. package/dist/cjs/clients/custom-apis.js.map +1 -0
  646. package/dist/cjs/clients/index.d.ts +127 -0
  647. package/dist/cjs/clients/index.js +125 -0
  648. package/dist/cjs/clients/index.js.map +1 -0
  649. package/dist/cjs/clients/middleware-registry.d.ts +184 -0
  650. package/dist/cjs/clients/middleware-registry.js +104 -0
  651. package/dist/cjs/clients/middleware-registry.js.map +1 -0
  652. package/dist/cjs/clients/middleware.d.ts +85 -0
  653. package/dist/cjs/clients/middleware.js +210 -0
  654. package/dist/cjs/clients/middleware.js.map +1 -0
  655. package/dist/cjs/clients/mrt.d.ts +120 -0
  656. package/dist/cjs/clients/mrt.generated.d.ts +2774 -0
  657. package/dist/cjs/clients/mrt.generated.js +6 -0
  658. package/dist/cjs/clients/mrt.generated.js.map +1 -0
  659. package/dist/cjs/clients/mrt.js +88 -0
  660. package/dist/cjs/clients/mrt.js.map +1 -0
  661. package/dist/cjs/clients/ocapi.d.ts +108 -0
  662. package/dist/cjs/clients/ocapi.generated.d.ts +26052 -0
  663. package/dist/cjs/clients/ocapi.generated.js +6 -0
  664. package/dist/cjs/clients/ocapi.generated.js.map +1 -0
  665. package/dist/cjs/clients/ocapi.js +80 -0
  666. package/dist/cjs/clients/ocapi.js.map +1 -0
  667. package/dist/cjs/clients/ods.d.ts +133 -0
  668. package/dist/cjs/clients/ods.generated.d.ts +2548 -0
  669. package/dist/cjs/clients/ods.generated.js +6 -0
  670. package/dist/cjs/clients/ods.generated.js.map +1 -0
  671. package/dist/cjs/clients/ods.js +103 -0
  672. package/dist/cjs/clients/ods.js.map +1 -0
  673. package/dist/cjs/clients/slas-admin.d.ts +104 -0
  674. package/dist/cjs/clients/slas-admin.generated.d.ts +1434 -0
  675. package/dist/cjs/clients/slas-admin.generated.js +6 -0
  676. package/dist/cjs/clients/slas-admin.generated.js.map +1 -0
  677. package/dist/cjs/clients/slas-admin.js +79 -0
  678. package/dist/cjs/clients/slas-admin.js.map +1 -0
  679. package/dist/cjs/clients/webdav.d.ts +157 -0
  680. package/dist/cjs/clients/webdav.js +337 -0
  681. package/dist/cjs/clients/webdav.js.map +1 -0
  682. package/dist/cjs/config/dw-json.d.ts +114 -0
  683. package/dist/cjs/config/dw-json.js +142 -0
  684. package/dist/cjs/config/dw-json.js.map +1 -0
  685. package/dist/cjs/config/index.d.ts +96 -0
  686. package/dist/cjs/config/index.js +103 -0
  687. package/dist/cjs/config/index.js.map +1 -0
  688. package/dist/cjs/config/mapping.d.ts +143 -0
  689. package/dist/cjs/config/mapping.js +212 -0
  690. package/dist/cjs/config/mapping.js.map +1 -0
  691. package/dist/cjs/config/resolved-config.d.ts +31 -0
  692. package/dist/cjs/config/resolved-config.js +84 -0
  693. package/dist/cjs/config/resolved-config.js.map +1 -0
  694. package/dist/cjs/config/resolver.d.ts +190 -0
  695. package/dist/cjs/config/resolver.js +323 -0
  696. package/dist/cjs/config/resolver.js.map +1 -0
  697. package/dist/cjs/config/sources/dw-json-source.d.ts +10 -0
  698. package/dist/cjs/config/sources/dw-json-source.js +38 -0
  699. package/dist/cjs/config/sources/dw-json-source.js.map +1 -0
  700. package/dist/cjs/config/sources/index.d.ts +7 -0
  701. package/dist/cjs/config/sources/index.js +13 -0
  702. package/dist/cjs/config/sources/index.js.map +1 -0
  703. package/dist/cjs/config/sources/mobify-source.d.ts +24 -0
  704. package/dist/cjs/config/sources/mobify-source.js +79 -0
  705. package/dist/cjs/config/sources/mobify-source.js.map +1 -0
  706. package/dist/cjs/config/types.d.ts +270 -0
  707. package/dist/cjs/config/types.js +2 -0
  708. package/dist/cjs/config/types.js.map +1 -0
  709. package/dist/cjs/defaults.d.ts +22 -0
  710. package/dist/cjs/defaults.js +28 -0
  711. package/dist/cjs/defaults.js.map +1 -0
  712. package/dist/cjs/discovery/detector.d.ts +75 -0
  713. package/dist/cjs/discovery/detector.js +108 -0
  714. package/dist/cjs/discovery/detector.js.map +1 -0
  715. package/dist/cjs/discovery/index.d.ts +63 -0
  716. package/dist/cjs/discovery/index.js +70 -0
  717. package/dist/cjs/discovery/index.js.map +1 -0
  718. package/dist/cjs/discovery/patterns/cartridges.d.ts +16 -0
  719. package/dist/cjs/discovery/patterns/cartridges.js +16 -0
  720. package/dist/cjs/discovery/patterns/cartridges.js.map +1 -0
  721. package/dist/cjs/discovery/patterns/index.d.ts +21 -0
  722. package/dist/cjs/discovery/patterns/index.js +16 -0
  723. package/dist/cjs/discovery/patterns/index.js.map +1 -0
  724. package/dist/cjs/discovery/patterns/pwa-kit.d.ts +15 -0
  725. package/dist/cjs/discovery/patterns/pwa-kit.js +26 -0
  726. package/dist/cjs/discovery/patterns/pwa-kit.js.map +1 -0
  727. package/dist/cjs/discovery/patterns/sfra.d.ts +34 -0
  728. package/dist/cjs/discovery/patterns/sfra.js +50 -0
  729. package/dist/cjs/discovery/patterns/sfra.js.map +1 -0
  730. package/dist/cjs/discovery/patterns/storefront-next.d.ts +14 -0
  731. package/dist/cjs/discovery/patterns/storefront-next.js +20 -0
  732. package/dist/cjs/discovery/patterns/storefront-next.js.map +1 -0
  733. package/dist/cjs/discovery/types.d.ts +47 -0
  734. package/dist/cjs/discovery/types.js +12 -0
  735. package/dist/cjs/discovery/types.js.map +1 -0
  736. package/dist/cjs/discovery/utils.d.ts +44 -0
  737. package/dist/cjs/discovery/utils.js +82 -0
  738. package/dist/cjs/discovery/utils.js.map +1 -0
  739. package/dist/cjs/errors/http-error.d.ts +34 -0
  740. package/dist/cjs/errors/http-error.js +45 -0
  741. package/dist/cjs/errors/http-error.js.map +1 -0
  742. package/dist/cjs/errors/index.d.ts +6 -0
  743. package/dist/cjs/errors/index.js +12 -0
  744. package/dist/cjs/errors/index.js.map +1 -0
  745. package/dist/cjs/i18n/index.d.ts +144 -0
  746. package/dist/cjs/i18n/index.js +242 -0
  747. package/dist/cjs/i18n/index.js.map +1 -0
  748. package/dist/cjs/i18n/locales/de.d.ts +13 -0
  749. package/dist/cjs/i18n/locales/de.js +19 -0
  750. package/dist/cjs/i18n/locales/de.js.map +1 -0
  751. package/dist/cjs/i18n/locales/index.d.ts +28 -0
  752. package/dist/cjs/i18n/locales/index.js +25 -0
  753. package/dist/cjs/i18n/locales/index.js.map +1 -0
  754. package/dist/cjs/index.d.ts +25 -0
  755. package/dist/cjs/index.js +31 -0
  756. package/dist/cjs/index.js.map +1 -0
  757. package/dist/cjs/instance/index.d.ts +132 -0
  758. package/dist/cjs/instance/index.js +124 -0
  759. package/dist/cjs/instance/index.js.map +1 -0
  760. package/dist/cjs/logger.d.ts +66 -0
  761. package/dist/cjs/logger.js +80 -0
  762. package/dist/cjs/logger.js.map +1 -0
  763. package/dist/cjs/logging/index.d.ts +116 -0
  764. package/dist/cjs/logging/index.js +121 -0
  765. package/dist/cjs/logging/index.js.map +1 -0
  766. package/dist/cjs/logging/logger.d.ts +9 -0
  767. package/dist/cjs/logging/logger.js +111 -0
  768. package/dist/cjs/logging/logger.js.map +1 -0
  769. package/dist/cjs/logging/types.d.ts +36 -0
  770. package/dist/cjs/logging/types.js +10 -0
  771. package/dist/cjs/logging/types.js.map +1 -0
  772. package/dist/cjs/operations/code/cartridges.d.ts +46 -0
  773. package/dist/cjs/operations/code/cartridges.js +59 -0
  774. package/dist/cjs/operations/code/cartridges.js.map +1 -0
  775. package/dist/cjs/operations/code/deploy.d.ts +101 -0
  776. package/dist/cjs/operations/code/deploy.js +218 -0
  777. package/dist/cjs/operations/code/deploy.js.map +1 -0
  778. package/dist/cjs/operations/code/index.d.ts +66 -0
  779. package/dist/cjs/operations/code/index.js +72 -0
  780. package/dist/cjs/operations/code/index.js.map +1 -0
  781. package/dist/cjs/operations/code/versions.d.ts +99 -0
  782. package/dist/cjs/operations/code/versions.js +156 -0
  783. package/dist/cjs/operations/code/versions.js.map +1 -0
  784. package/dist/cjs/operations/code/watch.d.ts +58 -0
  785. package/dist/cjs/operations/code/watch.js +226 -0
  786. package/dist/cjs/operations/code/watch.js.map +1 -0
  787. package/dist/cjs/operations/docs/download.d.ts +45 -0
  788. package/dist/cjs/operations/docs/download.js +96 -0
  789. package/dist/cjs/operations/docs/download.js.map +1 -0
  790. package/dist/cjs/operations/docs/index.d.ts +44 -0
  791. package/dist/cjs/operations/docs/index.js +12 -0
  792. package/dist/cjs/operations/docs/index.js.map +1 -0
  793. package/dist/cjs/operations/docs/schema.d.ts +24 -0
  794. package/dist/cjs/operations/docs/schema.js +92 -0
  795. package/dist/cjs/operations/docs/schema.js.map +1 -0
  796. package/dist/cjs/operations/docs/search.d.ts +67 -0
  797. package/dist/cjs/operations/docs/search.js +128 -0
  798. package/dist/cjs/operations/docs/search.js.map +1 -0
  799. package/dist/cjs/operations/docs/types.d.ts +64 -0
  800. package/dist/cjs/operations/docs/types.js +15 -0
  801. package/dist/cjs/operations/docs/types.js.map +1 -0
  802. package/dist/cjs/operations/jobs/index.d.ts +66 -0
  803. package/dist/cjs/operations/jobs/index.js +72 -0
  804. package/dist/cjs/operations/jobs/index.js.map +1 -0
  805. package/dist/cjs/operations/jobs/run.d.ts +224 -0
  806. package/dist/cjs/operations/jobs/run.js +322 -0
  807. package/dist/cjs/operations/jobs/run.js.map +1 -0
  808. package/dist/cjs/operations/jobs/site-archive.d.ts +224 -0
  809. package/dist/cjs/operations/jobs/site-archive.js +354 -0
  810. package/dist/cjs/operations/jobs/site-archive.js.map +1 -0
  811. package/dist/cjs/operations/mrt/bundle.d.ts +114 -0
  812. package/dist/cjs/operations/mrt/bundle.js +166 -0
  813. package/dist/cjs/operations/mrt/bundle.js.map +1 -0
  814. package/dist/cjs/operations/mrt/env-var.d.ts +176 -0
  815. package/dist/cjs/operations/mrt/env-var.js +231 -0
  816. package/dist/cjs/operations/mrt/env-var.js.map +1 -0
  817. package/dist/cjs/operations/mrt/env.d.ts +256 -0
  818. package/dist/cjs/operations/mrt/env.js +233 -0
  819. package/dist/cjs/operations/mrt/env.js.map +1 -0
  820. package/dist/cjs/operations/mrt/index.d.ts +49 -0
  821. package/dist/cjs/operations/mrt/index.js +55 -0
  822. package/dist/cjs/operations/mrt/index.js.map +1 -0
  823. package/dist/cjs/operations/mrt/push.d.ts +109 -0
  824. package/dist/cjs/operations/mrt/push.js +149 -0
  825. package/dist/cjs/operations/mrt/push.js.map +1 -0
  826. package/dist/cjs/operations/sites/index.d.ts +56 -0
  827. package/dist/cjs/operations/sites/index.js +19 -0
  828. package/dist/cjs/operations/sites/index.js.map +1 -0
  829. package/dist/cjs/package.json +1 -0
  830. package/dist/cjs/platform/index.d.ts +38 -0
  831. package/dist/cjs/platform/index.js +42 -0
  832. package/dist/cjs/platform/index.js.map +1 -0
  833. package/dist/cjs/platform/mrt.d.ts +19 -0
  834. package/dist/cjs/platform/mrt.js +22 -0
  835. package/dist/cjs/platform/mrt.js.map +1 -0
  836. package/dist/cjs/platform/ods.d.ts +17 -0
  837. package/dist/cjs/platform/ods.js +22 -0
  838. package/dist/cjs/platform/ods.js.map +1 -0
  839. package/dist/esm/auth/api-key.d.ts +28 -0
  840. package/dist/esm/auth/api-key.js +44 -0
  841. package/dist/esm/auth/api-key.js.map +1 -0
  842. package/dist/esm/auth/basic.d.ts +7 -0
  843. package/dist/esm/auth/basic.js +18 -0
  844. package/dist/esm/auth/basic.js.map +1 -0
  845. package/dist/esm/auth/index.d.ts +65 -0
  846. package/dist/esm/auth/index.js +69 -0
  847. package/dist/esm/auth/index.js.map +1 -0
  848. package/dist/esm/auth/oauth-implicit.d.ts +74 -0
  849. package/dist/esm/auth/oauth-implicit.js +330 -0
  850. package/dist/esm/auth/oauth-implicit.js.map +1 -0
  851. package/dist/esm/auth/oauth.d.ts +48 -0
  852. package/dist/esm/auth/oauth.js +178 -0
  853. package/dist/esm/auth/oauth.js.map +1 -0
  854. package/dist/esm/auth/resolve.d.ts +100 -0
  855. package/dist/esm/auth/resolve.js +173 -0
  856. package/dist/esm/auth/resolve.js.map +1 -0
  857. package/dist/esm/auth/types.d.ts +101 -0
  858. package/dist/esm/auth/types.js +3 -0
  859. package/dist/esm/auth/types.js.map +1 -0
  860. package/dist/esm/cli/base-command.d.ts +98 -0
  861. package/dist/esm/cli/base-command.js +331 -0
  862. package/dist/esm/cli/base-command.js.map +1 -0
  863. package/dist/esm/cli/cartridge-command.d.ts +65 -0
  864. package/dist/esm/cli/cartridge-command.js +142 -0
  865. package/dist/esm/cli/cartridge-command.js.map +1 -0
  866. package/dist/esm/cli/cartridge-providers.d.ts +149 -0
  867. package/dist/esm/cli/cartridge-providers.js +103 -0
  868. package/dist/esm/cli/cartridge-providers.js.map +1 -0
  869. package/dist/esm/cli/config.d.ts +75 -0
  870. package/dist/esm/cli/config.js +65 -0
  871. package/dist/esm/cli/config.js.map +1 -0
  872. package/dist/esm/cli/hooks.d.ts +231 -0
  873. package/dist/esm/cli/hooks.js +3 -0
  874. package/dist/esm/cli/hooks.js.map +1 -0
  875. package/dist/esm/cli/index.d.ts +103 -0
  876. package/dist/esm/cli/index.js +108 -0
  877. package/dist/esm/cli/index.js.map +1 -0
  878. package/dist/esm/cli/instance-command.d.ts +121 -0
  879. package/dist/esm/cli/instance-command.js +213 -0
  880. package/dist/esm/cli/instance-command.js.map +1 -0
  881. package/dist/esm/cli/job-command.d.ts +32 -0
  882. package/dist/esm/cli/job-command.js +66 -0
  883. package/dist/esm/cli/job-command.js.map +1 -0
  884. package/dist/esm/cli/lifecycle.d.ts +189 -0
  885. package/dist/esm/cli/lifecycle.js +130 -0
  886. package/dist/esm/cli/lifecycle.js.map +1 -0
  887. package/dist/esm/cli/mrt-command.d.ts +61 -0
  888. package/dist/esm/cli/mrt-command.js +113 -0
  889. package/dist/esm/cli/mrt-command.js.map +1 -0
  890. package/dist/esm/cli/oauth-command.d.ts +70 -0
  891. package/dist/esm/cli/oauth-command.js +173 -0
  892. package/dist/esm/cli/oauth-command.js.map +1 -0
  893. package/dist/esm/cli/ods-command.d.ts +70 -0
  894. package/dist/esm/cli/ods-command.js +79 -0
  895. package/dist/esm/cli/ods-command.js.map +1 -0
  896. package/dist/esm/cli/table.d.ts +113 -0
  897. package/dist/esm/cli/table.js +175 -0
  898. package/dist/esm/cli/table.js.map +1 -0
  899. package/dist/esm/cli/webdav-command.d.ts +100 -0
  900. package/dist/esm/cli/webdav-command.js +106 -0
  901. package/dist/esm/cli/webdav-command.js.map +1 -0
  902. package/dist/esm/clients/custom-apis.d.ts +137 -0
  903. package/dist/esm/clients/custom-apis.generated.d.ts +202 -0
  904. package/dist/esm/clients/custom-apis.generated.js +6 -0
  905. package/dist/esm/clients/custom-apis.generated.js.map +1 -0
  906. package/dist/esm/clients/custom-apis.js +124 -0
  907. package/dist/esm/clients/custom-apis.js.map +1 -0
  908. package/dist/esm/clients/index.d.ts +127 -0
  909. package/dist/esm/clients/index.js +125 -0
  910. package/dist/esm/clients/index.js.map +1 -0
  911. package/dist/esm/clients/middleware-registry.d.ts +184 -0
  912. package/dist/esm/clients/middleware-registry.js +104 -0
  913. package/dist/esm/clients/middleware-registry.js.map +1 -0
  914. package/dist/esm/clients/middleware.d.ts +85 -0
  915. package/dist/esm/clients/middleware.js +210 -0
  916. package/dist/esm/clients/middleware.js.map +1 -0
  917. package/dist/esm/clients/mrt.d.ts +120 -0
  918. package/dist/esm/clients/mrt.generated.d.ts +2774 -0
  919. package/dist/esm/clients/mrt.generated.js +6 -0
  920. package/dist/esm/clients/mrt.generated.js.map +1 -0
  921. package/dist/esm/clients/mrt.js +88 -0
  922. package/dist/esm/clients/mrt.js.map +1 -0
  923. package/dist/esm/clients/ocapi.d.ts +108 -0
  924. package/dist/esm/clients/ocapi.generated.d.ts +26052 -0
  925. package/dist/esm/clients/ocapi.generated.js +6 -0
  926. package/dist/esm/clients/ocapi.generated.js.map +1 -0
  927. package/dist/esm/clients/ocapi.js +80 -0
  928. package/dist/esm/clients/ocapi.js.map +1 -0
  929. package/dist/esm/clients/ods.d.ts +133 -0
  930. package/dist/esm/clients/ods.generated.d.ts +2548 -0
  931. package/dist/esm/clients/ods.generated.js +6 -0
  932. package/dist/esm/clients/ods.generated.js.map +1 -0
  933. package/dist/esm/clients/ods.js +103 -0
  934. package/dist/esm/clients/ods.js.map +1 -0
  935. package/dist/esm/clients/slas-admin.d.ts +104 -0
  936. package/dist/esm/clients/slas-admin.generated.d.ts +1434 -0
  937. package/dist/esm/clients/slas-admin.generated.js +6 -0
  938. package/dist/esm/clients/slas-admin.generated.js.map +1 -0
  939. package/dist/esm/clients/slas-admin.js +79 -0
  940. package/dist/esm/clients/slas-admin.js.map +1 -0
  941. package/dist/esm/clients/webdav.d.ts +157 -0
  942. package/dist/esm/clients/webdav.js +337 -0
  943. package/dist/esm/clients/webdav.js.map +1 -0
  944. package/dist/esm/config/dw-json.d.ts +114 -0
  945. package/dist/esm/config/dw-json.js +142 -0
  946. package/dist/esm/config/dw-json.js.map +1 -0
  947. package/dist/esm/config/index.d.ts +96 -0
  948. package/dist/esm/config/index.js +103 -0
  949. package/dist/esm/config/index.js.map +1 -0
  950. package/dist/esm/config/mapping.d.ts +143 -0
  951. package/dist/esm/config/mapping.js +212 -0
  952. package/dist/esm/config/mapping.js.map +1 -0
  953. package/dist/esm/config/resolved-config.d.ts +31 -0
  954. package/dist/esm/config/resolved-config.js +84 -0
  955. package/dist/esm/config/resolved-config.js.map +1 -0
  956. package/dist/esm/config/resolver.d.ts +190 -0
  957. package/dist/esm/config/resolver.js +323 -0
  958. package/dist/esm/config/resolver.js.map +1 -0
  959. package/dist/esm/config/sources/dw-json-source.d.ts +10 -0
  960. package/dist/esm/config/sources/dw-json-source.js +38 -0
  961. package/dist/esm/config/sources/dw-json-source.js.map +1 -0
  962. package/dist/esm/config/sources/index.d.ts +7 -0
  963. package/dist/esm/config/sources/index.js +13 -0
  964. package/dist/esm/config/sources/index.js.map +1 -0
  965. package/dist/esm/config/sources/mobify-source.d.ts +24 -0
  966. package/dist/esm/config/sources/mobify-source.js +79 -0
  967. package/dist/esm/config/sources/mobify-source.js.map +1 -0
  968. package/dist/esm/config/types.d.ts +270 -0
  969. package/dist/esm/config/types.js +2 -0
  970. package/dist/esm/config/types.js.map +1 -0
  971. package/dist/esm/defaults.d.ts +22 -0
  972. package/dist/esm/defaults.js +28 -0
  973. package/dist/esm/defaults.js.map +1 -0
  974. package/dist/esm/discovery/detector.d.ts +75 -0
  975. package/dist/esm/discovery/detector.js +108 -0
  976. package/dist/esm/discovery/detector.js.map +1 -0
  977. package/dist/esm/discovery/index.d.ts +63 -0
  978. package/dist/esm/discovery/index.js +70 -0
  979. package/dist/esm/discovery/index.js.map +1 -0
  980. package/dist/esm/discovery/patterns/cartridges.d.ts +16 -0
  981. package/dist/esm/discovery/patterns/cartridges.js +16 -0
  982. package/dist/esm/discovery/patterns/cartridges.js.map +1 -0
  983. package/dist/esm/discovery/patterns/index.d.ts +21 -0
  984. package/dist/esm/discovery/patterns/index.js +16 -0
  985. package/dist/esm/discovery/patterns/index.js.map +1 -0
  986. package/dist/esm/discovery/patterns/pwa-kit.d.ts +15 -0
  987. package/dist/esm/discovery/patterns/pwa-kit.js +26 -0
  988. package/dist/esm/discovery/patterns/pwa-kit.js.map +1 -0
  989. package/dist/esm/discovery/patterns/sfra.d.ts +34 -0
  990. package/dist/esm/discovery/patterns/sfra.js +50 -0
  991. package/dist/esm/discovery/patterns/sfra.js.map +1 -0
  992. package/dist/esm/discovery/patterns/storefront-next.d.ts +14 -0
  993. package/dist/esm/discovery/patterns/storefront-next.js +20 -0
  994. package/dist/esm/discovery/patterns/storefront-next.js.map +1 -0
  995. package/dist/esm/discovery/types.d.ts +47 -0
  996. package/dist/esm/discovery/types.js +12 -0
  997. package/dist/esm/discovery/types.js.map +1 -0
  998. package/dist/esm/discovery/utils.d.ts +44 -0
  999. package/dist/esm/discovery/utils.js +82 -0
  1000. package/dist/esm/discovery/utils.js.map +1 -0
  1001. package/dist/esm/errors/http-error.d.ts +34 -0
  1002. package/dist/esm/errors/http-error.js +45 -0
  1003. package/dist/esm/errors/http-error.js.map +1 -0
  1004. package/dist/esm/errors/index.d.ts +6 -0
  1005. package/dist/esm/errors/index.js +12 -0
  1006. package/dist/esm/errors/index.js.map +1 -0
  1007. package/dist/esm/i18n/index.d.ts +144 -0
  1008. package/dist/esm/i18n/index.js +242 -0
  1009. package/dist/esm/i18n/index.js.map +1 -0
  1010. package/dist/esm/i18n/locales/de.d.ts +13 -0
  1011. package/dist/esm/i18n/locales/de.js +19 -0
  1012. package/dist/esm/i18n/locales/de.js.map +1 -0
  1013. package/dist/esm/i18n/locales/index.d.ts +28 -0
  1014. package/dist/esm/i18n/locales/index.js +25 -0
  1015. package/dist/esm/i18n/locales/index.js.map +1 -0
  1016. package/dist/esm/index.d.ts +25 -0
  1017. package/dist/esm/index.js +31 -0
  1018. package/dist/esm/index.js.map +1 -0
  1019. package/dist/esm/instance/index.d.ts +132 -0
  1020. package/dist/esm/instance/index.js +124 -0
  1021. package/dist/esm/instance/index.js.map +1 -0
  1022. package/dist/esm/logger.d.ts +66 -0
  1023. package/dist/esm/logger.js +80 -0
  1024. package/dist/esm/logger.js.map +1 -0
  1025. package/dist/esm/logging/index.d.ts +116 -0
  1026. package/dist/esm/logging/index.js +121 -0
  1027. package/dist/esm/logging/index.js.map +1 -0
  1028. package/dist/esm/logging/logger.d.ts +9 -0
  1029. package/dist/esm/logging/logger.js +111 -0
  1030. package/dist/esm/logging/logger.js.map +1 -0
  1031. package/dist/esm/logging/types.d.ts +36 -0
  1032. package/dist/esm/logging/types.js +10 -0
  1033. package/dist/esm/logging/types.js.map +1 -0
  1034. package/dist/esm/operations/code/cartridges.d.ts +46 -0
  1035. package/dist/esm/operations/code/cartridges.js +59 -0
  1036. package/dist/esm/operations/code/cartridges.js.map +1 -0
  1037. package/dist/esm/operations/code/deploy.d.ts +101 -0
  1038. package/dist/esm/operations/code/deploy.js +218 -0
  1039. package/dist/esm/operations/code/deploy.js.map +1 -0
  1040. package/dist/esm/operations/code/index.d.ts +66 -0
  1041. package/dist/esm/operations/code/index.js +72 -0
  1042. package/dist/esm/operations/code/index.js.map +1 -0
  1043. package/dist/esm/operations/code/versions.d.ts +99 -0
  1044. package/dist/esm/operations/code/versions.js +157 -0
  1045. package/dist/esm/operations/code/versions.js.map +1 -0
  1046. package/dist/esm/operations/code/watch.d.ts +58 -0
  1047. package/dist/esm/operations/code/watch.js +226 -0
  1048. package/dist/esm/operations/code/watch.js.map +1 -0
  1049. package/dist/esm/operations/docs/download.d.ts +45 -0
  1050. package/dist/esm/operations/docs/download.js +96 -0
  1051. package/dist/esm/operations/docs/download.js.map +1 -0
  1052. package/dist/esm/operations/docs/index.d.ts +44 -0
  1053. package/dist/esm/operations/docs/index.js +12 -0
  1054. package/dist/esm/operations/docs/index.js.map +1 -0
  1055. package/dist/esm/operations/docs/schema.d.ts +24 -0
  1056. package/dist/esm/operations/docs/schema.js +92 -0
  1057. package/dist/esm/operations/docs/schema.js.map +1 -0
  1058. package/dist/esm/operations/docs/search.d.ts +67 -0
  1059. package/dist/esm/operations/docs/search.js +128 -0
  1060. package/dist/esm/operations/docs/search.js.map +1 -0
  1061. package/dist/esm/operations/docs/types.d.ts +64 -0
  1062. package/dist/esm/operations/docs/types.js +15 -0
  1063. package/dist/esm/operations/docs/types.js.map +1 -0
  1064. package/dist/esm/operations/jobs/index.d.ts +66 -0
  1065. package/dist/esm/operations/jobs/index.js +72 -0
  1066. package/dist/esm/operations/jobs/index.js.map +1 -0
  1067. package/dist/esm/operations/jobs/run.d.ts +224 -0
  1068. package/dist/esm/operations/jobs/run.js +333 -0
  1069. package/dist/esm/operations/jobs/run.js.map +1 -0
  1070. package/dist/esm/operations/jobs/site-archive.d.ts +224 -0
  1071. package/dist/esm/operations/jobs/site-archive.js +355 -0
  1072. package/dist/esm/operations/jobs/site-archive.js.map +1 -0
  1073. package/dist/esm/operations/mrt/bundle.d.ts +114 -0
  1074. package/dist/esm/operations/mrt/bundle.js +166 -0
  1075. package/dist/esm/operations/mrt/bundle.js.map +1 -0
  1076. package/dist/esm/operations/mrt/env-var.d.ts +176 -0
  1077. package/dist/esm/operations/mrt/env-var.js +231 -0
  1078. package/dist/esm/operations/mrt/env-var.js.map +1 -0
  1079. package/dist/esm/operations/mrt/env.d.ts +256 -0
  1080. package/dist/esm/operations/mrt/env.js +233 -0
  1081. package/dist/esm/operations/mrt/env.js.map +1 -0
  1082. package/dist/esm/operations/mrt/index.d.ts +49 -0
  1083. package/dist/esm/operations/mrt/index.js +55 -0
  1084. package/dist/esm/operations/mrt/index.js.map +1 -0
  1085. package/dist/esm/operations/mrt/push.d.ts +109 -0
  1086. package/dist/esm/operations/mrt/push.js +149 -0
  1087. package/dist/esm/operations/mrt/push.js.map +1 -0
  1088. package/dist/esm/operations/sites/index.d.ts +56 -0
  1089. package/dist/esm/operations/sites/index.js +67 -0
  1090. package/dist/esm/operations/sites/index.js.map +1 -0
  1091. package/dist/esm/platform/index.d.ts +38 -0
  1092. package/dist/esm/platform/index.js +42 -0
  1093. package/dist/esm/platform/index.js.map +1 -0
  1094. package/dist/esm/platform/mrt.d.ts +19 -0
  1095. package/dist/esm/platform/mrt.js +22 -0
  1096. package/dist/esm/platform/mrt.js.map +1 -0
  1097. package/dist/esm/platform/ods.d.ts +17 -0
  1098. package/dist/esm/platform/ods.js +22 -0
  1099. package/dist/esm/platform/ods.js.map +1 -0
  1100. package/package.json +263 -6
  1101. package/specs/README.md +7 -0
  1102. package/specs/custom-apis-v1.yaml +309 -0
  1103. package/specs/data-api.json +37503 -0
  1104. package/specs/mrt-api-v1.json +5555 -0
  1105. package/specs/ods-api-v1.json +3673 -0
  1106. package/specs/slas-admin-v1.yaml +1841 -0
@@ -0,0 +1,299 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Class Quantity
3
+
4
+ - [TopLevel.Object](TopLevel.Object.md)
5
+ - [dw.value.Quantity](dw.value.Quantity.md)
6
+
7
+ Represents the quantity of an item.
8
+
9
+
10
+ ## Property Summary
11
+
12
+ | Property | Description |
13
+ | --- | --- |
14
+ | [available](#available): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the instance contains settings for value and unit. |
15
+ | [decimalValue](#decimalvalue): [Decimal](dw.util.Decimal.md) `(read-only)` | Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available. |
16
+ | [unit](#unit): [String](TopLevel.String.md) `(read-only)` | Returns the value for unit which identifies the unit of measure for the quantity. |
17
+ | [value](#value): [Number](TopLevel.Number.md) `(read-only)` | Returns the quantity value. |
18
+
19
+ ## Constructor Summary
20
+
21
+ | Constructor | Description |
22
+ | --- | --- |
23
+ | [Quantity](#quantitynumber-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md)) | Creates a new quantity instance with the specified value and unit. |
24
+
25
+ ## Method Summary
26
+
27
+ | Method | Description |
28
+ | --- | --- |
29
+ | [add](dw.value.Quantity.md#addquantity)([Quantity](dw.value.Quantity.md)) | Add Quantity object to the current object. |
30
+ | [compareTo](dw.value.Quantity.md#comparetoquantity)([Quantity](dw.value.Quantity.md)) | Compares two Quantity values. |
31
+ | [divide](dw.value.Quantity.md#dividenumber)([Number](TopLevel.Number.md)) | Divide Quantity object by specified divisor. |
32
+ | [equals](dw.value.Quantity.md#equalsobject)([Object](TopLevel.Object.md)) | Compares two decimal values whether they are equivalent. |
33
+ | [getDecimalValue](dw.value.Quantity.md#getdecimalvalue)() | Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available. |
34
+ | [getUnit](dw.value.Quantity.md#getunit)() | Returns the value for unit which identifies the unit of measure for the quantity. |
35
+ | [getValue](dw.value.Quantity.md#getvalue)() | Returns the quantity value. |
36
+ | [hashCode](dw.value.Quantity.md#hashcode)() | Calculates the hash code for a decimal. |
37
+ | [isAvailable](dw.value.Quantity.md#isavailable)() | Identifies if the instance contains settings for value and unit. |
38
+ | [isOfSameUnit](dw.value.Quantity.md#isofsameunitquantity)([Quantity](dw.value.Quantity.md)) | Identifies if two Quantities have the same unit. |
39
+ | [multiply](dw.value.Quantity.md#multiplynumber)([Number](TopLevel.Number.md)) | Multiply Quantity object by specified factor. |
40
+ | [newQuantity](dw.value.Quantity.md#newquantitydecimal)([Decimal](dw.util.Decimal.md)) | Method returns a new instance of Quantity with the same unit but different value. |
41
+ | [round](dw.value.Quantity.md#roundnumber)([Number](TopLevel.Number.md)) | Rounds the Quantity value to the number of specified decimal digits. |
42
+ | [subtract](dw.value.Quantity.md#subtractquantity)([Quantity](dw.value.Quantity.md)) | Subtract Quantity object from the current object. |
43
+ | [toString](dw.value.Quantity.md#tostring)() | Returns a string representation of this quantity object. |
44
+ | [valueOf](dw.value.Quantity.md#valueof)() | According to the ECMA spec returns the "natural" primitive value. |
45
+
46
+ ### Methods inherited from class Object
47
+
48
+ [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)
49
+ ## Property Details
50
+
51
+ ### available
52
+ - available: [Boolean](TopLevel.Boolean.md) `(read-only)`
53
+ - : Identifies if the instance contains settings for value and unit.
54
+
55
+
56
+ ---
57
+
58
+ ### decimalValue
59
+ - decimalValue: [Decimal](dw.util.Decimal.md) `(read-only)`
60
+ - : Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available.
61
+
62
+
63
+ ---
64
+
65
+ ### unit
66
+ - unit: [String](TopLevel.String.md) `(read-only)`
67
+ - : Returns the value for unit which identifies the
68
+ unit of measure for the quantity. Examples of unit
69
+ are 'inches' or 'pounds'.
70
+
71
+
72
+
73
+ ---
74
+
75
+ ### value
76
+ - value: [Number](TopLevel.Number.md) `(read-only)`
77
+ - : Returns the quantity value.
78
+
79
+ **See Also:**
80
+ - [getDecimalValue()](dw.value.Quantity.md#getdecimalvalue)
81
+
82
+
83
+ ---
84
+
85
+ ## Constructor Details
86
+
87
+ ### Quantity(Number, String)
88
+ - Quantity(value: [Number](TopLevel.Number.md), unit: [String](TopLevel.String.md))
89
+ - : Creates a new quantity instance with the specified value and unit.
90
+
91
+ **Parameters:**
92
+ - value - the actual quantity, must not be `null`
93
+ - unit - the unit identifier for the quantity, must not be `null`
94
+
95
+
96
+ ---
97
+
98
+ ## Method Details
99
+
100
+ ### add(Quantity)
101
+ - add(value: [Quantity](dw.value.Quantity.md)): [Quantity](dw.value.Quantity.md)
102
+ - : Add Quantity object to the current object. Only objects representing the same unit can be added.
103
+
104
+ **Parameters:**
105
+ - value - Quantity object
106
+
107
+ **Returns:**
108
+ - Quantity object representing the sum of the operands
109
+
110
+
111
+ ---
112
+
113
+ ### compareTo(Quantity)
114
+ - compareTo(other: [Quantity](dw.value.Quantity.md)): [Number](TopLevel.Number.md)
115
+ - : Compares two Quantity values. An exception is thrown if the two Quantities values
116
+ are of different unit. If one of the Quantity values represents the N/A value
117
+ it is treated as 0.0.
118
+
119
+
120
+ **Parameters:**
121
+ - other - the other quantity to compare.
122
+
123
+ **Returns:**
124
+ - the comparison.
125
+
126
+
127
+ ---
128
+
129
+ ### divide(Number)
130
+ - divide(divisor: [Number](TopLevel.Number.md)): [Quantity](dw.value.Quantity.md)
131
+ - : Divide Quantity object by specified divisor.
132
+
133
+ **Parameters:**
134
+ - divisor - divisor
135
+
136
+ **Returns:**
137
+ - Quantity object representing division result
138
+
139
+
140
+ ---
141
+
142
+ ### equals(Object)
143
+ - equals(other: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
144
+ - : Compares two decimal values whether they are equivalent.
145
+
146
+ **Parameters:**
147
+ - other - the object to compare against this quantity instance.
148
+
149
+ **Returns:**
150
+ - true if equal, false otherwise.
151
+
152
+
153
+ ---
154
+
155
+ ### getDecimalValue()
156
+ - getDecimalValue(): [Decimal](dw.util.Decimal.md)
157
+ - : Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available.
158
+
159
+ **Returns:**
160
+ - the quantity as [Decimal](dw.util.Decimal.md)
161
+
162
+
163
+ ---
164
+
165
+ ### getUnit()
166
+ - getUnit(): [String](TopLevel.String.md)
167
+ - : Returns the value for unit which identifies the
168
+ unit of measure for the quantity. Examples of unit
169
+ are 'inches' or 'pounds'.
170
+
171
+
172
+ **Returns:**
173
+ - the unit value.
174
+
175
+
176
+ ---
177
+
178
+ ### getValue()
179
+ - getValue(): [Number](TopLevel.Number.md)
180
+ - : Returns the quantity value.
181
+
182
+ **Returns:**
183
+ - the quantity value.
184
+
185
+ **See Also:**
186
+ - [getDecimalValue()](dw.value.Quantity.md#getdecimalvalue)
187
+
188
+
189
+ ---
190
+
191
+ ### hashCode()
192
+ - hashCode(): [Number](TopLevel.Number.md)
193
+ - : Calculates the hash code for a decimal.
194
+
195
+ **Returns:**
196
+ - the hash code.
197
+
198
+
199
+ ---
200
+
201
+ ### isAvailable()
202
+ - isAvailable(): [Boolean](TopLevel.Boolean.md)
203
+ - : Identifies if the instance contains settings for value and unit.
204
+
205
+ **Returns:**
206
+ - true if the instance is initialized with value and
207
+ unit, false if the state is 'not available'.
208
+
209
+
210
+
211
+ ---
212
+
213
+ ### isOfSameUnit(Quantity)
214
+ - isOfSameUnit(value: [Quantity](dw.value.Quantity.md)): [Boolean](TopLevel.Boolean.md)
215
+ - : Identifies if two Quantities have the same unit.
216
+
217
+ **Parameters:**
218
+ - value - the second quantity for the comparison.
219
+
220
+ **Returns:**
221
+ - true if both quantities have the same unit, false otherwise.
222
+
223
+
224
+ ---
225
+
226
+ ### multiply(Number)
227
+ - multiply(factor: [Number](TopLevel.Number.md)): [Quantity](dw.value.Quantity.md)
228
+ - : Multiply Quantity object by specified factor.
229
+
230
+ **Parameters:**
231
+ - factor - multiplication factor
232
+
233
+ **Returns:**
234
+ - Quantity object representing multiplication result
235
+
236
+
237
+ ---
238
+
239
+ ### newQuantity(Decimal)
240
+ - newQuantity(value: [Decimal](dw.util.Decimal.md)): [Quantity](dw.value.Quantity.md)
241
+ - : Method returns a new instance of Quantity with the same unit but
242
+ different value. An N/A instance is returned if value is null.
243
+
244
+
245
+ **Parameters:**
246
+ - value - as a decimal
247
+
248
+ **Returns:**
249
+ - new Quantity instance with same unit
250
+
251
+
252
+ ---
253
+
254
+ ### round(Number)
255
+ - round(precision: [Number](TopLevel.Number.md)): [Quantity](dw.value.Quantity.md)
256
+ - : Rounds the Quantity value to the number of specified decimal digits.
257
+
258
+ **Parameters:**
259
+ - precision - number of decimal digits after the decimal point
260
+
261
+ **Returns:**
262
+ - the new rounded Quantity value
263
+
264
+
265
+ ---
266
+
267
+ ### subtract(Quantity)
268
+ - subtract(value: [Quantity](dw.value.Quantity.md)): [Quantity](dw.value.Quantity.md)
269
+ - : Subtract Quantity object from the current object. Only objects representing the same unit can be subtracted.
270
+
271
+ **Parameters:**
272
+ - value - Quantity object to subtract
273
+
274
+ **Returns:**
275
+ - Quantity object representing the result of subtraction
276
+
277
+
278
+ ---
279
+
280
+ ### toString()
281
+ - toString(): [String](TopLevel.String.md)
282
+ - : Returns a string representation of this quantity object.
283
+
284
+ **Returns:**
285
+ - a string representation of this quantity object.
286
+
287
+
288
+ ---
289
+
290
+ ### valueOf()
291
+ - valueOf(): [Object](TopLevel.Object.md)
292
+ - : According to the ECMA spec returns the "natural" primitive value. Here
293
+ the value portion of the Quantity is returned.
294
+
295
+
296
+
297
+ ---
298
+
299
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,9 @@
1
+ # Package dw.value
2
+
3
+ ## Classes
4
+ | Class | Description |
5
+ | --- | --- |
6
+ | [EnumValue](dw.value.EnumValue.md) | The class represents a single value for an Enumeration type. |
7
+ | [MimeEncodedText](dw.value.MimeEncodedText.md) | Container for an arbitrary text string its mime type, and encoding |
8
+ | [Money](dw.value.Money.md) | Represents money in Commerce Cloud Digital. |
9
+ | [Quantity](dw.value.Quantity.md) | Represents the quantity of an item. |
@@ -0,0 +1,105 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Class CSRFProtection
3
+
4
+ - [TopLevel.Object](TopLevel.Object.md)
5
+ - [dw.web.CSRFProtection](dw.web.CSRFProtection.md)
6
+
7
+ Used to generate and validate CSRF tokens. CSRFProtection allows
8
+ applications to protect themselves against CSRF attacks, using
9
+ synchronizer tokens, a best practice. Once created, these tokens
10
+ are tied to a user’s session and valid for 60 minutes.
11
+
12
+
13
+ Usage:
14
+
15
+ Adding CSRF token to forms:
16
+
17
+
18
+ ```
19
+ //CSRF token generation
20
+ <form ... action="<protected location>">
21
+ <input name="foo" value="bar">
22
+ <input name="${dw.web.CSRFProtection.getTokenName()}"
23
+ value="${dw.web.CSRFProtection.generateToken()">
24
+ </form>
25
+ ```
26
+
27
+
28
+ Then, in scripts call:
29
+
30
+
31
+ ```
32
+ dw.web.CSRFProtection.validateRequest();
33
+ ```
34
+
35
+
36
+
37
+ ## Property Summary
38
+
39
+ | Property | Description |
40
+ | --- | --- |
41
+ | [tokenName](#tokenname): [String](TopLevel.String.md) `(read-only)` | Returns the system generated CSRF token name. |
42
+
43
+ ## Constructor Summary
44
+
45
+ This class does not have a constructor, so you cannot create it directly.
46
+ ## Method Summary
47
+
48
+ | Method | Description |
49
+ | --- | --- |
50
+ | static [generateToken](dw.web.CSRFProtection.md#generatetoken)() | Constructs a new unique CSRF token for this session. |
51
+ | static [getTokenName](dw.web.CSRFProtection.md#gettokenname)() | Returns the system generated CSRF token name. |
52
+ | static [validateRequest](dw.web.CSRFProtection.md#validaterequest)() | Verifies that a client request contains a valid CSRF token, and that the token has not expired. |
53
+
54
+ ### Methods inherited from class Object
55
+
56
+ [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)
57
+ ## Property Details
58
+
59
+ ### tokenName
60
+ - tokenName: [String](TopLevel.String.md) `(read-only)`
61
+ - : Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for
62
+ [validateRequest()](dw.web.CSRFProtection.md#validaterequest) to work
63
+
64
+
65
+
66
+ ---
67
+
68
+ ## Method Details
69
+
70
+ ### generateToken()
71
+ - static generateToken(): [String](TopLevel.String.md)
72
+ - : Constructs a new unique CSRF token for this session.
73
+
74
+ **Returns:**
75
+ - a new CSRF token
76
+
77
+
78
+ ---
79
+
80
+ ### getTokenName()
81
+ - static getTokenName(): [String](TopLevel.String.md)
82
+ - : Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for
83
+ [validateRequest()](dw.web.CSRFProtection.md#validaterequest) to work
84
+
85
+
86
+ **Returns:**
87
+ - System-generated CSRF token parameter name
88
+
89
+
90
+ ---
91
+
92
+ ### validateRequest()
93
+ - static validateRequest(): [Boolean](TopLevel.Boolean.md)
94
+ - : Verifies that a client request contains a valid CSRF token, and that
95
+ the token has not expired. Returns true if these conditions are met,
96
+ and false otherwise
97
+
98
+
99
+ **Returns:**
100
+ - true if request contains a valid CSRF token, false otherwise
101
+
102
+
103
+ ---
104
+
105
+ <!-- prettier-ignore-end -->
@@ -0,0 +1,177 @@
1
+ <!-- prettier-ignore-start -->
2
+ # Class ClickStream
3
+
4
+ - [TopLevel.Object](TopLevel.Object.md)
5
+ - [dw.web.ClickStream](dw.web.ClickStream.md)
6
+
7
+ Represents the click stream in the session. A maximum number of 50 clicks is
8
+ recorded per session. After the maximum is reached, each time the customer
9
+ clicks on a new link, the oldest click stream entry is purged. The
10
+ ClickStream always remembers the first click.
11
+
12
+
13
+ The click stream is consulted when the GetLastVisitedProducts pipelet is
14
+ called to retrieve the products that the customer has recently visited.
15
+
16
+
17
+
18
+ ## Property Summary
19
+
20
+ | Property | Description |
21
+ | --- | --- |
22
+ | [clicks](#clicks): [List](dw.util.List.md) `(read-only)` | Returns a collection with all clicks. |
23
+ | [enabled](#enabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the clickstream recording is enabled or not. |
24
+ | [first](#first): [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)` | Returns the first click within this session. |
25
+ | [last](#last): [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)` | Returns the last recorded click stream, which is also typically the current click. |
26
+ | [partial](#partial): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this is only a partial click stream. |
27
+
28
+ ## Constructor Summary
29
+
30
+ This class does not have a constructor, so you cannot create it directly.
31
+ ## Method Summary
32
+
33
+ | Method | Description |
34
+ | --- | --- |
35
+ | [getClicks](dw.web.ClickStream.md#getclicks)() | Returns a collection with all clicks. |
36
+ | [getFirst](dw.web.ClickStream.md#getfirst)() | Returns the first click within this session. |
37
+ | [getLast](dw.web.ClickStream.md#getlast)() | Returns the last recorded click stream, which is also typically the current click. |
38
+ | [isEnabled](dw.web.ClickStream.md#isenabled)() | Identifies if the clickstream recording is enabled or not. |
39
+ | [isPartial](dw.web.ClickStream.md#ispartial)() | Identifies if this is only a partial click stream. |
40
+
41
+ ### Methods inherited from class Object
42
+
43
+ [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
44
+ ## Property Details
45
+
46
+ ### clicks
47
+ - clicks: [List](dw.util.List.md) `(read-only)`
48
+ - : Returns a collection with all clicks. The first entry is the oldest
49
+ entry. The last entry is the latest entry. The method returns a copy of
50
+ the click stream, which makes it safe to work with the click stream,
51
+ while it might be modified.
52
+
53
+
54
+
55
+ ---
56
+
57
+ ### enabled
58
+ - enabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
59
+ - : Identifies if the clickstream recording is enabled or not.
60
+ It is considered enabled if either:
61
+ - the method [Session.isTrackingAllowed()](dw.system.Session.md#istrackingallowed)returns true
62
+ - or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
63
+
64
+ When clickstream tracking is not enabled the [getFirst()](dw.web.ClickStream.md#getfirst) method still operates as expected
65
+ but the rest of the clicks are not collected.
66
+
67
+
68
+
69
+ ---
70
+
71
+ ### first
72
+ - first: [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)`
73
+ - : Returns the first click within this session. This first click
74
+ is stored independent of whether entries are purged.
75
+
76
+
77
+
78
+ ---
79
+
80
+ ### last
81
+ - last: [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)`
82
+ - : Returns the last recorded click stream, which is also typically
83
+ the current click. In where rare cases (e.g. RedirectURL pipeline) this
84
+ is not the current click, but instead the last recorded click.
85
+
86
+
87
+
88
+ ---
89
+
90
+ ### partial
91
+ - partial: [Boolean](TopLevel.Boolean.md) `(read-only)`
92
+ - : Identifies if this is only a partial click stream. If the maximum number
93
+ of clicks (50) is recorded, the oldest entry is automatically purged with
94
+ each additional click. In this case, this flag indicates that the click
95
+ stream is only partial.
96
+
97
+
98
+
99
+ ---
100
+
101
+ ## Method Details
102
+
103
+ ### getClicks()
104
+ - getClicks(): [List](dw.util.List.md)
105
+ - : Returns a collection with all clicks. The first entry is the oldest
106
+ entry. The last entry is the latest entry. The method returns a copy of
107
+ the click stream, which makes it safe to work with the click stream,
108
+ while it might be modified.
109
+
110
+
111
+ **Returns:**
112
+ - a collection of ClickStreamEntry instances, sorted
113
+ chronologically.
114
+
115
+
116
+
117
+ ---
118
+
119
+ ### getFirst()
120
+ - getFirst(): [ClickStreamEntry](dw.web.ClickStreamEntry.md)
121
+ - : Returns the first click within this session. This first click
122
+ is stored independent of whether entries are purged.
123
+
124
+
125
+ **Returns:**
126
+ - the first click within this session.
127
+
128
+
129
+ ---
130
+
131
+ ### getLast()
132
+ - getLast(): [ClickStreamEntry](dw.web.ClickStreamEntry.md)
133
+ - : Returns the last recorded click stream, which is also typically
134
+ the current click. In where rare cases (e.g. RedirectURL pipeline) this
135
+ is not the current click, but instead the last recorded click.
136
+
137
+
138
+ **Returns:**
139
+ - the last recorded click stream, which is also typically
140
+ the current click.
141
+
142
+
143
+
144
+ ---
145
+
146
+ ### isEnabled()
147
+ - isEnabled(): [Boolean](TopLevel.Boolean.md)
148
+ - : Identifies if the clickstream recording is enabled or not.
149
+ It is considered enabled if either:
150
+ - the method [Session.isTrackingAllowed()](dw.system.Session.md#istrackingallowed)returns true
151
+ - or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
152
+
153
+ When clickstream tracking is not enabled the [getFirst()](dw.web.ClickStream.md#getfirst) method still operates as expected
154
+ but the rest of the clicks are not collected.
155
+
156
+
157
+ **Returns:**
158
+ - whether clickstream tracking is enabled
159
+
160
+
161
+ ---
162
+
163
+ ### isPartial()
164
+ - isPartial(): [Boolean](TopLevel.Boolean.md)
165
+ - : Identifies if this is only a partial click stream. If the maximum number
166
+ of clicks (50) is recorded, the oldest entry is automatically purged with
167
+ each additional click. In this case, this flag indicates that the click
168
+ stream is only partial.
169
+
170
+
171
+ **Returns:**
172
+ - true if this click stream is partial, false otherwise.
173
+
174
+
175
+ ---
176
+
177
+ <!-- prettier-ignore-end -->