Skip to content

Commit a18bee1

Browse files
committed
update docs by upgrading typedoc
1 parent 77f766a commit a18bee1

File tree

2,107 files changed

+18461
-90187
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,107 files changed

+18461
-90187
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
## CHANGELOG
22

3+
34
## v5.0.0
5+
6+
**NOTE** These changes are compatible with ECOM 25.9
7+
48
- Enum types have been added for certain operations and types
59
- Certain operations have had types updated for query parameters
610
- SLAS helpers have been refactored to accept a single `options` object argument, where the properties are the old arguments
711
- Path parameter special characters are encoded by default
812
- 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)
13+
- Docs Site has been upgraded [TypeDoc upgraded from 0.17.8 to 0.28.7 for TypeScript 5.1.6 compatibility]
14+
915

1016
## v4.2.0
1117

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@ The Salesforce Commerce SDK allows easy interaction with the Salesforce B2C Comm
44

55
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.
66
7+
## Documentation
8+
9+
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.
10+
11+
### Navigating the Documentation
12+
13+
**For API Classes:**
14+
15+
1. **Accessing API Classes:** Click on the API class name (e.g., `shopperProducts`) on the right hand side
16+
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
17+
3. **Type Definitions:** Scroll to the `Type aliases` section for available types
18+
19+
**Utility Classes:** Utility classes and methods such as `clientConfig` and `helpers` maintain the same structure as previous versions.
20+
21+
**NOTES:**
22+
23+
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`.
24+
25+
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.
26+
727
## :warning: Planned API Changes :warning:
828

929
### Shopper Context

docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
## CHANGELOG
22

33

4+
## v5.0.0
5+
6+
**NOTE** These changes are compatible with ECOM 25.9
7+
8+
- Enum types have been added for certain operations and types
9+
- Certain operations have had types updated for query parameters
10+
- SLAS helpers have been refactored to accept a single `options` object argument, where the properties are the old arguments
11+
- Path parameter special characters are encoded by default
12+
- 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)
13+
- Docs Site has been upgraded [TypeDoc upgraded from 0.17.8 to 0.28.7 for TypeScript 5.1.6 compatibility]
14+
15+
416
## v4.2.0
517

618
### Enchancements

0 commit comments

Comments
 (0)