@salesforce/b2c-tooling-sdk 1.16.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (185) hide show
  1. package/data/content-schemas/componenttype.json +79 -17
  2. package/data/content-schemas/pagetype.json +4 -0
  3. package/data/content-schemas/regiondefinition.json +1 -0
  4. package/data/guides/enrichment.json +11264 -0
  5. package/data/guides/index.json +15166 -0
  6. package/data/job-steps/CatalogDeltaExport.md +31 -0
  7. package/data/job-steps/CreateSitemap.md +22 -0
  8. package/data/job-steps/CustomerListsDeltaExport.md +30 -0
  9. package/data/job-steps/DownloadActiveDataFromStorage.md +24 -0
  10. package/data/job-steps/ExecuteCategorizationRules.md +25 -0
  11. package/data/job-steps/ExecuteDataReplication.md +24 -0
  12. package/data/job-steps/ExecutePipeline.md +24 -0
  13. package/data/job-steps/ExecutePreconfiguredCodeReplicationProcess.md +24 -0
  14. package/data/job-steps/ExecutePreconfiguredDataReplicationProcess.md +24 -0
  15. package/data/job-steps/ExecuteScriptModule.md +27 -0
  16. package/data/job-steps/ExportABTests.md +30 -0
  17. package/data/job-steps/ExportAssignments.md +30 -0
  18. package/data/job-steps/ExportCatalog.md +37 -0
  19. package/data/job-steps/ExportContent.md +31 -0
  20. package/data/job-steps/ExportContentSlots.md +30 -0
  21. package/data/job-steps/ExportCouponCodes.md +33 -0
  22. package/data/job-steps/ExportCoupons.md +30 -0
  23. package/data/job-steps/ExportCustomObjects.md +31 -0
  24. package/data/job-steps/ExportCustomerGroups.md +30 -0
  25. package/data/job-steps/ExportCustomerList.md +31 -0
  26. package/data/job-steps/ExportCustomers.md +30 -0
  27. package/data/job-steps/ExportFacebookFeed.md +26 -0
  28. package/data/job-steps/ExportGiftCertificates.md +30 -0
  29. package/data/job-steps/ExportInventoryLists.md +31 -0
  30. package/data/job-steps/ExportMetaData.md +32 -0
  31. package/data/job-steps/ExportOrders.md +42 -0
  32. package/data/job-steps/ExportPageLocalization.md +34 -0
  33. package/data/job-steps/ExportPriceBook.md +31 -0
  34. package/data/job-steps/ExportProductLists.md +34 -0
  35. package/data/job-steps/ExportPromotions.md +30 -0
  36. package/data/job-steps/ExportShippingMethods.md +30 -0
  37. package/data/job-steps/ExportSourceCodeGroups.md +30 -0
  38. package/data/job-steps/ExportStores.md +31 -0
  39. package/data/job-steps/ExportTaxTable.md +30 -0
  40. package/data/job-steps/ImportABTests.md +34 -0
  41. package/data/job-steps/ImportActiveData.md +33 -0
  42. package/data/job-steps/ImportAssignments.md +34 -0
  43. package/data/job-steps/ImportCatalog.md +34 -0
  44. package/data/job-steps/ImportContent.md +34 -0
  45. package/data/job-steps/ImportContentSlots.md +34 -0
  46. package/data/job-steps/ImportCouponCodeRedemptions.md +34 -0
  47. package/data/job-steps/ImportCoupons.md +34 -0
  48. package/data/job-steps/ImportCustomObjects.md +34 -0
  49. package/data/job-steps/ImportCustomerGroups.md +34 -0
  50. package/data/job-steps/ImportCustomerList.md +34 -0
  51. package/data/job-steps/ImportCustomerLists.md +34 -0
  52. package/data/job-steps/ImportCustomers.md +34 -0
  53. package/data/job-steps/ImportGiftCertificates.md +34 -0
  54. package/data/job-steps/ImportInventoryLists.md +35 -0
  55. package/data/job-steps/ImportKeyValueMapping.md +35 -0
  56. package/data/job-steps/ImportPageLocalization.md +34 -0
  57. package/data/job-steps/ImportPriceBook.md +34 -0
  58. package/data/job-steps/ImportProductLists.md +34 -0
  59. package/data/job-steps/ImportPromotions.md +34 -0
  60. package/data/job-steps/ImportShippingMethods.md +34 -0
  61. package/data/job-steps/ImportSiteArchive.md +30 -0
  62. package/data/job-steps/ImportSourceCodeGroups.md +34 -0
  63. package/data/job-steps/ImportStores.md +34 -0
  64. package/data/job-steps/ImportTaxTable.md +34 -0
  65. package/data/job-steps/IncludeStepsFromJob.md +24 -0
  66. package/data/job-steps/InvalidateCache.md +26 -0
  67. package/data/job-steps/LibraryDeltaExport.md +30 -0
  68. package/data/job-steps/SearchReindex.md +27 -0
  69. package/data/job-steps/SiteExport.md +32 -0
  70. package/data/job-steps/UndoPreconfiguredCodeReplicationProcess.md +24 -0
  71. package/data/job-steps/UndoPreconfiguredDataReplicationProcess.md +24 -0
  72. package/data/job-steps/UpdateStorefrontURLs.md +22 -0
  73. package/data/job-steps/UploadActiveDataBackupToStorage.md +22 -0
  74. package/data/job-steps/UploadActiveDataToStorage.md +24 -0
  75. package/data/job-steps/index.json +496 -0
  76. package/data/job-steps/job-steps.json +2910 -0
  77. package/data/job-steps/job-steps.md +96 -0
  78. package/data/script-api/TopLevel.APIException.md +1 -1
  79. package/data/script-api/dw.catalog.CatalogMgr.md +8 -2
  80. package/data/script-api/dw.crypto.Cipher.md +5 -1
  81. package/data/script-api/dw.customer.Profile.md +45 -0
  82. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +92 -0
  83. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +247 -0
  84. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +74 -0
  85. package/data/script-api/dw.customer.consent.ShopperConsentException.md +63 -0
  86. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +152 -0
  87. package/data/script-api/dw.customer.consent.md +10 -0
  88. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +24 -0
  89. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +76 -0
  90. package/data/script-api/dw.object.CustomAttributes.md +72 -29
  91. package/data/script-api/dw.object.md +1 -1
  92. package/data/script-api/dw.order.Basket.md +3 -2
  93. package/data/script-api/dw.order.GiftCertificateLineItem.md +1 -1
  94. package/data/script-api/dw.order.LineItem.md +88 -0
  95. package/data/script-api/dw.order.LineItemCtnr.md +41 -11
  96. package/data/script-api/dw.order.LineItemTax.md +142 -0
  97. package/data/script-api/dw.order.OrderMgr.md +8 -0
  98. package/data/script-api/dw.order.PriceAdjustment.md +1 -1
  99. package/data/script-api/dw.order.ProductLineItem.md +1 -1
  100. package/data/script-api/dw.order.ProductShippingLineItem.md +1 -1
  101. package/data/script-api/dw.order.Shipment.md +12 -4
  102. package/data/script-api/dw.order.ShippingLineItem.md +1 -1
  103. package/data/script-api/dw.order.TaxMgr.md +54 -0
  104. package/data/script-api/dw.order.hooks.TaxHooks.md +495 -0
  105. package/data/script-api/dw.order.hooks.md +1 -0
  106. package/data/script-api/dw.order.md +1 -0
  107. package/data/script-api/dw.sitemap.SitemapFile.md +1 -1
  108. package/data/script-api/dw.sitemap.SitemapMgr.md +23 -0
  109. package/data/script-api/dw.system.Request.md +0 -1
  110. package/data/script-api/dw.util.Assert.md +29 -0
  111. package/data/script-api/dw.util.Locale.md +5 -2
  112. package/data/script-api/dw.web.Cookie.md +0 -6
  113. package/data/script-api/dw.web.PageMetaTag.md +25 -1
  114. package/data/script-api/dw.ws.WSUtil.md +2 -2
  115. package/data/script-api/index.json +2192 -37
  116. package/data/script-api/index.md +2 -1
  117. package/data/tooling/index.json +222 -0
  118. package/data/xsd/commercefeaturestate.xsd +1 -0
  119. package/data/xsd/customer.xsd +11 -0
  120. package/data/xsd/eventrouting.xsd +257 -0
  121. package/data/xsd/index.json +6 -2
  122. package/data/xsd/order.xsd +53 -0
  123. package/data/xsd/store.xsd +8 -0
  124. package/data/xsd/storefronts.xsd +57 -1
  125. package/dist/esm/auth/client-credentials.d.ts +27 -0
  126. package/dist/esm/auth/client-credentials.js +60 -0
  127. package/dist/esm/auth/client-credentials.js.map +1 -0
  128. package/dist/esm/auth/index.d.ts +1 -0
  129. package/dist/esm/auth/index.js +2 -0
  130. package/dist/esm/auth/index.js.map +1 -1
  131. package/dist/esm/auth/oauth.js +2 -1
  132. package/dist/esm/auth/oauth.js.map +1 -1
  133. package/dist/esm/cli/base-command.d.ts +40 -0
  134. package/dist/esm/cli/base-command.js +66 -5
  135. package/dist/esm/cli/base-command.js.map +1 -1
  136. package/dist/esm/cli/index.d.ts +2 -2
  137. package/dist/esm/cli/index.js +1 -1
  138. package/dist/esm/cli/index.js.map +1 -1
  139. package/dist/esm/cli/instance-command.d.ts +1 -1
  140. package/dist/esm/cli/instance-command.js +5 -3
  141. package/dist/esm/cli/instance-command.js.map +1 -1
  142. package/dist/esm/cli/oauth-command.d.ts +1 -1
  143. package/dist/esm/cli/oauth-command.js +5 -3
  144. package/dist/esm/cli/oauth-command.js.map +1 -1
  145. package/dist/esm/cli/ods-command.d.ts +1 -1
  146. package/dist/esm/cli/webdav-command.d.ts +1 -1
  147. package/dist/esm/config/sources/env-source.js +1 -0
  148. package/dist/esm/config/sources/env-source.js.map +1 -1
  149. package/dist/esm/discovery/detector.d.ts +0 -5
  150. package/dist/esm/discovery/detector.js +24 -3
  151. package/dist/esm/discovery/detector.js.map +1 -1
  152. package/dist/esm/discovery/index.d.ts +1 -0
  153. package/dist/esm/discovery/index.js +1 -0
  154. package/dist/esm/discovery/index.js.map +1 -1
  155. package/dist/esm/discovery/patterns/index.d.ts +4 -2
  156. package/dist/esm/discovery/patterns/index.js +9 -3
  157. package/dist/esm/discovery/patterns/index.js.map +1 -1
  158. package/dist/esm/discovery/patterns/pwa-kit.d.ts +12 -0
  159. package/dist/esm/discovery/patterns/pwa-kit.js +18 -7
  160. package/dist/esm/discovery/patterns/pwa-kit.js.map +1 -1
  161. package/dist/esm/discovery/patterns/sfra.d.ts +5 -4
  162. package/dist/esm/discovery/patterns/sfra.js +1 -1
  163. package/dist/esm/discovery/patterns/sfra.js.map +1 -1
  164. package/dist/esm/discovery/patterns/storefront-next.js +18 -2
  165. package/dist/esm/discovery/patterns/storefront-next.js.map +1 -1
  166. package/dist/esm/discovery/types.d.ts +13 -4
  167. package/dist/esm/discovery/types.js +11 -1
  168. package/dist/esm/discovery/types.js.map +1 -1
  169. package/dist/esm/docs/index.d.ts +3 -3
  170. package/dist/esm/docs/index.js +1 -1
  171. package/dist/esm/docs/index.js.map +1 -1
  172. package/dist/esm/docs/search.d.ts +113 -37
  173. package/dist/esm/docs/search.js +424 -72
  174. package/dist/esm/docs/search.js.map +1 -1
  175. package/dist/esm/docs/types.d.ts +57 -6
  176. package/dist/esm/docs/types.js +3 -0
  177. package/dist/esm/docs/types.js.map +1 -1
  178. package/dist/esm/slas/token.d.ts +9 -2
  179. package/dist/esm/slas/token.js +25 -29
  180. package/dist/esm/slas/token.js.map +1 -1
  181. package/dist/esm/telemetry/telemetry.d.ts +1 -0
  182. package/dist/esm/telemetry/telemetry.js +32 -0
  183. package/dist/esm/telemetry/telemetry.js.map +1 -1
  184. package/dist/esm/telemetry/types.d.ts +6 -0
  185. package/package.json +9 -2
@@ -99,7 +99,6 @@ This method is maintained for backward compatibility only. Cookie comments were
99
99
  :::
100
100
  **API Version:**
101
101
  :::note
102
- No longer available as of version 99.2.
103
102
  This method is deprecated and will be removed in the next API version.
104
103
  :::
105
104
 
@@ -172,7 +171,6 @@ This method is maintained for backward compatibility only. The version property
172
171
  :::
173
172
  **API Version:**
174
173
  :::note
175
- No longer available as of version 99.2.
176
174
  This method is deprecated and will be removed in the next API version.
177
175
  :::
178
176
 
@@ -212,7 +210,6 @@ This method is maintained for backward compatibility only. Cookie comments were
212
210
  :::
213
211
  **API Version:**
214
212
  :::note
215
- No longer available as of version 99.2.
216
213
  This method is deprecated and will be removed in the next API version.
217
214
  :::
218
215
 
@@ -301,7 +298,6 @@ This method is maintained for backward compatibility only. The version property
301
298
  :::
302
299
  **API Version:**
303
300
  :::note
304
- No longer available as of version 99.2.
305
301
  This method is deprecated and will be removed in the next API version.
306
302
  :::
307
303
 
@@ -334,7 +330,6 @@ This method is maintained for backward compatibility only. Cookie comments were
334
330
  :::
335
331
  **API Version:**
336
332
  :::note
337
- No longer available as of version 99.2.
338
333
  This method is deprecated and will be removed in the next API version.
339
334
  :::
340
335
 
@@ -428,7 +423,6 @@ This method is maintained for backward compatibility only. The version property
428
423
  :::
429
424
  **API Version:**
430
425
  :::note
431
- No longer available as of version 99.2.
432
426
  This method is deprecated and will be removed in the next API version.
433
427
  :::
434
428
 
@@ -6,7 +6,8 @@
6
6
 
7
7
  Page meta tags are used in HTML documents to provide structured data about a web
8
8
  page. They are usually part of the head section. Common tags are for example robots,
9
- description or social tags like open graph (e.g. 'og:title').
9
+ description or social tags like open graph (e.g. 'og:title'), or additionally
10
+ adding json-ld (JSON for linked data) and provides structured data that is easily crawlable.
10
11
 
11
12
 
12
13
  Page meta tags can be obtained within:
@@ -37,6 +38,7 @@ page meta tag elements.
37
38
  | --- | --- |
38
39
  | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the page meta tag ID. |
39
40
  | [content](#content): [String](TopLevel.String.md) `(read-only)` | Returns the page meta tag content. |
41
+ | [jsonLd](#jsonld): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is json-ld (JSON for linked data) and provides structured data about the page for crawlers, false otherwise. |
40
42
  | [name](#name): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is name, false otherwise. |
41
43
  | [property](#property): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is property, false otherwise. |
42
44
  | [title](#title): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is title, false otherwise. |
@@ -50,6 +52,7 @@ This class does not have a constructor, so you cannot create it directly.
50
52
  | --- | --- |
51
53
  | [getContent](dw.web.PageMetaTag.md#getcontent)() | Returns the page meta tag content. |
52
54
  | [getID](dw.web.PageMetaTag.md#getid)() | Returns the page meta tag ID. |
55
+ | [isJsonLd](dw.web.PageMetaTag.md#isjsonld)() | Returns true if the page meta tag type is json-ld (JSON for linked data) and provides structured data about the page for crawlers, false otherwise. |
53
56
  | [isName](dw.web.PageMetaTag.md#isname)() | Returns true if the page meta tag type is name, false otherwise. |
54
57
  | [isProperty](dw.web.PageMetaTag.md#isproperty)() | Returns true if the page meta tag type is property, false otherwise. |
55
58
  | [isTitle](dw.web.PageMetaTag.md#istitle)() | Returns true if the page meta tag type is title, false otherwise. |
@@ -71,6 +74,15 @@ This class does not have a constructor, so you cannot create it directly.
71
74
  - : Returns the page meta tag content.
72
75
 
73
76
 
77
+ ---
78
+
79
+ ### jsonLd
80
+ - jsonLd: [Boolean](TopLevel.Boolean.md) `(read-only)`
81
+ - : Returns true if the page meta tag type is json-ld (JSON for linked data) and provides
82
+ structured data about the page for crawlers, false otherwise.
83
+
84
+
85
+
74
86
  ---
75
87
 
76
88
  ### name
@@ -114,6 +126,18 @@ This class does not have a constructor, so you cannot create it directly.
114
126
  - page meta tag ID
115
127
 
116
128
 
129
+ ---
130
+
131
+ ### isJsonLd()
132
+ - isJsonLd(): [Boolean](TopLevel.Boolean.md)
133
+ - : Returns true if the page meta tag type is json-ld (JSON for linked data) and provides
134
+ structured data about the page for crawlers, false otherwise.
135
+
136
+
137
+ **Returns:**
138
+ - true if the page meta tag type is json-ld, false otherwise
139
+
140
+
117
141
  ---
118
142
 
119
143
  ### isName()
@@ -64,7 +64,7 @@ timeout values for Web Service calls.
64
64
  | static [addSOAPHeader](dw.ws.WSUtil.md#addsoapheaderobject-object-boolean-string)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md), [Boolean](TopLevel.Boolean.md), [String](TopLevel.String.md)) | Adds a header element to the SOAP Header. |
65
65
  | static [addSOAPHeader](dw.ws.WSUtil.md#addsoapheaderobject-string-boolean-string)([Object](TopLevel.Object.md), [String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md), [String](TopLevel.String.md)) | Adds a header element to the SOAP Header. |
66
66
  | static [clearSOAPHeaders](dw.ws.WSUtil.md#clearsoapheadersobject)([Object](TopLevel.Object.md)) | Removes all SOAP header elements from the port's request context. |
67
- | static [createHolder](dw.ws.WSUtil.md#createholderobject)([Object](TopLevel.Object.md)) | Creates an javax.xml.ws.Holder instance that wraps the specified element. |
67
+ | static [createHolder](dw.ws.WSUtil.md#createholderobject)([Object](TopLevel.Object.md)) | Creates an jakarta.xml.ws.Holder instance that wraps the specified element. |
68
68
  | static [getConnectionTimeout](dw.ws.WSUtil.md#getconnectiontimeoutobject)([Object](TopLevel.Object.md)) | Returns the connection timeout value for the port. |
69
69
  | static [getHTTPRequestHeader](dw.ws.WSUtil.md#gethttprequestheaderobject-string)([Object](TopLevel.Object.md), [String](TopLevel.String.md)) | Returns an HTTP request header property value using the specified key. |
70
70
  | static [getProperty](dw.ws.WSUtil.md#getpropertystring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Returns the value of the SOAP request property using the specified key on a port returned from one of the WebReference2 getService methods. |
@@ -489,7 +489,7 @@ timeout values for Web Service calls.
489
489
 
490
490
  ### createHolder(Object)
491
491
  - static createHolder(element: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
492
- - : Creates an javax.xml.ws.Holder instance that wraps the specified element. When a WSDL operation is
492
+ - : Creates an jakarta.xml.ws.Holder instance that wraps the specified element. When a WSDL operation is
493
493
  defined to have an input and output message using the same type, the operation may require the operation's
494
494
  object to be wrapped in a holder.
495
495