@constructor-io/constructorio-client-javascript 2.27.11 → 2.27.12
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/lib/modules/browse.js +5 -0
- package/package.json +1 -1
package/lib/modules/browse.js
CHANGED
|
@@ -226,6 +226,7 @@ var Browse = /*#__PURE__*/function () {
|
|
|
226
226
|
* @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
|
|
227
227
|
* @param {string} [parameters.sortBy='relevance'] - The sort method for results
|
|
228
228
|
* @param {string} [parameters.sortOrder='descending'] - The sort order for results
|
|
229
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
229
230
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
230
231
|
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
|
|
231
232
|
* @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
|
|
@@ -305,6 +306,7 @@ var Browse = /*#__PURE__*/function () {
|
|
|
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 facets to return
|
|
@@ -376,6 +378,7 @@ var Browse = /*#__PURE__*/function () {
|
|
|
376
378
|
*
|
|
377
379
|
* @function getBrowseGroups
|
|
378
380
|
* @param {object} [parameters.filters] - Filters used to refine results
|
|
381
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
379
382
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
380
383
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
381
384
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
@@ -441,6 +444,7 @@ var Browse = /*#__PURE__*/function () {
|
|
|
441
444
|
* @function getBrowseFacets
|
|
442
445
|
* @param {object} [parameters] - Additional parameters to refine result set
|
|
443
446
|
* @param {number} [parameters.page] - The page number of the results
|
|
447
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
444
448
|
* @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
|
|
445
449
|
* @param {number} [parameters.resultsPerPage] - The number of results per page to return
|
|
446
450
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
@@ -504,6 +508,7 @@ var Browse = /*#__PURE__*/function () {
|
|
|
504
508
|
* @param {object} [networkParameters] - Parameters relevant to the network request
|
|
505
509
|
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
|
|
506
510
|
* @param {object} [parameters] - Additional parameters to refine result set
|
|
511
|
+
* @param {string} [parameters.section='Products'] - The section name for results
|
|
507
512
|
* @param {object} [parameters.fmtOptions] - The format options used to refine result groups
|
|
508
513
|
* @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
|
|
509
514
|
* @param {}
|