@constructor-io/constructorio-client-javascript 2.35.0 → 2.35.1

package/lib/modules/quizzes.js

@@ -53,18 +53,24 @@ function createQuizUrl(quizId, parameters, options, path) {
   if (parameters) {
     var section = parameters.section,
         answers = parameters.answers,
-        versionId = parameters.versionId,
+        quizSessionId = parameters.quizSessionId,
+        quizVersionId = parameters.quizVersionId,
         page = parameters.page,
         resultsPerPage = parameters.resultsPerPage,
         filters = parameters.filters; // Pull section from parameters
 
     if (section) {
       queryParams.section = section;
-    } // Pull version_id from parameters
+    } // Pull quiz_version_id from parameters
 
 
-    if (versionId) {
-      queryParams.version_id = versionId;
+    if (quizVersionId) {
+      queryParams.quiz_version_id = quizVersionId;
+    } // Pull quiz_session_id from parameters
+
+
+    if (quizSessionId) {
+      queryParams.quiz_session_id = quizSessionId;
     } // Pull a (answers) from parameters and transform
 
 
@@ -120,7 +126,8 @@ var Quizzes = /*#__PURE__*/function () {
    * @param {string} [parameters] - Additional parameters to refine result set
    * @param {string} [parameters.section] - Product catalog section
    * @param {array} [parameters.answers] - An array of answers in the format [[1,2],[1]]
-   * @param {string} [parameters.versionId] - Version identifier for the quiz
+   * @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: 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: https://docs.constructor.io/rest_api/quiz/using_quizzes/#quiz-sessions
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -129,7 +136,8 @@ var Quizzes = /*#__PURE__*/function () {
    * constructorio.quizzes.getQuizNextQuestion('quizId', {
    *    answers: [[1,2],[1]],
    *    section: '123',
-   *    versionId: '123'
+   *    quizVersionId: '123',
+   *    quizSessionId: '1234',
    * });
    */
 
@@ -162,7 +170,7 @@ var Quizzes = /*#__PURE__*/function () {
 
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
-        if (json.version_id) {
+        if (json.quiz_version_id) {
           _this.eventDispatcher.queue('quizzes.getQuizNextQuestion.completed', json);
 
           return json;
@@ -180,7 +188,8 @@ var Quizzes = /*#__PURE__*/function () {
      * @param {string} parameters - Additional parameters to refine result set
      * @param {array} parameters.answers - An array of answers in the format [[1,2],[1]]
      * @param {string} [parameters.section] - Product catalog section
-     * @param {string} [parameters.versionId] - Specific version identifier for the quiz
+     * @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: 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: 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
@@ -192,7 +201,8 @@ var Quizzes = /*#__PURE__*/function () {
      * constructorio.quizzes.getQuizResults('quizId', {
      *    answers: [[1,2],[1]],
      *    section: '123',
-     *    versionId: '123'
+     *    quizVersionId: '123',
+     *    quizSessionId: '234'
      * });
      */
 
@@ -224,7 +234,7 @@ var Quizzes = /*#__PURE__*/function () {
 
         return helpers.throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
-        if (json.version_id) {
+        if (json.quiz_version_id) {
           _this2.eventDispatcher.queue('quizzes.getQuizResults.completed', json);
 
           return json;

package/lib/types/quizzes.d.ts

@@ -17,7 +17,8 @@ export default Quizzes;
 export interface QuizzesParameters {
   section?: string;
   answers?: any[];
-  versionId?: string;
+  quizVersionId?: string;
+  quizSessionId?: string;
 }
 
 export interface QuizzesResultsParameters extends QuizzesParameters {
@@ -50,6 +51,8 @@ export interface NextQuestionResponse extends Record<string, any> {
   next_question: Question;
   is_last_question?: boolean;
   version_id?: string;
+  quiz_id?: string;
+  quiz_session_id?: string;
 }
 
 export interface QuizResultsResponse extends Record<string, any> {
@@ -77,7 +80,7 @@ export interface QuizResultsResponse extends Record<string, any> {
     features: Partial<Feature>[];
   };
   result_id?: string;
-  version_id: string;
+  quiz_version_id: string;
   quiz_session_id: string;
   quiz_id: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.35.0",
+  "version": "2.35.1",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/constructorio.d.ts",