pipedrive 17.5.4 → 18.0.1

package/dist/api/GoalsApi.js

@@ -1,36 +1,22 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-
 var _AddOrUpdateGoalResponse = _interopRequireDefault(require("../model/AddOrUpdateGoalResponse200"));
-
 var _BasicGoal = _interopRequireDefault(require("../model/BasicGoal"));
-
 var _DeleteGoalResponse = _interopRequireDefault(require("../model/DeleteGoalResponse200"));
-
 var _GetGoalResultResponse = _interopRequireDefault(require("../model/GetGoalResultResponse200"));
-
 var _GetGoalsResponse = _interopRequireDefault(require("../model/GetGoalsResponse200"));
-
 var _NewGoal = _interopRequireDefault(require("../model/NewGoal"));
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 /**
 * Goals service.
 * @module api/GoalsApi
@@ -46,8 +32,9 @@ var GoalsApi = /*#__PURE__*/function () {
   */
   function GoalsApi(apiClient) {
     (0, _classCallCheck2["default"])(this, GoalsApi);
-    this.apiClient = apiClient || _ApiClient["default"].instance;
+    this.apiClient = apiClient;
   }
+
   /**
    * Add a new goal
    * Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
@@ -55,13 +42,26 @@ var GoalsApi = /*#__PURE__*/function () {
    * @param {module:model/NewGoal} opts.newGoal 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateGoalResponse200} and HTTP response
    */
-
-
   (0, _createClass2["default"])(GoalsApi, [{
     key: "addGoalWithHttpInfo",
     value: function addGoalWithHttpInfo(opts) {
       opts = opts || {};
       var postBody = opts['newGoal'];
+      if (opts['assignee'] === undefined || opts['assignee'] === null) {
+        throw new Error("Missing the required parameter 'assignee' when calling addGoal");
+      }
+      if (opts['type'] === undefined || opts['type'] === null) {
+        throw new Error("Missing the required parameter 'type' when calling addGoal");
+      }
+      if (opts['expected_outcome'] === undefined || opts['expected_outcome'] === null) {
+        throw new Error("Missing the required parameter 'expected_outcome' when calling addGoal");
+      }
+      if (opts['duration'] === undefined || opts['duration'] === null) {
+        throw new Error("Missing the required parameter 'duration' when calling addGoal");
+      }
+      if (opts['interval'] === undefined || opts['interval'] === null) {
+        throw new Error("Missing the required parameter 'interval' when calling addGoal");
+      }
       var pathParams = {};
       var queryParams = {};
       var headerParams = {};
@@ -70,7 +70,6 @@ var GoalsApi = /*#__PURE__*/function () {
       var contentTypes = ['application/json'];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -80,12 +79,12 @@ var GoalsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _AddOrUpdateGoalResponse["default"];
       return this.apiClient.callApi('/goals', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Add a new goal
      * Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
@@ -93,7 +92,6 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {module:model/NewGoal} opts.newGoal 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateGoalResponse200}
      */
-
   }, {
     key: "addGoal",
     value: function addGoal(opts) {
@@ -101,23 +99,23 @@ var GoalsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Delete existing goal
      * Marks a goal as deleted.
      * @param {String} id The ID of the goal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteGoalResponse200} and HTTP response
      */
-
   }, {
     key: "deleteGoalWithHttpInfo",
     value: function deleteGoalWithHttpInfo(id) {
       var opts = {};
-      var postBody = null; // verify the required parameter 'id' is set
+      var postBody = null;
 
+      // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
         throw new Error("Missing the required parameter 'id' when calling deleteGoal");
       }
-
       var pathParams = {
         'id': id
       };
@@ -128,7 +126,6 @@ var GoalsApi = /*#__PURE__*/function () {
       var contentTypes = [];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -138,19 +135,18 @@ var GoalsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _DeleteGoalResponse["default"];
       return this.apiClient.callApi('/goals/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Delete existing goal
      * Marks a goal as deleted.
      * @param {String} id The ID of the goal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteGoalResponse200}
      */
-
   }, {
     key: "deleteGoal",
     value: function deleteGoal(id) {
@@ -158,6 +154,7 @@ var GoalsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Get result of a goal
      * Gets the progress of a goal for the specified period.
@@ -166,27 +163,26 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {Date} periodEnd The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date. 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalResultResponse200} and HTTP response
      */
-
   }, {
     key: "getGoalResultWithHttpInfo",
     value: function getGoalResultWithHttpInfo(id, periodStart, periodEnd) {
       var opts = {};
-      var postBody = null; // verify the required parameter 'id' is set
+      var postBody = null;
 
+      // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
         throw new Error("Missing the required parameter 'id' when calling getGoalResult");
-      } // verify the required parameter 'periodStart' is set
-
+      }
 
+      // verify the required parameter 'periodStart' is set
       if (periodStart === undefined || periodStart === null) {
         throw new Error("Missing the required parameter 'periodStart' when calling getGoalResult");
-      } // verify the required parameter 'periodEnd' is set
-
+      }
 
+      // verify the required parameter 'periodEnd' is set
       if (periodEnd === undefined || periodEnd === null) {
         throw new Error("Missing the required parameter 'periodEnd' when calling getGoalResult");
       }
-
       var pathParams = {
         'id': id
       };
@@ -200,7 +196,6 @@ var GoalsApi = /*#__PURE__*/function () {
       var contentTypes = [];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -210,12 +205,12 @@ var GoalsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _GetGoalResultResponse["default"];
       return this.apiClient.callApi('/goals/{id}/results', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Get result of a goal
      * Gets the progress of a goal for the specified period.
@@ -224,7 +219,6 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {Date} periodEnd The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date. 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalResultResponse200}
      */
-
   }, {
     key: "getGoalResult",
     value: function getGoalResult(id, periodStart, periodEnd) {
@@ -232,6 +226,7 @@ var GoalsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Find goals
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
@@ -251,7 +246,6 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalsResponse200} and HTTP response
      */
-
   }, {
     key: "getGoalsWithHttpInfo",
     value: function getGoalsWithHttpInfo(opts) {
@@ -279,7 +273,6 @@ var GoalsApi = /*#__PURE__*/function () {
       var contentTypes = [];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -289,12 +282,12 @@ var GoalsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _GetGoalsResponse["default"];
       return this.apiClient.callApi('/goals/find', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Find goals
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
@@ -314,7 +307,6 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalsResponse200}
      */
-
   }, {
     key: "getGoals",
     value: function getGoals(opts) {
@@ -322,6 +314,7 @@ var GoalsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Update existing goal
      * Updates an existing goal.
@@ -330,17 +323,16 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {module:model/BasicGoal} opts.basicGoal 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateGoalResponse200} and HTTP response
      */
-
   }, {
     key: "updateGoalWithHttpInfo",
     value: function updateGoalWithHttpInfo(id, opts) {
       opts = opts || {};
-      var postBody = opts['basicGoal']; // verify the required parameter 'id' is set
+      var postBody = opts['basicGoal'];
 
+      // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
         throw new Error("Missing the required parameter 'id' when calling updateGoal");
       }
-
       var pathParams = {
         'id': id
       };
@@ -351,7 +343,6 @@ var GoalsApi = /*#__PURE__*/function () {
       var contentTypes = ['application/json'];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -361,12 +352,12 @@ var GoalsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _AddOrUpdateGoalResponse["default"];
       return this.apiClient.callApi('/goals/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Update existing goal
      * Updates an existing goal.
@@ -375,7 +366,6 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {module:model/BasicGoal} opts.basicGoal 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateGoalResponse200}
      */
-
   }, {
     key: "updateGoal",
     value: function updateGoal(id, opts) {
@@ -386,5 +376,4 @@ var GoalsApi = /*#__PURE__*/function () {
   }]);
   return GoalsApi;
 }();
-
 exports["default"] = GoalsApi;

package/dist/api/ItemSearchApi.js

@@ -1,28 +1,18 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-
 var _ItemSearchFieldResponse = _interopRequireDefault(require("../model/ItemSearchFieldResponse"));
-
 var _ItemSearchResponse = _interopRequireDefault(require("../model/ItemSearchResponse"));
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 /**
 * ItemSearch service.
 * @module api/ItemSearchApi
@@ -38,15 +28,16 @@ var ItemSearchApi = /*#__PURE__*/function () {
   */
   function ItemSearchApi(apiClient) {
     (0, _classCallCheck2["default"])(this, ItemSearchApi);
-    this.apiClient = apiClient || _ApiClient["default"].instance;
+    this.apiClient = apiClient;
   }
+
   /**
    * Perform a search from multiple item types
    * Performs a search from your choice of item types and fields.
-   * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
+   * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
    * @param {Object} opts Optional parameters
    * @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
-   * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
+   * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
    * @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization.
    * @param {module:model/Boolean} opts.exactMatch When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
    * @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
@@ -54,18 +45,16 @@ var ItemSearchApi = /*#__PURE__*/function () {
    * @param {Number} opts.limit Items shown per page
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ItemSearchResponse} and HTTP response
    */
-
-
   (0, _createClass2["default"])(ItemSearchApi, [{
     key: "searchItemWithHttpInfo",
     value: function searchItemWithHttpInfo(term, opts) {
       opts = opts || {};
-      var postBody = null; // verify the required parameter 'term' is set
+      var postBody = null;
 
+      // verify the required parameter 'term' is set
       if (term === undefined || term === null) {
         throw new Error("Missing the required parameter 'term' when calling searchItem");
       }
-
       var pathParams = {};
       var queryParams = {
         'term': term,
@@ -83,7 +72,6 @@ var ItemSearchApi = /*#__PURE__*/function () {
       var contentTypes = [];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -93,19 +81,19 @@ var ItemSearchApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _ItemSearchResponse["default"];
       return this.apiClient.callApi('/itemSearch', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Perform a search from multiple item types
      * Performs a search from your choice of item types and fields.
-     * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
+     * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
      * @param {Object} opts Optional parameters
      * @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
-     * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
+     * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
      * @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization.
      * @param {module:model/Boolean} opts.exactMatch When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
      * @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
@@ -113,7 +101,6 @@ var ItemSearchApi = /*#__PURE__*/function () {
      * @param {Number} opts.limit Items shown per page
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ItemSearchResponse}
      */
-
   }, {
     key: "searchItem",
     value: function searchItem(term, opts) {
@@ -121,10 +108,11 @@ var ItemSearchApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Perform a search using a specific field from an item type
      * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
-     * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
+     * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
      * @param {module:model/String} fieldType The type of the field to perform the search from
      * @param {String} fieldKey The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).
      * @param {Object} opts Optional parameters
@@ -134,27 +122,26 @@ var ItemSearchApi = /*#__PURE__*/function () {
      * @param {Number} opts.limit Items shown per page
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ItemSearchFieldResponse} and HTTP response
      */
-
   }, {
     key: "searchItemByFieldWithHttpInfo",
     value: function searchItemByFieldWithHttpInfo(term, fieldType, fieldKey, opts) {
       opts = opts || {};
-      var postBody = null; // verify the required parameter 'term' is set
+      var postBody = null;
 
+      // verify the required parameter 'term' is set
       if (term === undefined || term === null) {
         throw new Error("Missing the required parameter 'term' when calling searchItemByField");
-      } // verify the required parameter 'fieldType' is set
-
+      }
 
+      // verify the required parameter 'fieldType' is set
       if (fieldType === undefined || fieldType === null) {
         throw new Error("Missing the required parameter 'fieldType' when calling searchItemByField");
-      } // verify the required parameter 'fieldKey' is set
-
+      }
 
+      // verify the required parameter 'fieldKey' is set
       if (fieldKey === undefined || fieldKey === null) {
         throw new Error("Missing the required parameter 'fieldKey' when calling searchItemByField");
       }
-
       var pathParams = {};
       var queryParams = {
         'term': term,
@@ -171,7 +158,6 @@ var ItemSearchApi = /*#__PURE__*/function () {
       var contentTypes = [];
       var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
       var isJSON = contentTypes.includes('application/json');
-
       if (isJSON) {
         postBody = _objectSpread(_objectSpread({}, postBody), opts);
       } else if (isURLEncoded) {
@@ -181,16 +167,16 @@ var ItemSearchApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['applicatoin/json'];
       var returnType = _ItemSearchFieldResponse["default"];
       return this.apiClient.callApi('/itemSearch/field', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Perform a search using a specific field from an item type
      * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
-     * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
+     * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
      * @param {module:model/String} fieldType The type of the field to perform the search from
      * @param {String} fieldKey The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).
      * @param {Object} opts Optional parameters
@@ -200,7 +186,6 @@ var ItemSearchApi = /*#__PURE__*/function () {
      * @param {Number} opts.limit Items shown per page
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ItemSearchFieldResponse}
      */
-
   }, {
     key: "searchItemByField",
     value: function searchItemByField(term, fieldType, fieldKey, opts) {
@@ -211,5 +196,4 @@ var ItemSearchApi = /*#__PURE__*/function () {
   }]);
   return ItemSearchApi;
 }();
-
 exports["default"] = ItemSearchApi;