Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@joeluong-sfcc
joeluong-sfcc committed May 10, 2024
1 parent 0be3516 commit f5159ed
Show file tree
Hide file tree
Showing 42 changed files with 346 additions and 40 deletions.
4 changes: 4 additions & 0 deletions docs/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ you import the type definitions directly.
| ------------- |-------------|
| redeemCoupon | Redeems a coupon code for an existing coupon within the selected site. The coupon code must be redeemable. |

#### Enchancements

- Add helper function `customApiHelper.callCustomEndpoint` to call [Custom APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/custom-apis.html) - [#402](https://github.com/SalesforceCommerceCloud/commerce-sdk/pull/402)

#### Other Changes

- Removal of deprecated helper function `getShopperToken`
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/classes/cdn.cdnzones.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7812,6 +7812,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/checkout.orders.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4121,6 +4121,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/checkout.shopperbaskets.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6725,6 +6725,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/checkout.shopperorders.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3019,6 +3019,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/customer.customers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3181,6 +3181,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/customer.shoppercontext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1753,6 +1753,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/customer.shoppercustomers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5885,6 +5885,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/customer.shopperlogin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3552,6 +3552,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/customer.shopperseo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1461,6 +1461,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/customer.slasadmin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2473,6 +2473,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/discovery.shopperdiscoverysearch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2270,6 +2270,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/discovery.shoppersearch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1870,6 +1870,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/experience.shopperexperience.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1590,6 +1590,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.assignments.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1665,6 +1665,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.campaigns.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2062,6 +2062,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.coupons.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2636,6 +2636,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.giftcertificates.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2242,6 +2242,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.promotions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2127,6 +2127,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.shoppergiftcertificates.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1428,6 +1428,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.shopperpromotions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1566,6 +1566,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/pricing.sourcecodegroups.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2127,6 +2127,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/product.catalogs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6504,6 +6504,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/product.products.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6295,6 +6295,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/product.shopperproducts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2121,6 +2121,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/search.shoppersearch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1466,6 +1466,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/classes/seller.shopperstores.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1548,6 +1548,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down
1 change: 1 addition & 0 deletions docs/globals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ <h3>Modules</h3>
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
Expand Down

0 comments on commit f5159ed

Please sign in to comment.