@constructor-io/constructorio-node 3.8.8 → 3.8.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/modules/browse.js +5 -0
package/package.json
CHANGED
package/src/modules/browse.js
CHANGED
|
@@ -223,6 +223,7 @@ class Browse {
|
|
|
223
223
|
* @param {object} [parameters.filters] - Filters used to refine results
|
|
224
224
|
* @param {string} [parameters.sortBy='relevance'] - The sort method for results
|
|
225
225
|
* @param {string} [parameters.sortOrder='descending'] - The sort order for results
|
|
226
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
226
227
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
227
228
|
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
|
|
228
229
|
* @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
|
|
@@ -305,6 +306,7 @@ class Browse {
|
|
|
305
306
|
* @param {object} [parameters.filters] - Filters used to refine results
|
|
306
307
|
* @param {string} [parameters.sortBy='relevance'] - The sort method for results
|
|
307
308
|
* @param {string} [parameters.sortOrder='descending'] - The sort order for results
|
|
309
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
308
310
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
309
311
|
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
|
|
310
312
|
* @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
|
|
@@ -375,6 +377,7 @@ class Browse {
|
|
|
375
377
|
*
|
|
376
378
|
* @function getBrowseGroups
|
|
377
379
|
* @param {object} [parameters.filters] - Filters used to refine results
|
|
380
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
378
381
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
379
382
|
* @param {object} [userParameters] - Parameters relevant to the user request
|
|
380
383
|
* @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
|
|
@@ -433,6 +436,7 @@ class Browse {
|
|
|
433
436
|
* @function getBrowseFacets
|
|
434
437
|
* @param {object} [parameters] - Additional parameters to refine result set
|
|
435
438
|
* @param {number} [parameters.page] - The page number of the results
|
|
439
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
436
440
|
* @param {number} [parameters.resultsPerPage] - The number of results per page to return
|
|
437
441
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
438
442
|
* @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
|
|
@@ -492,6 +496,7 @@ class Browse {
|
|
|
492
496
|
* @function getBrowseFacetOptions
|
|
493
497
|
* @param {string} facetName - Name of the facet whose options to return
|
|
494
498
|
* @param {object} [parameters] - Additional parameters to refine result set
|
|
499
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
495
500
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
496
501
|
* @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
|
|
497
502
|
* @param {boolean} [parameters.fmtOptions.show_protected_facets] - Include facets configured as protected
|