Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joeluong-sfcc committed May 10, 2024
1 parent 83d5013 commit 14de5c5
Show file tree
Hide file tree
Showing 42 changed files with 4,042 additions and 1,611 deletions.
42 changes: 41 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,51 @@ only use JavaScript, or if you use TypeScript but only import the client classes
then your usage **will not change**. You will likely only need to make changes if
you import the type definitions directly.

## v2.16.0

#### API Changes

*Shopper Customers*

- Removal of deprecated endpoints:
- `invalidateCustomerAuth`
- `authorizeCustomer`
- `authorizeTrustedSystem`

*Shopper Orders*

| **Endpoint Name** | **Description** |
| ------------- |-------------|
| guestOrderLookup | Lookup a guest order |

*Customers*

| **Endpoint Name** | **Description** |
| ------------- |-------------|
| searchCustomerGroup | Search for customer groups in a given Site Id |

*Coupons*

| **Endpoint Name** | **Description** |
| ------------- |-------------|
| redeemCoupon | Redeems a coupon code for an existing coupon within the selected site. The coupon code must be redeemable. |

#### Other Changes

- Removal of deprecated helper function `getShopperToken`

## v2.15.0

#### API Changes

- Update APIs
- Update APIs for [Shopper Search](https://developer.salesforce.com/docs/commerce/commerce-api/references/about-commerce-api/about.html#282024)

* New Endpoints

| **Endpoint Name** | **Description** |
| ------------- |-----------------------------------|
| getWafManagedRulesets | Retrieves WAFv2 managed rulesets. |
| updateWafManagedRuleset | Updates WAFv2 managed ruleset. |

## v2.14.0

Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.json

Large diffs are not rendered by default.

25 changes: 14 additions & 11 deletions docs/classes/cdn.cdnzones.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h1><a href="https://developer.salesforce.com/docs/commerce/commerce-api/referen
clientConfig.headers[<span class="hljs-string">&#x27;authorization&#x27;</span>] = <span class="hljs-string">`Bearer <span class="hljs-subst">${token.access_token}</span>`</span>;
<span class="hljs-keyword">const</span> cdnZonesClient = <span class="hljs-keyword">new</span> Cdn.CdnZones(clientConfig);</code></pre>
<span style="font-size:.7em; display:block; text-align: right">
API Version: 1.0.29<br />
API Version: 1.0.30<br />
Last Updated: <br />
</span>
</div>
Expand Down Expand Up @@ -2055,7 +2055,7 @@ <h3>create<wbr>Firewall<wbr>Rule</h3>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>(DEPRECATED) Creates a firewall rule. This endpoint is deprecated as of February 6, 2024. Requests return a 400 Bad Request response. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Creates a firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
<p>If you would like to get a raw Response object use the other createFirewallRule function.</p>
</div>
Expand Down Expand Up @@ -2103,7 +2103,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>(DEPRECATED) Creates a firewall rule. This endpoint is deprecated as of February 6, 2024. Requests return a 400 Bad Request response. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Creates a firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -2995,7 +2995,7 @@ <h3>delete<wbr>Firewall<wbr>Rule</h3>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete a specific firewall rule. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Delete a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
<p>If you would like to get a raw Response object use the other deleteFirewallRule function.</p>
</div>
Expand Down Expand Up @@ -3040,7 +3040,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Delete a specific firewall rule. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Delete a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -3899,7 +3899,7 @@ <h3>get<wbr>Firewall<wbr>Rule</h3>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve a specific firewall rule. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Retrieve a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
<p>If you would like to get a raw Response object use the other getFirewallRule function.</p>
</div>
Expand Down Expand Up @@ -3944,7 +3944,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieve a specific firewall rule. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Retrieve a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -4012,7 +4012,7 @@ <h3>get<wbr>Firewall<wbr>Rules</h3>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves existing firewall rules. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Retrieves existing firewall rules. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
<p>If you would like to get a raw Response object use the other getFirewallRules function.</p>
</div>
Expand Down Expand Up @@ -4057,7 +4057,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Retrieves existing firewall rules. This endpoint will be deprecated at a later date and additional documentation will be provided. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Retrieves existing firewall rules. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -5838,7 +5838,7 @@ <h3>update<wbr>Firewall<wbr>Rule</h3>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>(DEPRECATED) Update a specific firewall rule. This endpoint is deprecated as of February 6, 2024. Requests return a 400 Bad Request response. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Update a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
<p>If you would like to get a raw Response object use the other updateFirewallRule function.</p>
</div>
Expand Down Expand Up @@ -5886,7 +5886,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>(DEPRECATED) Update a specific firewall rule. This endpoint is deprecated as of February 6, 2024. Requests return a 400 Bad Request response. Use eCDN custom rules moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
<p>(DEPRECATED) Update a specific firewall rule. This endpoint is deprecated. Requests return a 400 Bad Request response. Use <a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html">eCDN custom rules</a> moving forward. Any existing firewall rules are accessible and can be updated using the custom rule endpoints.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -7288,6 +7288,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-module">
<a href="../modules/search.html">search</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/seller.html">seller</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
Expand Down

0 comments on commit 14de5c5

Please sign in to comment.