Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
## CHANGELOG

## v5.0.0

### Enchancements
- Enum types have been added for certain operations and types
- Certain operations have had types updated for query parameters
- SLAS helpers have been refactored to accept a single `options` object argument, where the properties are the old arguments
- Path parameter special characters are encoded by default
- API family layer and API namespace has been removed. To import API classes, please refer to the [README](https://github.com/SalesforceCommerceCloud/commerce-sdk?tab=readme-ov-file#sample-code)
- Docs Site has been upgraded to reflect new directory structure [#426](https://github.com/SalesforceCommerceCloud/commerce-sdk/pull/426)


## v4.2.0

Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ The Salesforce Commerce SDK allows easy interaction with the Salesforce B2C Comm

Visit the [Commerce Cloud Developer Center](https://developer.salesforce.com/developer-centers/commerce-cloud) to learn more about Salesforce Commerce. The developer center has API documentation, getting started guides, community forums, and more.
## Documentation

An auto-generated [documentation site](https://salesforcecommercecloud.github.io/commerce-sdk/) provides comprehensive reference for all available endpoints and types across API classes. Following the v5.0.0 release, the underlying SDK file structure has been reorganized, introducing additional layers of imports/exports that may affect navigation.

### Navigating the Documentation

**For API Classes:**

1. **Accessing API Classes:** Click on the API class name (e.g., `shopperProducts`) on the right hand side
2. **Viewing Endpoints:** Scroll to the `Classes` section and click the corresponding API class link (e.g., `ShopperProducts`) to see available endpoints and their parameters
3. **Type Definitions:** Scroll to the `Type aliases` section for available types
4. **Navigating Back to API Classes**: To return to the main documentation page with all API classes listed on the right sidebar, click on `Globals` in the navigation.

**Utility Classes:** Utility classes and methods such as `clientConfig` and `helpers` maintain the same structure as previous versions.

**NOTES:**

1. **Type Access**: API class types are accessible through the `<api_class>Types` namespace (e.g., `ShopperProductsTypes`). Individual types can be accessed as `ShopperProductsTypes.Product`.

2. **Type References**: The `References` section under API classes in the generated documentation may show duplicate entries. This occurs because types are exported both at their original definition and under the API class namespace. Both references point to the same underlying type definition.

## :warning: Planned API Changes :warning:

### Shopper Context
Expand Down
10 changes: 10 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
## CHANGELOG

## v5.0.0

### Enchancements
- Enum types have been added for certain operations and types
- Certain operations have had types updated for query parameters
- SLAS helpers have been refactored to accept a single `options` object argument, where the properties are the old arguments
- Path parameter special characters are encoded by default
- API family layer and API namespace has been removed. To import API classes, please refer to the [README](https://github.com/SalesforceCommerceCloud/commerce-sdk?tab=readme-ov-file#sample-code)
- Docs Site has been upgraded to reflect new directory structure [#426](https://github.com/SalesforceCommerceCloud/commerce-sdk/pull/426)


## v4.2.0

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

Large diffs are not rendered by default.

494 changes: 494 additions & 0 deletions docs/classes/assignments.assignments-3.html

Large diffs are not rendered by default.

793 changes: 793 additions & 0 deletions docs/classes/campaigns.campaigns-3.html

Large diffs are not rendered by default.

3,600 changes: 3,600 additions & 0 deletions docs/classes/catalogs.catalogsv1-2.html

Large diffs are not rendered by default.

8,877 changes: 0 additions & 8,877 deletions docs/classes/cdn.cdnzones.html

This file was deleted.

5,300 changes: 5,300 additions & 0 deletions docs/classes/cdnapiprocessapis.cdnzones-2.html

Large diffs are not rendered by default.

4,148 changes: 0 additions & 4,148 deletions docs/classes/checkout.orders.html

This file was deleted.

6,935 changes: 0 additions & 6,935 deletions docs/classes/checkout.shopperbaskets.html

This file was deleted.

3,046 changes: 0 additions & 3,046 deletions docs/classes/checkout.shopperorders.html

This file was deleted.

542 changes: 542 additions & 0 deletions docs/classes/corspreferences.corspreferences-5.html

Large diffs are not rendered by default.

1,100 changes: 1,100 additions & 0 deletions docs/classes/coupons.coupons-3.html

Large diffs are not rendered by default.

3,208 changes: 0 additions & 3,208 deletions docs/classes/customer.customers.html

This file was deleted.

1,838 changes: 0 additions & 1,838 deletions docs/classes/customer.shoppercontext.html

This file was deleted.

5,912 changes: 0 additions & 5,912 deletions docs/classes/customer.shoppercustomers.html

This file was deleted.

3,620 changes: 0 additions & 3,620 deletions docs/classes/customer.shopperlogin.html

This file was deleted.

1,488 changes: 0 additions & 1,488 deletions docs/classes/customer.shopperseo.html

This file was deleted.

2,500 changes: 0 additions & 2,500 deletions docs/classes/customer.slasadmin.html

This file was deleted.

1,432 changes: 1,432 additions & 0 deletions docs/classes/customers.customers-3.html

Large diffs are not rendered by default.

2,297 changes: 0 additions & 2,297 deletions docs/classes/discovery.shopperdiscoverysearch.html

This file was deleted.

1,911 changes: 0 additions & 1,911 deletions docs/classes/discovery.shoppersearch.html

This file was deleted.

1,636 changes: 0 additions & 1,636 deletions docs/classes/experience.shopperexperience.html

This file was deleted.

823 changes: 823 additions & 0 deletions docs/classes/giftcertificates.giftcertificates-3.html

Large diffs are not rendered by default.

1,516 changes: 1,516 additions & 0 deletions docs/classes/orders.orders-3.html

Large diffs are not rendered by default.

500 changes: 500 additions & 0 deletions docs/classes/preferences.preferences-3.html

Large diffs are not rendered by default.

1,860 changes: 0 additions & 1,860 deletions docs/classes/pricing.assignments.html

This file was deleted.

2,108 changes: 0 additions & 2,108 deletions docs/classes/pricing.campaigns.html

This file was deleted.

2,849 changes: 0 additions & 2,849 deletions docs/classes/pricing.coupons.html

This file was deleted.

2,314 changes: 0 additions & 2,314 deletions docs/classes/pricing.giftcertificates.html

This file was deleted.

2,322 changes: 0 additions & 2,322 deletions docs/classes/pricing.promotions.html

This file was deleted.

1,482 changes: 0 additions & 1,482 deletions docs/classes/pricing.shoppergiftcertificates.html

This file was deleted.

1,626 changes: 0 additions & 1,626 deletions docs/classes/pricing.shopperpromotions.html

This file was deleted.

2,192 changes: 0 additions & 2,192 deletions docs/classes/pricing.sourcecodegroups.html

This file was deleted.

6,606 changes: 0 additions & 6,606 deletions docs/classes/product.catalogs.html

This file was deleted.

6,371 changes: 0 additions & 6,371 deletions docs/classes/product.products.html

This file was deleted.

2,162 changes: 0 additions & 2,162 deletions docs/classes/product.shopperproducts.html

This file was deleted.

3,572 changes: 3,572 additions & 0 deletions docs/classes/products.products-3.html

Large diffs are not rendered by default.

759 changes: 759 additions & 0 deletions docs/classes/promotions.promotions-3.html

Large diffs are not rendered by default.

1,493 changes: 0 additions & 1,493 deletions docs/classes/search.shoppersearch.html

This file was deleted.

1,595 changes: 0 additions & 1,595 deletions docs/classes/seller.shopperstores.html

This file was deleted.

377 changes: 377 additions & 0 deletions docs/classes/seo.seo-3.html

Large diffs are not rendered by default.

3,636 changes: 3,636 additions & 0 deletions docs/classes/shopperbaskets.shopperbasketsv1-2.html

Large diffs are not rendered by default.

3,689 changes: 3,689 additions & 0 deletions docs/classes/shopperbasketsv2.shopperbasketsv2-3.html

Large diffs are not rendered by default.

678 changes: 678 additions & 0 deletions docs/classes/shoppercontext.shoppercontexts-2.html

Large diffs are not rendered by default.

2,537 changes: 2,537 additions & 0 deletions docs/classes/shoppercustomers.shoppercustomers-3.html

Large diffs are not rendered by default.

524 changes: 524 additions & 0 deletions docs/classes/shopperexperience.shopperexperience-3.html

Large diffs are not rendered by default.

396 changes: 396 additions & 0 deletions docs/classes/shoppergiftcertificates.shoppergiftcertificates-3.html

Large diffs are not rendered by default.

1,658 changes: 1,658 additions & 0 deletions docs/classes/shopperlogin.shopperlogin-3.html

Large diffs are not rendered by default.

937 changes: 937 additions & 0 deletions docs/classes/shopperorders.shopperorders-3.html

Large diffs are not rendered by default.

666 changes: 666 additions & 0 deletions docs/classes/shopperproducts.shopperproducts-3.html

Large diffs are not rendered by default.

512 changes: 512 additions & 0 deletions docs/classes/shopperpromotions.shopperpromotions-3.html

Large diffs are not rendered by default.

488 changes: 488 additions & 0 deletions docs/classes/shoppersearch.shoppersearch-3.html

Large diffs are not rendered by default.

408 changes: 408 additions & 0 deletions docs/classes/shopperseo.shopperseo-3.html

Large diffs are not rendered by default.

527 changes: 527 additions & 0 deletions docs/classes/shopperstores.shopperstores-3.html

Large diffs are not rendered by default.

1,365 changes: 1,365 additions & 0 deletions docs/classes/slasadmin.slasadmin-3.html

Large diffs are not rendered by default.

776 changes: 776 additions & 0 deletions docs/classes/sourcecodegroups.sourcecodegroups-3.html

Large diffs are not rendered by default.

122 changes: 104 additions & 18 deletions docs/globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,16 +71,37 @@ <h2>Index</h2>
<h3>Modules</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-module"><a href="modules/_index_.html" class="tsd-kind-icon">&quot;index&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/cdn.html" class="tsd-kind-icon">cdn</a></li>
<li class="tsd-kind-module"><a href="modules/checkout.html" class="tsd-kind-icon">checkout</a></li>
<li class="tsd-kind-module"><a href="modules/customer.html" class="tsd-kind-icon">customer</a></li>
<li class="tsd-kind-module"><a href="modules/discovery.html" class="tsd-kind-icon">discovery</a></li>
<li class="tsd-kind-module"><a href="modules/experience.html" class="tsd-kind-icon">experience</a></li>
<li class="tsd-kind-module"><a href="modules/_types_.html" class="tsd-kind-icon">&quot;types&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/_version_.html" class="tsd-kind-icon">&quot;version&quot;</a></li>
<li class="tsd-kind-module"><a href="modules/assignments.html" class="tsd-kind-icon">assignments</a></li>
<li class="tsd-kind-module"><a href="modules/campaigns.html" class="tsd-kind-icon">campaigns</a></li>
<li class="tsd-kind-module"><a href="modules/catalogs.html" class="tsd-kind-icon">catalogs</a></li>
<li class="tsd-kind-module"><a href="modules/cdnapiprocessapis.html" class="tsd-kind-icon">cdn<wbr>Api<wbr>Process<wbr>Apis</a></li>
<li class="tsd-kind-module"><a href="modules/corspreferences.html" class="tsd-kind-icon">cors<wbr>Preferences</a></li>
<li class="tsd-kind-module"><a href="modules/coupons.html" class="tsd-kind-icon">coupons</a></li>
<li class="tsd-kind-module"><a href="modules/customers.html" class="tsd-kind-icon">customers</a></li>
<li class="tsd-kind-module"><a href="modules/giftcertificates.html" class="tsd-kind-icon">gift<wbr>Certificates</a></li>
<li class="tsd-kind-module"><a href="modules/helpers.html" class="tsd-kind-icon">helpers</a></li>
<li class="tsd-kind-module"><a href="modules/pricing.html" class="tsd-kind-icon">pricing</a></li>
<li class="tsd-kind-module"><a href="modules/product.html" class="tsd-kind-icon">product</a></li>
<li class="tsd-kind-module"><a href="modules/search.html" class="tsd-kind-icon">search</a></li>
<li class="tsd-kind-module"><a href="modules/seller.html" class="tsd-kind-icon">seller</a></li>
<li class="tsd-kind-module"><a href="modules/orders.html" class="tsd-kind-icon">orders</a></li>
<li class="tsd-kind-module"><a href="modules/preferences.html" class="tsd-kind-icon">preferences</a></li>
<li class="tsd-kind-module"><a href="modules/products.html" class="tsd-kind-icon">products</a></li>
<li class="tsd-kind-module"><a href="modules/promotions.html" class="tsd-kind-icon">promotions</a></li>
<li class="tsd-kind-module"><a href="modules/seo.html" class="tsd-kind-icon">seo</a></li>
<li class="tsd-kind-module"><a href="modules/shopperbaskets.html" class="tsd-kind-icon">shopper<wbr>Baskets</a></li>
<li class="tsd-kind-module"><a href="modules/shopperbasketsv2.html" class="tsd-kind-icon">shopper<wbr>Basketsv2</a></li>
<li class="tsd-kind-module"><a href="modules/shoppercontext.html" class="tsd-kind-icon">shopper<wbr>Context</a></li>
<li class="tsd-kind-module"><a href="modules/shoppercustomers.html" class="tsd-kind-icon">shopper<wbr>Customers</a></li>
<li class="tsd-kind-module"><a href="modules/shopperexperience.html" class="tsd-kind-icon">shopper<wbr>Experience</a></li>
<li class="tsd-kind-module"><a href="modules/shoppergiftcertificates.html" class="tsd-kind-icon">shopper<wbr>Gift<wbr>Certificates</a></li>
<li class="tsd-kind-module"><a href="modules/shopperlogin.html" class="tsd-kind-icon">shopper<wbr>Login</a></li>
<li class="tsd-kind-module"><a href="modules/shopperorders.html" class="tsd-kind-icon">shopper<wbr>Orders</a></li>
<li class="tsd-kind-module"><a href="modules/shopperproducts.html" class="tsd-kind-icon">shopper<wbr>Products</a></li>
<li class="tsd-kind-module"><a href="modules/shopperpromotions.html" class="tsd-kind-icon">shopper<wbr>Promotions</a></li>
<li class="tsd-kind-module"><a href="modules/shoppersearch.html" class="tsd-kind-icon">shopper<wbr>Search</a></li>
<li class="tsd-kind-module"><a href="modules/shopperseo.html" class="tsd-kind-icon">shopper<wbr>Seo</a></li>
<li class="tsd-kind-module"><a href="modules/shopperstores.html" class="tsd-kind-icon">shopper<wbr>Stores</a></li>
<li class="tsd-kind-module"><a href="modules/slasadmin.html" class="tsd-kind-icon">slas<wbr>Admin</a></li>
<li class="tsd-kind-module"><a href="modules/sourcecodegroups.html" class="tsd-kind-icon">source<wbr>Code<wbr>Groups</a></li>
</ul>
</section>
</div>
Expand All @@ -97,34 +118,97 @@ <h3>Modules</h3>
<a href="modules/_index_.html">&quot;index&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/cdn.html">cdn</a>
<a href="modules/_types_.html">&quot;types&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/checkout.html">checkout</a>
<a href="modules/_version_.html">&quot;version&quot;</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/customer.html">customer</a>
<a href="modules/assignments.html">assignments</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/discovery.html">discovery</a>
<a href="modules/campaigns.html">campaigns</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/experience.html">experience</a>
<a href="modules/catalogs.html">catalogs</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/cdnapiprocessapis.html">cdn<wbr>Api<wbr>Process<wbr>Apis</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/corspreferences.html">cors<wbr>Preferences</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/coupons.html">coupons</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/customers.html">customers</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/giftcertificates.html">gift<wbr>Certificates</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/helpers.html">helpers</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/pricing.html">pricing</a>
<a href="modules/orders.html">orders</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/preferences.html">preferences</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/products.html">products</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/promotions.html">promotions</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/seo.html">seo</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperbaskets.html">shopper<wbr>Baskets</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperbasketsv2.html">shopper<wbr>Basketsv2</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shoppercontext.html">shopper<wbr>Context</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shoppercustomers.html">shopper<wbr>Customers</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperexperience.html">shopper<wbr>Experience</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shoppergiftcertificates.html">shopper<wbr>Gift<wbr>Certificates</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperlogin.html">shopper<wbr>Login</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperorders.html">shopper<wbr>Orders</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperproducts.html">shopper<wbr>Products</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperpromotions.html">shopper<wbr>Promotions</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shoppersearch.html">shopper<wbr>Search</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/shopperseo.html">shopper<wbr>Seo</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/product.html">product</a>
<a href="modules/shopperstores.html">shopper<wbr>Stores</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/search.html">search</a>
<a href="modules/slasadmin.html">slas<wbr>Admin</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/seller.html">seller</a>
<a href="modules/sourcecodegroups.html">source<wbr>Code<wbr>Groups</a>
</li>
</ul>
</nav>
Expand All @@ -140,10 +224,12 @@ <h3>Modules</h3>
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<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>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
Expand Down
Loading