@constructor-io/constructorio-node 3.10.1 → 3.10.3

package/README.md

@@ -8,9 +8,12 @@ A Node.js client for [Constructor.io](http://constructor.io/). [Constructor.io](
 
 > This client is intended for use in server side integrations.  If you want a JavaScript client for client side (i.e. front end) integrations please use [@constructor-io/constructorio-client-javascript](https://github.com/Constructor-io/constructorio-client-javascript)
 
+## Documentation
+Full API documentation is available on [Github Pages](https://constructor-io.github.io/constructorio-node)
+
 ## 1. Review the Requirements
 
-Requesting results from your Node.js back-end can be useful in order to control result rendering logic on your server, or augment/hydrate results with data from another system. However, a back-end integration has additional requirements compared to a front-end integration.  Please review [Back End API Integration](https://constructorio.zendesk.com/hc/en-us/articles/360047993194-Back-end-API-Integration) for more detail.
+Requesting results from your Node.js back-end can be useful in order to control result rendering logic on your server, or augment/hydrate results with data from another system. However, a back-end integration has additional requirements compared to a front-end integration. Please review the [Additional Information For Backend Integrations](https://github.com/Constructor-io/constructorio-node/wiki/Additional-Information-For-Backend-Integrations) article within the wiki for more detail.
 
 ## 2. Install
 
@@ -38,8 +41,6 @@ var constructorio = new ConstructorIOClient({
 
 After instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: `search`, `browse`, `autocomplete`, `recommendations`, `catalog` and `tracker`.
 
-Full API documentation is available on [Github Pages](https://constructor-io.github.io/constructorio-node)
-
 ## Development / npm commands
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "3.10.1",
+  "version": "3.10.3",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "scripts": {
@@ -31,6 +31,7 @@
     "src/**/*"
   ],
   "devDependencies": {
+    "@cspell/eslint-plugin": "^6.8.2",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "dotenv": "^8.6.0",

package/src/modules/catalog.js

@@ -149,7 +149,26 @@ class Catalog {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/add_an_item
+   * @see https://docs.constructor.io/rest_api/items/v1/add_an_item
+   * @example
+   * constructorio.catalog.addItem({
+   *     item_name: 'black pullover hoodie',
+   *     section: 'Products',
+   *     keywords: ['black', 'hoodie', 'tops', 'outerwear'],
+   *     url: '/products/blk_pllvr_hd_001'
+   *     image_url: '/products/images/blk_pllvr_hd_001'
+   *     description: 'a short description about the black pullover hoodie',
+   *     id: 'blk_pllvr_hd_001',
+   *     facets: {
+   *         size: 'medium',
+   *         color: 'black',
+   *     },
+   *     metadata: {
+   *         swatch_image_url: '/products/swatch_images/blk_pllvr_hd_001',
+   *         on_sale: true,
+   *     },
+   *     group_ids: ['cat_49203', 'subcat_12891'],
+   * });
    */
   addItem(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -203,7 +222,26 @@ class Catalog {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/add_or_update_an_item
+   * @see https://docs.constructor.io/rest_api/items/v1/add_or_update_an_item
+   * @example
+   * constructorio.catalog.addOrUpdateItem({
+   *     item_name: 'black pullover hoodie',
+   *     section: 'Products',
+   *     keywords: ['black', 'hoodie', 'tops', 'outerwear'],
+   *     url: '/products/blk_pllvr_hd_001'
+   *     image_url: '/products/images/blk_pllvr_hd_001'
+   *     description: 'a short description about the black pullover hoodie',
+   *     id: 'blk_pllvr_hd_001',
+   *     facets: {
+   *         size: 'medium',
+   *         color: 'black',
+   *     },
+   *     metadata: {
+   *         swatch_image_url: '/products/swatch_images/blk_pllvr_hd_001',
+   *         on_sale: true,
+   *     },
+   *     group_ids: ['cat_49203', 'subcat_12891'],
+   * });
    */
   addOrUpdateItem(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -248,7 +286,12 @@ class Catalog {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/remove_an_item
+   * @see https://docs.constructor.io/rest_api/items/v1/remove_an_item
+   * @example
+   * constructorio.catalog.removeItem({
+   *     id: 'blk_pllvr_hd_001',
+   *     section: 'Products',
+   * });
    */
   removeItem(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -303,7 +346,26 @@ class Catalog {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/modify_an_item
+   * @see https://docs.constructor.io/rest_api/items/v1/modify_an_item
+   * @example
+   * constructorio.catalog.modifyItem({
+   *     item_name: 'midnight black pullover hoodie',
+   *     section: 'Products',
+   *     keywords: ['midnight black', 'black', 'hoodie', 'tops', 'outerwear'],
+   *     url: '/products/blk_pllvr_hd_001'
+   *     image_url: '/products/images/blk_pllvr_hd_001'
+   *     description: 'a modified short description about the black pullover hoodie',
+   *     id: 'blk_pllvr_hd_001',
+   *     facets: {
+   *         size: 'large',
+   *         color: 'midnight black',
+   *     },
+   *     metadata: {
+   *         swatch_image_url: '/products/swatch_images/blk_pllvr_hd_001',
+   *         on_sale: true,
+   *     },
+   *     group_ids: ['cat_49203', 'subcat_12891'],
+   * });
    */
   modifyItem(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -342,12 +404,28 @@ class Catalog {
    *
    * @function addItemsBatch
    * @param {object} parameters - Additional parameters for item details
-   * @param {object[]} parameters.items - A list of items with the same attributes as defined in the `addItem` resource
+   * @param {object[]} parameters.items - A list of items with the same attributes as defined in the [addItem]{@link module:catalog~addItem} resource
    * @param {string} parameters.section - Your autosuggest and search results can have multiple sections like "Products" and "Search Suggestions". This indicates which section this item is for
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/batch_add_items
+   * @see https://docs.constructor.io/rest_api/items/v1/batch_add_items
+   * @example
+   * constructorio.catalog.addItemsBatch({
+   *     items: [
+   *         {
+   *             item_name: 'midnight black pullover hoodie',
+   *             section: 'Products',
+   *             keywords: ['midnight black', 'black', 'hoodie', 'tops', 'outerwear'],
+   *             url: '/products/blk_pllvr_hd_001'
+   *             image_url: '/products/images/blk_pllvr_hd_001'
+   *             description: 'a modified short description about the black pullover hoodie',
+   *             id: 'blk_pllvr_hd_001',
+   *         },
+   *         . . .
+   *     ],
+   *     section: 'Products',
+   * });
    */
   addItemsBatch(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -386,12 +464,28 @@ class Catalog {
    *
    * @function addOrUpdateItemsBatch
    * @param {object} parameters - Additional parameters for item details
-   * @param {object[]} parameters.items - A list of items with the same attributes as defined in the `addItem` resource
+   * @param {object[]} parameters.items - A list of items with the same attributes as defined in the [addItem]{@link module:catalog~addItem} resource
    * @param {string} parameters.section - Your autosuggest and search results can have multiple sections like "Products" and "Search Suggestions". This indicates which section this item is for
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/batch_add_or_update_items
+   * @see https://docs.constructor.io/rest_api/items/v1/batch_add_or_update_items
+   * @example
+   * constructorio.catalog.addOrUpdateItemsBatch({
+   *     items: [
+   *         {
+   *             item_name: 'midnight black pullover hoodie',
+   *             section: 'Products',
+   *             keywords: ['midnight black', 'black', 'hoodie', 'tops', 'outerwear'],
+   *             url: '/products/blk_pllvr_hd_001'
+   *             image_url: '/products/images/blk_pllvr_hd_001'
+   *             description: 'a modified short description about the black pullover hoodie',
+   *             id: 'blk_pllvr_hd_001',
+   *         },
+   *         . . .
+   *     ],
+   *     section: 'Products',
+   * });
    */
   addOrUpdateItemsBatch(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -430,12 +524,20 @@ class Catalog {
    *
    * @function removeItemsBatch
    * @param {object} parameters - Additional parameters for item details
-   * @param {object[]} parameters.items - A list of items with the same attributes as defined in the `addItem` resource
+   * @param {object[]} parameters.items - A list of items with the same attributes as defined in the [addItem]{@link module:catalog~addItem} resource
    * @param {string} parameters.section - Your autosuggest and search results can have multiple sections like "Products" and "Search Suggestions". This indicates which section this item is for
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/batch_remove_items
+   * @see https://docs.constructor.io/rest_api/items/v1/batch_remove_items
+   * @example
+   * constructorio.catalog.removeItemsBatch({
+   *     items: [
+   *         { id: 'blk_pllvr_hd_001' },
+   *         { id: 'red_pllvr_hd_02' },
+   *     ],
+   *     section: 'Products',
+   * });
    */
   removeItemsBatch(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -478,7 +580,11 @@ class Catalog {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/get_items
+   * @see https://docs.constructor.io/rest_api/items/v1/get_items
+   * @example
+   * constructorio.catalog.getItem({
+   *     id: 'blk_pllvr_hd_001',
+   * });
    */
   getItem(parameters = {}, networkParameters = {}) {
     const queryParams = {};
@@ -536,7 +642,13 @@ class Catalog {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/items/get_items
+   * @see https://docs.constructor.io/rest_api/items/v1/get_items
+   * @example
+   * constructorio.catalog.getItems({
+   *     section: 'Products',
+   *     num_results_per_page: 50,
+   *     page: 2,
+   * });
    */
   getItems(parameters = {}, networkParameters = {}) {
     const queryParams = {};
@@ -601,6 +713,12 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+   * @example
+   * constructorio.catalog.addItemGroup({
+   *     id: 'subcat_12891',
+   *     name: 'Hoodies & Sweaters',
+   *     parent_id: 'cat_49203',
+   * });
    */
   addItemGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -645,6 +763,20 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+   * @example
+   * constructorio.catalog.addItemGroups({
+   *     item_groups: [
+   *         {
+   *             id: 'subcat_12891',
+   *             name: 'Hoodies & Sweaters',
+   *             parent_id: 'cat_49203',
+   *         },
+   *         {
+   *             id: 'cat49203',
+   *             name: 'Outerwear',
+   *         },
+   *     ],
+   * });
    */
   addItemGroups(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -688,6 +820,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+   * @example
+   * constructorio.catalog.getItemGroup({
+   *     id: 'subcat_12891',
+   * });
    */
   getItemGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -728,6 +864,8 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+   * @example
+   * constructorio.catalog.getItemGroups();
    */
   getItemGroups(networkParameters = {}) {
     let requestUrl;
@@ -770,6 +908,20 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+  * @example
+   * constructorio.catalog.addOrUpdateItemGroups({
+   *     item_groups: [
+   *         {
+   *             id: 'subcat_12891',
+   *             name: 'Hoodies, Sweaters, & Jackets',
+   *             parent_id: 'cat_49203',
+   *         },
+   *         {
+   *             id: 'cat49203',
+   *             name: 'Outerwear',
+   *         },
+   *     ],
+   * });
    */
   addOrUpdateItemGroups(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -816,6 +968,15 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+   * @example
+   * constructorio.catalog.modifyItemGroup({
+   *     id: 'subcat_12891',
+   *     name: 'Hoodies, Sweaters & Jackets',
+   *     parent_id: 'cat_49203',
+   *     data: {
+   *         landing_image_url: '/images/hd_swtrs_jckts.jpg',
+   *     },
+   * });
    */
   modifyItemGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -858,6 +1019,8 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/item_groups
+   * @example
+   * constructorio.catalog.removeItemGroups();
    */
   removeItemGroups(networkParameters = {}) {
     let requestUrl;
@@ -898,6 +1061,14 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/one_way_synonyms/add_synonyms
+   * @example
+   * constructorio.catalog.addOneWaySynonym({
+   *     phrase: 'spices',
+   *     child_phrases: [
+   *         { phrase: 'pepper' },
+   *         { phrase: 'cinnamon' },
+   *     ],
+   * });
    */
   addOneWaySynonym(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -943,6 +1114,15 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/one_way_synonyms/modify_synonyms
+   * @example
+   * constructorio.catalog.modifyOneWaySynonym({
+   *     phrase: 'spices',
+   *     child_phrases: [
+   *         { phrase: 'pepper' },
+   *         { phrase: 'cinnamon' },
+   *         { phrase: 'paprika' },
+   *     ],
+   * });
    */
   modifyOneWaySynonym(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -987,6 +1167,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/one_way_synonyms/retrieve_synonyms
+   * @example
+   * constructorio.catalog.getOneWaySynonym({
+   *     phrase: 'spices',
+   * });
    */
   getOneWaySynonym(parameters = {}, networkParameters = {}) {
     const { phrase } = parameters;
@@ -1032,6 +1216,11 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/one_way_synonyms/retrieve_synonyms
+   * @example
+   * constructorio.catalog.getOneWaySynonyms({
+   *     num_results_per_page: 50,
+   *     page: 2,
+   * });
    */
   getOneWaySynonyms(parameters = {}, networkParameters = {}) {
     const queryParams = {};
@@ -1089,6 +1278,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/one_way_synonyms/remove_synonyms
+   * @example
+   * constructorio.catalog.removeOneWaySynonym({
+   *     phrase: 'spices',
+   * });
    */
   removeOneWaySynonym(parameters = {}, networkParameters = {}) {
     const { phrase } = parameters;
@@ -1130,6 +1323,8 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/one_way_synonyms/remove_synonyms
+   * @example
+   * constructorio.catalog.removeOneWaySynonyms();
    */
   removeOneWaySynonyms(networkParameters = {}) {
     let requestUrl;
@@ -1172,6 +1367,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/synonyms/
+   * @example
+   * constructorio.catalog.addSynonymGroup({
+   *     synonyms: ['0% milk', 'skim milk'],
+   * });
    */
   addSynonymGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1216,6 +1415,11 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/synonyms/
+   * @example
+   * constructorio.catalog.modifySynonymGroup({
+   *     id: 32,
+   *     synonyms: ['0% milk', 'skim milk', 'fat free milk'],
+   * });
    */
   modifySynonymGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1260,6 +1464,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/synonyms/
+   * @example
+   * constructorio.catalog.modifySynonymGroup({
+   *     id: 32,
+   * });
    */
   getSynonymGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1301,6 +1509,12 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/synonyms/
+   * @example
+   * constructorio.catalog.modifySynonymGroup({
+   *     phrase: '0% milk',
+   *     num_results_per_page: 50,
+   *     page: 3,
+   * });
    */
   getSynonymGroups(parameters = {}, networkParameters = {}) {
     const queryParams = {};
@@ -1356,6 +1570,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/synonyms/
+   * @example
+   * constructorio.catalog.removeSynonymGroup({
+   *     id: 32,
+   * });
    */
   removeSynonymGroup(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1394,6 +1612,8 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/synonyms/
+   * @example
+   * constructorio.catalog.modifySynonymGroup();
    */
   removeSynonymGroups(networkParameters = {}) {
     let requestUrl;
@@ -1438,6 +1658,20 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/redirect_rules
+   * @example
+   * constructorio.catalog.addRedirectRule({
+   *     url: '/categories/cat_49203',
+   *     matches: [{
+   *         pattern: 'outerwear',
+   *         match_type: 'EXACT'
+   *     }],
+   *     start_time: '2022-08-11T23:41:02.568Z',
+   *     end_time: '2022-08-20T23:41:02.568Z',
+   *     user_segments: ['US', 'Mobile'],
+   *     metadata: {
+   *         additional_data: 'additional string data',
+   *     },
+   * });
    */
   addRedirectRule(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1487,6 +1721,19 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/redirect_rules
+   * @example
+   * constructorio.catalog.updateRedirectRule({
+   *     id: 1,
+   *     url: '/categories/cat_49203',
+   *     matches: [{
+   *         pattern: 'outerwear',
+   *         match_type: 'EXACT'
+   *     }],
+   *     user_segments: ['US', 'Mobile', 'Web'],
+   *     metadata: {
+   *         additional_data: 'additional string data',
+   *     },
+   * });
    */
   updateRedirectRule(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1537,6 +1784,16 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/redirect_rules
+   * @example
+   * constructorio.catalog.modifyRedirectRule({
+   *     id: '1',
+   *     url: '/categories/cat_49203',
+   *     matches: [{
+   *         pattern: 'outerwear',
+   *         match_type: 'EXACT'
+   *     }],
+   *     user_segments: ['US', 'Mobile', 'Web'],
+   * });
    */
   modifyRedirectRule(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1581,6 +1838,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/redirect_rules
+   * @example
+   * constructorio.catalog.getRedirectRule({
+   *     id: '1',
+   * });
    */
   getRedirectRule(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1623,6 +1884,13 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/redirect_rules
+   * @example
+   * constructorio.catalog.getRedirectRules({
+   *     num_results_per_page: 50,
+   *     page: 2,
+   *     query: 'outerwear',
+   *     status: 'active',
+   * });
    */
   getRedirectRules(parameters = {}, networkParameters = {}) {
     const queryParams = {};
@@ -1687,6 +1955,10 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/redirect_rules
+   * @example
+   * constructorio.catalog.removeRedirectRule({
+   *     id: '1',
+   * });
    */
   removeRedirectRule(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1731,6 +2003,14 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/full_catalog
+   * @example
+   * constructorio.catalog.replaceCatalog({
+   *     section: 'Products',
+   *     notification_email: 'notifications@example.com',
+   *     items: itemsFileBufferOrStream,
+   *     variations: variationsFileBufferOrStream,
+   *     item_groups: itemGroupsFileBufferOrStream,
+   * });
    */
   async replaceCatalog(parameters = {}, networkParameters = {}) {
     try {
@@ -1775,6 +2055,14 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/full_catalog
+   * @example
+   * constructorio.catalog.updateCatalog({
+   *     section: 'Products',
+   *     notification_email: 'notifications@example.com',
+   *     items: itemsFileBufferOrStream,
+   *     variations: variationsFileBufferOrStream,
+   *     item_groups: itemGroupsFileBufferOrStream,
+   * });
    */
   async updateCatalog(parameters = {}, networkParameters = {}) {
     try {
@@ -1819,6 +2107,14 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/full_catalog
+   * @example
+   * constructorio.catalog.patchCatalog({
+   *     section: 'Products',
+   *     notification_email: 'notifications@example.com',
+   *     items: itemsFileBufferOrStream,
+   *     variations: variationsFileBufferOrStream,
+   *     item_groups: itemGroupsFileBufferOrStream,
+   * });
    */
   async patchCatalog(parameters = {}, networkParameters = {}) {
     try {
@@ -1852,12 +2148,12 @@ class Catalog {
    * Create a facet configuration
    *
    * @function addFacetConfiguration
-   * @param {object} parameters - Aditional paramaters for facet configuration details
+   * @param {object} parameters - Additional parameters for facet configuration details
    * @param {string} parameters.name - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.type - Type of facet. Must be one of multiple or range (numerical).
    * @param {string} [parameters.display_name] - The name of the facet presented to the end users. Defaults to null, in which case the name will be presented.
-   * @param {string} [parameters.sort_order] - Defines the criterion by which the options of this facet group are sorted. Must be one of relevance, value, num_matches. Defaults to relevance. Can be overriden by setting position attribute on facet options.
-   * @param {boolean} [parameters.sort_descending] - Set to true if the options should be sorted in descending order, false to sort ascencing. Default value is true if sort_order is relevance and false for others.
+   * @param {string} [parameters.sort_order] - Defines the criterion by which the options of this facet group are sorted. Must be one of relevance, value, num_matches. Defaults to relevance. Can be overridden by setting position attribute on facet options.
+   * @param {boolean} [parameters.sort_descending] - Set to true if the options should be sorted in descending order, false to sort ascending. Default value is true if sort_order is relevance and false for others.
    * @param {string} [parameters.range_type] - Specifies how the range buckets are determined. Must be one of dynamic or static. Default value is null. Required if facet type is range and range_format is options.
    * @param {string} [parameters.range_format] - Determine wether the range facet is configured to displayed as a slider (with min/max values) or as a list of buckets. Must be one of boundaries (for sliders) or options (for buckets).
    * @param {string} [parameters.range_inclusive] - Used to create inclusive buckets. Must be one of above (options have no upper bound), below (no lower bound), or null (if range options should not be inclusive).
@@ -1874,6 +2170,15 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#create-a-facet-config
+   * @example
+   * constructorio.catalog.addFacetConfiguration({
+   *     name: 'color',
+   *     type: 'multiple',
+   *     display_name: 'Color',
+   *     sort_order: 'value',
+   *     sort_descending: false,
+   *     position: 1,
+   * });
    */
   addFacetConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1915,7 +2220,7 @@ class Catalog {
    * Get all facet configurations
    *
    * @function getFacetConfigurations
-   * @param {object} parameters - Aditional paramaters for retrieving facet configurations.
+   * @param {object} parameters - Additional parameters for retrieving facet configurations.
    * @param {number} [parameters.page] - Page number you'd like to request. Defaults to 1.
    * @param {number} [parameters.num_results_per_page] - Number of facets per page in paginated response. Default value is 100.
    * @param {string} [parameters.section] - The section in which your facet is defined. Default value is Products.
@@ -1923,6 +2228,11 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#get-all-facet-configs
+   * @example
+   * constructorio.catalog.getFacetConfigurations({
+   *     page: 2,
+   *     num_results_per_page: 50,
+   * });
    */
   getFacetConfigurations(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -1962,13 +2272,17 @@ class Catalog {
    * Get a single facet's configuration
    *
    * @function getFacetConfiguration
-   * @param {object} parameters - Aditional paramaters for retrieving a facet configuration.
-   * @param {number} [parameters.name] - Page number you'd like to request. Defaults to 1.
+   * @param {object} parameters - Additional parameters for retrieving a facet configuration.
+   * @param {number} [parameters.name] - Unique facet name used to refer to the facet in your catalog
    * @param {string} [parameters.section] - The section in which your facet is defined. Default value is Products.
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#get-a-single-facets-config
+   * @example
+   * constructorio.catalog.getFacetConfiguration({
+   *     name: 'color',
+   * });
    */
   getFacetConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2009,12 +2323,29 @@ class Catalog {
    * Modify the configurations of multiple facets (partially) at once.
    *
    * @function modifyFacetConfigurations
-   * @param {object} parameters - Aditional paramaters for modifying facet configurations
+   * @param {object} parameters - Additional parameters for modifying facet configurations
    * @param {array} parameters.facetConfigurations - List of facet configurations you would like to update. See [addFacetConfiguration]{@link module:catalog~addFacetConfiguration} for additional details on what parameters you can supply for each facet configuration.
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#update-facet-configs-partial
+   * @example
+   * constructorio.catalog.modifyFacetConfigurations(
+   *     facetConfigurations: [
+   *         {
+   *             name: 'color',
+   *             type: 'multiple',
+   *             display_name: 'Color',
+   *             sort_order: 'value',
+   *             sort_descending: false,
+   *             position: 1,
+   *         },
+   *         {
+   *             name: 'size',
+   *             ...
+   *         }
+   *     ],
+   * });
    */
   modifyFacetConfigurations(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2058,12 +2389,12 @@ class Catalog {
    * Caution: Overwrites all other configurations you may have defined for the facet group, resetting them to their defaults. This includes all facet option configurations you may have defined.
    *
    * @function replaceFacetConfiguration
-   * @param {object} parameters - Aditional paramaters for facet configuration details
+   * @param {object} parameters - Additional parameters for facet configuration details
    * @param {string} parameters.name - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.type - Type of facet. Must be one of multiple or range (numerical).
    * @param {string} [parameters.display_name] - The name of the facet presented to the end users. Defaults to null, in which case the name will be presented.
-   * @param {string} [parameters.sort_order] - Defines the criterion by which the options of this facet group are sorted. Must be one of relevance, value, num_matches. Defaults to relevance. Can be overriden by setting position attribute on facet options.
-   * @param {boolean} [parameters.sort_descending] - Set to true if the options should be sorted in descending order, false to sort ascencing. Default value is true if sort_order is relevance and false for others.
+   * @param {string} [parameters.sort_order] - Defines the criterion by which the options of this facet group are sorted. Must be one of relevance, value, num_matches. Defaults to relevance. Can be overridden by setting position attribute on facet options.
+   * @param {boolean} [parameters.sort_descending] - Set to true if the options should be sorted in descending order, false to sort ascending. Default value is true if sort_order is relevance and false for others.
    * @param {string} [parameters.range_type] - Specifies how the range buckets are determined. Must be one of dynamic or static. Default value is null. Required if facet type is range and range_format is options.
    * @param {string} [parameters.range_format] - Determine wether the range facet is configured to displayed as a slider (with min/max values) or as a list of buckets. Must be one of boundaries (for sliders) or options (for buckets).
    * @param {string} [parameters.range_inclusive] - Used to create inclusive buckets. Must be one of above (options have no upper bound), below (no lower bound), or null (if range options should not be inclusive).
@@ -2080,6 +2411,15 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#update-a-facet-config-total
+   * @example
+   * constructorio.catalog.replaceFacetConfiguration({
+   *     name: 'color',
+   *     type: 'multiple',
+   *     display_name: 'Color',
+   *     sort_order: 'value',
+   *     sort_descending: false,
+   *     position: 1,
+   * });
    */
   replaceFacetConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2121,12 +2461,12 @@ class Catalog {
    * Modify the configuration of a facet (partially)
    *
    * @function modifyFacetConfiguration
-   * @param {object} parameters - Aditional paramaters for facet configuration details
+   * @param {object} parameters - Additional parameters for facet configuration details
    * @param {string} parameters.name - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.type - Type of facet. Must be one of multiple or range (numerical).
    * @param {string} [parameters.display_name] - The name of the facet presented to the end users. Defaults to null, in which case the name will be presented.
-   * @param {string} [parameters.sort_order] - Defines the criterion by which the options of this facet group are sorted. Must be one of relevance, value, num_matches. Defaults to relevance. Can be overriden by setting position attribute on facet options.
-   * @param {boolean} [parameters.sort_descending] - Set to true if the options should be sorted in descending order, false to sort ascencing. Default value is true if sort_order is relevance and false for others.
+   * @param {string} [parameters.sort_order] - Defines the criterion by which the options of this facet group are sorted. Must be one of relevance, value, num_matches. Defaults to relevance. Can be overridden by setting position attribute on facet options.
+   * @param {boolean} [parameters.sort_descending] - Set to true if the options should be sorted in descending order, false to sort ascending. Default value is true if sort_order is relevance and false for others.
    * @param {string} [parameters.range_type] - Specifies how the range buckets are determined. Must be one of dynamic or static. Default value is null. Required if facet type is range and range_format is options.
    * @param {string} [parameters.range_format] - Determine wether the range facet is configured to displayed as a slider (with min/max values) or as a list of buckets. Must be one of boundaries (for sliders) or options (for buckets).
    * @param {string} [parameters.range_inclusive] - Used to create inclusive buckets. Must be one of above (options have no upper bound), below (no lower bound), or null (if range options should not be inclusive).
@@ -2143,6 +2483,15 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#update-a-facet-config-partial
+   * @example
+   * constructorio.catalog.modifyFacetConfiguration({
+   *     name: 'color',
+   *     type: 'multiple',
+   *     display_name: 'Color',
+   *     sort_order: 'num_matches',
+   *     sort_descending: true,
+   *     position: 1,
+   * });
    */
   modifyFacetConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2186,13 +2535,17 @@ class Catalog {
    * Caution: Once a facet group's configuration is removed, all configurations will return to their default values. This includes all facet option configurations (display name, position, etc) you may have defined for the facet group.
    *
    * @function removeFacetConfiguration
-   * @param {object} parameters - Aditional paramaters for facet configuration details
+   * @param {object} parameters - Additional parameters for facet configuration details
    * @param {string} parameters.name - Unique facet name used to refer to the facet in your catalog
    * @param {string} [parameters.section] - The section in which your facet is defined. Default value is Products.
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facets#delete-a-facet-config
+   * @example
+   * constructorio.catalog.removeFacetConfiguration({
+   *     name: 'color',
+   * });
    */
   removeFacetConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2232,7 +2585,7 @@ class Catalog {
    * Create a facet option configuration
    *
    * @function addFacetOptionConfiguration
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.value - A unique value for the facet option
    * @param {string} [parameters.display_name=null] - The name of the facet presented to the end users - if none is supplied, the value from name will be used
@@ -2244,6 +2597,13 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#create-a-facet-option-config
+   * @example
+   * constructorio.catalog.addFacetOptionConfiguration({
+   *     facetGroupName: 'color',
+   *     value: 'blue',
+   *     display_name: 'Blue',
+   *     position: 5,
+   * });
    */
   addFacetOptionConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2285,7 +2645,7 @@ class Catalog {
    * Create new facet option configurations or modify if they already exist
    *
    * @function addOrModifyFacetOptionConfigurations
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in the catalog
    * @param {object[]} parameters.facetOptionConfigurations - List of facet option configurations to would like to update - refer to [addFacetConfiguration]{@link module:catalog~addFacetOptionConfiguration} for additional details on what parameters can be supplied for each facet option configuration
    * @param {string} [parameters.section='Products'] - The section in which your facet is defined
@@ -2293,6 +2653,22 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#batch-update-or-create-facet-options-configs
+   * @example
+   * constructorio.catalog.addOrModifyFacetOptionConfigurations({
+   *     facetGroupName: 'color',
+   *     facetOptionConfigurations: [
+   *         {
+   *             value: 'blue',
+   *             display_name: 'Blue',
+   *             position: 5,
+   *         },
+   *         {
+   *             value: 'red',
+   *             display_name: 'Red',
+   *             position: 3,
+   *         },
+   *     ],
+   * });
    */
   addOrModifyFacetOptionConfigurations(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2334,7 +2710,7 @@ class Catalog {
    * Get all facet option configurations for a given facet
    *
    * @function getFacetOptionConfigurations
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in your catalog
    * @param {number} [parameters.page=1] - Page number you'd like to request
    * @param {number} [parameters.num_results_per_page=100] - Number of facets per page in paginated response
@@ -2343,6 +2719,12 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#get-all-option-configs-for-facet
+   * @example
+   * constructorio.catalog.getFacetOptionConfigurations({
+   *     facetGroupName: 'color',
+   *     page: 3,
+   *     num_results_per_page: 50
+   * });
    */
   getFacetOptionConfigurations(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2383,7 +2765,7 @@ class Catalog {
    * Get a single facet option configuration for a given facet
    *
    * @function getFacetOptionConfiguration
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.value - The facet option value. Unique for a particular facet
    * @param {string} [parameters.section='Products'] - The section in which your facet is defined
@@ -2391,6 +2773,11 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#get-a-single-facet-option-config
+   * @example
+   * constructorio.catalog.getFacetOptionConfiguration({
+   *     facetGroupName: 'color',
+   *     value: 'blue',
+   * });
    */
   getFacetOptionConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2431,7 +2818,7 @@ class Catalog {
    * Replace a facet option configuration
    *
    * @function replaceFacetOptionConfiguration
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.value - A unique facet option value
    * @param {string} [parameters.display_name=null] - The name of the facet presented to the end users - if none is supplied, the value from name will be used
@@ -2443,6 +2830,13 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#update-facet-option-total
+   * @example
+   * constructorio.catalog.replaceFacetOptionConfiguration({
+   *     facetGroupName: 'color',
+   *     value: 'blue',
+   *     display_name: 'Midnight Blue',
+   *     position: 9,
+   * });
    */
   replaceFacetOptionConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2484,7 +2878,7 @@ class Catalog {
    * Modify a facet option configuration
    *
    * @function modifyFacetOptionConfiguration
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.value - A unique facet option value
    * @param {string} [parameters.display_name=null] - The name of the facet presented to the end users - if none is supplied, the value from name will be used
@@ -2496,6 +2890,13 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#update-facet-option-partial
+   * @example
+   * constructorio.catalog.modifyFacetOptionConfiguration({
+   *     facetGroupName: 'color',
+   *     value: 'blue',
+   *     display_name: 'Midnight Blue',
+   *     position: 9,
+   * });
    */
   modifyFacetOptionConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;
@@ -2537,7 +2938,7 @@ class Catalog {
    * Remove a facet option configuration
    *
    * @function removeFacetOptionConfiguration
-   * @param {object} parameters - Aditional paramaters for facet option configuration details
+   * @param {object} parameters - Additional parameters for facet option configuration details
    * @param {string} parameters.facetGroupName - Unique facet name used to refer to the facet in your catalog
    * @param {string} parameters.value - A unique value for this facet option
    * @param {string} [parameters.section='Products'] - The section in which your facet is defined
@@ -2545,6 +2946,11 @@ class Catalog {
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
    * @see https://docs.constructor.io/rest_api/facet_options#delete-a-facet-option-config
+   * @example
+   * constructorio.removeFacetOptionConfiguration({
+   *     facetGroupName: 'color',
+   *     value: 'red',
+   * });
    */
   removeFacetOptionConfiguration(parameters = {}, networkParameters = {}) {
     let requestUrl;

package/src/modules/recommendations.js

@@ -101,7 +101,7 @@ class Recommendations {
    * @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)
-   * @param {object} [parameters.filters] - Filters used to refine results (strategy specific)
+   * @param {object} [parameters.filters] - Key / value mapping of filters used to refine results
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
    * @param {object} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results

package/src/modules/tasks.js

@@ -46,6 +46,9 @@ class Tasks {
    * @param {object} parameters - Additional parameters for task details
    * @param {number} [parameters.num_results_per_page = 20] - The number of tasks to return - maximum value 100
    * @param {number} [parameters.page = 1] - The page of results to return
+   * @param {string} [parameters.startDate] - The start date of results to return - YYYY-MM-DD
+   * @param {string} [parameters.endDate] - The end date of results to return - YYYY-MM-DD
+   * @param {string} [parameters.status] - The status of tasks to return - 'QUEUED', 'IN_PROGRESS', 'DONE', 'FAILED', 'CANCELED'
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -59,7 +62,7 @@ class Tasks {
     const { signal } = controller;
 
     if (parameters) {
-      const { num_results_per_page: numResultsPerPage, page } = parameters;
+      const { num_results_per_page: numResultsPerPage, page, startDate, endDate, status } = parameters;
 
       // Pull number of results per page from parameters
       if (numResultsPerPage) {
@@ -70,6 +73,18 @@ class Tasks {
       if (page) {
         queryParams.page = page;
       }
+
+      if (startDate) {
+        queryParams.start_date = startDate;
+      }
+
+      if (endDate) {
+        queryParams.end_date = endDate;
+      }
+
+      if (status) {
+        queryParams.status = status;
+      }
     }
 
     try {