@constructor-io/constructorio-node 4.16.3 → 4.17.0

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@constructor-io/constructorio-node",
3
- "version": "4.16.3",
3
+ "version": "4.17.0",
4
4
  "description": "Constructor.io Node.js client",
5
5
  "main": "src/constructorio.js",
6
6
  "types": "src/types/constructorio.d.ts",
@@ -147,8 +147,8 @@ class Autocomplete {
147
147
  * @param {object} [parameters.filtersPerSection] - Filters used to refine search per section
148
148
  * @param {object} [parameters.resultsPerSection] - Number of results to return (value) per section (key)
149
149
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
150
- * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
151
- * @param {object} [parameters.preFilterExpression] - Faceting expression to scope autocomplete results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
150
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
151
+ * @param {object} [parameters.preFilterExpression] - Faceting expression to scope autocomplete results. Please refer to https://docs.constructor.com/reference/configuration-collections for details
152
152
  * @param {object} [userParameters] - Parameters relevant to the user request
153
153
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
154
154
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -160,7 +160,7 @@ class Autocomplete {
160
160
  * @param {object} [networkParameters] - Parameters relevant to the network request
161
161
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
162
162
  * @returns {Promise}
163
- * @see https://docs.constructor.io/rest_api/autocomplete_queries
163
+ * @see https://docs.constructor.com/reference/autocomplete-autocomplete-results
164
164
  * @example
165
165
  * constructorio.autocomplete.getAutocompleteResults('t-shirt', {
166
166
  * resultsPerSection: {
@@ -256,9 +256,9 @@ class Browse {
256
256
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
257
257
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
258
258
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
259
- * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
260
- * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
261
- * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/browse/queries for details
259
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
260
+ * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections for details
261
+ * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/browse-browse-results for details
262
262
  * @param {object} [userParameters] - Parameters relevant to the user request
263
263
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
264
264
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -270,7 +270,7 @@ class Browse {
270
270
  * @param {object} [networkParameters] - Parameters relevant to the network request
271
271
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
272
272
  * @returns {Promise}
273
- * @see https://docs.constructor.io/rest_api/browse/results
273
+ * @see https://docs.constructor.com/reference/shared-results-response-structure
274
274
  * @example
275
275
  * constructorio.browse.getBrowseResults('group_id', 't-shirts', {
276
276
  * resultsPerPage: 40,
@@ -339,7 +339,7 @@ class Browse {
339
339
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
340
340
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
341
341
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
342
- * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
342
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
343
343
  * @param {object} [userParameters] - Parameters relevant to the user request
344
344
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
345
345
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -351,7 +351,7 @@ class Browse {
351
351
  * @param {object} [networkParameters] - Parameters relevant to the network request
352
352
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
353
353
  * @returns {Promise}
354
- * @see https://docs.constructor.io/rest_api/browse/items/
354
+ * @see https://docs.constructor.com/reference/v1-browse-get-browse-items-results
355
355
  * @example
356
356
  * constructorio.browse.getBrowseResultsForItemIds(['shirt-123', 'shirt-456', 'shirt-789'], {
357
357
  * filters: {
@@ -416,7 +416,7 @@ class Browse {
416
416
  * @param {object} [networkParameters] - Parameters relevant to the network request
417
417
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
418
418
  * @returns {Promise}
419
- * @see https://docs.constructor.io/rest_api/browse/groups
419
+ * @see https://docs.constructor.com/reference/v1-browse-get-browse-groups
420
420
  * @example
421
421
  * constructorio.browse.getBrowseGroups({
422
422
  * filters: {
@@ -475,7 +475,7 @@ class Browse {
475
475
  * @param {object} [networkParameters] - Parameters relevant to the network request
476
476
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
477
477
  * @returns {Promise}
478
- * @see https://docs.constructor.io/rest_api/browse/facets
478
+ * @see https://docs.constructor.com/reference/browse-browse-facets
479
479
  * @example
480
480
  * constructorio.browse.getBrowseFacets({
481
481
  * page: 1,
@@ -531,7 +531,7 @@ class Browse {
531
531
  * @param {object} [networkParameters] - Parameters relevant to the network request
532
532
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
533
533
  * @returns {Promise}
534
- * @see https://docs.constructor.io/rest_api/browse/facet_options
534
+ * @see https://docs.constructor.com/reference/v1-browse-get-browse-facet-options
535
535
  * @example
536
536
  * constructorio.browse.getBrowseFacetOptions('price', {
537
537
  * fmtOptions: { ... },
@@ -185,14 +185,14 @@ class Catalog {
185
185
  *
186
186
  * @function createOrReplaceItems
187
187
  * @param {object} parameters - Additional parameters for item details
188
- * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.io/rest_api/items/items/#item-schema)
188
+ * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.com/reference/catalog-items)
189
189
  * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing items
190
190
  * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
191
191
  * @param {string} [parameters.section="Products"] - This indicates which section to operate on within the index
192
192
  * @param {object} [networkParameters] - Parameters relevant to the network request
193
193
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
194
194
  * @returns {Promise}
195
- * @see https://docs.constructor.io/rest_api/items/items#create-or-replace-items
195
+ * @see https://docs.constructor.com/reference/catalog-items
196
196
  * @example
197
197
  * constructorio.catalog.createOrReplaceItems({
198
198
  * items: [
@@ -266,7 +266,7 @@ class Catalog {
266
266
  *
267
267
  * @function updateItems
268
268
  * @param {object} parameters - Additional parameters for item details
269
- * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.io/rest_api/items/items/#item-schema)
269
+ * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.com/reference/catalog-items)
270
270
  * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing items
271
271
  * @param {string} [parameters.onMissing="FAIL"] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence
272
272
  * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
@@ -274,7 +274,7 @@ class Catalog {
274
274
  * @param {object} [networkParameters] - Parameters relevant to the network request
275
275
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
276
276
  * @returns {Promise}
277
- * @see https://docs.constructor.io/rest_api/items/items#update-items
277
+ * @see https://docs.constructor.com/reference/catalog-items
278
278
  * @example
279
279
  * constructorio.catalog.updateItems({
280
280
  * items: [
@@ -358,14 +358,14 @@ class Catalog {
358
358
  *
359
359
  * @function deleteItems
360
360
  * @param {object} parameters - Additional parameters for item details
361
- * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.io/rest_api/items/items/#item-schema)
361
+ * @param {object[]} parameters.items - A list of items with the same attributes as defined in the Item schema resource (https://docs.constructor.com/reference/catalog-items)
362
362
  * @param {string} [parameters.section="Products"] - This indicates which section to operate on within the index
363
363
  * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
364
364
  * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing items
365
365
  * @param {object} [networkParameters] - Parameters relevant to the network request
366
366
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
367
367
  * @returns {Promise}
368
- * @see https://docs.constructor.io/rest_api/items/items#delete-items
368
+ * @see https://docs.constructor.com/reference/catalog-items
369
369
  * @example
370
370
  * constructorio.catalog.deleteItems({
371
371
  * items: [
@@ -438,7 +438,7 @@ class Catalog {
438
438
  * @param {object} [networkParameters] - Parameters relevant to the network request
439
439
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
440
440
  * @returns {Promise}
441
- * @see https://docs.constructor.io/rest_api/items/items#retrieve-items
441
+ * @see https://docs.constructor.com/reference/catalog-items
442
442
  * @example
443
443
  * constructorio.catalog.retrieveItems({
444
444
  * section: 'Products',
@@ -507,14 +507,14 @@ class Catalog {
507
507
  *
508
508
  * @function createOrReplaceVariations
509
509
  * @param {object} parameters - Additional parameters for variation details
510
- * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.io/rest_api/items/variations/#variation-schema)
510
+ * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.com/reference/catalog-variations)
511
511
  * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing variations
512
512
  * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
513
513
  * @param {string} [parameters.section="Products"] - This indicates which section to operate on within the index
514
514
  * @param {object} [networkParameters] - Parameters relevant to the network request
515
515
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
516
516
  * @returns {Promise}
517
- * @see https://docs.constructor.io/rest_api/items/variations/#create-or-replace-variations
517
+ * @see https://docs.constructor.com/reference/catalog-variations
518
518
  * @example
519
519
  * constructorio.catalog.createOrReplaceVariations({
520
520
  * variations: [
@@ -590,7 +590,7 @@ class Catalog {
590
590
  *
591
591
  * @function updateVariations
592
592
  * @param {object} parameters - Additional parameters for variation details
593
- * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.io/rest_api/items/variations/#variation-schema)
593
+ * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.com/reference/catalog-variations)
594
594
  * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing variations
595
595
  * @param {string} [parameters.onMissing="FAIL"] - Defines the strategy for handling items which are present in the file and missing in the system. IGNORE silently prevents adding them to the system, CREATE creates them, FAIL fails the ingestion in case of their presence
596
596
  * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
@@ -598,7 +598,7 @@ class Catalog {
598
598
  * @param {object} [networkParameters] - Parameters relevant to the network request
599
599
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
600
600
  * @returns {Promise}
601
- * @see https://docs.constructor.io/rest_api/items/variations/#update-variations
601
+ * @see https://docs.constructor.com/reference/catalog-variations
602
602
  * @example
603
603
  * constructorio.catalog.updateVariations({
604
604
  * variations: [
@@ -683,14 +683,14 @@ class Catalog {
683
683
  *
684
684
  * @function deleteVariations
685
685
  * @param {object} parameters - Additional parameters for variation details
686
- * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.io/rest_api/items/variations/#variation-schema)
686
+ * @param {object[]} parameters.variations - A list of variations with the same attributes as defined in the Variation schema resource (https://docs.constructor.com/reference/catalog-variations)
687
687
  * @param {boolean} [parameters.force=false] - Process the request even if it will invalidate a large number of existing variations
688
688
  * @param {string} [parameters.notificationEmail] - An email address where you'd like to receive an email notification in case the task fails
689
689
  * @param {string} [parameters.section="Products"] - This indicates which section to operate on within the index
690
690
  * @param {object} [networkParameters] - Parameters relevant to the network request
691
691
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
692
692
  * @returns {Promise}
693
- * @see https://docs.constructor.io/rest_api/items/variations/#delete-variations
693
+ * @see https://docs.constructor.com/reference/catalog-variations
694
694
  * @example
695
695
  * constructorio.catalog.deleteVariations({
696
696
  * variations: [
@@ -764,7 +764,7 @@ class Catalog {
764
764
  * @param {object} [networkParameters] - Parameters relevant to the network request
765
765
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
766
766
  * @returns {Promise}
767
- * @see https://docs.constructor.io/rest_api/items/variations/#retrieve-variations
767
+ * @see https://docs.constructor.com/reference/catalog-variations
768
768
  * @example
769
769
  * constructorio.catalog.retrieveVariations({
770
770
  * section: 'Products',
@@ -846,7 +846,7 @@ class Catalog {
846
846
  * @param {object} [networkParameters] - Parameters relevant to the network request
847
847
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
848
848
  * @returns {Promise}
849
- * @see https://docs.constructor.io/rest_api/item_groups
849
+ * @see https://docs.constructor.com/reference/catalog-item-groups
850
850
  * @example
851
851
  * constructorio.catalog.addItemGroup({
852
852
  * id: 'subcat_12891',
@@ -896,7 +896,7 @@ class Catalog {
896
896
  * @param {object} [networkParameters] - Parameters relevant to the network request
897
897
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
898
898
  * @returns {Promise}
899
- * @see https://docs.constructor.io/rest_api/item_groups
899
+ * @see https://docs.constructor.com/reference/catalog-item-groups
900
900
  * @example
901
901
  * constructorio.catalog.addItemGroups({
902
902
  * itemGroups: [
@@ -958,7 +958,7 @@ class Catalog {
958
958
  * @param {object} [networkParameters] - Parameters relevant to the network request
959
959
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
960
960
  * @returns {Promise}
961
- * @see https://docs.constructor.io/rest_api/item_groups
961
+ * @see https://docs.constructor.com/reference/catalog-item-groups
962
962
  * @example
963
963
  * constructorio.catalog.getItemGroup({
964
964
  * id: 'subcat_12891',
@@ -1002,7 +1002,7 @@ class Catalog {
1002
1002
  * @param {object} [networkParameters] - Parameters relevant to the network request
1003
1003
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1004
1004
  * @returns {Promise}
1005
- * @see https://docs.constructor.io/rest_api/item_groups
1005
+ * @see https://docs.constructor.com/reference/catalog-item-groups
1006
1006
  * @example
1007
1007
  * constructorio.catalog.getItemGroups();
1008
1008
  */
@@ -1046,7 +1046,7 @@ class Catalog {
1046
1046
  * @param {object} [networkParameters] - Parameters relevant to the network request
1047
1047
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1048
1048
  * @returns {Promise}
1049
- * @see https://docs.constructor.io/rest_api/item_groups
1049
+ * @see https://docs.constructor.com/reference/catalog-item-groups
1050
1050
  * @example
1051
1051
  * constructorio.catalog.addOrUpdateItemGroups({
1052
1052
  * itemGroups: [
@@ -1110,7 +1110,7 @@ class Catalog {
1110
1110
  * @param {object} [networkParameters] - Parameters relevant to the network request
1111
1111
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1112
1112
  * @returns {Promise}
1113
- * @see https://docs.constructor.io/rest_api/item_groups
1113
+ * @see https://docs.constructor.com/reference/catalog-item-groups
1114
1114
  * @example
1115
1115
  * constructorio.catalog.modifyItemGroup({
1116
1116
  * id: 'subcat_12891',
@@ -1161,7 +1161,7 @@ class Catalog {
1161
1161
  * @param {object} [networkParameters] - Parameters relevant to the network request
1162
1162
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1163
1163
  * @returns {Promise}
1164
- * @see https://docs.constructor.io/rest_api/item_groups
1164
+ * @see https://docs.constructor.com/reference/catalog-item-groups
1165
1165
  * @example
1166
1166
  * constructorio.catalog.removeItemGroups();
1167
1167
  */
@@ -1203,7 +1203,7 @@ class Catalog {
1203
1203
  * @param {object} [networkParameters] - Parameters relevant to the network request
1204
1204
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1205
1205
  * @returns {Promise}
1206
- * @see https://docs.constructor.io/rest_api/one_way_synonyms/add_synonyms
1206
+ * @see https://docs.constructor.com/reference/v2-one-way-synonyms-create-one-way-synonym
1207
1207
  * @example
1208
1208
  * constructorio.catalog.addOneWaySynonym({
1209
1209
  * phrase: 'spices',
@@ -1256,7 +1256,7 @@ class Catalog {
1256
1256
  * @param {object} [networkParameters] - Parameters relevant to the network request
1257
1257
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1258
1258
  * @returns {Promise}
1259
- * @see https://docs.constructor.io/rest_api/one_way_synonyms/modify_synonyms
1259
+ * @see https://docs.constructor.com/reference/v2-one-way-synonyms-replace-one-way-synonym
1260
1260
  * @example
1261
1261
  * constructorio.catalog.modifyOneWaySynonym({
1262
1262
  * phrase: 'spices',
@@ -1309,7 +1309,7 @@ class Catalog {
1309
1309
  * @param {object} [networkParameters] - Parameters relevant to the network request
1310
1310
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1311
1311
  * @returns {Promise}
1312
- * @see https://docs.constructor.io/rest_api/one_way_synonyms/retrieve_synonyms
1312
+ * @see https://docs.constructor.com/reference/v2-one-way-synonyms-retrieve-one-way-synonyms
1313
1313
  * @example
1314
1314
  * constructorio.catalog.getOneWaySynonym({
1315
1315
  * phrase: 'spices',
@@ -1358,7 +1358,7 @@ class Catalog {
1358
1358
  * @param {object} [networkParameters] - Parameters relevant to the network request
1359
1359
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1360
1360
  * @returns {Promise}
1361
- * @see https://docs.constructor.io/rest_api/one_way_synonyms/retrieve_synonyms
1361
+ * @see https://docs.constructor.com/reference/v2-one-way-synonyms-retrieve-one-way-synonyms
1362
1362
  * @example
1363
1363
  * constructorio.catalog.getOneWaySynonyms({
1364
1364
  * numResultsPerPage: 50,
@@ -1420,7 +1420,7 @@ class Catalog {
1420
1420
  * @param {object} [networkParameters] - Parameters relevant to the network request
1421
1421
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1422
1422
  * @returns {Promise}
1423
- * @see https://docs.constructor.io/rest_api/one_way_synonyms/remove_synonyms
1423
+ * @see https://docs.constructor.com/reference/v2-one-way-synonyms-delete-one-way-synonyms
1424
1424
  * @example
1425
1425
  * constructorio.catalog.removeOneWaySynonym({
1426
1426
  * phrase: 'spices',
@@ -1464,7 +1464,7 @@ class Catalog {
1464
1464
  * @param {object} [networkParameters] - Parameters relevant to the network request
1465
1465
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1466
1466
  * @returns {Promise}
1467
- * @see https://docs.constructor.io/rest_api/one_way_synonyms/remove_synonyms
1467
+ * @see https://docs.constructor.com/reference/v2-one-way-synonyms-delete-one-way-synonyms
1468
1468
  * @example
1469
1469
  * constructorio.catalog.removeOneWaySynonyms();
1470
1470
  */
@@ -1507,7 +1507,7 @@ class Catalog {
1507
1507
  * @param {object} [networkParameters] - Parameters relevant to the network request
1508
1508
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1509
1509
  * @returns {Promise}
1510
- * @see https://docs.constructor.io/rest_api/synonyms/
1510
+ * @see https://docs.constructor.com/reference/configuration-synonym-groups
1511
1511
  * @example
1512
1512
  * constructorio.catalog.addSynonymGroup({
1513
1513
  * synonyms: ['0% milk', 'skim milk'],
@@ -1555,7 +1555,7 @@ class Catalog {
1555
1555
  * @param {object} [networkParameters] - Parameters relevant to the network request
1556
1556
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1557
1557
  * @returns {Promise}
1558
- * @see https://docs.constructor.io/rest_api/synonyms/
1558
+ * @see https://docs.constructor.com/reference/configuration-synonym-groups
1559
1559
  * @example
1560
1560
  * constructorio.catalog.modifySynonymGroup({
1561
1561
  * id: 32,
@@ -1604,7 +1604,7 @@ class Catalog {
1604
1604
  * @param {object} [networkParameters] - Parameters relevant to the network request
1605
1605
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1606
1606
  * @returns {Promise}
1607
- * @see https://docs.constructor.io/rest_api/synonyms/
1607
+ * @see https://docs.constructor.com/reference/configuration-synonym-groups
1608
1608
  * @example
1609
1609
  * constructorio.catalog.modifySynonymGroup({
1610
1610
  * id: 32,
@@ -1649,7 +1649,7 @@ class Catalog {
1649
1649
  * @param {object} [networkParameters] - Parameters relevant to the network request
1650
1650
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1651
1651
  * @returns {Promise}
1652
- * @see https://docs.constructor.io/rest_api/synonyms/
1652
+ * @see https://docs.constructor.com/reference/configuration-synonym-groups
1653
1653
  * @example
1654
1654
  * constructorio.catalog.modifySynonymGroup({
1655
1655
  * phrase: '0% milk',
@@ -1710,7 +1710,7 @@ class Catalog {
1710
1710
  * @param {object} [networkParameters] - Parameters relevant to the network request
1711
1711
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1712
1712
  * @returns {Promise}
1713
- * @see https://docs.constructor.io/rest_api/synonyms/
1713
+ * @see https://docs.constructor.com/reference/configuration-synonym-groups
1714
1714
  * @example
1715
1715
  * constructorio.catalog.removeSynonymGroup({
1716
1716
  * id: 32,
@@ -1752,7 +1752,7 @@ class Catalog {
1752
1752
  * @param {object} [networkParameters] - Parameters relevant to the network request
1753
1753
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1754
1754
  * @returns {Promise}
1755
- * @see https://docs.constructor.io/rest_api/synonyms/
1755
+ * @see https://docs.constructor.com/reference/configuration-synonym-groups
1756
1756
  * @example
1757
1757
  * constructorio.catalog.modifySynonymGroup();
1758
1758
  */
@@ -1798,7 +1798,7 @@ class Catalog {
1798
1798
  * @param {object} [networkParameters] - Parameters relevant to the network request
1799
1799
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1800
1800
  * @returns {Promise}
1801
- * @see https://docs.constructor.io/rest_api/redirect_rules
1801
+ * @see https://docs.constructor.com/reference/configuration-redirect-rules
1802
1802
  * @example
1803
1803
  * constructorio.catalog.addRedirectRule({
1804
1804
  * url: '/categories/cat_49203',
@@ -1865,7 +1865,7 @@ class Catalog {
1865
1865
  * @param {object} [networkParameters] - Parameters relevant to the network request
1866
1866
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1867
1867
  * @returns {Promise}
1868
- * @see https://docs.constructor.io/rest_api/redirect_rules
1868
+ * @see https://docs.constructor.com/reference/configuration-redirect-rules
1869
1869
  * @example
1870
1870
  * constructorio.catalog.updateRedirectRule({
1871
1871
  * id: 1,
@@ -1932,7 +1932,7 @@ class Catalog {
1932
1932
  * @param {object} [networkParameters] - Parameters relevant to the network request
1933
1933
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1934
1934
  * @returns {Promise}
1935
- * @see https://docs.constructor.io/rest_api/redirect_rules
1935
+ * @see https://docs.constructor.com/reference/configuration-redirect-rules
1936
1936
  * @example
1937
1937
  * constructorio.catalog.modifyRedirectRule({
1938
1938
  * id: '1',
@@ -1990,7 +1990,7 @@ class Catalog {
1990
1990
  * @param {object} [networkParameters] - Parameters relevant to the network request
1991
1991
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
1992
1992
  * @returns {Promise}
1993
- * @see https://docs.constructor.io/rest_api/redirect_rules
1993
+ * @see https://docs.constructor.com/reference/configuration-redirect-rules
1994
1994
  * @example
1995
1995
  * constructorio.catalog.getRedirectRule({
1996
1996
  * id: '1',
@@ -2036,7 +2036,7 @@ class Catalog {
2036
2036
  * @param {object} [networkParameters] - Parameters relevant to the network request
2037
2037
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2038
2038
  * @returns {Promise}
2039
- * @see https://docs.constructor.io/rest_api/redirect_rules
2039
+ * @see https://docs.constructor.com/reference/configuration-redirect-rules
2040
2040
  * @example
2041
2041
  * constructorio.catalog.getRedirectRules({
2042
2042
  * numResultsPerPage: 50,
@@ -2107,7 +2107,7 @@ class Catalog {
2107
2107
  * @param {object} [networkParameters] - Parameters relevant to the network request
2108
2108
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2109
2109
  * @returns {Promise}
2110
- * @see https://docs.constructor.io/rest_api/redirect_rules
2110
+ * @see https://docs.constructor.com/reference/configuration-redirect-rules
2111
2111
  * @example
2112
2112
  * constructorio.catalog.removeRedirectRule({
2113
2113
  * id: '1',
@@ -2155,7 +2155,7 @@ class Catalog {
2155
2155
  * @param {object} [networkParameters] - Parameters relevant to the network request
2156
2156
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2157
2157
  * @returns {Promise}
2158
- * @see https://docs.constructor.io/rest_api/full_catalog
2158
+ * @see https://docs.constructor.com/reference/catalog-catalog
2159
2159
  * @example
2160
2160
  * constructorio.catalog.replaceCatalog({
2161
2161
  * section: 'Products',
@@ -2207,7 +2207,7 @@ class Catalog {
2207
2207
  * @param {object} [networkParameters] - Parameters relevant to the network request
2208
2208
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2209
2209
  * @returns {Promise}
2210
- * @see https://docs.constructor.io/rest_api/full_catalog
2210
+ * @see https://docs.constructor.com/reference/catalog-catalog
2211
2211
  * @example
2212
2212
  * constructorio.catalog.updateCatalog({
2213
2213
  * section: 'Products',
@@ -2260,7 +2260,7 @@ class Catalog {
2260
2260
  * @param {object} [networkParameters] - Parameters relevant to the network request
2261
2261
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2262
2262
  * @returns {Promise}
2263
- * @see https://docs.constructor.io/rest_api/full_catalog
2263
+ * @see https://docs.constructor.com/reference/catalog-catalog
2264
2264
  * @example
2265
2265
  * constructorio.catalog.patchCatalog({
2266
2266
  * section: 'Products',
@@ -2310,7 +2310,7 @@ class Catalog {
2310
2310
  * @param {object} [networkParameters] - Parameters relevant to the network request
2311
2311
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2312
2312
  * @returns {Promise}
2313
- * @see https://docs.constructor.io/rest_api/full_catalog
2313
+ * @see https://docs.constructor.com/reference/catalog-catalog
2314
2314
  * @example
2315
2315
  * constructorio.catalog.replaceCatalogUsingTarArchive({
2316
2316
  * section: 'Products',
@@ -2366,7 +2366,7 @@ class Catalog {
2366
2366
  * @param {object} [networkParameters] - Parameters relevant to the network request
2367
2367
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2368
2368
  * @returns {Promise}
2369
- * @see https://docs.constructor.io/rest_api/full_catalog
2369
+ * @see https://docs.constructor.com/reference/catalog-catalog
2370
2370
  * @example
2371
2371
  * constructorio.catalog.updateCatalogUsingTarArchive({
2372
2372
  * section: 'Products',
@@ -2425,7 +2425,7 @@ class Catalog {
2425
2425
  * @param {object} [networkParameters] - Parameters relevant to the network request
2426
2426
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2427
2427
  * @returns {Promise}
2428
- * @see https://docs.constructor.io/rest_api/full_catalog
2428
+ * @see https://docs.constructor.com/reference/catalog-catalog
2429
2429
  * @example
2430
2430
  * constructorio.catalog.patchCatalogUsingTarArchive({
2431
2431
  * section: 'Products',
@@ -2495,7 +2495,7 @@ class Catalog {
2495
2495
  * @param {object} [networkParameters] - Parameters relevant to the network request
2496
2496
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2497
2497
  * @returns {Promise}
2498
- * @see https://docs.constructor.io/rest_api/facets#create-a-facet-config
2498
+ * @see https://docs.constructor.com/reference/configuration-facets
2499
2499
  * @example
2500
2500
  * constructorio.catalog.addFacetConfiguration({
2501
2501
  * name: 'color',
@@ -2552,7 +2552,7 @@ class Catalog {
2552
2552
  * @param {object} [networkParameters] - Parameters relevant to the network request
2553
2553
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2554
2554
  * @returns {Promise}
2555
- * @see https://docs.constructor.io/rest_api/facets#get-all-facet-configs
2555
+ * @see https://docs.constructor.com/reference/configuration-facets
2556
2556
  * @example
2557
2557
  * constructorio.catalog.getFacetConfigurations({
2558
2558
  * page: 2,
@@ -2612,7 +2612,7 @@ class Catalog {
2612
2612
  * @param {object} [networkParameters] - Parameters relevant to the network request
2613
2613
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2614
2614
  * @returns {Promise}
2615
- * @see https://docs.constructor.io/rest_api/facets#get-a-single-facets-config
2615
+ * @see https://docs.constructor.com/reference/configuration-facets
2616
2616
  * @example
2617
2617
  * constructorio.catalog.getFacetConfiguration({
2618
2618
  * name: 'color',
@@ -2662,7 +2662,7 @@ class Catalog {
2662
2662
  * @param {object} [networkParameters] - Parameters relevant to the network request
2663
2663
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2664
2664
  * @returns {Promise}
2665
- * @see https://docs.constructor.io/rest_api/facets#update-facet-configs-partial
2665
+ * @see https://docs.constructor.com/reference/configuration-facets
2666
2666
  * @example
2667
2667
  * constructorio.catalog.modifyFacetConfigurations(
2668
2668
  * facetConfigurations: [
@@ -2745,7 +2745,7 @@ class Catalog {
2745
2745
  * @param {object} [networkParameters] - Parameters relevant to the network request
2746
2746
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2747
2747
  * @returns {Promise}
2748
- * @see https://docs.constructor.io/rest_api/facets#update-a-facet-config-total
2748
+ * @see https://docs.constructor.com/reference/configuration-facets
2749
2749
  * @example
2750
2750
  * constructorio.catalog.replaceFacetConfiguration({
2751
2751
  * name: 'color',
@@ -2817,7 +2817,7 @@ class Catalog {
2817
2817
  * @param {object} [networkParameters] - Parameters relevant to the network request
2818
2818
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2819
2819
  * @returns {Promise}
2820
- * @see https://docs.constructor.io/rest_api/facets#update-a-facet-config-partial
2820
+ * @see https://docs.constructor.com/reference/configuration-facets
2821
2821
  * @example
2822
2822
  * constructorio.catalog.modifyFacetConfiguration({
2823
2823
  * name: 'color',
@@ -2876,7 +2876,7 @@ class Catalog {
2876
2876
  * @param {object} [networkParameters] - Parameters relevant to the network request
2877
2877
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2878
2878
  * @returns {Promise}
2879
- * @see https://docs.constructor.io/rest_api/facets#delete-a-facet-config
2879
+ * @see https://docs.constructor.com/reference/configuration-facets
2880
2880
  * @example
2881
2881
  * constructorio.catalog.removeFacetConfiguration({
2882
2882
  * name: 'color',
@@ -2931,7 +2931,7 @@ class Catalog {
2931
2931
  * @param {object} [networkParameters] - Parameters relevant to the network request
2932
2932
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2933
2933
  * @returns {Promise}
2934
- * @see https://docs.constructor.io/rest_api/facet_options#create-a-facet-option-config
2934
+ * @see https://docs.constructor.com/reference/configuration-facets
2935
2935
  * @example
2936
2936
  * constructorio.catalog.addFacetOptionConfiguration({
2937
2937
  * facetGroupName: 'color',
@@ -2987,7 +2987,7 @@ class Catalog {
2987
2987
  * @param {object} [networkParameters] - Parameters relevant to the network request
2988
2988
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
2989
2989
  * @returns {Promise}
2990
- * @see https://docs.constructor.io/rest_api/facet_options#batch-update-or-create-facet-options-configs
2990
+ * @see https://docs.constructor.com/reference/configuration-facets
2991
2991
  * @example
2992
2992
  * constructorio.catalog.addOrModifyFacetOptionConfigurations({
2993
2993
  * facetGroupName: 'color',
@@ -3054,7 +3054,7 @@ class Catalog {
3054
3054
  * @param {object} [networkParameters] - Parameters relevant to the network request
3055
3055
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3056
3056
  * @returns {Promise}
3057
- * @see https://docs.constructor.io/rest_api/facet_options#get-all-option-configs-for-facet
3057
+ * @see https://docs.constructor.com/reference/configuration-facets
3058
3058
  * @example
3059
3059
  * constructorio.catalog.getFacetOptionConfigurations({
3060
3060
  * facetGroupName: 'color',
@@ -3122,7 +3122,7 @@ class Catalog {
3122
3122
  * @param {object} [networkParameters] - Parameters relevant to the network request
3123
3123
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3124
3124
  * @returns {Promise}
3125
- * @see https://docs.constructor.io/rest_api/facet_options#get-a-single-facet-option-config
3125
+ * @see https://docs.constructor.com/reference/configuration-facets
3126
3126
  * @example
3127
3127
  * constructorio.catalog.getFacetOptionConfiguration({
3128
3128
  * facetGroupName: 'color',
@@ -3179,7 +3179,7 @@ class Catalog {
3179
3179
  * @param {object} [networkParameters] - Parameters relevant to the network request
3180
3180
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3181
3181
  * @returns {Promise}
3182
- * @see https://docs.constructor.io/rest_api/facet_options#update-facet-option-total
3182
+ * @see https://docs.constructor.com/reference/configuration-facets
3183
3183
  * @example
3184
3184
  * constructorio.catalog.replaceFacetOptionConfiguration({
3185
3185
  * facetGroupName: 'color',
@@ -3239,7 +3239,7 @@ class Catalog {
3239
3239
  * @param {object} [networkParameters] - Parameters relevant to the network request
3240
3240
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3241
3241
  * @returns {Promise}
3242
- * @see https://docs.constructor.io/rest_api/facet_options#update-facet-option-partial
3242
+ * @see https://docs.constructor.com/reference/configuration-facets
3243
3243
  * @example
3244
3244
  * constructorio.catalog.modifyFacetOptionConfiguration({
3245
3245
  * facetGroupName: 'color',
@@ -3295,7 +3295,7 @@ class Catalog {
3295
3295
  * @param {object} [networkParameters] - Parameters relevant to the network request
3296
3296
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3297
3297
  * @returns {Promise}
3298
- * @see https://docs.constructor.io/rest_api/facet_options#delete-a-facet-option-config
3298
+ * @see https://docs.constructor.com/reference/configuration-facets
3299
3299
  * @example
3300
3300
  * constructorio.removeFacetOptionConfiguration({
3301
3301
  * facetGroupName: 'color',
@@ -3353,7 +3353,7 @@ class Catalog {
3353
3353
  * @param {object} [networkParameters] - Parameters relevant to the network request
3354
3354
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3355
3355
  * @returns {Promise}
3356
- * @see https://docs.constructor.io/rest_api/searchabilities/#retrieve-searchabilities
3356
+ * @see https://docs.constructor.com/reference/configuration-searchabilities
3357
3357
  * @example
3358
3358
  * constructorio.catalog.retrieveSearchabilities({
3359
3359
  * page: 2,
@@ -3443,12 +3443,12 @@ class Catalog {
3443
3443
  *
3444
3444
  * @function patchSearchabilities
3445
3445
  * @param {object} parameters - Additional parameters for patching metadata searchabilities
3446
- * @param {object[]} parameters.searchabilities - Array of searchabilities. Additional information about the searchabilities schema can be found [here]{@link https://docs.constructor.io/rest_api/searchabilities/#patch-searchabilities}
3446
+ * @param {object[]} parameters.searchabilities - Array of searchabilities. Additional information about the searchabilities schema can be found [here]{@link https://docs.constructor.com/reference/configuration-searchabilities}
3447
3447
  * @param {string} [parameters.section] - The section in which the searchability is defined. Default value is Products
3448
3448
  * @param {object} [networkParameters] - Parameters relevant to the network request
3449
3449
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
3450
3450
  * @returns {Promise}
3451
- * @see https://docs.constructor.io/rest_api/searchabilities/#patch-searchabilities
3451
+ * @see https://docs.constructor.com/reference/configuration-searchabilities
3452
3452
  * @example
3453
3453
  * constructorio.catalog.patchSearchabilities({
3454
3454
  * searchabilities: [
@@ -1,3 +1,4 @@
1
+ /* eslint-disable max-len */
1
2
  /* eslint-disable object-curly-newline, no-underscore-dangle */
2
3
  const qs = require('qs');
3
4
  const helpers = require('../utils/helpers');
@@ -107,10 +108,10 @@ class Quizzes {
107
108
  * @description Retrieve quiz question from Constructor.io API
108
109
  * @param {string} quizId - The identifier of the quiz
109
110
  * @param {string} parameters - Additional parameters to refine result set
110
- * @param {array} parameters.answers - An array of answers in the format [[1,2],[1]]
111
+ * @param {array} parameters.answers - An array of answers in the format [[1,2],[1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true", "false", "seen" or empty string ("") if skipped
111
112
  * @param {string} [parameters.section] - Product catalog section
112
- * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-versioning}
113
- * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions}
113
+ * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
114
+ * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
114
115
  * @param {object} [userParameters] - Parameters relevant to the user request
115
116
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
116
117
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -122,7 +123,7 @@ class Quizzes {
122
123
  * @param {object} [networkParameters] - Parameters relevant to the network request
123
124
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
124
125
  * @returns {Promise}
125
- * @see https://docs.constructor.io/rest_api/quiz/using_quizzes/#answering-a-quiz
126
+ * @see https://docs.constructor.com/reference/configuration-quizzes
126
127
  * @example
127
128
  * constructorio.quizzes.getQuizNextQuestion('quizId', {
128
129
  * answers: [[1,2],[1]],
@@ -185,10 +186,10 @@ class Quizzes {
185
186
  * @description Retrieve quiz recommendation and filter expression from Constructor.io API
186
187
  * @param {string} quizId - The identifier of the quiz
187
188
  * @param {string} parameters - Additional parameters to refine result set
188
- * @param {array} parameters.answers - An array of answers in the format [[1,2],[1]]
189
+ * @param {array} parameters.answers - An array of answers in the format [[1,2],[1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true", "false", "seen" or empty string ("") if skipped
189
190
  * @param {string} [parameters.section] - Product catalog section
190
- * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-versioning}
191
- * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions}
191
+ * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
192
+ * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found [here]{@link https://docs.constructor.com/reference/configuration-quizzes}
192
193
  * @param {number} [parameters.page] - The page number of the results
193
194
  * @param {number} [parameters.resultsPerPage] - The number of results per page to return
194
195
  * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
@@ -203,7 +204,7 @@ class Quizzes {
203
204
  * @param {object} [networkParameters] - Parameters relevant to the network request
204
205
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
205
206
  * @returns {Promise}
206
- * @see https://docs.constructor.io/rest_api/quiz/using_quizzes/#completing-the-quiz
207
+ * @see https://docs.constructor.com/reference/configuration-quizzes
207
208
  * @example
208
209
  * constructorio.quizzes.getQuizResults('quizId', {
209
210
  * answers: [[1,2],[1]],
@@ -110,7 +110,7 @@ class Recommendations {
110
110
  * @param {string} [parameters.section] - The section to return results from
111
111
  * @param {string} [parameters.term] - The term to use to refine results (strategy specific)
112
112
  * @param {object} [parameters.filters] - Key / value mapping of filters used to refine results
113
- * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
113
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
114
114
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
115
115
  * @param {object} [userParameters] - Parameters relevant to the user request
116
116
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
@@ -123,7 +123,7 @@ class Recommendations {
123
123
  * @param {object} [networkParameters] - Parameters relevant to the network request
124
124
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
125
125
  * @returns {Promise}
126
- * @see https://docs.constructor.io/rest_api/recommendations
126
+ * @see https://docs.constructor.com/reference/recommendations-recommendation-results
127
127
  * @example
128
128
  * constructorio.recommendations.getRecommendations('t-shirt-best-sellers', {
129
129
  * numResults: 5,
@@ -177,9 +177,9 @@ class Search {
177
177
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
178
178
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
179
179
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
180
- * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
181
- * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
182
- * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries for details
180
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
181
+ * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections for details
182
+ * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details
183
183
  * @param {object} [userParameters] - Parameters relevant to the user request
184
184
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
185
185
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -191,7 +191,7 @@ class Search {
191
191
  * @param {object} [networkParameters] - Parameters relevant to the network request
192
192
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
193
193
  * @returns {Promise}
194
- * @see https://docs.constructor.io/rest_api/search/
194
+ * @see https://docs.constructor.com/reference/search-search-results
195
195
  * @example
196
196
  * constructorio.search.getSearchResults('t-shirt', {
197
197
  * resultsPerPage: 40,
@@ -275,9 +275,9 @@ class Search {
275
275
  * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
276
276
  * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
277
277
  * @param {string[]} [parameters.hiddenFacets] - Hidden facet fields to return
278
- * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
279
- * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
280
- * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries for details
278
+ * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
279
+ * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections for details
280
+ * @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details
281
281
  * @param {object} [userParameters] - Parameters relevant to the user request
282
282
  * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
283
283
  * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results
@@ -289,7 +289,7 @@ class Search {
289
289
  * @param {object} [networkParameters] - Parameters relevant to the network request
290
290
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
291
291
  * @returns {Promise}
292
- * @see https://docs.constructor.io/rest_api/search/natural_language_search/
292
+ * @see https://docs.constructor.com/reference/search-search-resultsnatural_language_search/
293
293
  * @example
294
294
  * constructorio.search.getVoiceSearchResults('show me lipstick', {
295
295
  * resultsPerPage: 40,
@@ -52,7 +52,7 @@ class Tasks {
52
52
  * @param {object} [networkParameters] - Parameters relevant to the network request
53
53
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
54
54
  * @returns {Promise}
55
- * @see https://docs.constructor.io/rest_api/tasks/#retrieve-all-tasks
55
+ * @see https://docs.constructor.com/reference/catalog-tasks
56
56
  */
57
57
  getAllTasks(parameters = {}, networkParameters = {}) {
58
58
  const queryParams = {};
@@ -129,7 +129,7 @@ class Tasks {
129
129
  * @param {object} [networkParameters] - Parameters relevant to the network request
130
130
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
131
131
  * @returns {Promise}
132
- * @see https://docs.constructor.io/rest_api/tasks/#retrieve-by-specific-task-id
132
+ * @see https://docs.constructor.com/reference/catalog-tasks
133
133
  */
134
134
  getTask(parameters = {}, networkParameters = {}) {
135
135
  let requestUrl;
@@ -804,7 +804,7 @@ class Tracker {
804
804
  * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
805
805
  * @returns {(true|Error)}
806
806
  * @description User performed an action indicating interest in an item (add to cart, add to wishlist, etc.)
807
- * @see https://docs.constructor.io/rest_api/behavioral_logging/conversions
807
+ * @see https://docs.constructor.com/docs/integrating-with-constructor-behavioral-tracking-data-driven-event-tracking
808
808
  * @example
809
809
  * constructorio.tracker.trackConversion(
810
810
  * 'T-Shirt',
@@ -7,7 +7,7 @@ export interface TrackerUserParameters {
7
7
  sessionId: number;
8
8
  clientId: string;
9
9
  userId?: string;
10
- segments?: string;
10
+ segments?: string | string[];
11
11
  testCells?: Record<string, any>;
12
12
  originReferrer?: string;
13
13
  referer?: string;