Skip to content

Commit bbc5f0c

Browse files
committed
update docs
1 parent 248ba9b commit bbc5f0c

34 files changed

+899
-973
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ An auto-generated [documentation site](https://salesforcecommercecloud.github.io
1515
1. **Accessing API Classes:** Click on the API class name (e.g., `shopperProducts`) on the right hand side
1616
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
1717
3. **Type Definitions:** Scroll to the `Type aliases` section for available types
18+
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.
1819

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

docs/assets/js/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ <h3>Navigating the Documentation</h3>
8282
<li><strong>Accessing API Classes:</strong> Click on the API class name (e.g., <code>shopperProducts</code>) on the right hand side</li>
8383
<li><strong>Viewing Endpoints:</strong> Scroll to the <code>Classes</code> section and click the corresponding API class link (e.g., <code>ShopperProducts</code>) to see available endpoints and their parameters</li>
8484
<li><strong>Type Definitions:</strong> Scroll to the <code>Type aliases</code> section for available types</li>
85+
<li><strong>Navigating Back to API Classes</strong>: To return to the main documentation page with all API classes listed on the right sidebar, click on <code>Globals</code> in the navigation.</li>
8586
</ol>
8687
<p><strong>Utility Classes:</strong> Utility classes and methods such as <code>clientConfig</code> and <code>helpers</code> maintain the same structure as previous versions.</p>
8788
<p><strong>NOTES:</strong> </p>
@@ -617,7 +618,7 @@ <h2>Security</h2>
617618
<p>For more information about security considerations related to developing headless commerce applications, see
618619
<a href="https://developer.salesforce.com/docs/commerce/commerce-api/guide/security-considerations-for-headless-commerce.html">Security Considerations for Headless Commerce</a> on the
619620
<a href="https://developer.salesforce.com/developer-centers/commerce-cloud">Commerce Cloud Developer Center</a>.</p>
620-
<p>If you discover any potential security issues, please report them to <a href="mailto:&#x73;&#x65;&#99;&#x75;&#114;&#105;&#x74;&#x79;&#64;&#x73;&#x61;&#x6c;&#101;&#115;&#102;&#x6f;&#114;&#x63;&#101;&#46;&#99;&#x6f;&#x6d;">&#x73;&#x65;&#99;&#x75;&#114;&#105;&#x74;&#x79;&#64;&#x73;&#x61;&#x6c;&#101;&#115;&#102;&#x6f;&#114;&#x63;&#101;&#46;&#99;&#x6f;&#x6d;</a> as soon as possible.</p>
621+
<p>If you discover any potential security issues, please report them to <a href="mailto:&#115;&#x65;&#x63;&#x75;&#114;&#x69;&#x74;&#x79;&#64;&#115;&#97;&#x6c;&#101;&#x73;&#x66;&#x6f;&#114;&#99;&#101;&#x2e;&#99;&#x6f;&#x6d;">&#115;&#x65;&#x63;&#x75;&#114;&#x69;&#x74;&#x79;&#64;&#115;&#97;&#x6c;&#101;&#x73;&#x66;&#x6f;&#114;&#99;&#101;&#x2e;&#99;&#x6f;&#x6d;</a> as soon as possible.</p>
621622
<a href="#additional-documentation" id="additional-documentation" style="color: inherit; text-decoration: none;">
622623
<h2>Additional Documentation</h2>
623624
</a>

docs/modules/assignments.html

Lines changed: 37 additions & 37 deletions
Large diffs are not rendered by default.

docs/modules/campaigns.html

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

docs/modules/catalogs.CatalogsV1Types.html

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,6 @@ <h3>Type aliases</h3>
146146
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#termfilteroperatorenum" class="tsd-kind-icon">Term<wbr>Filter<wbr>Operator<wbr>Enum</a></li>
147147
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#termquery" class="tsd-kind-icon">Term<wbr>Query</a></li>
148148
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#termqueryoperatorenum" class="tsd-kind-icon">Term<wbr>Query<wbr>Operator<wbr>Enum</a></li>
149-
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#termqueryvaluesinner" class="tsd-kind-icon">Term<wbr>Query<wbr>Values<wbr>Inner</a></li>
150149
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#textquery" class="tsd-kind-icon">Text<wbr>Query</a></li>
151150
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#variant" class="tsd-kind-icon">Variant</a></li>
152151
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="catalogs.catalogsv1types.html#variationattribute" class="tsd-kind-icon">Variation<wbr>Attribute</a></li>
@@ -860,23 +859,13 @@ <h3>Term<wbr>Query<wbr>Operator<wbr>Enum</h3>
860859
</ul>
861860
</aside>
862861
</section>
863-
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
864-
<a name="termqueryvaluesinner" class="tsd-anchor"></a>
865-
<h3>Term<wbr>Query<wbr>Values<wbr>Inner</h3>
866-
<div class="tsd-signature tsd-kind-icon">Term<wbr>Query<wbr>Values<wbr>Inner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.TermQueryValuesInner</span></div>
867-
<aside class="tsd-sources">
868-
<ul>
869-
<li>Defined in renderedTemplates/catalogs/index.ts:82</li>
870-
</ul>
871-
</aside>
872-
</section>
873862
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace">
874863
<a name="textquery" class="tsd-anchor"></a>
875864
<h3>Text<wbr>Query</h3>
876865
<div class="tsd-signature tsd-kind-icon">Text<wbr>Query<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.TextQuery</span></div>
877866
<aside class="tsd-sources">
878867
<ul>
879-
<li>Defined in renderedTemplates/catalogs/index.ts:83</li>
868+
<li>Defined in renderedTemplates/catalogs/index.ts:82</li>
880869
</ul>
881870
</aside>
882871
</section>
@@ -886,7 +875,7 @@ <h3>Variant</h3>
886875
<div class="tsd-signature tsd-kind-icon">Variant<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.Variant</span></div>
887876
<aside class="tsd-sources">
888877
<ul>
889-
<li>Defined in renderedTemplates/catalogs/index.ts:84</li>
878+
<li>Defined in renderedTemplates/catalogs/index.ts:83</li>
890879
</ul>
891880
</aside>
892881
</section>
@@ -896,7 +885,7 @@ <h3>Variation<wbr>Attribute</h3>
896885
<div class="tsd-signature tsd-kind-icon">Variation<wbr>Attribute<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.VariationAttribute</span></div>
897886
<aside class="tsd-sources">
898887
<ul>
899-
<li>Defined in renderedTemplates/catalogs/index.ts:85</li>
888+
<li>Defined in renderedTemplates/catalogs/index.ts:84</li>
900889
</ul>
901890
</aside>
902891
</section>
@@ -906,7 +895,7 @@ <h3>Variation<wbr>Attribute<wbr>Value</h3>
906895
<div class="tsd-signature tsd-kind-icon">Variation<wbr>Attribute<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.VariationAttributeValue</span></div>
907896
<aside class="tsd-sources">
908897
<ul>
909-
<li>Defined in renderedTemplates/catalogs/index.ts:87</li>
898+
<li>Defined in renderedTemplates/catalogs/index.ts:86</li>
910899
</ul>
911900
</aside>
912901
</section>
@@ -916,7 +905,7 @@ <h3>Variation<wbr>Attribute<wbr>Variation<wbr>Attribute<wbr>Type<wbr>Enum</h3>
916905
<div class="tsd-signature tsd-kind-icon">Variation<wbr>Attribute<wbr>Variation<wbr>Attribute<wbr>Type<wbr>Enum<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.VariationAttributeVariationAttributeTypeEnum</span></div>
917906
<aside class="tsd-sources">
918907
<ul>
919-
<li>Defined in renderedTemplates/catalogs/index.ts:86</li>
908+
<li>Defined in renderedTemplates/catalogs/index.ts:85</li>
920909
</ul>
921910
</aside>
922911
</section>
@@ -926,7 +915,7 @@ <h3>Variation<wbr>Group</h3>
926915
<div class="tsd-signature tsd-kind-icon">Variation<wbr>Group<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CatalogsV1ModelTypes.VariationGroup</span></div>
927916
<aside class="tsd-sources">
928917
<ul>
929-
<li>Defined in renderedTemplates/catalogs/index.ts:88</li>
918+
<li>Defined in renderedTemplates/catalogs/index.ts:87</li>
930919
</ul>
931920
</aside>
932921
</section>
@@ -1160,9 +1149,6 @@ <h3>Variation<wbr>Group</h3>
11601149
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
11611150
<a href="catalogs.catalogsv1types.html#termqueryoperatorenum" class="tsd-kind-icon">Term<wbr>Query<wbr>Operator<wbr>Enum</a>
11621151
</li>
1163-
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
1164-
<a href="catalogs.catalogsv1types.html#termqueryvaluesinner" class="tsd-kind-icon">Term<wbr>Query<wbr>Values<wbr>Inner</a>
1165-
</li>
11661152
<li class=" tsd-kind-type-alias tsd-parent-kind-namespace">
11671153
<a href="catalogs.catalogsv1types.html#textquery" class="tsd-kind-icon">Text<wbr>Query</a>
11681154
</li>

0 commit comments

Comments
 (0)