Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexvuong
alexvuong committed Mar 5, 2024
1 parent 96119ae commit 6856d08
Show file tree
Hide file tree
Showing 11 changed files with 168 additions and 111 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

221 changes: 139 additions & 82 deletions docs/classes/product.shopperproducts.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ <h2>Security</h2>
<p>For more information about security considerations related to developing headless commerce applications, see
<a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/security-considerations-for-headless-commerce.html">Security Considerations for Headless Commerce</a> on the
<a href="https://developer.salesforce.com/developer-centers/commerce-cloud">Commerce Cloud Developer Center</a>.</p>
<p>If you discover any potential security issues, please report them to <a href="mailto:&#x73;&#101;&#x63;&#117;&#x72;&#105;&#x74;&#x79;&#64;&#x73;&#x61;&#x6c;&#101;&#115;&#102;&#111;&#x72;&#99;&#101;&#46;&#99;&#x6f;&#109;">&#x73;&#101;&#x63;&#117;&#x72;&#105;&#x74;&#x79;&#64;&#x73;&#x61;&#x6c;&#101;&#115;&#102;&#111;&#x72;&#99;&#101;&#46;&#99;&#x6f;&#109;</a> as soon as possible.</p>
<p>If you discover any potential security issues, please report them to <a href="mailto:&#x73;&#101;&#x63;&#x75;&#114;&#105;&#116;&#121;&#64;&#x73;&#x61;&#x6c;&#101;&#x73;&#x66;&#x6f;&#x72;&#x63;&#101;&#x2e;&#99;&#111;&#x6d;">&#x73;&#101;&#x63;&#x75;&#114;&#105;&#116;&#121;&#64;&#x73;&#x61;&#x6c;&#101;&#x73;&#x66;&#x6f;&#x72;&#x63;&#101;&#x2e;&#99;&#111;&#x6d;</a> as soon as possible.</p>
<a href="#additional-documentation" id="additional-documentation" style="color: inherit; text-decoration: none;">
<h2>Additional Documentation</h2>
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/cdn.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>HEADER
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/cdn/cdnZones/cdnZones.ts:643</li>
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/checkout.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>HEADER
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/checkout/orders/orders.ts:721</li>
Expand All @@ -137,7 +137,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/checkout/shopperBaskets/shopperBaskets.ts:729</li>
Expand All @@ -147,7 +147,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-2" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/checkout/shopperOrders/shopperOrders.ts:714</li>
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/customer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>HEADER
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/customer/customers/customers.ts:385</li>
Expand All @@ -176,7 +176,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/customer/shopperContext/shopperContext.ts:300</li>
Expand All @@ -186,7 +186,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-2" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/customer/shopperCustomers/shopperCustomers.ts:1073</li>
Expand All @@ -196,7 +196,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-3" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/customer/shopperLogin/shopperLogin.ts:420</li>
Expand All @@ -206,7 +206,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-4" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/customer/shopperSeo/shopperSeo.ts:318</li>
Expand All @@ -216,7 +216,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-5" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/customer/slasAdmin/slasAdmin.ts:216</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/discovery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>HEADER
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/discovery/shopperDiscoverySearch/shopperDiscoverySearch.ts:418</li>
Expand All @@ -124,7 +124,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE<
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/discovery/shopperSearch/shopperSearch.ts:449</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/experience.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>HEADER
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
<a name="user_agent_value" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.13.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.13.0;&quot;</span></div>
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk@2.14.0;"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk@2.14.0;&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in renderedTemplates/experience/shopperExperience/shopperExperience.ts:337</li>
Expand Down
Loading

0 comments on commit 6856d08

Please sign in to comment.