@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.1

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 (582) hide show
  1. package/data/guides/index.json +99 -2301
  2. package/data/help/index.json +9685 -0
  3. package/data/script-api/index.json +1 -528
  4. package/data/tooling/index.json +4 -4
  5. package/data/xsd/index.json +1 -1
  6. package/dist/esm/cli/base-command.js +5 -0
  7. package/dist/esm/cli/base-command.js.map +1 -1
  8. package/dist/esm/cli/oauth-command.js +6 -2
  9. package/dist/esm/cli/oauth-command.js.map +1 -1
  10. package/dist/esm/clients/index.d.ts +2 -0
  11. package/dist/esm/clients/index.js +1 -0
  12. package/dist/esm/clients/index.js.map +1 -1
  13. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  14. package/dist/esm/clients/middleware-registry.js.map +1 -1
  15. package/dist/esm/clients/preferences.d.ts +83 -0
  16. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  17. package/dist/esm/clients/preferences.generated.js +6 -0
  18. package/dist/esm/clients/preferences.generated.js.map +1 -0
  19. package/dist/esm/clients/preferences.js +64 -0
  20. package/dist/esm/clients/preferences.js.map +1 -0
  21. package/dist/esm/config/dw-json.d.ts +2 -0
  22. package/dist/esm/config/dw-json.js.map +1 -1
  23. package/dist/esm/config/mapping.js +4 -0
  24. package/dist/esm/config/mapping.js.map +1 -1
  25. package/dist/esm/config/sources/dw-json-source.js +17 -4
  26. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  27. package/dist/esm/config/sources/env-source.js +2 -0
  28. package/dist/esm/config/sources/env-source.js.map +1 -1
  29. package/dist/esm/config/types.d.ts +14 -0
  30. package/dist/esm/discovery/patterns/storefront-next.js +6 -8
  31. package/dist/esm/discovery/patterns/storefront-next.js.map +1 -1
  32. package/dist/esm/docs/content-cache.d.ts +70 -0
  33. package/dist/esm/docs/content-cache.js +186 -0
  34. package/dist/esm/docs/content-cache.js.map +1 -0
  35. package/dist/esm/docs/index.d.ts +1 -0
  36. package/dist/esm/docs/index.js +2 -0
  37. package/dist/esm/docs/index.js.map +1 -1
  38. package/dist/esm/docs/search.js +34 -6
  39. package/dist/esm/docs/search.js.map +1 -1
  40. package/dist/esm/docs/types.d.ts +6 -1
  41. package/dist/esm/docs/types.js +1 -0
  42. package/dist/esm/docs/types.js.map +1 -1
  43. package/dist/esm/index.d.ts +2 -2
  44. package/dist/esm/index.js +1 -1
  45. package/dist/esm/index.js.map +1 -1
  46. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  47. package/dist/esm/operations/jobs/discover.js +87 -0
  48. package/dist/esm/operations/jobs/discover.js.map +1 -0
  49. package/dist/esm/operations/jobs/index.d.ts +2 -0
  50. package/dist/esm/operations/jobs/index.js +2 -0
  51. package/dist/esm/operations/jobs/index.js.map +1 -1
  52. package/dist/esm/operations/jobs/run.js +4 -3
  53. package/dist/esm/operations/jobs/run.js.map +1 -1
  54. package/package.json +6 -3
  55. package/specs/preferences-v1.yaml +2095 -0
  56. package/data/script-api/TopLevel.APIException.md +0 -119
  57. package/data/script-api/TopLevel.Array.md +0 -732
  58. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  59. package/data/script-api/TopLevel.BigInt.md +0 -154
  60. package/data/script-api/TopLevel.Boolean.md +0 -83
  61. package/data/script-api/TopLevel.ConversionError.md +0 -51
  62. package/data/script-api/TopLevel.DataView.md +0 -271
  63. package/data/script-api/TopLevel.Date.md +0 -688
  64. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  65. package/data/script-api/TopLevel.Error.md +0 -124
  66. package/data/script-api/TopLevel.EvalError.md +0 -47
  67. package/data/script-api/TopLevel.Fault.md +0 -133
  68. package/data/script-api/TopLevel.Float32Array.md +0 -186
  69. package/data/script-api/TopLevel.Float64Array.md +0 -186
  70. package/data/script-api/TopLevel.Function.md +0 -114
  71. package/data/script-api/TopLevel.Generator.md +0 -132
  72. package/data/script-api/TopLevel.IOError.md +0 -98
  73. package/data/script-api/TopLevel.Int16Array.md +0 -186
  74. package/data/script-api/TopLevel.Int32Array.md +0 -186
  75. package/data/script-api/TopLevel.Int8Array.md +0 -186
  76. package/data/script-api/TopLevel.InternalError.md +0 -47
  77. package/data/script-api/TopLevel.Iterable.md +0 -44
  78. package/data/script-api/TopLevel.Iterator.md +0 -89
  79. package/data/script-api/TopLevel.JSON.md +0 -173
  80. package/data/script-api/TopLevel.Map.md +0 -189
  81. package/data/script-api/TopLevel.Math.md +0 -948
  82. package/data/script-api/TopLevel.Module.md +0 -152
  83. package/data/script-api/TopLevel.Namespace.md +0 -152
  84. package/data/script-api/TopLevel.Number.md +0 -404
  85. package/data/script-api/TopLevel.Object.md +0 -472
  86. package/data/script-api/TopLevel.QName.md +0 -147
  87. package/data/script-api/TopLevel.RangeError.md +0 -47
  88. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  89. package/data/script-api/TopLevel.RegExp.md +0 -155
  90. package/data/script-api/TopLevel.Set.md +0 -150
  91. package/data/script-api/TopLevel.StopIteration.md +0 -36
  92. package/data/script-api/TopLevel.String.md +0 -1060
  93. package/data/script-api/TopLevel.Symbol.md +0 -196
  94. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  95. package/data/script-api/TopLevel.SystemError.md +0 -99
  96. package/data/script-api/TopLevel.TypeError.md +0 -47
  97. package/data/script-api/TopLevel.URIError.md +0 -47
  98. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  99. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  100. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  101. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  102. package/data/script-api/TopLevel.WeakMap.md +0 -135
  103. package/data/script-api/TopLevel.WeakSet.md +0 -96
  104. package/data/script-api/TopLevel.XML.md +0 -922
  105. package/data/script-api/TopLevel.XMLList.md +0 -418
  106. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  107. package/data/script-api/TopLevel.arguments.md +0 -56
  108. package/data/script-api/TopLevel.global.md +0 -539
  109. package/data/script-api/TopLevel.md +0 -58
  110. package/data/script-api/dw.alert.Alert.md +0 -175
  111. package/data/script-api/dw.alert.Alerts.md +0 -256
  112. package/data/script-api/dw.alert.md +0 -7
  113. package/data/script-api/dw.campaign.ABTest.md +0 -63
  114. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  115. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  116. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  117. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  118. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  119. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  120. package/data/script-api/dw.campaign.Campaign.md +0 -346
  121. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  122. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  123. package/data/script-api/dw.campaign.Coupon.md +0 -324
  124. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  125. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  126. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  127. package/data/script-api/dw.campaign.Discount.md +0 -271
  128. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  129. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  130. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  131. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  132. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  133. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  134. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  135. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  136. package/data/script-api/dw.campaign.Promotion.md +0 -939
  137. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  138. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  139. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  140. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  141. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  142. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  143. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  144. package/data/script-api/dw.campaign.md +0 -36
  145. package/data/script-api/dw.catalog.Catalog.md +0 -158
  146. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  147. package/data/script-api/dw.catalog.Category.md +0 -1212
  148. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  149. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  150. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  151. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  152. package/data/script-api/dw.catalog.Product.md +0 -2492
  153. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  154. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  155. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  156. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  157. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  158. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  159. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  160. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  161. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  162. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  163. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  164. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  165. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  166. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  167. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  168. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  169. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  170. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  171. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  172. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  173. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  174. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  175. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  176. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  177. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  178. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  179. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  180. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  181. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  182. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  183. package/data/script-api/dw.catalog.Store.md +0 -484
  184. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  185. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  186. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  187. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  188. package/data/script-api/dw.catalog.Variant.md +0 -1000
  189. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  190. package/data/script-api/dw.catalog.md +0 -50
  191. package/data/script-api/dw.content.Content.md +0 -481
  192. package/data/script-api/dw.content.ContentMgr.md +0 -147
  193. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  194. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  195. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  196. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  197. package/data/script-api/dw.content.Folder.md +0 -432
  198. package/data/script-api/dw.content.Library.md +0 -124
  199. package/data/script-api/dw.content.MarkupText.md +0 -150
  200. package/data/script-api/dw.content.MediaFile.md +0 -367
  201. package/data/script-api/dw.content.md +0 -15
  202. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  203. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  204. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  205. package/data/script-api/dw.crypto.Encoding.md +0 -193
  206. package/data/script-api/dw.crypto.JWE.md +0 -245
  207. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  208. package/data/script-api/dw.crypto.JWS.md +0 -260
  209. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  210. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  211. package/data/script-api/dw.crypto.Mac.md +0 -191
  212. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  213. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  214. package/data/script-api/dw.crypto.Signature.md +0 -241
  215. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  216. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  217. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  218. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  219. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  220. package/data/script-api/dw.crypto.md +0 -23
  221. package/data/script-api/dw.customer.AddressBook.md +0 -158
  222. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  223. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  224. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  225. package/data/script-api/dw.customer.Credentials.md +0 -524
  226. package/data/script-api/dw.customer.Customer.md +0 -488
  227. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  228. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  229. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  230. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  231. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  232. package/data/script-api/dw.customer.CustomerList.md +0 -76
  233. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  234. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  235. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  236. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  237. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  238. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  239. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  240. package/data/script-api/dw.customer.ProductList.md +0 -870
  241. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  242. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  243. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  244. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  245. package/data/script-api/dw.customer.Profile.md +0 -940
  246. package/data/script-api/dw.customer.Wallet.md +0 -136
  247. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  248. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  249. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  250. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  251. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  252. package/data/script-api/dw.customer.consent.md +0 -10
  253. package/data/script-api/dw.customer.md +0 -31
  254. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  255. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  256. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  257. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  258. package/data/script-api/dw.customer.oauth.md +0 -9
  259. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  260. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  261. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  262. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  263. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  264. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  265. package/data/script-api/dw.experience.Component.md +0 -166
  266. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  267. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  268. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  269. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  270. package/data/script-api/dw.experience.Page.md +0 -467
  271. package/data/script-api/dw.experience.PageMgr.md +0 -549
  272. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  273. package/data/script-api/dw.experience.Region.md +0 -119
  274. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  275. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  276. package/data/script-api/dw.experience.cms.md +0 -6
  277. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  278. package/data/script-api/dw.experience.image.Image.md +0 -101
  279. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  280. package/data/script-api/dw.experience.image.md +0 -8
  281. package/data/script-api/dw.experience.md +0 -16
  282. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  283. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  284. package/data/script-api/dw.extensions.applepay.md +0 -7
  285. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  286. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  287. package/data/script-api/dw.extensions.facebook.md +0 -7
  288. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  289. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  290. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  291. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  292. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  293. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  294. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  295. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  296. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  297. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  298. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  299. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  300. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  301. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  302. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  303. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  304. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  305. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  306. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  307. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  308. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  309. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  310. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  311. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  312. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  313. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  314. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  315. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  316. package/data/script-api/dw.extensions.payments.md +0 -28
  317. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  318. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  319. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  320. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  321. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  322. package/data/script-api/dw.extensions.pinterest.md +0 -10
  323. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  324. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  325. package/data/script-api/dw.io.File.md +0 -729
  326. package/data/script-api/dw.io.FileReader.md +0 -70
  327. package/data/script-api/dw.io.FileWriter.md +0 -159
  328. package/data/script-api/dw.io.InputStream.md +0 -35
  329. package/data/script-api/dw.io.OutputStream.md +0 -38
  330. package/data/script-api/dw.io.PrintWriter.md +0 -66
  331. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  332. package/data/script-api/dw.io.Reader.md +0 -284
  333. package/data/script-api/dw.io.StringWriter.md +0 -89
  334. package/data/script-api/dw.io.Writer.md +0 -96
  335. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  336. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  337. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  338. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  339. package/data/script-api/dw.io.md +0 -21
  340. package/data/script-api/dw.job.JobExecution.md +0 -111
  341. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  342. package/data/script-api/dw.job.md +0 -7
  343. package/data/script-api/dw.net.FTPClient.md +0 -621
  344. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  345. package/data/script-api/dw.net.HTTPClient.md +0 -775
  346. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  347. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  348. package/data/script-api/dw.net.Mail.md +0 -487
  349. package/data/script-api/dw.net.SFTPClient.md +0 -535
  350. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  351. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  352. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  353. package/data/script-api/dw.net.md +0 -15
  354. package/data/script-api/dw.object.ActiveData.md +0 -86
  355. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  356. package/data/script-api/dw.object.CustomObject.md +0 -82
  357. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  358. package/data/script-api/dw.object.Extensible.md +0 -71
  359. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  360. package/data/script-api/dw.object.Note.md +0 -118
  361. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  362. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  363. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  364. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  365. package/data/script-api/dw.object.PersistentObject.md +0 -92
  366. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  367. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  368. package/data/script-api/dw.object.md +0 -19
  369. package/data/script-api/dw.order.AbstractItem.md +0 -220
  370. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  371. package/data/script-api/dw.order.Appeasement.md +0 -398
  372. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  373. package/data/script-api/dw.order.Basket.md +0 -868
  374. package/data/script-api/dw.order.BasketMgr.md +0 -673
  375. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  376. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  377. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  378. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  379. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  380. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  381. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  382. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  383. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  384. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  385. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  386. package/data/script-api/dw.order.Invoice.md +0 -571
  387. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  388. package/data/script-api/dw.order.LineItem.md +0 -577
  389. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  390. package/data/script-api/dw.order.LineItemTax.md +0 -142
  391. package/data/script-api/dw.order.Order.md +0 -2770
  392. package/data/script-api/dw.order.OrderAddress.md +0 -624
  393. package/data/script-api/dw.order.OrderItem.md +0 -613
  394. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  395. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  396. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  397. package/data/script-api/dw.order.PaymentCard.md +0 -220
  398. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  399. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  400. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  401. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  402. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  403. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  404. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  405. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  406. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  407. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  408. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  409. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  410. package/data/script-api/dw.order.Return.md +0 -396
  411. package/data/script-api/dw.order.ReturnCase.md +0 -463
  412. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  413. package/data/script-api/dw.order.ReturnItem.md +0 -335
  414. package/data/script-api/dw.order.Shipment.md +0 -1132
  415. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  416. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  417. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  418. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  419. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  420. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  421. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  422. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  423. package/data/script-api/dw.order.SumItem.md +0 -158
  424. package/data/script-api/dw.order.TaxGroup.md +0 -128
  425. package/data/script-api/dw.order.TaxItem.md +0 -74
  426. package/data/script-api/dw.order.TaxMgr.md +0 -314
  427. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  428. package/data/script-api/dw.order.TrackingRef.md +0 -108
  429. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  430. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  431. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  432. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  433. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  434. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  435. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  436. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  437. package/data/script-api/dw.order.hooks.md +0 -13
  438. package/data/script-api/dw.order.md +0 -65
  439. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  440. package/data/script-api/dw.rpc.Stub.md +0 -373
  441. package/data/script-api/dw.rpc.WebReference.md +0 -133
  442. package/data/script-api/dw.rpc.md +0 -8
  443. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  444. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  445. package/data/script-api/dw.sitemap.md +0 -7
  446. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  447. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  448. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  449. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  450. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  451. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  452. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  453. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  454. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  455. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  456. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  457. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  458. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  459. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  460. package/data/script-api/dw.suggest.md +0 -19
  461. package/data/script-api/dw.svc.FTPService.md +0 -140
  462. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  463. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  464. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  465. package/data/script-api/dw.svc.HTTPService.md +0 -370
  466. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  467. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  468. package/data/script-api/dw.svc.Result.md +0 -320
  469. package/data/script-api/dw.svc.SOAPService.md +0 -104
  470. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  471. package/data/script-api/dw.svc.Service.md +0 -276
  472. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  473. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  474. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  475. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  476. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  477. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  478. package/data/script-api/dw.svc.md +0 -22
  479. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  480. package/data/script-api/dw.system.Cache.md +0 -126
  481. package/data/script-api/dw.system.CacheMgr.md +0 -70
  482. package/data/script-api/dw.system.HookMgr.md +0 -78
  483. package/data/script-api/dw.system.InternalObject.md +0 -47
  484. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  485. package/data/script-api/dw.system.Log.md +0 -198
  486. package/data/script-api/dw.system.LogNDC.md +0 -75
  487. package/data/script-api/dw.system.Logger.md +0 -216
  488. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  489. package/data/script-api/dw.system.Pipeline.md +0 -94
  490. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  491. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  492. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  493. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  494. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  495. package/data/script-api/dw.system.Request.md +0 -785
  496. package/data/script-api/dw.system.RequestHooks.md +0 -112
  497. package/data/script-api/dw.system.Response.md +0 -612
  498. package/data/script-api/dw.system.SearchStatus.md +0 -187
  499. package/data/script-api/dw.system.Session.md +0 -469
  500. package/data/script-api/dw.system.Site.md +0 -570
  501. package/data/script-api/dw.system.SitePreferences.md +0 -90
  502. package/data/script-api/dw.system.Status.md +0 -330
  503. package/data/script-api/dw.system.StatusItem.md +0 -273
  504. package/data/script-api/dw.system.System.md +0 -224
  505. package/data/script-api/dw.system.Transaction.md +0 -107
  506. package/data/script-api/dw.system.md +0 -32
  507. package/data/script-api/dw.template.ISML.md +0 -127
  508. package/data/script-api/dw.template.Velocity.md +0 -168
  509. package/data/script-api/dw.template.md +0 -7
  510. package/data/script-api/dw.util.ArrayList.md +0 -99
  511. package/data/script-api/dw.util.Assert.md +0 -370
  512. package/data/script-api/dw.util.BigInteger.md +0 -283
  513. package/data/script-api/dw.util.Bytes.md +0 -278
  514. package/data/script-api/dw.util.Calendar.md +0 -1051
  515. package/data/script-api/dw.util.Collection.md +0 -272
  516. package/data/script-api/dw.util.Currency.md +0 -147
  517. package/data/script-api/dw.util.DateUtils.md +0 -82
  518. package/data/script-api/dw.util.Decimal.md +0 -386
  519. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  520. package/data/script-api/dw.util.Geolocation.md +0 -293
  521. package/data/script-api/dw.util.HashMap.md +0 -50
  522. package/data/script-api/dw.util.HashSet.md +0 -65
  523. package/data/script-api/dw.util.Iterator.md +0 -86
  524. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  525. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  526. package/data/script-api/dw.util.List.md +0 -429
  527. package/data/script-api/dw.util.Locale.md +0 -277
  528. package/data/script-api/dw.util.Map.md +0 -251
  529. package/data/script-api/dw.util.MapEntry.md +0 -68
  530. package/data/script-api/dw.util.MappingKey.md +0 -96
  531. package/data/script-api/dw.util.MappingMgr.md +0 -113
  532. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  533. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  534. package/data/script-api/dw.util.SecureFilter.md +0 -572
  535. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  536. package/data/script-api/dw.util.Set.md +0 -39
  537. package/data/script-api/dw.util.SortedMap.md +0 -148
  538. package/data/script-api/dw.util.SortedSet.md +0 -173
  539. package/data/script-api/dw.util.StringUtils.md +0 -655
  540. package/data/script-api/dw.util.Template.md +0 -141
  541. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  542. package/data/script-api/dw.util.md +0 -37
  543. package/data/script-api/dw.value.EnumValue.md +0 -105
  544. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  545. package/data/script-api/dw.value.Money.md +0 -526
  546. package/data/script-api/dw.value.Quantity.md +0 -299
  547. package/data/script-api/dw.value.md +0 -9
  548. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  549. package/data/script-api/dw.web.ClickStream.md +0 -177
  550. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  551. package/data/script-api/dw.web.Cookie.md +0 -431
  552. package/data/script-api/dw.web.Cookies.md +0 -59
  553. package/data/script-api/dw.web.Form.md +0 -84
  554. package/data/script-api/dw.web.FormAction.md +0 -195
  555. package/data/script-api/dw.web.FormElement.md +0 -211
  556. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  557. package/data/script-api/dw.web.FormField.md +0 -642
  558. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  559. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  560. package/data/script-api/dw.web.FormGroup.md +0 -222
  561. package/data/script-api/dw.web.FormList.md +0 -134
  562. package/data/script-api/dw.web.FormListItem.md +0 -57
  563. package/data/script-api/dw.web.Forms.md +0 -25
  564. package/data/script-api/dw.web.HttpParameter.md +0 -462
  565. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  566. package/data/script-api/dw.web.LoopIterator.md +0 -231
  567. package/data/script-api/dw.web.PageMetaData.md +0 -197
  568. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  569. package/data/script-api/dw.web.PagingModel.md +0 -407
  570. package/data/script-api/dw.web.Resource.md +0 -147
  571. package/data/script-api/dw.web.URL.md +0 -174
  572. package/data/script-api/dw.web.URLAction.md +0 -95
  573. package/data/script-api/dw.web.URLParameter.md +0 -52
  574. package/data/script-api/dw.web.URLRedirect.md +0 -72
  575. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  576. package/data/script-api/dw.web.URLUtils.md +0 -1357
  577. package/data/script-api/dw.web.md +0 -34
  578. package/data/script-api/dw.ws.Port.md +0 -126
  579. package/data/script-api/dw.ws.WSUtil.md +0 -728
  580. package/data/script-api/dw.ws.WebReference2.md +0 -137
  581. package/data/script-api/dw.ws.md +0 -8
  582. package/data/script-api/index.md +0 -40
@@ -1,478 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class XMLStreamWriter
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.io.XMLStreamWriter](dw.io.XMLStreamWriter.md)
6
-
7
- The XMLStreamWriter can be used to write small and large XML feeds.
8
-
9
-
10
- **Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
11
-
12
-
13
-
14
- The XMLStreamWriter does not perform well-formedness checking on its input.
15
- However the writeCharacters method escapes '&' , '<' and '>'. For attribute
16
- values the writeAttribute method escapes the above characters plus '"' to
17
- ensure that all character content and attribute values are well formed.
18
-
19
-
20
- The following example illustrates how to use this class:
21
-
22
-
23
- ```
24
- var fileWriter : FileWriter = new FileWriter(file, "UTF-8");
25
- var xsw : XMLStreamWriter = new XMLStreamWriter(fileWriter);
26
-
27
- xsw.writeStartDocument();
28
- xsw.writeStartElement("products");
29
- xsw.writeStartElement("product");
30
- xsw.writeAttribute("id", "p42");
31
- xsw.writeStartElement("name");
32
- xsw.writeCharacters("blue t-shirt");
33
- xsw.writeEndElement();
34
- xsw.writeStartElement("rating");
35
- xsw.writeCharacters("2.0");
36
- xsw.writeEndElement();
37
- xsw.writeEndElement();
38
- xsw.writeEndElement();
39
- xsw.writeEndDocument();
40
-
41
- xsw.close();
42
- fileWriter.close();
43
- ```
44
-
45
-
46
-
47
-
48
-
49
- The code above will write the following to file:
50
-
51
-
52
- ```
53
- <?xml version="1.0" ?>
54
- <products>
55
- <product id="p42">
56
- <name>a blue t-shirt</name>
57
- <rating>2.0</rating>
58
- </product>
59
- </products>
60
- ```
61
-
62
-
63
- Note: This output has been formatted for readability. See
64
- [XMLIndentingStreamWriter](dw.io.XMLIndentingStreamWriter.md).
65
-
66
-
67
-
68
- ## All Known Subclasses
69
- [XMLIndentingStreamWriter](dw.io.XMLIndentingStreamWriter.md)
70
- ## Property Summary
71
-
72
- | Property | Description |
73
- | --- | --- |
74
- | [defaultNamespace](#defaultnamespace): [String](TopLevel.String.md) | Returns the current default name space. |
75
-
76
- ## Constructor Summary
77
-
78
- | Constructor | Description |
79
- | --- | --- |
80
- | [XMLStreamWriter](#xmlstreamwriterwriter)([Writer](dw.io.Writer.md)) | Constructs the XMLStreamWriter for a writer. |
81
-
82
- ## Method Summary
83
-
84
- | Method | Description |
85
- | --- | --- |
86
- | [close](dw.io.XMLStreamWriter.md#close)() | Close this writer and free any resources associated with the writer. |
87
- | [flush](dw.io.XMLStreamWriter.md#flush)() | Write any cached data to the underlying output mechanism. |
88
- | [getDefaultNamespace](dw.io.XMLStreamWriter.md#getdefaultnamespace)() | Returns the current default name space. |
89
- | [getPrefix](dw.io.XMLStreamWriter.md#getprefixstring)([String](TopLevel.String.md)) | Gets the prefix the URI is bound to. |
90
- | [setDefaultNamespace](dw.io.XMLStreamWriter.md#setdefaultnamespacestring)([String](TopLevel.String.md)) | Binds a URI to the default namespace. |
91
- | [setPrefix](dw.io.XMLStreamWriter.md#setprefixstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Sets the prefix the uri is bound to. |
92
- | [writeAttribute](dw.io.XMLStreamWriter.md#writeattributestring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes an attribute to the output stream without a prefix. |
93
- | [writeAttribute](dw.io.XMLStreamWriter.md#writeattributestring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes an attribute to the output stream. |
94
- | [writeAttribute](dw.io.XMLStreamWriter.md#writeattributestring-string-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes an attribute to the output stream. |
95
- | [writeCData](dw.io.XMLStreamWriter.md#writecdatastring)([String](TopLevel.String.md)) | Writes a CData section. |
96
- | [writeCharacters](dw.io.XMLStreamWriter.md#writecharactersstring)([String](TopLevel.String.md)) | Write text to the output. |
97
- | [writeComment](dw.io.XMLStreamWriter.md#writecommentstring)([String](TopLevel.String.md)) | Writes an XML comment with the data enclosed. |
98
- | [writeDTD](dw.io.XMLStreamWriter.md#writedtdstring)([String](TopLevel.String.md)) | Write a DTD section. |
99
- | [writeDefaultNamespace](dw.io.XMLStreamWriter.md#writedefaultnamespacestring)([String](TopLevel.String.md)) | Writes the default namespace to the stream. |
100
- | [writeEmptyElement](dw.io.XMLStreamWriter.md#writeemptyelementstring)([String](TopLevel.String.md)) | Writes an empty element tag to the output. |
101
- | [writeEmptyElement](dw.io.XMLStreamWriter.md#writeemptyelementstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes an empty element tag to the output. |
102
- | [writeEmptyElement](dw.io.XMLStreamWriter.md#writeemptyelementstring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes an empty element tag to the output. |
103
- | [writeEndDocument](dw.io.XMLStreamWriter.md#writeenddocument)() | Closes any start tags and writes corresponding end tags. |
104
- | [writeEndElement](dw.io.XMLStreamWriter.md#writeendelement)() | Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event. |
105
- | [writeEntityRef](dw.io.XMLStreamWriter.md#writeentityrefstring)([String](TopLevel.String.md)) | Writes an entity reference. |
106
- | [writeNamespace](dw.io.XMLStreamWriter.md#writenamespacestring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes a namespace to the output stream. |
107
- | [writeProcessingInstruction](dw.io.XMLStreamWriter.md#writeprocessinginstructionstring)([String](TopLevel.String.md)) | Writes a processing instruction. |
108
- | [writeProcessingInstruction](dw.io.XMLStreamWriter.md#writeprocessinginstructionstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes a processing instruction. |
109
- | [writeRaw](dw.io.XMLStreamWriter.md#writerawstring)([String](TopLevel.String.md)) | Writes the given string directly into the output stream. |
110
- | [writeStartDocument](dw.io.XMLStreamWriter.md#writestartdocument)() | Write the XML Declaration. |
111
- | [writeStartDocument](dw.io.XMLStreamWriter.md#writestartdocumentstring)([String](TopLevel.String.md)) | Write the XML Declaration. |
112
- | [writeStartDocument](dw.io.XMLStreamWriter.md#writestartdocumentstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Write the XML Declaration. |
113
- | [writeStartElement](dw.io.XMLStreamWriter.md#writestartelementstring)([String](TopLevel.String.md)) | Writes a start tag to the output. |
114
- | [writeStartElement](dw.io.XMLStreamWriter.md#writestartelementstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes a start tag to the output. |
115
- | [writeStartElement](dw.io.XMLStreamWriter.md#writestartelementstring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Writes a start tag to the output. |
116
-
117
- ### Methods inherited from class Object
118
-
119
- [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)
120
- ## Property Details
121
-
122
- ### defaultNamespace
123
- - defaultNamespace: [String](TopLevel.String.md)
124
- - : Returns the current default name space.
125
-
126
-
127
- ---
128
-
129
- ## Constructor Details
130
-
131
- ### XMLStreamWriter(Writer)
132
- - XMLStreamWriter(writer: [Writer](dw.io.Writer.md))
133
- - : Constructs the XMLStreamWriter for a writer.
134
-
135
- **Parameters:**
136
- - writer - the writer for which the XMLStreamWriter is constructed.
137
-
138
-
139
- ---
140
-
141
- ## Method Details
142
-
143
- ### close()
144
- - close(): void
145
- - : Close this writer and free any resources associated with the
146
- writer. This method does not close the underlying writer.
147
-
148
-
149
-
150
- ---
151
-
152
- ### flush()
153
- - flush(): void
154
- - : Write any cached data to the underlying output mechanism.
155
-
156
-
157
- ---
158
-
159
- ### getDefaultNamespace()
160
- - getDefaultNamespace(): [String](TopLevel.String.md)
161
- - : Returns the current default name space.
162
-
163
- **Returns:**
164
- - the current default name space.
165
-
166
-
167
- ---
168
-
169
- ### getPrefix(String)
170
- - getPrefix(uri: [String](TopLevel.String.md)): [String](TopLevel.String.md)
171
- - : Gets the prefix the URI is bound to.
172
-
173
- **Parameters:**
174
- - uri - the URI to use.
175
-
176
- **Returns:**
177
- - the prefix or null.
178
-
179
-
180
- ---
181
-
182
- ### setDefaultNamespace(String)
183
- - setDefaultNamespace(uri: [String](TopLevel.String.md)): void
184
- - : Binds a URI to the default namespace.
185
- This URI is bound
186
- in the scope of the current START\_ELEMENT / END\_ELEMENT pair.
187
- If this method is called before a START\_ELEMENT has been written
188
- the uri is bound in the root scope.
189
-
190
-
191
- **Parameters:**
192
- - uri - the uri to bind to the default namespace, may be null.
193
-
194
-
195
- ---
196
-
197
- ### setPrefix(String, String)
198
- - setPrefix(prefix: [String](TopLevel.String.md), uri: [String](TopLevel.String.md)): void
199
- - : Sets the prefix the uri is bound to. This prefix is bound
200
- in the scope of the current START\_ELEMENT / END\_ELEMENT pair.
201
- If this method is called before a START\_ELEMENT has been written
202
- the prefix is bound in the root scope.
203
-
204
-
205
- **Parameters:**
206
- - prefix - the prefix to bind to the uri, may not be null.
207
- - uri - the uri to bind to the prefix, may be null.
208
-
209
-
210
- ---
211
-
212
- ### writeAttribute(String, String)
213
- - writeAttribute(localName: [String](TopLevel.String.md), value: [String](TopLevel.String.md)): void
214
- - : Writes an attribute to the output stream without
215
- a prefix.
216
-
217
-
218
- **Parameters:**
219
- - localName - the local name of the attribute.
220
- - value - the value of the attribute.
221
-
222
-
223
- ---
224
-
225
- ### writeAttribute(String, String, String)
226
- - writeAttribute(namespaceURI: [String](TopLevel.String.md), localName: [String](TopLevel.String.md), value: [String](TopLevel.String.md)): void
227
- - : Writes an attribute to the output stream.
228
-
229
- **Parameters:**
230
- - namespaceURI - the uri of the prefix for this attribute.
231
- - localName - the local name of the attribute.
232
- - value - the value of the attribute.
233
-
234
-
235
- ---
236
-
237
- ### writeAttribute(String, String, String, String)
238
- - writeAttribute(prefix: [String](TopLevel.String.md), namespaceURI: [String](TopLevel.String.md), localName: [String](TopLevel.String.md), value: [String](TopLevel.String.md)): void
239
- - : Writes an attribute to the output stream.
240
-
241
- **Parameters:**
242
- - prefix - the prefix for this attribute.
243
- - namespaceURI - the uri of the prefix for this attribute.
244
- - localName - the local name of the attribute.
245
- - value - the value of the attribute.
246
-
247
-
248
- ---
249
-
250
- ### writeCData(String)
251
- - writeCData(data: [String](TopLevel.String.md)): void
252
- - : Writes a CData section.
253
-
254
- **Parameters:**
255
- - data - the data contained in the CData Section, may not be null.
256
-
257
-
258
- ---
259
-
260
- ### writeCharacters(String)
261
- - writeCharacters(text: [String](TopLevel.String.md)): void
262
- - : Write text to the output.
263
-
264
- **Parameters:**
265
- - text - the value to write.
266
-
267
-
268
- ---
269
-
270
- ### writeComment(String)
271
- - writeComment(data: [String](TopLevel.String.md)): void
272
- - : Writes an XML comment with the data enclosed.
273
-
274
- **Parameters:**
275
- - data - the data contained in the comment, may be null.
276
-
277
-
278
- ---
279
-
280
- ### writeDTD(String)
281
- - writeDTD(dtd: [String](TopLevel.String.md)): void
282
- - : Write a DTD section. This string represents the entire doctypedecl production
283
- from the XML 1.0 specification.
284
-
285
-
286
- **Parameters:**
287
- - dtd - the DTD to be written.
288
-
289
-
290
- ---
291
-
292
- ### writeDefaultNamespace(String)
293
- - writeDefaultNamespace(namespaceURI: [String](TopLevel.String.md)): void
294
- - : Writes the default namespace to the stream.
295
-
296
- **Parameters:**
297
- - namespaceURI - the uri to bind the default namespace to.
298
-
299
-
300
- ---
301
-
302
- ### writeEmptyElement(String)
303
- - writeEmptyElement(localName: [String](TopLevel.String.md)): void
304
- - : Writes an empty element tag to the output.
305
-
306
- **Parameters:**
307
- - localName - local name of the tag, may not be null.
308
-
309
-
310
- ---
311
-
312
- ### writeEmptyElement(String, String)
313
- - writeEmptyElement(namespaceURI: [String](TopLevel.String.md), localName: [String](TopLevel.String.md)): void
314
- - : Writes an empty element tag to the output.
315
-
316
- **Parameters:**
317
- - namespaceURI - the uri to bind the tag to, may not be null.
318
- - localName - local name of the tag, may not be null.
319
-
320
-
321
- ---
322
-
323
- ### writeEmptyElement(String, String, String)
324
- - writeEmptyElement(prefix: [String](TopLevel.String.md), localName: [String](TopLevel.String.md), namespaceURI: [String](TopLevel.String.md)): void
325
- - : Writes an empty element tag to the output.
326
-
327
- **Parameters:**
328
- - prefix - the prefix of the tag, may not be null.
329
- - localName - local name of the tag, may not be null.
330
- - namespaceURI - the uri to bind the tag to, may not be null.
331
-
332
-
333
- ---
334
-
335
- ### writeEndDocument()
336
- - writeEndDocument(): void
337
- - : Closes any start tags and writes corresponding end tags.
338
-
339
-
340
- ---
341
-
342
- ### writeEndElement()
343
- - writeEndElement(): void
344
- - : Writes an end tag to the output relying on the internal
345
- state of the writer to determine the prefix and local name
346
- of the event.
347
-
348
-
349
-
350
- ---
351
-
352
- ### writeEntityRef(String)
353
- - writeEntityRef(name: [String](TopLevel.String.md)): void
354
- - : Writes an entity reference.
355
-
356
- **Parameters:**
357
- - name - the name of the entity.
358
-
359
-
360
- ---
361
-
362
- ### writeNamespace(String, String)
363
- - writeNamespace(prefix: [String](TopLevel.String.md), namespaceURI: [String](TopLevel.String.md)): void
364
- - : Writes a namespace to the output stream.
365
- If the prefix argument to this method is the empty string,
366
- "xmlns", or null this method will delegate to writeDefaultNamespace.
367
-
368
-
369
- **Parameters:**
370
- - prefix - the prefix to bind this namespace to.
371
- - namespaceURI - the uri to bind the prefix to.
372
-
373
-
374
- ---
375
-
376
- ### writeProcessingInstruction(String)
377
- - writeProcessingInstruction(target: [String](TopLevel.String.md)): void
378
- - : Writes a processing instruction.
379
-
380
- **Parameters:**
381
- - target - the target of the processing instruction, may not be null.
382
-
383
-
384
- ---
385
-
386
- ### writeProcessingInstruction(String, String)
387
- - writeProcessingInstruction(target: [String](TopLevel.String.md), data: [String](TopLevel.String.md)): void
388
- - : Writes a processing instruction.
389
-
390
- **Parameters:**
391
- - target - the target of the processing instruction, may not be null.
392
- - data - the data contained in the processing instruction, may not be null.
393
-
394
-
395
- ---
396
-
397
- ### writeRaw(String)
398
- - writeRaw(raw: [String](TopLevel.String.md)): void
399
- - : Writes the given string directly into the output stream. No checks
400
- regarding the correctness of the XML are done. The caller must ensure
401
- that the final result is a correct XML.
402
-
403
-
404
- **Parameters:**
405
- - raw - the string to write to the output stream.
406
-
407
-
408
- ---
409
-
410
- ### writeStartDocument()
411
- - writeStartDocument(): void
412
- - : Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8
413
-
414
-
415
- ---
416
-
417
- ### writeStartDocument(String)
418
- - writeStartDocument(version: [String](TopLevel.String.md)): void
419
- - : Write the XML Declaration. Defaults the XML version to 1.0
420
-
421
- **Parameters:**
422
- - version - version of the xml document.
423
-
424
-
425
- ---
426
-
427
- ### writeStartDocument(String, String)
428
- - writeStartDocument(encoding: [String](TopLevel.String.md), version: [String](TopLevel.String.md)): void
429
- - : Write the XML Declaration. Note that the encoding parameter does
430
- not set the actual encoding of the underlying output. That must
431
- be set when the instance of the XMLStreamWriter is created using the
432
- XMLOutputFactory.
433
-
434
-
435
- **Parameters:**
436
- - encoding - encoding of the xml declaration.
437
- - version - version of the xml document.
438
-
439
-
440
- ---
441
-
442
- ### writeStartElement(String)
443
- - writeStartElement(localName: [String](TopLevel.String.md)): void
444
- - : Writes a start tag to the output. All writeStartElement methods
445
- open a new scope in the internal namespace context. Writing the
446
- corresponding EndElement causes the scope to be closed.
447
-
448
-
449
- **Parameters:**
450
- - localName - local name of the tag, may not be null.
451
-
452
-
453
- ---
454
-
455
- ### writeStartElement(String, String)
456
- - writeStartElement(namespaceURI: [String](TopLevel.String.md), localName: [String](TopLevel.String.md)): void
457
- - : Writes a start tag to the output.
458
-
459
- **Parameters:**
460
- - namespaceURI - the namespaceURI of the prefix to use, may not be null.
461
- - localName - local name of the tag, may not be null.
462
-
463
-
464
- ---
465
-
466
- ### writeStartElement(String, String, String)
467
- - writeStartElement(prefix: [String](TopLevel.String.md), localName: [String](TopLevel.String.md), namespaceURI: [String](TopLevel.String.md)): void
468
- - : Writes a start tag to the output.
469
-
470
- **Parameters:**
471
- - prefix - the prefix of the tag, may not be null.
472
- - localName - local name of the tag, may not be null.
473
- - namespaceURI - the uri to bind the prefix to, may not be null.
474
-
475
-
476
- ---
477
-
478
- <!-- prettier-ignore-end -->
@@ -1,21 +0,0 @@
1
- # Package dw.io
2
-
3
- ## Classes
4
- | Class | Description |
5
- | --- | --- |
6
- | [CSVStreamReader](dw.io.CSVStreamReader.md) | The class supports reading a CSV file. |
7
- | [CSVStreamWriter](dw.io.CSVStreamWriter.md) | The class writes a CSV file. |
8
- | [File](dw.io.File.md) | Represents a file resource accessible from scripting. |
9
- | [FileReader](dw.io.FileReader.md) | File reader class. |
10
- | [FileWriter](dw.io.FileWriter.md) | Convenience class for writing character files. |
11
- | [InputStream](dw.io.InputStream.md) | The class represent a stream of bytes that can be read from the application. |
12
- | [OutputStream](dw.io.OutputStream.md) | The class represent a stream of bytes that can be written from the application. |
13
- | [PrintWriter](dw.io.PrintWriter.md) | Template output stream writer. |
14
- | [RandomAccessFileReader](dw.io.RandomAccessFileReader.md) | Instances of this class support reading from a random access file. |
15
- | [Reader](dw.io.Reader.md) | The class supports reading characters from a stream. |
16
- | [StringWriter](dw.io.StringWriter.md) | A Writer that can be used to generate a String. |
17
- | [Writer](dw.io.Writer.md) | The class supports writing characters to a stream. |
18
- | [XMLIndentingStreamWriter](dw.io.XMLIndentingStreamWriter.md) | A XMLIndentingStreamWriter writes the XML output formatted for good readability. |
19
- | [XMLStreamConstants](dw.io.XMLStreamConstants.md) | Useful constants for working with XML streams. |
20
- | [XMLStreamReader](dw.io.XMLStreamReader.md) | The XMLStreamReader allows forward, read-only access to XML. |
21
- | [XMLStreamWriter](dw.io.XMLStreamWriter.md) | The XMLStreamWriter can be used to write small and large XML feeds. |
@@ -1,111 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class JobExecution
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.job.JobExecution](dw.job.JobExecution.md)
6
-
7
- Represents an execution of a job. The job execution can be accessed from a [JobStepExecution](dw.job.JobStepExecution.md) via
8
- [JobStepExecution.getJobExecution()](dw.job.JobStepExecution.md#getjobexecution). If a pipeline is used to implement a step the step execution is available
9
- in the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step the step
10
- execution is available as the second parameter of the module's function that is used to execute the step, e.g.:
11
-
12
-
13
- ```
14
- ...
15
- exports.execute( parameters, stepExecution)
16
- {
17
- ...
18
- var jobExecution = stepExecution.getJobExecution();
19
- ...
20
- }
21
- ...
22
- ```
23
-
24
-
25
-
26
- ## Property Summary
27
-
28
- | Property | Description |
29
- | --- | --- |
30
- | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of this job execution. |
31
- | [context](#context): [Map](dw.util.Map.md) `(read-only)` | Returns the job context which can be used to share data between steps. |
32
- | [jobID](#jobid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the job this job execution belongs to. |
33
-
34
- ## Constructor Summary
35
-
36
- This class does not have a constructor, so you cannot create it directly.
37
- ## Method Summary
38
-
39
- | Method | Description |
40
- | --- | --- |
41
- | [getContext](dw.job.JobExecution.md#getcontext)() | Returns the job context which can be used to share data between steps. |
42
- | [getID](dw.job.JobExecution.md#getid)() | Returns the ID of this job execution. |
43
- | [getJobID](dw.job.JobExecution.md#getjobid)() | Returns the ID of the job this job execution belongs to. |
44
-
45
- ### Methods inherited from class Object
46
-
47
- [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)
48
- ## Property Details
49
-
50
- ### ID
51
- - ID: [String](TopLevel.String.md) `(read-only)`
52
- - : Returns the ID of this job execution.
53
-
54
-
55
- ---
56
-
57
- ### context
58
- - context: [Map](dw.util.Map.md) `(read-only)`
59
- - : Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the
60
- job context should only be used when necessary and with caution. If two steps which are running in parallel in
61
- the same job store data in the job context using the same key the result is undefined. Don't add any complex data
62
- to the job context since only simple data types are supported (for example, String and Integer).
63
-
64
-
65
-
66
- ---
67
-
68
- ### jobID
69
- - jobID: [String](TopLevel.String.md) `(read-only)`
70
- - : Returns the ID of the job this job execution belongs to.
71
-
72
-
73
- ---
74
-
75
- ## Method Details
76
-
77
- ### getContext()
78
- - getContext(): [Map](dw.util.Map.md)
79
- - : Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the
80
- job context should only be used when necessary and with caution. If two steps which are running in parallel in
81
- the same job store data in the job context using the same key the result is undefined. Don't add any complex data
82
- to the job context since only simple data types are supported (for example, String and Integer).
83
-
84
-
85
- **Returns:**
86
- - the map that represents the job context.
87
-
88
-
89
- ---
90
-
91
- ### getID()
92
- - getID(): [String](TopLevel.String.md)
93
- - : Returns the ID of this job execution.
94
-
95
- **Returns:**
96
- - the ID of this job execution.
97
-
98
-
99
- ---
100
-
101
- ### getJobID()
102
- - getJobID(): [String](TopLevel.String.md)
103
- - : Returns the ID of the job this job execution belongs to.
104
-
105
- **Returns:**
106
- - the ID of the job this job execution belongs to.
107
-
108
-
109
- ---
110
-
111
- <!-- prettier-ignore-end -->