pipedrive 13.0.5 → 13.0.9

Sign up to get free protection for your applications and to get access to all the features.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,32 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
7
7
  For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).
8
8
 
9
9
  ## [Unreleased]
10
+
11
+ ## 13.0.9
12
+ ### Added
13
+ - Added `tax` parameter on add product to the deal.
14
+ * POST /v1/deals/{id}/products
15
+ * PUT /v1/deals/{id}/products/{product_attachment_id}
16
+ - Improved `follower_id` description
17
+ * DELETE /v1/products/{id}/followers/{follower_id}
18
+
19
+ ## 13.0.8
20
+ ### Changed
21
+ - Improve Products `price` description
22
+
23
+ ## 13.0.7
24
+ ### Changed
25
+ - Changed/improve Products `visible_to` type, and differentiate options by plans
26
+ * POST /products
27
+ * PUT /products/{id}
28
+
29
+ ## 13.0.6
30
+ ### Fixed
31
+ - Fixed `POST /roles/{id}/settings` `value` parameter description
32
+ ### Added
33
+ - Added type to `POST /roles/{id}/settings` `value` parameter
34
+ - Added description to `POST /roles/{id}/settings`
35
+
10
36
  ## 13.0.5
11
37
  ### Changed
12
38
  - Changed Organization `custom_fields` type to a string array
@@ -46,7 +46,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
46
46
  * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
47
47
  * @param {Object} opts Optional parameters
48
48
  * @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
49
- * @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`.
49
+ * @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`.
50
50
  * @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.
51
51
  * @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.
52
52
  * @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 () {
105
105
  * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
106
106
  * @param {Object} opts Optional parameters
107
107
  * @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
108
- * @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`.
108
+ * @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`.
109
109
  * @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.
110
110
  * @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.
111
111
  * @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
@@ -241,7 +241,7 @@ var ProductsApi = /*#__PURE__*/function () {
241
241
  * Delete a follower from a product
242
242
  * Deletes a follower from a product.
243
243
  * @param {Number} id ID of the product
244
- * @param {Number} followerId ID of the follower
244
+ * @param {Number} followerId ID of the relationship between the follower and the product
245
245
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFollowerResponse} and HTTP response
246
246
  */
247
247
 
@@ -291,7 +291,7 @@ var ProductsApi = /*#__PURE__*/function () {
291
291
  * Delete a follower from a product
292
292
  * Deletes a follower from a product.
293
293
  * @param {Number} id ID of the product
294
- * @param {Number} followerId ID of the follower
294
+ * @param {Number} followerId ID of the relationship between the follower and the product
295
295
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFollowerResponse}
296
296
  */
297
297
 
@@ -60,9 +60,10 @@ var RolesApi = /*#__PURE__*/function () {
60
60
  }
61
61
  /**
62
62
  * Add or update role setting
63
+ * Add or update the visibility setting for a role
63
64
  * @param {Number} id ID of the role
64
65
  * @param {module:model/String} settingKey
65
- * @param {module:model/Object} value Possible values for `default_visibility` settings: `1`, `3`, `5` or `7`
66
+ * @param {module:model/Number} value Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner&#39;s visibility group</td></tr> <tr><td>`5`</td><td>Owner&#39;s visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.
66
67
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoleSettings} and HTTP response
67
68
  */
68
69
 
@@ -118,9 +119,10 @@ var RolesApi = /*#__PURE__*/function () {
118
119
  }
119
120
  /**
120
121
  * Add or update role setting
122
+ * Add or update the visibility setting for a role
121
123
  * @param {Number} id ID of the role
122
124
  * @param {module:model/String} settingKey
123
- * @param {module:model/Object} value Possible values for `default_visibility` settings: `1`, `3`, `5` or `7`
125
+ * @param {module:model/Number} value Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner&#39;s visibility group</td></tr> <tr><td>`5`</td><td>Owner&#39;s visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.
124
126
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoleSettings}
125
127
  */
126
128
 
@@ -111,6 +111,11 @@ var AddProductAttachmentDetails = /*#__PURE__*/function () {
111
111
  delete data['comments'];
112
112
  }
113
113
 
114
+ if (data.hasOwnProperty('tax')) {
115
+ obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
116
+ delete data['tax'];
117
+ }
118
+
114
119
  if (data.hasOwnProperty('enabled_flag')) {
115
120
  obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
116
121
  delete data['enabled_flag'];
@@ -171,11 +176,6 @@ var AddProductAttachmentDetails = /*#__PURE__*/function () {
171
176
  delete data['active_flag'];
172
177
  }
173
178
 
174
- if (data.hasOwnProperty('tax')) {
175
- obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
176
- delete data['tax'];
177
- }
178
-
179
179
  if (data.hasOwnProperty('name')) {
180
180
  obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
181
181
  delete data['name'];
@@ -235,6 +235,12 @@ AddProductAttachmentDetails.prototype['product_variation_id'] = undefined;
235
235
  */
236
236
 
237
237
  AddProductAttachmentDetails.prototype['comments'] = undefined;
238
+ /**
239
+ * The Product tax
240
+ * @member {Number} tax
241
+ */
242
+
243
+ AddProductAttachmentDetails.prototype['tax'] = undefined;
238
244
  /**
239
245
  * 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.
240
246
  * @member {module:model/NumberBoolean} enabled_flag
@@ -307,12 +313,6 @@ AddProductAttachmentDetails.prototype['last_edit'] = undefined;
307
313
  */
308
314
 
309
315
  AddProductAttachmentDetails.prototype['active_flag'] = undefined;
310
- /**
311
- * The Product tax
312
- * @member {Number} tax
313
- */
314
-
315
- AddProductAttachmentDetails.prototype['tax'] = undefined;
316
316
  /**
317
317
  * The Product name
318
318
  * @member {String} name
@@ -364,6 +364,12 @@ _ProductAttachmentDetails["default"].prototype['product_variation_id'] = undefin
364
364
  */
365
365
 
366
366
  _ProductAttachmentDetails["default"].prototype['comments'] = undefined;
367
+ /**
368
+ * The Product tax
369
+ * @member {Number} tax
370
+ */
371
+
372
+ _ProductAttachmentDetails["default"].prototype['tax'] = undefined;
367
373
  /**
368
374
  * 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.
369
375
  * @member {module:model/NumberBoolean} enabled_flag
@@ -436,12 +442,6 @@ _ProductAttachmentDetails["default"].prototype['last_edit'] = undefined;
436
442
  */
437
443
 
438
444
  _ProductAttachmentDetails["default"].prototype['active_flag'] = undefined;
439
- /**
440
- * The Product tax
441
- * @member {Number} tax
442
- */
443
-
444
- _ProductAttachmentDetails["default"].prototype['tax'] = undefined;
445
445
  /**
446
446
  * The Product name
447
447
  * @member {String} name
@@ -168,7 +168,7 @@ AddProductRequestBody.prototype['active_flag'] = undefined;
168
168
 
169
169
  AddProductRequestBody.prototype['selectable'] = undefined;
170
170
  /**
171
- * Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
171
+ * Visibility of the product. If omitted, 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>
172
172
  * @member {module:model/VisibleTo} visible_to
173
173
  */
174
174
 
@@ -180,7 +180,7 @@ AddProductRequestBody.prototype['visible_to'] = undefined;
180
180
 
181
181
  AddProductRequestBody.prototype['owner_id'] = undefined;
182
182
  /**
183
- * 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, no prices will be set up for the product
183
+ * Object containing price objects, where each key is the price currency code, and each value is the price object. Each price object contains: `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, no prices will be set up for the product.
184
184
  * @member {Array.<Object>} prices
185
185
  */
186
186
 
@@ -222,7 +222,7 @@ _ProductRequest["default"].prototype['active_flag'] = undefined;
222
222
 
223
223
  _ProductRequest["default"].prototype['selectable'] = undefined;
224
224
  /**
225
- * Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
225
+ * Visibility of the product. If omitted, 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>
226
226
  * @member {module:model/VisibleTo} visible_to
227
227
  */
228
228
 
@@ -234,7 +234,7 @@ _ProductRequest["default"].prototype['visible_to'] = undefined;
234
234
 
235
235
  _ProductRequest["default"].prototype['owner_id'] = undefined;
236
236
  /**
237
- * 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, no prices will be set up for the product
237
+ * Object containing price objects, where each key is the price currency code, and each value is the price object. Each price object contains: `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, no prices will be set up for the product.
238
238
  * @member {Array.<Object>} prices
239
239
  */
240
240
 
@@ -96,6 +96,11 @@ var BasicDealProduct = /*#__PURE__*/function () {
96
96
  delete data['comments'];
97
97
  }
98
98
 
99
+ if (data.hasOwnProperty('tax')) {
100
+ obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
101
+ delete data['tax'];
102
+ }
103
+
99
104
  if (data.hasOwnProperty('enabled_flag')) {
100
105
  obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
101
106
  delete data['enabled_flag'];
@@ -150,6 +155,13 @@ BasicDealProduct.prototype['product_variation_id'] = undefined;
150
155
  */
151
156
 
152
157
  BasicDealProduct.prototype['comments'] = undefined;
158
+ /**
159
+ * Tax percentage
160
+ * @member {Number} tax
161
+ * @default 0
162
+ */
163
+
164
+ BasicDealProduct.prototype['tax'] = 0;
153
165
  /**
154
166
  * 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.
155
167
  * @member {module:model/NumberBoolean} enabled_flag
@@ -118,6 +118,11 @@ var NewDealProduct = /*#__PURE__*/function () {
118
118
  delete data['comments'];
119
119
  }
120
120
 
121
+ if (data.hasOwnProperty('tax')) {
122
+ obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
123
+ delete data['tax'];
124
+ }
125
+
121
126
  if (data.hasOwnProperty('enabled_flag')) {
122
127
  obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
123
128
  delete data['enabled_flag'];
@@ -177,6 +182,13 @@ NewDealProduct.prototype['product_variation_id'] = undefined;
177
182
  */
178
183
 
179
184
  NewDealProduct.prototype['comments'] = undefined;
185
+ /**
186
+ * Tax percentage
187
+ * @member {Number} tax
188
+ * @default 0
189
+ */
190
+
191
+ NewDealProduct.prototype['tax'] = 0;
180
192
  /**
181
193
  * 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.
182
194
  * @member {module:model/NumberBoolean} enabled_flag
@@ -228,6 +240,13 @@ _BasicDealProduct["default"].prototype['product_variation_id'] = undefined;
228
240
  */
229
241
 
230
242
  _BasicDealProduct["default"].prototype['comments'] = undefined;
243
+ /**
244
+ * Tax percentage
245
+ * @member {Number} tax
246
+ * @default 0
247
+ */
248
+
249
+ _BasicDealProduct["default"].prototype['tax'] = 0;
231
250
  /**
232
251
  * 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.
233
252
  * @member {module:model/NumberBoolean} enabled_flag
@@ -111,6 +111,11 @@ var ProductAttachmentDetails = /*#__PURE__*/function () {
111
111
  delete data['comments'];
112
112
  }
113
113
 
114
+ if (data.hasOwnProperty('tax')) {
115
+ obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
116
+ delete data['tax'];
117
+ }
118
+
114
119
  if (data.hasOwnProperty('enabled_flag')) {
115
120
  obj['enabled_flag'] = _ApiClient["default"].convertToType(data['enabled_flag'], _NumberBoolean["default"]);
116
121
  delete data['enabled_flag'];
@@ -171,11 +176,6 @@ var ProductAttachmentDetails = /*#__PURE__*/function () {
171
176
  delete data['active_flag'];
172
177
  }
173
178
 
174
- if (data.hasOwnProperty('tax')) {
175
- obj['tax'] = _ApiClient["default"].convertToType(data['tax'], 'Number');
176
- delete data['tax'];
177
- }
178
-
179
179
  if (data.hasOwnProperty('name')) {
180
180
  obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
181
181
  delete data['name'];
@@ -230,6 +230,12 @@ ProductAttachmentDetails.prototype['product_variation_id'] = undefined;
230
230
  */
231
231
 
232
232
  ProductAttachmentDetails.prototype['comments'] = undefined;
233
+ /**
234
+ * The Product tax
235
+ * @member {Number} tax
236
+ */
237
+
238
+ ProductAttachmentDetails.prototype['tax'] = undefined;
233
239
  /**
234
240
  * 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.
235
241
  * @member {module:model/NumberBoolean} enabled_flag
@@ -302,12 +308,6 @@ ProductAttachmentDetails.prototype['last_edit'] = undefined;
302
308
  */
303
309
 
304
310
  ProductAttachmentDetails.prototype['active_flag'] = undefined;
305
- /**
306
- * The Product tax
307
- * @member {Number} tax
308
- */
309
-
310
- ProductAttachmentDetails.prototype['tax'] = undefined;
311
311
  /**
312
312
  * The Product name
313
313
  * @member {String} name
@@ -353,6 +353,13 @@ _BasicDealProduct["default"].prototype['product_variation_id'] = undefined;
353
353
  */
354
354
 
355
355
  _BasicDealProduct["default"].prototype['comments'] = undefined;
356
+ /**
357
+ * Tax percentage
358
+ * @member {Number} tax
359
+ * @default 0
360
+ */
361
+
362
+ _BasicDealProduct["default"].prototype['tax'] = 0;
356
363
  /**
357
364
  * 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.
358
365
  * @member {module:model/NumberBoolean} enabled_flag
@@ -160,7 +160,7 @@ ProductRequest.prototype['active_flag'] = undefined;
160
160
 
161
161
  ProductRequest.prototype['selectable'] = undefined;
162
162
  /**
163
- * Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers (private)</td><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
163
+ * Visibility of the product. If omitted, 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>
164
164
  * @member {module:model/VisibleTo} visible_to
165
165
  */
166
166
 
@@ -172,7 +172,7 @@ ProductRequest.prototype['visible_to'] = undefined;
172
172
 
173
173
  ProductRequest.prototype['owner_id'] = undefined;
174
174
  /**
175
- * 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, no prices will be set up for the product
175
+ * Object containing price objects, where each key is the price currency code, and each value is the price object. Each price object contains: `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, no prices will be set up for the product.
176
176
  * @member {Array.<Object>} prices
177
177
  */
178
178
 
@@ -38,6 +38,8 @@ var VisibleTo = /*#__PURE__*/function () {
38
38
  (0, _classCallCheck2["default"])(this, VisibleTo);
39
39
  (0, _defineProperty2["default"])(this, "1", "1");
40
40
  (0, _defineProperty2["default"])(this, "3", "3");
41
+ (0, _defineProperty2["default"])(this, "5", "5");
42
+ (0, _defineProperty2["default"])(this, "7", "7");
41
43
  }
42
44
 
43
45
  (0, _createClass2["default"])(VisibleTo, null, [{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "13.0.5",
3
+ "version": "13.0.9",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",