@constructor-io/constructorio-node 4.16.1 → 4.16.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "4.16.1",
+  "version": "4.16.3",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",

package/src/modules/quizzes.js

@@ -43,7 +43,7 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
   }
 
   if (parameters) {
-    const { section, answers, quizVersionId, quizSessionId } = parameters;
+    const { section, answers, quizVersionId, quizSessionId, filters, resultsPerPage, page } = parameters;
 
     // Pull section from parameters
     if (section) {
@@ -60,6 +60,18 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
       queryParams.quiz_session_id = quizSessionId;
     }
 
+    if (!helpers.isNil(page)) {
+      queryParams.page = page;
+    }
+
+    if (!helpers.isNil(resultsPerPage)) {
+      queryParams.num_results_per_page = resultsPerPage;
+    }
+
+    if (filters) {
+      queryParams.filters = filters;
+    }
+
     // Pull answers from parameters and transform
     if (answers) {
       answers.forEach((ans) => {
@@ -177,6 +189,9 @@ class Quizzes {
    * @param {string} [parameters.section] - Product catalog section
    * @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}
    * @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}
+   * @param {number} [parameters.page] - The page number of the results
+   * @param {number} [parameters.resultsPerPage] - The number of results per page to return
+   * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
    * @param {object} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results

package/src/modules/tracker.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable camelcase, no-underscore-dangle, no-unneeded-ternary, brace-style */
 const qs = require('qs');
 const { AbortController } = require('node-abort-controller');
@@ -381,8 +382,8 @@ class Tracker {
    * @param {string} parameters.originalQuery - The current autocomplete search query
    * @param {string} parameters.section - Section the selected item resides within
    * @param {string} [parameters.tr] - Trigger used to select the item (click, etc.)
-   * @param {string} [parameters.groupId] - Group identifier of selected item
-   * @param {string} [parameters.displayName] - Display name of group of selected item
+   * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
+   * @param {string} [parameters.displayName] - Display name of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
    * @param {object} userParameters - Parameters relevant to the user request
    * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
    * @param {string} userParameters.clientId - Client ID, utilized to personalize results
@@ -483,8 +484,8 @@ class Tracker {
    * @param {string} term - Term of submitted autocomplete event
    * @param {object} parameters - Additional parameters to be sent with request
    * @param {string} parameters.originalQuery - The current autocomplete search query
-   * @param {string} [parameters.groupId] - Group identifier of selected item
-   * @param {string} [parameters.displayName] - Display name of group of selected item
+   * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
+   * @param {string} [parameters.displayName] - Display name of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
    * @param {object} userParameters - Parameters relevant to the user request
    * @param {number} userParameters.sessionId - Session ID, utilized to personalize results
    * @param {string} userParameters.clientId - Client ID, utilized to personalize results