Update documentation

esezen · esezen · commit 895720b037f4 · 2025-04-14T19:19:51.000+03:00
diff --git a/docs/ConstructorIO.html b/docs/ConstructorIO.html
@@ -794,7 +794,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/constructorio.js.html b/docs/constructorio.js.html
@@ -150,7 +150,7 @@ <h1 class="page-title">constructorio.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/index.html b/docs/index.html
@@ -109,7 +109,7 @@ <h2>Development / npm commands</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-autocomplete.html b/docs/module-autocomplete.html
@@ -1098,7 +1098,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-browse.html b/docs/module-browse.html
@@ -4767,7 +4767,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-catalog.html b/docs/module-catalog.html
@@ -24626,7 +24626,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-quizzes.html b/docs/module-quizzes.html
@@ -351,7 +351,7 @@ <h6>Properties</h6>
 
             
 
-            <td class="description last">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</td>
+            <td class="description last">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 the question is skippable: i.e., configured as `is_skippable:true`.</td>
         </tr>
 
     
@@ -1121,7 +1121,7 @@ <h6>Properties</h6>
 
             
 
-            <td class="description last">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</td>
+            <td class="description last">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 the question is skippable: i.e., configured as `is_skippable:true`.</td>
         </tr>
 
     
@@ -1792,7 +1792,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-recommendations.html b/docs/module-recommendations.html
@@ -1427,7 +1427,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-search.html b/docs/module-search.html
@@ -2315,7 +2315,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-tasks.html b/docs/module-tasks.html
@@ -996,7 +996,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-tracker.html b/docs/module-tracker.html
@@ -14156,7 +14156,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_autocomplete.js.html b/docs/modules_autocomplete.js.html
@@ -301,7 +301,7 @@ <h1 class="page-title">modules/autocomplete.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_browse.js.html b/docs/modules_browse.js.html
@@ -630,7 +630,7 @@ <h1 class="page-title">modules/browse.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_catalog.js.html b/docs/modules_catalog.js.html
@@ -3596,7 +3596,7 @@ <h1 class="page-title">modules/catalog.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_quizzes.js.html b/docs/modules_quizzes.js.html
@@ -157,7 +157,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
    * @description Retrieve quiz question from Constructor.io API
    * @param {string} quizId - The identifier of the quiz
    * @param {string} parameters - Additional parameters to refine result set
-   * @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
+   * @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 the question is skippable: i.e., configured as `is_skippable:true`.
    * @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.com/reference/configuration-quizzes}
    * @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}
@@ -235,7 +235,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
    * @description Retrieve quiz recommendation and filter expression from Constructor.io API
    * @param {string} quizId - The identifier of the quiz
    * @param {string} parameters - Additional parameters to refine result set
-   * @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
+   * @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 the question is skippable: i.e., configured as `is_skippable:true`.
    * @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.com/reference/configuration-quizzes}
    * @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}
@@ -325,7 +325,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_recommendations.js.html b/docs/modules_recommendations.js.html
@@ -353,7 +353,7 @@ <h1 class="page-title">modules/recommendations.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_search.js.html b/docs/modules_search.js.html
@@ -427,7 +427,7 @@ <h1 class="page-title">modules/search.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_tasks.js.html b/docs/modules_tasks.js.html
@@ -231,7 +231,7 @@ <h1 class="page-title">modules/tasks.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_tracker.js.html b/docs/modules_tracker.js.html
@@ -1826,7 +1826,7 @@ <h1 class="page-title">modules/tracker.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Mar 03 2025 22:41:02 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Mon Apr 14 2025 19:19:50 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",
