pipedrive 13.0.8 → 13.0.9

package/CHANGELOG.md

@@ -8,6 +8,14 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## 13.0.9
+### Added
+- Added `tax` parameter on add product to the deal.
+* POST /v1/deals/{id}/products
+* PUT /v1/deals/{id}/products/{product_attachment_id}
+- Improved `follower_id` description
+* DELETE /v1/products/{id}/followers/{follower_id}
+
 ## 13.0.8
 ### Changed
 - Improve Products `price` description

package/dist/api/ItemSearchApi.js

@@ -46,7 +46,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
    * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
    * @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>`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> </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.
@@ -105,7 +105,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
      * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
      * @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>`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> </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.

package/dist/api/ProductsApi.js

@@ -241,7 +241,7 @@ var ProductsApi = /*#__PURE__*/function () {
      * Delete a follower from a product
      * Deletes a follower from a product.
      * @param {Number} id ID of the product
-     * @param {Number} followerId ID of the follower
+     * @param {Number} followerId ID of the relationship between the follower and the product
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFollowerResponse} and HTTP response
      */
 
@@ -291,7 +291,7 @@ var ProductsApi = /*#__PURE__*/function () {
      * Delete a follower from a product
      * Deletes a follower from a product.
      * @param {Number} id ID of the product
-     * @param {Number} followerId ID of the follower
+     * @param {Number} followerId ID of the relationship between the follower and the product
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFollowerResponse}
      */
 

package/dist/model/AddProductAttachmentDetails.js

@@ -111,6 +111,11 @@ var AddProductAttachmentDetails = /*#__PURE__*/function () {
           delete data['comments'];
         }
 
+        if (data.hasOwnProperty('tax')) {
+          obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
+          delete data['tax'];
+        }
+
         if (data.hasOwnProperty('enabled_flag')) {
           obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
           delete data['enabled_flag'];
@@ -171,11 +176,6 @@ var AddProductAttachmentDetails = /*#__PURE__*/function () {
           delete data['active_flag'];
         }
 
-        if (data.hasOwnProperty('tax')) {
-          obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
-          delete data['tax'];
-        }
-
         if (data.hasOwnProperty('name')) {
           obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
           delete data['name'];
@@ -235,6 +235,12 @@ AddProductAttachmentDetails.prototype['product_variation_id'] = undefined;
  */
 
 AddProductAttachmentDetails.prototype['comments'] = undefined;
+/**
+ * The Product tax
+ * @member {Number} tax
+ */
+
+AddProductAttachmentDetails.prototype['tax'] = undefined;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag
@@ -307,12 +313,6 @@ AddProductAttachmentDetails.prototype['last_edit'] = undefined;
  */
 
 AddProductAttachmentDetails.prototype['active_flag'] = undefined;
-/**
- * The Product tax
- * @member {Number} tax
- */
-
-AddProductAttachmentDetails.prototype['tax'] = undefined;
 /**
  * The Product name
  * @member {String} name
@@ -364,6 +364,12 @@ _ProductAttachmentDetails["default"].prototype['product_variation_id'] = undefin
  */
 
 _ProductAttachmentDetails["default"].prototype['comments'] = undefined;
+/**
+ * The Product tax
+ * @member {Number} tax
+ */
+
+_ProductAttachmentDetails["default"].prototype['tax'] = undefined;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag
@@ -436,12 +442,6 @@ _ProductAttachmentDetails["default"].prototype['last_edit'] = undefined;
  */
 
 _ProductAttachmentDetails["default"].prototype['active_flag'] = undefined;
-/**
- * The Product tax
- * @member {Number} tax
- */
-
-_ProductAttachmentDetails["default"].prototype['tax'] = undefined;
 /**
  * The Product name
  * @member {String} name

package/dist/model/BasicDealProduct.js

@@ -96,6 +96,11 @@ var BasicDealProduct = /*#__PURE__*/function () {
           delete data['comments'];
         }
 
+        if (data.hasOwnProperty('tax')) {
+          obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
+          delete data['tax'];
+        }
+
         if (data.hasOwnProperty('enabled_flag')) {
           obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
           delete data['enabled_flag'];
@@ -150,6 +155,13 @@ BasicDealProduct.prototype['product_variation_id'] = undefined;
  */
 
 BasicDealProduct.prototype['comments'] = undefined;
+/**
+ * Tax percentage
+ * @member {Number} tax
+ * @default 0
+ */
+
+BasicDealProduct.prototype['tax'] = 0;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag

package/dist/model/NewDealProduct.js

@@ -118,6 +118,11 @@ var NewDealProduct = /*#__PURE__*/function () {
           delete data['comments'];
         }
 
+        if (data.hasOwnProperty('tax')) {
+          obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
+          delete data['tax'];
+        }
+
         if (data.hasOwnProperty('enabled_flag')) {
           obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
           delete data['enabled_flag'];
@@ -177,6 +182,13 @@ NewDealProduct.prototype['product_variation_id'] = undefined;
  */
 
 NewDealProduct.prototype['comments'] = undefined;
+/**
+ * Tax percentage
+ * @member {Number} tax
+ * @default 0
+ */
+
+NewDealProduct.prototype['tax'] = 0;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag
@@ -228,6 +240,13 @@ _BasicDealProduct["default"].prototype['product_variation_id'] = undefined;
  */
 
 _BasicDealProduct["default"].prototype['comments'] = undefined;
+/**
+ * Tax percentage
+ * @member {Number} tax
+ * @default 0
+ */
+
+_BasicDealProduct["default"].prototype['tax'] = 0;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag

package/dist/model/ProductAttachmentDetails.js

@@ -111,6 +111,11 @@ var ProductAttachmentDetails = /*#__PURE__*/function () {
           delete data['comments'];
         }
 
+        if (data.hasOwnProperty('tax')) {
+          obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
+          delete data['tax'];
+        }
+
         if (data.hasOwnProperty('enabled_flag')) {
           obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
           delete data['enabled_flag'];
@@ -171,11 +176,6 @@ var ProductAttachmentDetails = /*#__PURE__*/function () {
           delete data['active_flag'];
         }
 
-        if (data.hasOwnProperty('tax')) {
-          obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
-          delete data['tax'];
-        }
-
         if (data.hasOwnProperty('name')) {
           obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
           delete data['name'];
@@ -230,6 +230,12 @@ ProductAttachmentDetails.prototype['product_variation_id'] = undefined;
  */
 
 ProductAttachmentDetails.prototype['comments'] = undefined;
+/**
+ * The Product tax
+ * @member {Number} tax
+ */
+
+ProductAttachmentDetails.prototype['tax'] = undefined;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag
@@ -302,12 +308,6 @@ ProductAttachmentDetails.prototype['last_edit'] = undefined;
  */
 
 ProductAttachmentDetails.prototype['active_flag'] = undefined;
-/**
- * The Product tax
- * @member {Number} tax
- */
-
-ProductAttachmentDetails.prototype['tax'] = undefined;
 /**
  * The Product name
  * @member {String} name
@@ -353,6 +353,13 @@ _BasicDealProduct["default"].prototype['product_variation_id'] = undefined;
  */
 
 _BasicDealProduct["default"].prototype['comments'] = undefined;
+/**
+ * Tax percentage
+ * @member {Number} tax
+ * @default 0
+ */
+
+_BasicDealProduct["default"].prototype['tax'] = 0;
 /**
  * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipedrive",
-  "version": "13.0.8",
+  "version": "13.0.9",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "main": "dist/index.js",