You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,7 @@ An auto-generated [documentation site](https://salesforcecommercecloud.github.io
24
24
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`.
25
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
26
3.**V4 Migration Guide**: Starting in v5, API classes will no longer be exported under API family namespaces. See the [Sample Code](#sample-code) section for migration examples.
27
+
4.**Supporting Files**: The SDK includes additional supporting modules beyond the `helpers` SLAS functions. The `types` module provides common type definitions shared across API classes, while the `version` module automatically implements user agent headers for all requests. The user agent value follows the format `commerce-sdk@<version>` based on the current SDK version.
Copy file name to clipboardExpand all lines: docs/index.html
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,7 @@ <h3>Navigating the Documentation</h3>
90
90
<li><strong>Type Access</strong>: API class types are accessible through the <code><api_class>Types</code> namespace (e.g., <code>ShopperProductsTypes</code>). Individual types can be accessed as <code>ShopperProductsTypes.Product</code>.</li>
91
91
<li><strong>Type References</strong>: The <code>References</code> 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.</li>
92
92
<li><strong>V4 Migration Guide</strong>: Starting in v5, API classes will no longer be exported under API family namespaces. See the <ahref="#sample-code">Sample Code</a> section for migration examples.</li>
93
+
<li><strong>Supporting Files</strong>: The SDK includes additional supporting modules beyond the <code>helpers</code> SLAS functions. The <code>types</code> module provides common type definitions shared across API classes, while the <code>version</code> module automatically implements user agent headers for all requests. The user agent value follows the format <code>commerce-sdk@<version></code> based on the current SDK version.</li>
<p>For more information about security considerations related to developing headless commerce applications, see
623
624
<ahref="https://developer.salesforce.com/docs/commerce/commerce-api/guide/security-considerations-for-headless-commerce.html">Security Considerations for Headless Commerce</a> on the
<p>If you discover any potential security issues, please report them to <ahref="mailto:security@salesforce.com">security@salesforce.com</a> as soon as possible.</p>
626
+
<p>If you discover any potential security issues, please report them to <ahref="mailto:security@salesforce.com">security@salesforce.com</a> as soon as possible.</p>
0 commit comments