pipedrive 13.0.10 → 13.1.1

package/dist/model/AddOrganizationRelationshipRequest.js

@@ -36,8 +36,8 @@ var AddOrganizationRelationshipRequest = /*#__PURE__*/function () {
    * Constructs a new <code>AddOrganizationRelationshipRequest</code>.
    * @alias module:model/AddOrganizationRelationshipRequest
    * @param type {module:model/AddOrganizationRelationshipRequest.TypeEnum} The type of organization relationship
-   * @param relOwnerOrgId {Number} The owner of this relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
-   * @param relLinkedOrgId {Number} The linked organization in this relationship. If type is `parent`, then the linked organization is the daughter.
+   * @param relOwnerOrgId {Number} The owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
+   * @param relLinkedOrgId {Number} The linked organization in the relationship. If type is `parent`, then the linked organization is the daughter.
    */
   function AddOrganizationRelationshipRequest(type, relOwnerOrgId, relLinkedOrgId) {
     (0, _classCallCheck2["default"])(this, AddOrganizationRelationshipRequest);
@@ -102,7 +102,7 @@ var AddOrganizationRelationshipRequest = /*#__PURE__*/function () {
   return AddOrganizationRelationshipRequest;
 }();
 /**
- * ID of the base organization for the returned calculated values
+ * The ID of the base organization for the returned calculated values
  * @member {Number} org_id
  */
 
@@ -115,13 +115,13 @@ AddOrganizationRelationshipRequest.prototype['org_id'] = undefined;
 
 AddOrganizationRelationshipRequest.prototype['type'] = undefined;
 /**
- * The owner of this relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
+ * The owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
  * @member {Number} rel_owner_org_id
  */
 
 AddOrganizationRelationshipRequest.prototype['rel_owner_org_id'] = undefined;
 /**
- * The linked organization in this relationship. If type is `parent`, then the linked organization is the daughter.
+ * The linked organization in the relationship. If type is `parent`, then the linked organization is the daughter.
  * @member {Number} rel_linked_org_id
  */
 

package/dist/model/AddPersonFollowerRequest.js

@@ -35,7 +35,7 @@ var AddPersonFollowerRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>AddPersonFollowerRequest</code>.
    * @alias module:model/AddPersonFollowerRequest
-   * @param userId {Number} ID of the user
+   * @param userId {Number} The ID of the user
    */
   function AddPersonFollowerRequest(userId) {
     (0, _classCallCheck2["default"])(this, AddPersonFollowerRequest);
@@ -83,7 +83,7 @@ var AddPersonFollowerRequest = /*#__PURE__*/function () {
   return AddPersonFollowerRequest;
 }();
 /**
- * ID of the user
+ * The ID of the user
  * @member {Number} user_id
  */
 

package/dist/model/AddProductAttachmentDetails.js

@@ -197,7 +197,7 @@ var AddProductAttachmentDetails = /*#__PURE__*/function () {
   return AddProductAttachmentDetails;
 }();
 /**
- * Price at which this product will be added to the deal
+ * The price at which this product will be added to the deal
  * @member {Number} item_price
  */
 
@@ -210,21 +210,21 @@ AddProductAttachmentDetails.prototype['item_price'] = undefined;
 
 AddProductAttachmentDetails.prototype['quantity'] = undefined;
 /**
- * Discount %. If omitted, will be set to 0
+ * The discount %. If omitted, will be set to 0.
  * @member {Number} discount_percentage
  * @default 0
  */
 
 AddProductAttachmentDetails.prototype['discount_percentage'] = 0;
 /**
- * Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
+ * The duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
  * @member {Number} duration
  * @default 1
  */
 
 AddProductAttachmentDetails.prototype['duration'] = 1;
 /**
- * ID of the product variation to use. When omitted, no variation will be used.
+ * The ID of the product variation to use. When omitted, no variation will be used.
  * @member {Number} product_variation_id
  */
 
@@ -236,37 +236,37 @@ AddProductAttachmentDetails.prototype['product_variation_id'] = undefined;
 
 AddProductAttachmentDetails.prototype['comments'] = undefined;
 /**
- * The Product tax
+ * 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.
+ * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with a specific price and discount criteria - but keep them disabled, which refrains them from being included in the deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag
  */
 
 AddProductAttachmentDetails.prototype['enabled_flag'] = undefined;
 /**
- * The ID of the deal-product (the ID of the Product attached to the Deal)
+ * The ID of the deal-product (the ID of the product attached to the deal)
  * @member {Number} id
  */
 
 AddProductAttachmentDetails.prototype['id'] = undefined;
 /**
- * The ID of the Company
+ * The ID of the company
  * @member {Number} company_id
  */
 
 AddProductAttachmentDetails.prototype['company_id'] = undefined;
 /**
- * The ID of the Deal
+ * The ID of the deal
  * @member {Number} deal_id
  */
 
 AddProductAttachmentDetails.prototype['deal_id'] = undefined;
 /**
- * The ID of the Product
+ * The ID of the product
  * @member {Number} product_id
  */
 
@@ -278,56 +278,56 @@ AddProductAttachmentDetails.prototype['product_id'] = undefined;
 
 AddProductAttachmentDetails.prototype['duration_unit'] = undefined;
 /**
- * The Product sum without the discount
+ * The product sum without the discount
  * @member {Number} sum_no_discount
  */
 
 AddProductAttachmentDetails.prototype['sum_no_discount'] = undefined;
 /**
- * The sum of all the Products attached to the Deal
+ * The sum of all the products attached to the deal
  * @member {Number} sum
  */
 
 AddProductAttachmentDetails.prototype['sum'] = undefined;
 /**
- * The currency associated with the Deal Product
+ * The currency associated with the deal product
  * @member {String} currency
  */
 
 AddProductAttachmentDetails.prototype['currency'] = undefined;
 /**
- * The date and time when the Product was added to the Deal
+ * The date and time when the product was added to the deal
  * @member {String} add_time
  */
 
 AddProductAttachmentDetails.prototype['add_time'] = undefined;
 /**
- * The date and time when the Deal Product was last edited
+ * The date and time when the deal product was last edited
  * @member {String} last_edit
  */
 
 AddProductAttachmentDetails.prototype['last_edit'] = undefined;
 /**
- * Boolean indicates if the Product is activated or not
+ * Whether the product is active or not
  * @member {Boolean} active_flag
  */
 
 AddProductAttachmentDetails.prototype['active_flag'] = undefined;
 /**
- * The Product name
+ * The product name
  * @member {String} name
  */
 
 AddProductAttachmentDetails.prototype['name'] = undefined;
 /**
- * The ID of the deal-product (the ID of the Product attached to the Deal)
+ * The ID of the deal-product (the ID of the product attached to the deal)
  * @member {Number} product_attachment_id
  */
 
 AddProductAttachmentDetails.prototype['product_attachment_id'] = undefined; // Implement ProductAttachmentDetails interface:
 
 /**
- * Price at which this product will be added to the deal
+ * The price at which this product will be added to the deal
  * @member {Number} item_price
  */
 
@@ -339,21 +339,21 @@ _ProductAttachmentDetails["default"].prototype['item_price'] = undefined;
 
 _ProductAttachmentDetails["default"].prototype['quantity'] = undefined;
 /**
- * Discount %. If omitted, will be set to 0
+ * The discount %. If omitted, will be set to 0.
  * @member {Number} discount_percentage
  * @default 0
  */
 
 _ProductAttachmentDetails["default"].prototype['discount_percentage'] = 0;
 /**
- * Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
+ * The duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)
  * @member {Number} duration
  * @default 1
  */
 
 _ProductAttachmentDetails["default"].prototype['duration'] = 1;
 /**
- * ID of the product variation to use. When omitted, no variation will be used.
+ * The ID of the product variation to use. When omitted, no variation will be used.
  * @member {Number} product_variation_id
  */
 
@@ -365,37 +365,37 @@ _ProductAttachmentDetails["default"].prototype['product_variation_id'] = undefin
 
 _ProductAttachmentDetails["default"].prototype['comments'] = undefined;
 /**
- * The Product tax
+ * 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.
+ * Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with a specific price and discount criteria - but keep them disabled, which refrains them from being included in the deal price calculation. When omitted, the product will be marked as enabled by default.
  * @member {module:model/NumberBoolean} enabled_flag
  */
 
 _ProductAttachmentDetails["default"].prototype['enabled_flag'] = undefined;
 /**
- * The ID of the deal-product (the ID of the Product attached to the Deal)
+ * The ID of the deal-product (the ID of the product attached to the deal)
  * @member {Number} id
  */
 
 _ProductAttachmentDetails["default"].prototype['id'] = undefined;
 /**
- * The ID of the Company
+ * The ID of the company
  * @member {Number} company_id
  */
 
 _ProductAttachmentDetails["default"].prototype['company_id'] = undefined;
 /**
- * The ID of the Deal
+ * The ID of the deal
  * @member {Number} deal_id
  */
 
 _ProductAttachmentDetails["default"].prototype['deal_id'] = undefined;
 /**
- * The ID of the Product
+ * The ID of the product
  * @member {Number} product_id
  */
 
@@ -407,50 +407,50 @@ _ProductAttachmentDetails["default"].prototype['product_id'] = undefined;
 
 _ProductAttachmentDetails["default"].prototype['duration_unit'] = undefined;
 /**
- * The Product sum without the discount
+ * The product sum without the discount
  * @member {Number} sum_no_discount
  */
 
 _ProductAttachmentDetails["default"].prototype['sum_no_discount'] = undefined;
 /**
- * The sum of all the Products attached to the Deal
+ * The sum of all the products attached to the deal
  * @member {Number} sum
  */
 
 _ProductAttachmentDetails["default"].prototype['sum'] = undefined;
 /**
- * The currency associated with the Deal Product
+ * The currency associated with the deal product
  * @member {String} currency
  */
 
 _ProductAttachmentDetails["default"].prototype['currency'] = undefined;
 /**
- * The date and time when the Product was added to the Deal
+ * The date and time when the product was added to the deal
  * @member {String} add_time
  */
 
 _ProductAttachmentDetails["default"].prototype['add_time'] = undefined;
 /**
- * The date and time when the Deal Product was last edited
+ * The date and time when the deal product was last edited
  * @member {String} last_edit
  */
 
 _ProductAttachmentDetails["default"].prototype['last_edit'] = undefined;
 /**
- * Boolean indicates if the Product is activated or not
+ * Whether the product is active or not
  * @member {Boolean} active_flag
  */
 
 _ProductAttachmentDetails["default"].prototype['active_flag'] = undefined;
 /**
- * The Product name
+ * The product name
  * @member {String} name
  */
 
 _ProductAttachmentDetails["default"].prototype['name'] = undefined; // Implement AddProductAttachmentDetailsAllOf interface:
 
 /**
- * The ID of the deal-product (the ID of the Product attached to the Deal)
+ * The ID of the deal-product (the ID of the product attached to the deal)
  * @member {Number} product_attachment_id
  */
 

package/dist/model/AddProductAttachmentDetailsAllOf.js

@@ -80,7 +80,7 @@ var AddProductAttachmentDetailsAllOf = /*#__PURE__*/function () {
   return AddProductAttachmentDetailsAllOf;
 }();
 /**
- * The ID of the deal-product (the ID of the Product attached to the Deal)
+ * The ID of the deal-product (the ID of the product attached to the deal)
  * @member {Number} product_attachment_id
  */
 

package/dist/model/AddProductFollowerRequest.js

@@ -35,7 +35,7 @@ var AddProductFollowerRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>AddProductFollowerRequest</code>.
    * @alias module:model/AddProductFollowerRequest
-   * @param userId {Number} ID of the user
+   * @param userId {Number} The ID of the user
    */
   function AddProductFollowerRequest(userId) {
     (0, _classCallCheck2["default"])(this, AddProductFollowerRequest);
@@ -83,7 +83,7 @@ var AddProductFollowerRequest = /*#__PURE__*/function () {
   return AddProductFollowerRequest;
 }();
 /**
- * ID of the user
+ * The ID of the user
  * @member {Number} user_id
  */
 

package/dist/model/AddProductRequestBody.js

@@ -132,26 +132,26 @@ var AddProductRequestBody = /*#__PURE__*/function () {
   return AddProductRequestBody;
 }();
 /**
- * Name of the product.
+ * The name of the product
  * @member {String} name
  */
 
 
 AddProductRequestBody.prototype['name'] = undefined;
 /**
- * Product code.
+ * The product code
  * @member {String} code
  */
 
 AddProductRequestBody.prototype['code'] = undefined;
 /**
- * Unit in which this product is sold
+ * The unit in which this product is sold
  * @member {String} unit
  */
 
 AddProductRequestBody.prototype['unit'] = undefined;
 /**
- * Tax percentage
+ * The tax percentage
  * @member {Number} tax
  * @default 0
  */
@@ -168,13 +168,13 @@ AddProductRequestBody.prototype['active_flag'] = undefined;
 
 AddProductRequestBody.prototype['selectable'] = undefined;
 /**
- * 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>
+ * 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>
  * @member {module:model/VisibleTo} visible_to
  */
 
 AddProductRequestBody.prototype['visible_to'] = undefined;
 /**
- * ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.
+ * The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.
  * @member {Number} owner_id
  */
 
@@ -187,25 +187,25 @@ AddProductRequestBody.prototype['owner_id'] = undefined;
 AddProductRequestBody.prototype['prices'] = undefined; // Implement ProductRequest interface:
 
 /**
- * Name of the product.
+ * The name of the product
  * @member {String} name
  */
 
 _ProductRequest["default"].prototype['name'] = undefined;
 /**
- * Product code.
+ * The product code
  * @member {String} code
  */
 
 _ProductRequest["default"].prototype['code'] = undefined;
 /**
- * Unit in which this product is sold
+ * The unit in which this product is sold
  * @member {String} unit
  */
 
 _ProductRequest["default"].prototype['unit'] = undefined;
 /**
- * Tax percentage
+ * The tax percentage
  * @member {Number} tax
  * @default 0
  */
@@ -222,13 +222,13 @@ _ProductRequest["default"].prototype['active_flag'] = undefined;
 
 _ProductRequest["default"].prototype['selectable'] = undefined;
 /**
- * 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>
+ * 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>
  * @member {module:model/VisibleTo} visible_to
  */
 
 _ProductRequest["default"].prototype['visible_to'] = undefined;
 /**
- * ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.
+ * The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.
  * @member {Number} owner_id
  */
 

package/dist/model/AddTeamUserRequest.js

@@ -35,7 +35,7 @@ var AddTeamUserRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>AddTeamUserRequest</code>.
    * @alias module:model/AddTeamUserRequest
-   * @param users {Array.<Number>} List of User IDs
+   * @param users {Array.<Number>} The list of user IDs
    */
   function AddTeamUserRequest(users) {
     (0, _classCallCheck2["default"])(this, AddTeamUserRequest);
@@ -83,7 +83,7 @@ var AddTeamUserRequest = /*#__PURE__*/function () {
   return AddTeamUserRequest;
 }();
 /**
- * List of User IDs
+ * The list of user IDs
  * @member {Array.<Number>} users
  */
 

package/dist/model/AddWebhookRequest.js

@@ -36,8 +36,8 @@ var AddWebhookRequest = /*#__PURE__*/function () {
    * Constructs a new <code>AddWebhookRequest</code>.
    * @alias module:model/AddWebhookRequest
    * @param subscriptionUrl {String} A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link.
-   * @param eventAction {module:model/AddWebhookRequest.EventActionEnum} Type of action to receive notifications about. Wildcard will match all supported actions.
-   * @param eventObject {module:model/AddWebhookRequest.EventObjectEnum} Type of object to receive notifications about. Wildcard will match all supported objects.
+   * @param eventAction {module:model/AddWebhookRequest.EventActionEnum} The type of action to receive notifications about. Wildcard will match all supported actions.
+   * @param eventObject {module:model/AddWebhookRequest.EventObjectEnum} The type of object to receive notifications about. Wildcard will match all supported objects.
    */
   function AddWebhookRequest(subscriptionUrl, eventAction, eventObject) {
     (0, _classCallCheck2["default"])(this, AddWebhookRequest);
@@ -119,31 +119,31 @@ var AddWebhookRequest = /*#__PURE__*/function () {
 
 AddWebhookRequest.prototype['subscription_url'] = undefined;
 /**
- * Type of action to receive notifications about. Wildcard will match all supported actions.
+ * The type of action to receive notifications about. Wildcard will match all supported actions.
  * @member {module:model/AddWebhookRequest.EventActionEnum} event_action
  */
 
 AddWebhookRequest.prototype['event_action'] = undefined;
 /**
- * Type of object to receive notifications about. Wildcard will match all supported objects.
+ * The type of object to receive notifications about. Wildcard will match all supported objects.
  * @member {module:model/AddWebhookRequest.EventObjectEnum} event_object
  */
 
 AddWebhookRequest.prototype['event_object'] = undefined;
 /**
- * The ID of the user this webhook will be authorized with. If not set, current authorized user will be used. Note that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.
+ * The ID of the user this Webhook will be authorized with. If not set, current authorized user will be used. Note that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.
  * @member {Number} user_id
  */
 
 AddWebhookRequest.prototype['user_id'] = undefined;
 /**
- * HTTP basic auth username of the subscription URL endpoint (if required).
+ * The HTTP basic auth username of the subscription URL endpoint (if required)
  * @member {String} http_auth_user
  */
 
 AddWebhookRequest.prototype['http_auth_user'] = undefined;
 /**
- * HTTP basic auth password of the subscription URL endpoint (if required).
+ * The HTTP basic auth password of the subscription URL endpoint (if required)
  * @member {String} http_auth_password
  */
 

package/dist/model/AddedDealFollowerData.js

@@ -95,26 +95,26 @@ var AddedDealFollowerData = /*#__PURE__*/function () {
   return AddedDealFollowerData;
 }();
 /**
- * The User ID who added the Follower
+ * The user ID who added the follower
  * @member {Number} user_id
  */
 
 
 AddedDealFollowerData.prototype['user_id'] = undefined;
 /**
- * The Follower ID
+ * The follower ID
  * @member {Number} id
  */
 
 AddedDealFollowerData.prototype['id'] = undefined;
 /**
- * The ID of the Deal which the Follower was added to
+ * The ID of the deal which the follower was added to
  * @member {Number} deal_id
  */
 
 AddedDealFollowerData.prototype['deal_id'] = undefined;
 /**
- * The date and time when the Deal Follower was added
+ * The date and time when the deal follower was added
  * @member {String} add_time
  */