diff --git a/CHANGELOG.md b/CHANGELOG.md index e3879ada..b26d4b11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,12 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an ## [Unreleased] +## [23.4.0] - 2024-09-24 +### Changed +- Added the field "notes" to product prices in the body and response for v1 and v2 +- Added the field "overhead_cost" to the product variation prices in the response for v1 +- Added the field "direct_cost" to the product variation prices in the response and body for v2 + ## [23.3.0] - 2024-09-23 ### Added - Add documentation for installments functionality: @@ -691,7 +697,8 @@ structure * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal * Fixed typo in lead example response (`crrency` to `currency`) -[Unreleased]: https://github.com/pipedrive/api-docs/compare/v23.3.0...HEAD +[Unreleased]: https://github.com/pipedrive/api-docs/compare/v23.4.0...HEAD +[23.4.0]: https://github.com/pipedrive/api-docs/compare/v23.3.0...v23.4.0 [23.3.0]: https://github.com/pipedrive/api-docs/compare/v23.2.5...v23.3.0 [23.2.5]: https://github.com/pipedrive/api-docs/compare/v23.2.4...v23.2.5 [23.2.4]: https://github.com/pipedrive/api-docs/compare/v23.2.3...v23.2.4 diff --git a/docs/AddProductRequestBody.md b/docs/AddProductRequestBody.md index 5af51ad8..69353eec 100644 --- a/docs/AddProductRequestBody.md +++ b/docs/AddProductRequestBody.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] **owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] -**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] +**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] **billing_frequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] **billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] diff --git a/docs/ProductRequest.md b/docs/ProductRequest.md index aca4a2c9..aa663f61 100644 --- a/docs/ProductRequest.md +++ b/docs/ProductRequest.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] **owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] -**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] +**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] diff --git a/docs/UpdateProductRequestBody.md b/docs/UpdateProductRequestBody.md index d5ee71a3..39252f49 100644 --- a/docs/UpdateProductRequestBody.md +++ b/docs/UpdateProductRequestBody.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **selectable** | **Boolean** | Whether this product can be selected in deals or not | [optional] [default to true] **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] **owner_id** | **Number** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional] -**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] +**prices** | **[Object]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional] **billing_frequency** | [**BillingFrequency1**](BillingFrequency1.md) | | [optional] **billing_frequency_cycles** | **Number** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional] diff --git a/package-lock.json b/package-lock.json index f31ddc9b..066cd558 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "pipedrive", - "version": "23.3.0", + "version": "23.4.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "pipedrive", - "version": "23.3.0", + "version": "23.4.0", "license": "MIT", "dependencies": { "@babel/runtime": "^7.20.1", diff --git a/package.json b/package.json index 759d8bfa..5bc2887f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "pipedrive", - "version": "23.3.0", + "version": "23.4.0", "description": "Pipedrive REST client for NodeJS", "license": "MIT", "main": "dist/index.js", diff --git a/src/model/AddProductRequestBody.js b/src/model/AddProductRequestBody.js index c7e1a008..00ff2ab7 100644 --- a/src/model/AddProductRequestBody.js +++ b/src/model/AddProductRequestBody.js @@ -191,7 +191,7 @@ AddProductRequestBody.prototype['visible_to'] = undefined; AddProductRequestBody.prototype['owner_id'] = undefined; /** - * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. + * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. * @member {Array.} prices */ AddProductRequestBody.prototype['prices'] = undefined; @@ -259,7 +259,7 @@ ProductRequest.prototype['visible_to'] = undefined; */ ProductRequest.prototype['owner_id'] = undefined; /** - * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. + * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. * @member {Array.} prices */ ProductRequest.prototype['prices'] = undefined; diff --git a/src/model/ProductRequest.js b/src/model/ProductRequest.js index bc00fe03..4181d4b5 100644 --- a/src/model/ProductRequest.js +++ b/src/model/ProductRequest.js @@ -157,7 +157,7 @@ ProductRequest.prototype['visible_to'] = undefined; ProductRequest.prototype['owner_id'] = undefined; /** - * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. + * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. * @member {Array.} prices */ ProductRequest.prototype['prices'] = undefined; diff --git a/src/model/UpdateProductRequestBody.js b/src/model/UpdateProductRequestBody.js index 38165e6e..11487323 100644 --- a/src/model/UpdateProductRequestBody.js +++ b/src/model/UpdateProductRequestBody.js @@ -191,7 +191,7 @@ UpdateProductRequestBody.prototype['visible_to'] = undefined; UpdateProductRequestBody.prototype['owner_id'] = undefined; /** - * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. + * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. * @member {Array.} prices */ UpdateProductRequestBody.prototype['prices'] = undefined; @@ -259,7 +259,7 @@ ProductRequest.prototype['visible_to'] = undefined; */ ProductRequest.prototype['owner_id'] = undefined; /** - * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. + * An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional), `notes` (string, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. * @member {Array.} prices */ ProductRequest.prototype['prices'] = undefined;