pipedrive 13.0.8 → 13.0.12

package/dist/model/StageConversions.js

@@ -90,20 +90,20 @@ var StageConversions = /*#__PURE__*/function () {
   return StageConversions;
 }();
 /**
- * The Stage ID from where conversion starts
+ * The stage ID from where conversion starts
  * @member {Number} from_stage_id
  */
 
 
 StageConversions.prototype['from_stage_id'] = undefined;
 /**
- * The Stage ID to where conversion ends
+ * The stage ID to where conversion ends
  * @member {Number} to_stage_id
  */
 
 StageConversions.prototype['to_stage_id'] = undefined;
 /**
- * Conversion rate
+ * The conversion rate
  * @member {Number} conversion_rate
  */
 

package/dist/model/StageDetails.js

@@ -40,7 +40,7 @@ var _PipelineDetailsAllOf = _interopRequireDefault(require("./PipelineDetailsAll
 var StageDetails = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>StageDetails</code>.
-   * The Stage object
+   * The stage object
    * @alias module:model/StageDetails
    * @implements module:model/BaseStage
    * @implements module:model/PipelineDetailsAllOf
@@ -148,62 +148,62 @@ var StageDetails = /*#__PURE__*/function () {
   return StageDetails;
 }();
 /**
- * The ID of the Stage
+ * The ID of the stage
  * @member {Number} id
  */
 
 
 StageDetails.prototype['id'] = undefined;
 /**
- * Defines the order of the Stage
+ * Defines the order of the stage
  * @member {Number} order_nr
  */
 
 StageDetails.prototype['order_nr'] = undefined;
 /**
- * The name of the Stage
+ * The name of the stage
  * @member {String} name
  */
 
 StageDetails.prototype['name'] = undefined;
 /**
- * If the Stage is active or deleted
+ * Whether the stage is active or deleted
  * @member {Boolean} active_flag
  */
 
 StageDetails.prototype['active_flag'] = undefined;
 /**
- * The Deal success probability percentage. Used/shown when the Deal weighted values are used.
+ * The success probability percentage of the deal. Used/shown when the deal weighted values are used.
  * @member {Number} deal_probability
  */
 
 StageDetails.prototype['deal_probability'] = undefined;
 /**
- * The ID of the Pipeline to add the Stage to
+ * The ID of the pipeline to add the stage to
  * @member {Number} pipeline_id
  */
 
 StageDetails.prototype['pipeline_id'] = undefined;
 /**
- * Whether Deals in this Stage can become rotten
+ * Whether deals in this stage can become rotten
  * @member {module:model/StageDetails.RottenFlagEnum} rotten_flag
  */
 
 StageDetails.prototype['rotten_flag'] = undefined;
 /**
- * The number of days the Deals are 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
  */
 
 StageDetails.prototype['rotten_days'] = undefined;
 /**
- * The Stage creation time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage creation time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} add_time
  */
 
 StageDetails.prototype['add_time'] = undefined;
 /**
- * The Stage update time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage update time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} update_time
  */
 
@@ -215,61 +215,61 @@ StageDetails.prototype['update_time'] = undefined;
 StageDetails.prototype['deals_summary'] = undefined; // Implement BaseStage interface:
 
 /**
- * The ID of the Stage
+ * The ID of the stage
  * @member {Number} id
  */
 
 _BaseStage["default"].prototype['id'] = undefined;
 /**
- * Defines the order of the Stage
+ * Defines the order of the stage
  * @member {Number} order_nr
  */
 
 _BaseStage["default"].prototype['order_nr'] = undefined;
 /**
- * The name of the Stage
+ * The name of the stage
  * @member {String} name
  */
 
 _BaseStage["default"].prototype['name'] = undefined;
 /**
- * If the Stage is active or deleted
+ * Whether the stage is active or deleted
  * @member {Boolean} active_flag
  */
 
 _BaseStage["default"].prototype['active_flag'] = undefined;
 /**
- * The Deal success probability percentage. Used/shown when the Deal weighted values are used.
+ * The success probability percentage of the deal. Used/shown when the deal weighted values are used.
  * @member {Number} deal_probability
  */
 
 _BaseStage["default"].prototype['deal_probability'] = undefined;
 /**
- * The ID of the Pipeline to add the Stage to
+ * The ID of the pipeline to add the stage to
  * @member {Number} pipeline_id
  */
 
 _BaseStage["default"].prototype['pipeline_id'] = undefined;
 /**
- * Whether Deals in this Stage can become rotten
+ * Whether deals in this stage can become rotten
  * @member {module:model/BaseStage.RottenFlagEnum} rotten_flag
  */
 
 _BaseStage["default"].prototype['rotten_flag'] = undefined;
 /**
- * The number of days the Deals are 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
  */
 
 _BaseStage["default"].prototype['rotten_days'] = undefined;
 /**
- * The Stage creation time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage creation time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} add_time
  */
 
 _BaseStage["default"].prototype['add_time'] = undefined;
 /**
- * The Stage update time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage update time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} update_time
  */
 

package/dist/model/StageWithPipelineInfo.js

@@ -150,148 +150,148 @@ var StageWithPipelineInfo = /*#__PURE__*/function () {
   return StageWithPipelineInfo;
 }();
 /**
- * The ID of the Stage
+ * The ID of the stage
  * @member {Number} id
  */
 
 
 StageWithPipelineInfo.prototype['id'] = undefined;
 /**
- * Defines the order of the Stage
+ * Defines the order of the stage
  * @member {Number} order_nr
  */
 
 StageWithPipelineInfo.prototype['order_nr'] = undefined;
 /**
- * The name of the Stage
+ * The name of the stage
  * @member {String} name
  */
 
 StageWithPipelineInfo.prototype['name'] = undefined;
 /**
- * If the Stage is active or deleted
+ * Whether the stage is active or deleted
  * @member {Boolean} active_flag
  */
 
 StageWithPipelineInfo.prototype['active_flag'] = undefined;
 /**
- * The Deal success probability percentage. Used/shown when the Deal weighted values are used.
+ * The success probability percentage of the deal. Used/shown when the deal weighted values are used.
  * @member {Number} deal_probability
  */
 
 StageWithPipelineInfo.prototype['deal_probability'] = undefined;
 /**
- * The ID of the Pipeline to add the Stage to
+ * The ID of the pipeline to add the stage to
  * @member {Number} pipeline_id
  */
 
 StageWithPipelineInfo.prototype['pipeline_id'] = undefined;
 /**
- * Whether Deals in this Stage can become rotten
+ * Whether deals in this stage can become rotten
  * @member {module:model/StageWithPipelineInfo.RottenFlagEnum} rotten_flag
  */
 
 StageWithPipelineInfo.prototype['rotten_flag'] = undefined;
 /**
- * The number of days the Deals are 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
  */
 
 StageWithPipelineInfo.prototype['rotten_days'] = undefined;
 /**
- * The Stage creation time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage creation time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} add_time
  */
 
 StageWithPipelineInfo.prototype['add_time'] = undefined;
 /**
- * The Stage update time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage update time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} update_time
  */
 
 StageWithPipelineInfo.prototype['update_time'] = undefined;
 /**
- * The name of the Pipeline
+ * The name of the pipeline
  * @member {String} pipeline_name
  */
 
 StageWithPipelineInfo.prototype['pipeline_name'] = undefined;
 /**
- * Pipeline Deal probability. When `true`, overrides the Stage probability.
+ * The pipeline deal probability. When `true`, overrides the stage probability.
  * @member {Boolean} pipeline_deal_probability
  */
 
 StageWithPipelineInfo.prototype['pipeline_deal_probability'] = undefined; // Implement BaseStage interface:
 
 /**
- * The ID of the Stage
+ * The ID of the stage
  * @member {Number} id
  */
 
 _BaseStage["default"].prototype['id'] = undefined;
 /**
- * Defines the order of the Stage
+ * Defines the order of the stage
  * @member {Number} order_nr
  */
 
 _BaseStage["default"].prototype['order_nr'] = undefined;
 /**
- * The name of the Stage
+ * The name of the stage
  * @member {String} name
  */
 
 _BaseStage["default"].prototype['name'] = undefined;
 /**
- * If the Stage is active or deleted
+ * Whether the stage is active or deleted
  * @member {Boolean} active_flag
  */
 
 _BaseStage["default"].prototype['active_flag'] = undefined;
 /**
- * The Deal success probability percentage. Used/shown when the Deal weighted values are used.
+ * The success probability percentage of the deal. Used/shown when the deal weighted values are used.
  * @member {Number} deal_probability
  */
 
 _BaseStage["default"].prototype['deal_probability'] = undefined;
 /**
- * The ID of the Pipeline to add the Stage to
+ * The ID of the pipeline to add the stage to
  * @member {Number} pipeline_id
  */
 
 _BaseStage["default"].prototype['pipeline_id'] = undefined;
 /**
- * Whether Deals in this Stage can become rotten
+ * Whether deals in this stage can become rotten
  * @member {module:model/BaseStage.RottenFlagEnum} rotten_flag
  */
 
 _BaseStage["default"].prototype['rotten_flag'] = undefined;
 /**
- * The number of days the Deals are 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
  */
 
 _BaseStage["default"].prototype['rotten_days'] = undefined;
 /**
- * The Stage creation time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage creation time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} add_time
  */
 
 _BaseStage["default"].prototype['add_time'] = undefined;
 /**
- * The Stage update time. Format: YYYY-MM-DD HH:MM:SS.
+ * The stage update time. Format: YYYY-MM-DD HH:MM:SS.
  * @member {String} update_time
  */
 
 _BaseStage["default"].prototype['update_time'] = undefined; // Implement StageWithPipelineInfoAllOf interface:
 
 /**
- * The name of the Pipeline
+ * The name of the pipeline
  * @member {String} pipeline_name
  */
 
 _StageWithPipelineInfoAllOf["default"].prototype['pipeline_name'] = undefined;
 /**
- * Pipeline Deal probability. When `true`, overrides the Stage probability.
+ * The pipeline deal probability. When `true`, overrides the stage probability.
  * @member {Boolean} pipeline_deal_probability
  */
 

package/dist/model/StageWithPipelineInfoAllOf.js

@@ -85,14 +85,14 @@ var StageWithPipelineInfoAllOf = /*#__PURE__*/function () {
   return StageWithPipelineInfoAllOf;
 }();
 /**
- * The name of the Pipeline
+ * The name of the pipeline
  * @member {String} pipeline_name
  */
 
 
 StageWithPipelineInfoAllOf.prototype['pipeline_name'] = undefined;
 /**
- * Pipeline Deal probability. When `true`, overrides the Stage probability.
+ * The pipeline deal probability. When `true`, overrides the stage probability.
  * @member {Boolean} pipeline_deal_probability
  */
 

package/dist/model/SubRole.js

@@ -121,32 +121,32 @@ var SubRole = /*#__PURE__*/function () {
   return SubRole;
 }();
 /**
- * The ID of the parent Role
+ * The ID of the parent role
  * @member {Number} parent_role_id
  */
 
 
 SubRole.prototype['parent_role_id'] = undefined;
 /**
- * The name of the Role
+ * The name of the role
  * @member {String} name
  */
 
 SubRole.prototype['name'] = undefined;
 /**
- * The ID of the Role
+ * The ID of the role
  * @member {Number} id
  */
 
 SubRole.prototype['id'] = undefined;
 /**
- * If the Role is active or not
+ * Whether the role is active or not
  * @member {Boolean} active_flag
  */
 
 SubRole.prototype['active_flag'] = undefined;
 /**
- * The number of Users assigned to this Role
+ * The number of users assigned to this role
  * @member {String} assignment_count
  */
 
@@ -159,32 +159,32 @@ SubRole.prototype['assignment_count'] = undefined;
 SubRole.prototype['sub_role_count'] = undefined; // Implement BaseRole interface:
 
 /**
- * The ID of the parent Role
+ * The ID of the parent role
  * @member {Number} parent_role_id
  */
 
 _BaseRole["default"].prototype['parent_role_id'] = undefined;
 /**
- * The name of the Role
+ * The name of the role
  * @member {String} name
  */
 
 _BaseRole["default"].prototype['name'] = undefined; // Implement SubRoleAllOf interface:
 
 /**
- * The ID of the Role
+ * The ID of the role
  * @member {Number} id
  */
 
 _SubRoleAllOf["default"].prototype['id'] = undefined;
 /**
- * If the Role is active or not
+ * Whether the role is active or not
  * @member {Boolean} active_flag
  */
 
 _SubRoleAllOf["default"].prototype['active_flag'] = undefined;
 /**
- * The number of Users assigned to this Role
+ * The number of users assigned to this role
  * @member {String} assignment_count
  */
 

package/dist/model/SubRoleAllOf.js

@@ -95,20 +95,20 @@ var SubRoleAllOf = /*#__PURE__*/function () {
   return SubRoleAllOf;
 }();
 /**
- * The ID of the Role
+ * The ID of the role
  * @member {Number} id
  */
 
 
 SubRoleAllOf.prototype['id'] = undefined;
 /**
- * If the Role is active or not
+ * Whether the role is active or not
  * @member {Boolean} active_flag
  */
 
 SubRoleAllOf.prototype['active_flag'] = undefined;
 /**
- * The number of Users assigned to this Role
+ * The number of users assigned to this role
  * @member {String} assignment_count
  */
 

package/dist/model/SubscriptionInstallmentCreateRequest.js

@@ -35,8 +35,8 @@ var SubscriptionInstallmentCreateRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SubscriptionInstallmentCreateRequest</code>.
    * @alias module:model/SubscriptionInstallmentCreateRequest
-   * @param dealId {Number} ID of the Deal this Installment Subscription is associated with
-   * @param currency {String} The currency of the Installment Subscription. Accepts a 3-character currency code.
+   * @param dealId {Number} The ID of the deal this installment subscription is associated with
+   * @param currency {String} The currency of the installment subscription. Accepts a 3-character currency code.
    * @param payments {Array.<Object>} Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
    */
   function SubscriptionInstallmentCreateRequest(dealId, currency, payments) {
@@ -102,14 +102,14 @@ var SubscriptionInstallmentCreateRequest = /*#__PURE__*/function () {
   return SubscriptionInstallmentCreateRequest;
 }();
 /**
- * ID of the Deal this Installment Subscription is associated with
+ * The ID of the deal this installment subscription is associated with
  * @member {Number} deal_id
  */
 
 
 SubscriptionInstallmentCreateRequest.prototype['deal_id'] = undefined;
 /**
- * The currency of the Installment Subscription. Accepts a 3-character currency code.
+ * The currency of the installment subscription. Accepts a 3-character currency code.
  * @member {String} currency
  */
 
@@ -121,7 +121,7 @@ SubscriptionInstallmentCreateRequest.prototype['currency'] = undefined;
 
 SubscriptionInstallmentCreateRequest.prototype['payments'] = undefined;
 /**
- * Indicates that the Deal value must be set to the Installment Subscription's total value
+ * Indicates that the deal value must be set to the installment subscription's total value
  * @member {Boolean} update_deal_value
  */
 

package/dist/model/SubscriptionInstallmentUpdateRequest.js

@@ -95,7 +95,7 @@ var SubscriptionInstallmentUpdateRequest = /*#__PURE__*/function () {
 
 SubscriptionInstallmentUpdateRequest.prototype['payments'] = undefined;
 /**
- * Indicates that the Deal value must be set to Installment Subscription's total value
+ * Indicates that the deal value must be set to installment subscription's total value
  * @member {Boolean} update_deal_value
  */
 

package/dist/model/SubscriptionItem.js

@@ -155,74 +155,74 @@ var SubscriptionItem = /*#__PURE__*/function () {
   return SubscriptionItem;
 }();
 /**
- * The ID of the Subscription
+ * The ID of the subscription
  * @member {Number} id
  */
 
 
 SubscriptionItem.prototype['id'] = undefined;
 /**
- * The ID of the User who created Subscription
+ * The ID of the user who created the subscription
  * @member {Number} user_id
  */
 
 SubscriptionItem.prototype['user_id'] = undefined;
 /**
- * The ID of the Deal this Subscription associated with
+ * The ID of the deal this subscription is associated with
  * @member {Number} deal_id
  */
 
 SubscriptionItem.prototype['deal_id'] = undefined;
 /**
- * Description of the recurring Subscription
+ * The description of the recurring subscription
  * @member {String} description
  */
 
 SubscriptionItem.prototype['description'] = undefined;
 /**
- * The Subscription status
+ * The subscription status
  * @member {Boolean} is_active
  */
 
 SubscriptionItem.prototype['is_active'] = undefined;
 /**
- * Shows how many payments a Recurring Subscription has
+ * Shows how many payments a recurring subscription has
  * @member {Number} cycles_count
  */
 
 SubscriptionItem.prototype['cycles_count'] = undefined;
 /**
- * Amount of each payment
+ * The amount of each payment
  * @member {Number} cycle_amount
  */
 
 SubscriptionItem.prototype['cycle_amount'] = undefined;
 /**
- * Indicates that the Recurring Subscription will last until it's manually canceled or deleted
+ * Indicates that the recurring subscription will last until it is manually canceled or deleted
  * @member {Boolean} infinite
  */
 
 SubscriptionItem.prototype['infinite'] = undefined;
 /**
- * The currency of the Subscription
+ * The currency of the subscription
  * @member {String} currency
  */
 
 SubscriptionItem.prototype['currency'] = undefined;
 /**
- * Interval between payments
+ * The interval between payments
  * @member {String} cadence_type
  */
 
 SubscriptionItem.prototype['cadence_type'] = undefined;
 /**
- * The start date of the Recurring Subscription
+ * The start date of the recurring subscription
  * @member {Date} start_date
  */
 
 SubscriptionItem.prototype['start_date'] = undefined;
 /**
- * The end date of the Subscription
+ * The end date of the subscription
  * @member {Date} end_date
  */
 
@@ -234,19 +234,19 @@ SubscriptionItem.prototype['end_date'] = undefined;
 
 SubscriptionItem.prototype['lifetime_value'] = undefined;
 /**
- * The final status of the Subscription
+ * The final status of the subscription
  * @member {String} final_status
  */
 
 SubscriptionItem.prototype['final_status'] = undefined;
 /**
- * The creation time of the Subscription
+ * The creation time of the subscription
  * @member {String} add_time
  */
 
 SubscriptionItem.prototype['add_time'] = undefined;
 /**
- * The update time of the Subscription
+ * The update time of the subscription
  * @member {String} update_time
  */
 

package/dist/model/SubscriptionRecurringCancelRequest.js

@@ -80,7 +80,7 @@ var SubscriptionRecurringCancelRequest = /*#__PURE__*/function () {
   return SubscriptionRecurringCancelRequest;
 }();
 /**
- * Subscription termination date. All payments after specified date will be deleted. Default value is the current date.
+ * The subscription termination date. All payments after specified date will be deleted. Default value is the current date.
  * @member {Date} end_date
  */