pipedrive 13.0.8 → 13.0.12

package/dist/model/SubscriptionRecurringCreateRequest.js

@@ -35,11 +35,11 @@ var SubscriptionRecurringCreateRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SubscriptionRecurringCreateRequest</code>.
    * @alias module:model/SubscriptionRecurringCreateRequest
-   * @param dealId {Number} ID of the Deal this Recurring Subscription is associated with
-   * @param currency {String} The currency of the Recurring Subscription. Accepts a 3-character currency code.
-   * @param cadenceType {module:model/SubscriptionRecurringCreateRequest.CadenceTypeEnum} Interval between payments
-   * @param cycleAmount {Number} Amount of each payment
-   * @param startDate {Date} Start date of the Recurring Subscription. Format: YYYY-MM-DD
+   * @param dealId {Number} The ID of the deal this recurring subscription is associated with
+   * @param currency {String} The currency of the recurring subscription. Accepts a 3-character currency code.
+   * @param cadenceType {module:model/SubscriptionRecurringCreateRequest.CadenceTypeEnum} The interval between payments
+   * @param cycleAmount {Number} The amount of each payment
+   * @param startDate {Date} The start date of the recurring subscription. Format: YYYY-MM-DD
    */
   function SubscriptionRecurringCreateRequest(dealId, currency, cadenceType, cycleAmount, startDate) {
     (0, _classCallCheck2["default"])(this, SubscriptionRecurringCreateRequest);
@@ -136,50 +136,50 @@ var SubscriptionRecurringCreateRequest = /*#__PURE__*/function () {
   return SubscriptionRecurringCreateRequest;
 }();
 /**
- * ID of the Deal this Recurring Subscription is associated with
+ * The ID of the deal this recurring subscription is associated with
  * @member {Number} deal_id
  */
 
 
 SubscriptionRecurringCreateRequest.prototype['deal_id'] = undefined;
 /**
- * The currency of the Recurring Subscription. Accepts a 3-character currency code.
+ * The currency of the recurring subscription. Accepts a 3-character currency code.
  * @member {String} currency
  */
 
 SubscriptionRecurringCreateRequest.prototype['currency'] = undefined;
 /**
- * Description of the Recurring Subscription
+ * The description of the recurring subscription
  * @member {String} description
  */
 
 SubscriptionRecurringCreateRequest.prototype['description'] = undefined;
 /**
- * Interval between payments
+ * The interval between payments
  * @member {module:model/SubscriptionRecurringCreateRequest.CadenceTypeEnum} cadence_type
  */
 
 SubscriptionRecurringCreateRequest.prototype['cadence_type'] = undefined;
 /**
- * Shows how many payments the Subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required.
+ * Shows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required.
  * @member {Number} cycles_count
  */
 
 SubscriptionRecurringCreateRequest.prototype['cycles_count'] = undefined;
 /**
- * Amount of each payment
+ * The amount of each payment
  * @member {Number} cycle_amount
  */
 
 SubscriptionRecurringCreateRequest.prototype['cycle_amount'] = undefined;
 /**
- * Start date of the Recurring Subscription. Format: YYYY-MM-DD
+ * The start date of the recurring subscription. Format: YYYY-MM-DD
  * @member {Date} start_date
  */
 
 SubscriptionRecurringCreateRequest.prototype['start_date'] = undefined;
 /**
- * This indicates that the Recurring Subscription will last until it's manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`.
+ * This indicates that the recurring subscription will last until it's manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`.
  * @member {Boolean} infinite
  */
 
@@ -191,7 +191,7 @@ SubscriptionRecurringCreateRequest.prototype['infinite'] = undefined;
 
 SubscriptionRecurringCreateRequest.prototype['payments'] = undefined;
 /**
- * Indicates that the Deal value must be set to Recurring Subscription's MRR value
+ * Indicates that the deal value must be set to recurring subscription's MRR value
  * @member {Boolean} update_deal_value
  */
 

package/dist/model/SubscriptionRecurringUpdateRequest.js

@@ -103,14 +103,14 @@ var SubscriptionRecurringUpdateRequest = /*#__PURE__*/function () {
   return SubscriptionRecurringUpdateRequest;
 }();
 /**
- * Description of the Recurring Subscription
+ * The description of the recurring subscription
  * @member {String} description
  */
 
 
 SubscriptionRecurringUpdateRequest.prototype['description'] = undefined;
 /**
- * Amount of each payment
+ * The amount of each payment
  * @member {Number} cycle_amount
  */
 
@@ -122,7 +122,7 @@ SubscriptionRecurringUpdateRequest.prototype['cycle_amount'] = undefined;
 
 SubscriptionRecurringUpdateRequest.prototype['payments'] = undefined;
 /**
- * Indicates that the Deal value must be set to Recurring Subscription's MRR value
+ * Indicates that the deal value must be set to recurring subscription's MRR value
  * @member {Boolean} update_deal_value
  */
 

package/dist/model/TeamId.js

@@ -80,7 +80,7 @@ var TeamId = /*#__PURE__*/function () {
   return TeamId;
 }();
 /**
- * The Team ID
+ * The team ID
  * @member {Number} id
  */
 

package/dist/model/UpdateDealRequest.js

@@ -143,44 +143,44 @@ var UpdateDealRequest = /*#__PURE__*/function () {
   return UpdateDealRequest;
 }();
 /**
- * Deal title
+ * The title of the deal
  * @member {String} title
  */
 
 
 UpdateDealRequest.prototype['title'] = undefined;
 /**
- * Value of the deal. If omitted, value will be set to 0.
+ * The value of the deal. If omitted, value will be set to 0.
  * @member {String} value
  */
 
 UpdateDealRequest.prototype['value'] = undefined;
 /**
- * Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
+ * The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
  * @member {String} currency
  */
 
 UpdateDealRequest.prototype['currency'] = undefined;
 /**
- * The ID of the User which will be the owner of the created Deal. If not provided, the user making the request will be used.
+ * The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used.
  * @member {Number} user_id
  */
 
 UpdateDealRequest.prototype['user_id'] = undefined;
 /**
- * The ID of a Person which this Deal will be linked to. If the Person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified.
+ * The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified.
  * @member {Number} person_id
  */
 
 UpdateDealRequest.prototype['person_id'] = undefined;
 /**
- * The ID of an Organization which this Deal will be linked to. If the Organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified.
+ * The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified.
  * @member {Number} org_id
  */
 
 UpdateDealRequest.prototype['org_id'] = undefined;
 /**
- * The ID of a stage this Deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on `stage_id`). If omitted, the deal will be placed in the first stage of the default pipeline.
+ * The ID of a stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on `stage_id`). If omitted, the deal will be placed in the first stage of the default pipeline.
  * @member {Number} stage_id
  */
 
@@ -192,69 +192,69 @@ UpdateDealRequest.prototype['stage_id'] = undefined;
 
 UpdateDealRequest.prototype['status'] = undefined;
 /**
- * The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.
+ * The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD.
  * @member {Date} expected_close_date
  */
 
 UpdateDealRequest.prototype['expected_close_date'] = undefined;
 /**
- * Deal success probability percentage. Used/shown only when `deal_probability` for the pipeline of the deal is enabled.
+ * The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled.
  * @member {Number} probability
  */
 
 UpdateDealRequest.prototype['probability'] = undefined;
 /**
- * Optional message about why the deal was lost (to be used when status=lost)
+ * The optional message about why the deal was lost (to be used when status = lost)
  * @member {String} lost_reason
  */
 
 UpdateDealRequest.prototype['lost_reason'] = undefined;
 /**
- * Visibility of the deal. 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><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
+ * The visibility of the deal. If omitted, the 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><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
  * @member {module:model/VisibleTo} visible_to
  */
 
 UpdateDealRequest.prototype['visible_to'] = undefined; // Implement DealTitleParameter interface:
 
 /**
- * Deal title
+ * The title of the deal
  * @member {String} title
  */
 
 _DealTitleParameter["default"].prototype['title'] = undefined; // Implement BasicDeal interface:
 
 /**
- * Value of the deal. If omitted, value will be set to 0.
+ * The value of the deal. If omitted, value will be set to 0.
  * @member {String} value
  */
 
 _BasicDeal["default"].prototype['value'] = undefined;
 /**
- * Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
+ * The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
  * @member {String} currency
  */
 
 _BasicDeal["default"].prototype['currency'] = undefined;
 /**
- * The ID of the User which will be the owner of the created Deal. If not provided, the user making the request will be used.
+ * The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used.
  * @member {Number} user_id
  */
 
 _BasicDeal["default"].prototype['user_id'] = undefined;
 /**
- * The ID of a Person which this Deal will be linked to. If the Person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified.
+ * The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `org_id` is specified.
  * @member {Number} person_id
  */
 
 _BasicDeal["default"].prototype['person_id'] = undefined;
 /**
- * The ID of an Organization which this Deal will be linked to. If the Organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified.
+ * The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified.
  * @member {Number} org_id
  */
 
 _BasicDeal["default"].prototype['org_id'] = undefined;
 /**
- * The ID of a stage this Deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on `stage_id`). If omitted, the deal will be placed in the first stage of the default pipeline.
+ * The ID of a stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on `stage_id`). If omitted, the deal will be placed in the first stage of the default pipeline.
  * @member {Number} stage_id
  */
 
@@ -266,25 +266,25 @@ _BasicDeal["default"].prototype['stage_id'] = undefined;
 
 _BasicDeal["default"].prototype['status'] = undefined;
 /**
- * The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.
+ * The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD.
  * @member {Date} expected_close_date
  */
 
 _BasicDeal["default"].prototype['expected_close_date'] = undefined;
 /**
- * Deal success probability percentage. Used/shown only when `deal_probability` for the pipeline of the deal is enabled.
+ * The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled.
  * @member {Number} probability
  */
 
 _BasicDeal["default"].prototype['probability'] = undefined;
 /**
- * Optional message about why the deal was lost (to be used when status=lost)
+ * The optional message about why the deal was lost (to be used when status = lost)
  * @member {String} lost_reason
  */
 
 _BasicDeal["default"].prototype['lost_reason'] = undefined;
 /**
- * Visibility of the deal. 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><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
+ * The visibility of the deal. If omitted, the 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><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
  * @member {module:model/VisibleTo} visible_to
  */
 

package/dist/model/UpdateLeadLabelRequest.js

@@ -87,7 +87,7 @@ var UpdateLeadLabelRequest = /*#__PURE__*/function () {
   return UpdateLeadLabelRequest;
 }();
 /**
- * The name of the Lead Label
+ * The name of the lead label
  * @member {String} name
  */
 

package/dist/model/UpdateLeadRequest.js

@@ -129,38 +129,38 @@ var UpdateLeadRequest = /*#__PURE__*/function () {
   return UpdateLeadRequest;
 }();
 /**
- * The name of the Lead
+ * The name of the lead
  * @member {String} title
  */
 
 
 UpdateLeadRequest.prototype['title'] = undefined;
 /**
- * The ID of the User which will be the owner of the created Lead. If not provided, the user making the request will be used.
+ * The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
  * @member {Number} owner_id
  */
 
 UpdateLeadRequest.prototype['owner_id'] = undefined;
 /**
- * The IDs of the Lead Labels which will be associated with the Lead
+ * The IDs of the lead labels which will be associated with the lead
  * @member {Array.<String>} label_ids
  */
 
 UpdateLeadRequest.prototype['label_ids'] = undefined;
 /**
- * The ID of a Person which this Lead will be linked to. If the Person does not exist yet, it needs to be created first. A Lead always has to be linked to a Person or Organization or both. 
+ * The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both. 
  * @member {Number} person_id
  */
 
 UpdateLeadRequest.prototype['person_id'] = undefined;
 /**
- * The ID of an Organization which this Lead will be linked to. If the Organization does not exist yet, it needs to be created first. A Lead always has to be linked to a Person or Organization or both.
+ * The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both.
  * @member {Number} organization_id
  */
 
 UpdateLeadRequest.prototype['organization_id'] = undefined;
 /**
- * A flag indicating whether the Lead is archived or not
+ * A flag indicating whether the lead is archived or not
  * @member {Boolean} is_archived
  */
 
@@ -171,19 +171,19 @@ UpdateLeadRequest.prototype['is_archived'] = undefined;
 
 UpdateLeadRequest.prototype['value'] = undefined;
 /**
- * The date of when the Deal which will be created from the Lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
+ * The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
  * @member {Date} expected_close_date
  */
 
 UpdateLeadRequest.prototype['expected_close_date'] = undefined;
 /**
- * Visibility of the lead. 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><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
+ * The visibility of the lead. If omitted, the 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><tr><td>`3`</td><td>Entire company (shared)</td></tr></table>
  * @member {module:model/VisibleTo} visible_to
  */
 
 UpdateLeadRequest.prototype['visible_to'] = undefined;
 /**
- * A flag indicating whether the Lead was seen by someone in the Pipedrive UI
+ * A flag indicating whether the lead was seen by someone in the Pipedrive UI
  * @member {module:model/UpdateLeadRequest.WasSeenEnum} was_seen
  */
 

package/dist/model/UpdateStageRequest.js

@@ -120,32 +120,32 @@ var UpdateStageRequest = /*#__PURE__*/function () {
   return UpdateStageRequest;
 }();
 /**
- * Name of the Stage
+ * The name of the stage
  * @member {String} name
  */
 
 
 UpdateStageRequest.prototype['name'] = undefined;
 /**
- * The ID of the Pipeline to add Stage to.
+ * The ID of the pipeline to add stage to
  * @member {Number} pipeline_id
  */
 
 UpdateStageRequest.prototype['pipeline_id'] = undefined;
 /**
- * Deal success probability percentage. Used/shown when Deal weighted values are used
+ * The success probability percentage of the deal. Used/shown when deal weighted values are used.
  * @member {Number} deal_probability
  */
 
 UpdateStageRequest.prototype['deal_probability'] = undefined;
 /**
- * Whether Deals in this stage can become rotten
+ * Whether deals in this stage can become rotten
  * @member {module:model/UpdateStageRequest.RottenFlagEnum} rotten_flag
  */
 
 UpdateStageRequest.prototype['rotten_flag'] = undefined;
 /**
- * The number of days the Deals not updated in this Stage would become rotten. Applies only if the `rotten_flag` is set.
+ * The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set.
  * @member {Number} rotten_days
  */
 
@@ -158,31 +158,31 @@ UpdateStageRequest.prototype['rotten_days'] = undefined;
 UpdateStageRequest.prototype['order_nr'] = undefined; // Implement Stage interface:
 
 /**
- * Name of the Stage
+ * The name of the stage
  * @member {String} name
  */
 
 _Stage["default"].prototype['name'] = undefined;
 /**
- * The ID of the Pipeline to add Stage to.
+ * The ID of the pipeline to add stage to
  * @member {Number} pipeline_id
  */
 
 _Stage["default"].prototype['pipeline_id'] = undefined;
 /**
- * Deal success probability percentage. Used/shown when Deal weighted values are used
+ * The success probability percentage of the deal. Used/shown when deal weighted values are used.
  * @member {Number} deal_probability
  */
 
 _Stage["default"].prototype['deal_probability'] = undefined;
 /**
- * Whether Deals in this stage can become rotten
+ * Whether deals in this stage can become rotten
  * @member {module:model/Stage.RottenFlagEnum} rotten_flag
  */
 
 _Stage["default"].prototype['rotten_flag'] = undefined;
 /**
- * The number of days the Deals not updated in this Stage would become rotten. Applies only if the `rotten_flag` is set.
+ * The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set.
  * @member {Number} rotten_days
  */
 

package/dist/model/UpdateTeam.js

@@ -43,8 +43,8 @@ var UpdateTeam = /*#__PURE__*/function () {
    * @alias module:model/UpdateTeam
    * @implements module:model/CreateTeam
    * @implements module:model/UpdateTeamAllOf
-   * @param name {String} The Team name
-   * @param managerId {Number} The Team manager ID
+   * @param name {String} The team name
+   * @param managerId {Number} The team manager ID
    */
   function UpdateTeam(name, managerId) {
     (0, _classCallCheck2["default"])(this, UpdateTeam);
@@ -127,76 +127,76 @@ var UpdateTeam = /*#__PURE__*/function () {
   return UpdateTeam;
 }();
 /**
- * The Team name
+ * The team name
  * @member {String} name
  */
 
 
 UpdateTeam.prototype['name'] = undefined;
 /**
- * The Team description
+ * The team description
  * @member {String} description
  */
 
 UpdateTeam.prototype['description'] = undefined;
 /**
- * The Team manager ID
+ * The team manager ID
  * @member {Number} manager_id
  */
 
 UpdateTeam.prototype['manager_id'] = undefined;
 /**
- * List of User IDs
+ * The list of user IDs
  * @member {Array.<Number>} users
  */
 
 UpdateTeam.prototype['users'] = undefined;
 /**
- * Flag that indicates if the Team is activated
+ * Flag that indicates whether the team is active
  * @member {module:model/NumberBoolean} active_flag
  */
 
 UpdateTeam.prototype['active_flag'] = undefined;
 /**
- * Flag that indicates if the Team is deleted
+ * Flag that indicates whether the team is deleted
  * @member {module:model/NumberBoolean} deleted_flag
  */
 
 UpdateTeam.prototype['deleted_flag'] = undefined; // Implement CreateTeam interface:
 
 /**
- * The Team name
+ * The team name
  * @member {String} name
  */
 
 _CreateTeam["default"].prototype['name'] = undefined;
 /**
- * The Team description
+ * The team description
  * @member {String} description
  */
 
 _CreateTeam["default"].prototype['description'] = undefined;
 /**
- * The Team manager ID
+ * The team manager ID
  * @member {Number} manager_id
  */
 
 _CreateTeam["default"].prototype['manager_id'] = undefined;
 /**
- * List of User IDs
+ * The list of user IDs
  * @member {Array.<Number>} users
  */
 
 _CreateTeam["default"].prototype['users'] = undefined; // Implement UpdateTeamAllOf interface:
 
 /**
- * Flag that indicates if the Team is activated
+ * Flag that indicates whether the team is active
  * @member {module:model/NumberBoolean} active_flag
  */
 
 _UpdateTeamAllOf["default"].prototype['active_flag'] = undefined;
 /**
- * Flag that indicates if the Team is deleted
+ * Flag that indicates whether the team is deleted
  * @member {module:model/NumberBoolean} deleted_flag
  */
 

package/dist/model/UpdateTeamAllOf.js

@@ -87,14 +87,14 @@ var UpdateTeamAllOf = /*#__PURE__*/function () {
   return UpdateTeamAllOf;
 }();
 /**
- * Flag that indicates if the Team is activated
+ * Flag that indicates whether the team is active
  * @member {module:model/NumberBoolean} active_flag
  */
 
 
 UpdateTeamAllOf.prototype['active_flag'] = undefined;
 /**
- * Flag that indicates if the Team is deleted
+ * Flag that indicates whether the team is deleted
  * @member {module:model/NumberBoolean} deleted_flag
  */