@constructor-io/constructorio-node 5.0.0 → 5.1.0

package/package.json

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

package/src/modules/recommendations.js

@@ -1,4 +1,4 @@
-/* eslint-disable object-curly-newline, no-param-reassign */
+/* eslint-disable object-curly-newline, no-param-reassign, max-len */
 const qs = require('qs');
 const { AbortController } = require('node-abort-controller');
 const helpers = require('../utils/helpers');
@@ -41,6 +41,7 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
     const {
       numResults,
       itemIds,
+      variationId,
       section,
       term,
       filters,
@@ -59,6 +60,18 @@ function createRecommendationsUrl(podId, parameters, userParameters, options) {
       queryParams.item_id = itemIds;
     }
 
+    if (variationId) {
+      if (!itemIds) {
+        throw new Error('itemIds is a required parameter for variationId');
+      }
+
+      if (Array.isArray(itemIds) && !itemIds.length) {
+        throw new Error('At least one itemId is a required parameter for variationId');
+      }
+
+      queryParams.variation_id = variationId;
+    }
+
     // Pull section from parameters
     if (section) {
       queryParams.section = section;
@@ -119,7 +132,8 @@ class Recommendations {
    * @function getRecommendations
    * @param {string} podId - Pod identifier
    * @param {object} [parameters] - Additional parameters to refine results
-   * @param {string|array} [parameters.itemIds] - Item ID(s) to retrieve recommendations for (strategy specific)
+   * @param {string|array} [parameters.itemIds] - Item ID(s) to retrieve recommendations for (strategy specific). Required for variationId
+   * @param {string} [parameters.variationId] - Variation ID to retrieve recommendations for (strategy specific)
    * @param {number} [parameters.numResults] - The number of results to return
    * @param {string} [parameters.section] - The section to return results from
    * @param {string} [parameters.term] - The term to use to refine results (strategy specific)

package/src/types/recommendations.d.ts

@@ -1,9 +1,10 @@
-import { ConstructorClientOptions, NetworkParameters, UserParameters, VariationsMap } from '.';
+import { ConstructorClientOptions, NetworkParameters, UserParameters, VariationsMap, FilterExpression } from '.';
 
 export default Recommendations;
 
 export interface RecommendationsParameters {
   itemIds?: string | string[];
+  variationId?: string;
   numResults?: number;
   section?: string;
   term?: string;
@@ -39,7 +40,8 @@ export interface RecommendationsResponse extends Record<string, any> {
 
 export interface RecommendationsRequestType extends Record<string, any> {
   num_results: number;
-  item_id: string;
+  item_id: string | string[];
+  variation_id: string;
   filters: {
     group_id: string;
     [key: string]: any;