pipedrive 17.5.4 → 18.0.0

package/dist/api/LeadsApi.js

@@ -1,38 +1,23 @@
 "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 _AddLeadRequest = _interopRequireDefault(require("../model/AddLeadRequest"));
-
 var _GetLeadsResponse = _interopRequireDefault(require("../model/GetLeadsResponse200"));
-
 var _LeadIdResponse = _interopRequireDefault(require("../model/LeadIdResponse200"));
-
 var _LeadResponse = _interopRequireDefault(require("../model/LeadResponse404"));
-
 var _LeadSearchResponse = _interopRequireDefault(require("../model/LeadSearchResponse"));
-
 var _OneLeadResponse = _interopRequireDefault(require("../model/OneLeadResponse200"));
-
 var _UpdateLeadRequest = _interopRequireDefault(require("../model/UpdateLeadRequest"));
-
 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; }
-
 /**
 * Leads service.
 * @module api/LeadsApi
@@ -48,8 +33,9 @@ var LeadsApi = /*#__PURE__*/function () {
   */
   function LeadsApi(apiClient) {
     (0, _classCallCheck2["default"])(this, LeadsApi);
-    this.apiClient = apiClient || _ApiClient["default"].instance;
+    this.apiClient = apiClient;
   }
+
   /**
    * Add a lead
    * Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
@@ -57,18 +43,14 @@ var LeadsApi = /*#__PURE__*/function () {
    * @param {module:model/AddLeadRequest} opts.addLeadRequest 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OneLeadResponse200} and HTTP response
    */
-
-
   (0, _createClass2["default"])(LeadsApi, [{
     key: "addLeadWithHttpInfo",
     value: function addLeadWithHttpInfo(opts) {
       opts = opts || {};
       var postBody = opts['addLeadRequest'];
-
       if (opts['title'] === undefined || opts['title'] === null) {
         throw new Error("Missing the required parameter 'title' when calling addLead");
       }
-
       var pathParams = {};
       var queryParams = {};
       var headerParams = {};
@@ -77,7 +59,6 @@ var LeadsApi = /*#__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) {
@@ -87,12 +68,12 @@ var LeadsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _OneLeadResponse["default"];
       return this.apiClient.callApi('/leads', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Add a lead
      * Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
@@ -100,7 +81,6 @@ var LeadsApi = /*#__PURE__*/function () {
      * @param {module:model/AddLeadRequest} opts.addLeadRequest 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OneLeadResponse200}
      */
-
   }, {
     key: "addLead",
     value: function addLead(opts) {
@@ -108,23 +88,23 @@ var LeadsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Delete a lead
      * Deletes a specific lead.
      * @param {String} id The ID of the lead
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeadIdResponse200} and HTTP response
      */
-
   }, {
     key: "deleteLeadWithHttpInfo",
     value: function deleteLeadWithHttpInfo(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 deleteLead");
       }
-
       var pathParams = {
         'id': id
       };
@@ -135,7 +115,6 @@ var LeadsApi = /*#__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) {
@@ -145,19 +124,18 @@ var LeadsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _LeadIdResponse["default"];
       return this.apiClient.callApi('/leads/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Delete a lead
      * Deletes a specific lead.
      * @param {String} id The ID of the lead
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeadIdResponse200}
      */
-
   }, {
     key: "deleteLead",
     value: function deleteLead(id) {
@@ -165,23 +143,23 @@ var LeadsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Get one lead
      * Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @param {String} id The ID of the lead
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OneLeadResponse200} and HTTP response
      */
-
   }, {
     key: "getLeadWithHttpInfo",
     value: function getLeadWithHttpInfo(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 getLead");
       }
-
       var pathParams = {
         'id': id
       };
@@ -192,7 +170,6 @@ var LeadsApi = /*#__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) {
@@ -202,19 +179,18 @@ var LeadsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _OneLeadResponse["default"];
       return this.apiClient.callApi('/leads/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Get one lead
      * Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
      * @param {String} id The ID of the lead
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OneLeadResponse200}
      */
-
   }, {
     key: "getLead",
     value: function getLead(id) {
@@ -222,6 +198,7 @@ var LeadsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Get all leads
      * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. 
@@ -236,7 +213,6 @@ var LeadsApi = /*#__PURE__*/function () {
      * @param {module:model/String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLeadsResponse200} and HTTP response
      */
-
   }, {
     key: "getLeadsWithHttpInfo",
     value: function getLeadsWithHttpInfo(opts) {
@@ -259,7 +235,6 @@ var LeadsApi = /*#__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) {
@@ -269,12 +244,12 @@ var LeadsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _GetLeadsResponse["default"];
       return this.apiClient.callApi('/leads', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Get all leads
      * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. 
@@ -289,7 +264,6 @@ var LeadsApi = /*#__PURE__*/function () {
      * @param {module:model/String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLeadsResponse200}
      */
-
   }, {
     key: "getLeads",
     value: function getLeads(opts) {
@@ -297,10 +271,11 @@ var LeadsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Search leads
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
-     * @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.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
      * @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.
@@ -311,17 +286,16 @@ var LeadsApi = /*#__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/LeadSearchResponse} and HTTP response
      */
-
   }, {
     key: "searchLeadsWithHttpInfo",
     value: function searchLeadsWithHttpInfo(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 searchLeads");
       }
-
       var pathParams = {};
       var queryParams = {
         'term': term,
@@ -339,7 +313,6 @@ var LeadsApi = /*#__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) {
@@ -349,16 +322,16 @@ var LeadsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _LeadSearchResponse["default"];
       return this.apiClient.callApi('/leads/search', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Search leads
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
-     * @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.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
      * @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.
@@ -369,7 +342,6 @@ var LeadsApi = /*#__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/LeadSearchResponse}
      */
-
   }, {
     key: "searchLeads",
     value: function searchLeads(term, opts) {
@@ -377,6 +349,7 @@ var LeadsApi = /*#__PURE__*/function () {
         return response_and_data;
       });
     }
+
     /**
      * Update a lead
      * Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
@@ -385,17 +358,16 @@ var LeadsApi = /*#__PURE__*/function () {
      * @param {module:model/UpdateLeadRequest} opts.updateLeadRequest 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OneLeadResponse200} and HTTP response
      */
-
   }, {
     key: "updateLeadWithHttpInfo",
     value: function updateLeadWithHttpInfo(id, opts) {
       opts = opts || {};
-      var postBody = opts['updateLeadRequest']; // verify the required parameter 'id' is set
+      var postBody = opts['updateLeadRequest'];
 
+      // verify the required parameter 'id' is set
       if (id === undefined || id === null) {
         throw new Error("Missing the required parameter 'id' when calling updateLead");
       }
-
       var pathParams = {
         'id': id
       };
@@ -406,7 +378,6 @@ var LeadsApi = /*#__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) {
@@ -416,12 +387,12 @@ var LeadsApi = /*#__PURE__*/function () {
           }
         }
       }
-
       var authNames = ['api_key', 'oauth2'];
       var accepts = ['application/json'];
       var returnType = _OneLeadResponse["default"];
       return this.apiClient.callApi('/leads/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
+
     /**
      * Update a lead
      * Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
@@ -430,7 +401,6 @@ var LeadsApi = /*#__PURE__*/function () {
      * @param {module:model/UpdateLeadRequest} opts.updateLeadRequest 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OneLeadResponse200}
      */
-
   }, {
     key: "updateLead",
     value: function updateLead(id, opts) {
@@ -441,5 +411,4 @@ var LeadsApi = /*#__PURE__*/function () {
   }]);
   return LeadsApi;
 }();
-
 exports["default"] = LeadsApi;