Skip to content

Commit 1ee96cf

Browse files
joeluong-sfccjoeluong-sfcc
committed
update docs
1 parent d9edac9 commit 1ee96cf

Some content is hidden

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

47 files changed

+3638
-1493
lines changed

‎CHANGELOG.md‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,40 @@
1-
## CHANGELOG
1+
# CHANGELOG
22

33
## v5.0.0
44

5+
### API Versions
6+
7+
| API Name | API Version |
8+
|----------|-------------|
9+
| assignments | 1.0.35 |
10+
| campaigns | 1.0.37 |
11+
| catalogs | 1.0.42 |
12+
| cdn-api-process-apis | 1.0.39 |
13+
| cors-preferences | 1.0.5 |
14+
| coupons | 1.0.39 |
15+
| customers | 1.0.32 |
16+
| gift-certificates | 1.0.39 |
17+
| orders | 1.4.10 |
18+
| preferences | 1.1.3 |
19+
| products | 1.0.40 |
20+
| promotions | 1.0.33 |
21+
| shopper-baskets | 1.9.0 |
22+
| shopper-baskets | 2.1.0 |
23+
| shopper-consents | 1.1.0 |
24+
| shopper-context | 1.1.1 |
25+
| shopper-customers | 1.1.1 |
26+
| shopper-experience | 1.0.7 |
27+
| shopper-gift-certificates | 1.0.26 |
28+
| shopper-login | 1.39.41 |
29+
| shopper-orders | 1.5.0 |
30+
| shopper-products | 1.0.37 |
31+
| shopper-promotions | 1.0.36 |
32+
| shopper-search | 1.3.0 |
33+
| shopper-seo | 1.0.13 |
34+
| shopper-stores | 1.0.17 |
35+
| slas-admin | 1.12.30 |
36+
| source-code-groups | 1.0.37 |
37+
538
### Enchancements
639
- Enum types have been added for certain operations and types
740
- Certain operations have had types updated for query parameters

‎docs/CHANGELOG.md‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,45 @@
1-
## CHANGELOG
1+
# CHANGELOG
22

33
## v5.0.0
44

5+
### API Versions
6+
7+
| API Name | API Version |
8+
|----------|-------------|
9+
| assignments | 1.0.35 |
10+
| campaigns | 1.0.37 |
11+
| catalogs | 1.0.42 |
12+
| cdn-api-process-apis | 1.0.39 |
13+
| cors-preferences | 1.0.5 |
14+
| coupons | 1.0.39 |
15+
| customers | 1.0.32 |
16+
| gift-certificates | 1.0.39 |
17+
| orders | 1.4.10 |
18+
| preferences | 1.1.3 |
19+
| products | 1.0.40 |
20+
| promotions | 1.0.33 |
21+
| shopper-baskets | 1.9.0 |
22+
| shopper-baskets | 2.1.0 |
23+
| shopper-consents | 1.1.0 |
24+
| shopper-context | 1.1.1 |
25+
| shopper-customers | 1.1.1 |
26+
| shopper-experience | 1.0.7 |
27+
| shopper-gift-certificates | 1.0.26 |
28+
| shopper-login | 1.39.41 |
29+
| shopper-orders | 1.5.0 |
30+
| shopper-products | 1.0.37 |
31+
| shopper-promotions | 1.0.36 |
32+
| shopper-search | 1.3.0 |
33+
| shopper-seo | 1.0.13 |
34+
| shopper-stores | 1.0.17 |
35+
| slas-admin | 1.12.30 |
36+
| source-code-groups | 1.0.37 |
37+
538
### Enchancements
639
- Enum types have been added for certain operations and types
740
- Certain operations have had types updated for query parameters
841
- SLAS helpers have been refactored to accept a single `options` object argument, where the properties are the old arguments
42+
- `loginGuestUserPrivate` now passes `usid` under `options.parameters`
943
- Path parameter special characters are encoded by default
1044
- 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)
1145
- Docs Site has been upgraded to reflect new directory structure [#426](https://github.com/SalesforceCommerceCloud/commerce-sdk/pull/426)

‎docs/assets/js/search.json‎

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

‎docs/classes/catalogs.catalogsv1-2.html‎

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2342,14 +2342,15 @@ <h3>search<wbr>Categories</h3>
23422342
<li class="tsd-description">
23432343
<aside class="tsd-sources">
23442344
<ul>
2345-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4218</li>
2345+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4221</li>
23462346
</ul>
23472347
</aside>
23482348
<div class="tsd-comment tsd-typography">
23492349
<div class="lead">
23502350
<p>Search for catalog categories.
23512351
By default, the server returns the first level of subcategories,
23522352
but you can specify another level by setting the levels parameter.
2353+
Subcategories are sorted by category position, then by categoryId.
23532354
Using a large value for levels can cause performance
23542355
issues with large and deep category trees.</p>
23552356
</div>
@@ -2419,6 +2420,7 @@ <h3>search<wbr>Categories</h3>
24192420
<td>Double</td>
24202421
</tr>
24212422
</tbody></table>
2423+
<p>If no sorting clause is provided, categories are sorted by categoryId. If sorting clause(s) are provided, categoryId is used as a tiebreaker.</p>
24222424
<p>If you would like to get a raw Response object use the other searchCategories function.</p>
24232425
</div>
24242426
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2438,14 +2440,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
24382440
<li class="tsd-description">
24392441
<aside class="tsd-sources">
24402442
<ul>
2441-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4272</li>
2443+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4278</li>
24422444
</ul>
24432445
</aside>
24442446
<div class="tsd-comment tsd-typography">
24452447
<div class="lead">
24462448
<p>Search for catalog categories.
24472449
By default, the server returns the first level of subcategories,
24482450
but you can specify another level by setting the levels parameter.
2451+
Subcategories are sorted by category position, then by categoryId.
24492452
Using a large value for levels can cause performance
24502453
issues with large and deep category trees.</p>
24512454
</div>
@@ -2515,6 +2518,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
25152518
<td>Double</td>
25162519
</tr>
25172520
</tbody></table>
2521+
<p>If no sorting clause is provided, categories are sorted by categoryId. If sorting clause(s) are provided, categoryId is used as a tiebreaker.</p>
25182522
</div>
25192523
<h4 class="tsd-type-parameters-title">Type parameters</h4>
25202524
<ul class="tsd-type-parameters">
@@ -2557,14 +2561,15 @@ <h3>search<wbr>Categories<wbr>InCatalog</h3>
25572561
<li class="tsd-description">
25582562
<aside class="tsd-sources">
25592563
<ul>
2560-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4433</li>
2564+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4445</li>
25612565
</ul>
25622566
</aside>
25632567
<div class="tsd-comment tsd-typography">
25642568
<div class="lead">
25652569
<p>Search for catalog categories in the scope of a catalog.
25662570
By default, the server returns the first level of subcategories,
25672571
but you can specify another level by setting the levels parameter.
2572+
Subcategories are sorted by category position, then by categoryId.
25682573
Using a large value for levels can cause performance
25692574
issues with large and deep category trees.</p>
25702575
</div>
@@ -2634,6 +2639,7 @@ <h3>search<wbr>Categories<wbr>InCatalog</h3>
26342639
<td>Double</td>
26352640
</tr>
26362641
</tbody></table>
2642+
<p>If no sorting clause is provided, categories are sorted by categoryId. If sorting clause(s) are provided, categoryId is used as a tiebreaker.</p>
26372643
<p>If you would like to get a raw Response object use the other searchCategoriesInCatalog function.</p>
26382644
</div>
26392645
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2653,14 +2659,15 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
26532659
<li class="tsd-description">
26542660
<aside class="tsd-sources">
26552661
<ul>
2656-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4490</li>
2662+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4505</li>
26572663
</ul>
26582664
</aside>
26592665
<div class="tsd-comment tsd-typography">
26602666
<div class="lead">
26612667
<p>Search for catalog categories in the scope of a catalog.
26622668
By default, the server returns the first level of subcategories,
26632669
but you can specify another level by setting the levels parameter.
2670+
Subcategories are sorted by category position, then by categoryId.
26642671
Using a large value for levels can cause performance
26652672
issues with large and deep category trees.</p>
26662673
</div>
@@ -2730,6 +2737,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
27302737
<td>Double</td>
27312738
</tr>
27322739
</tbody></table>
2740+
<p>If no sorting clause is provided, categories are sorted by categoryId. If sorting clause(s) are provided, categoryId is used as a tiebreaker.</p>
27332741
</div>
27342742
<h4 class="tsd-type-parameters-title">Type parameters</h4>
27352743
<ul class="tsd-type-parameters">
@@ -2772,7 +2780,7 @@ <h3>search<wbr>Products<wbr>Assigned<wbr>ToCategory</h3>
27722780
<li class="tsd-description">
27732781
<aside class="tsd-sources">
27742782
<ul>
2775-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4693</li>
2783+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4711</li>
27762784
</ul>
27772785
</aside>
27782786
<div class="tsd-comment tsd-typography">
@@ -2937,7 +2945,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
29372945
<li class="tsd-description">
29382946
<aside class="tsd-sources">
29392947
<ul>
2940-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4781</li>
2948+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4799</li>
29412949
</ul>
29422950
</aside>
29432951
<div class="tsd-comment tsd-typography">
@@ -3125,7 +3133,7 @@ <h3>unassign<wbr>Product<wbr>From<wbr>Category</h3>
31253133
<li class="tsd-description">
31263134
<aside class="tsd-sources">
31273135
<ul>
3128-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4971</li>
3136+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:4989</li>
31293137
</ul>
31303138
</aside>
31313139
<div class="tsd-comment tsd-typography">
@@ -3153,7 +3161,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
31533161
<li class="tsd-description">
31543162
<aside class="tsd-sources">
31553163
<ul>
3156-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5005</li>
3164+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5023</li>
31573165
</ul>
31583166
</aside>
31593167
<div class="tsd-comment tsd-typography">
@@ -3204,7 +3212,7 @@ <h3>update<wbr>Catalog</h3>
32043212
<li class="tsd-description">
32053213
<aside class="tsd-sources">
32063214
<ul>
3207-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5136</li>
3215+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5154</li>
32083216
</ul>
32093217
</aside>
32103218
<div class="tsd-comment tsd-typography">
@@ -3230,7 +3238,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
32303238
<li class="tsd-description">
32313239
<aside class="tsd-sources">
32323240
<ul>
3233-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5164</li>
3241+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5182</li>
32343242
</ul>
32353243
</aside>
32363244
<div class="tsd-comment tsd-typography">
@@ -3279,7 +3287,7 @@ <h3>update<wbr>Category<wbr>InCatalog</h3>
32793287
<li class="tsd-description">
32803288
<aside class="tsd-sources">
32813289
<ul>
3282-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5275</li>
3290+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5293</li>
32833291
</ul>
32843292
</aside>
32853293
<div class="tsd-comment tsd-typography">
@@ -3305,7 +3313,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
33053313
<li class="tsd-description">
33063314
<aside class="tsd-sources">
33073315
<ul>
3308-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5305</li>
3316+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5323</li>
33093317
</ul>
33103318
</aside>
33113319
<div class="tsd-comment tsd-typography">
@@ -3354,7 +3362,7 @@ <h3>update<wbr>Product<wbr>Category<wbr>Assignment</h3>
33543362
<li class="tsd-description">
33553363
<aside class="tsd-sources">
33563364
<ul>
3357-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5436</li>
3365+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5454</li>
33583366
</ul>
33593367
</aside>
33603368
<div class="tsd-comment tsd-typography">
@@ -3386,7 +3394,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
33863394
<li class="tsd-description">
33873395
<aside class="tsd-sources">
33883396
<ul>
3389-
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5476</li>
3397+
<li>Defined in renderedTemplates/catalogs/apis/DefaultApi.ts:5494</li>
33903398
</ul>
33913399
</aside>
33923400
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)