pipedrive 17.4.0 → 17.5.0

package/CHANGELOG.md

@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## 17.5.0
+### Changed
+- Updated `type.params.pipeline_id` and `type.params.activity_type_id` description, type and response example for goals queries
+
 ## 17.4.0
 ### Changed
 - Added `pipeline` and `stage` objects to the `related_objects` section in the following endpoints:

package/dist/api/GoalsApi.js

@@ -104,7 +104,7 @@ var GoalsApi = /*#__PURE__*/function () {
     /**
      * Delete existing goal
      * Marks a goal as deleted.
-     * @param {String} id The ID of the goal to be deleted
+     * @param {String} id The ID of the goal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteGoalResponse200} and HTTP response
      */
 
@@ -147,7 +147,7 @@ var GoalsApi = /*#__PURE__*/function () {
     /**
      * Delete existing goal
      * Marks a goal as deleted.
-     * @param {String} id The ID of the goal to be deleted
+     * @param {String} id The ID of the goal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteGoalResponse200}
      */
 
@@ -162,8 +162,8 @@ var GoalsApi = /*#__PURE__*/function () {
      * Get result of a goal
      * Gets the progress of a goal for the specified period.
      * @param {String} id The ID of the goal that the results are looked for
-     * @param {Date} periodStart The start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
-     * @param {Date} periodEnd The end date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
+     * @param {Date} periodStart The start date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date. 
+     * @param {Date} periodEnd The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date. 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalResultResponse200} and HTTP response
      */
 
@@ -220,8 +220,8 @@ var GoalsApi = /*#__PURE__*/function () {
      * Get result of a goal
      * Gets the progress of a goal for the specified period.
      * @param {String} id The ID of the goal that the results are looked for
-     * @param {Date} periodStart The start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
-     * @param {Date} periodEnd The end date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
+     * @param {Date} periodStart The start date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date. 
+     * @param {Date} periodEnd The end date of the period for which to find the goal's progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date. 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalResultResponse200}
      */
 
@@ -244,9 +244,9 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {Number} opts.expectedOutcomeTarget The numeric value of the outcome. If provided, everyone's goals will be returned.
      * @param {module:model/String} opts.expectedOutcomeTrackingMetric The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
      * @param {Number} opts.expectedOutcomeCurrencyId The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsPipelineId The ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
+     * @param {Array.<Number>} opts.typeParamsPipelineId An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned.
      * @param {Number} opts.typeParamsStageId The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsActivityTypeId The ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
+     * @param {Array.<Number>} opts.typeParamsActivityTypeId An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone's goals will be returned.
      * @param {Date} opts.periodStart The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
      * @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalsResponse200} and HTTP response
@@ -267,9 +267,9 @@ var GoalsApi = /*#__PURE__*/function () {
         'expected_outcome.target': opts['expectedOutcomeTarget'],
         'expected_outcome.tracking_metric': opts['expectedOutcomeTrackingMetric'],
         'expected_outcome.currency_id': opts['expectedOutcomeCurrencyId'],
-        'type.params.pipeline_id': opts['typeParamsPipelineId'],
+        'type.params.pipeline_id': this.apiClient.buildCollectionParam(opts['typeParamsPipelineId'], 'csv'),
         'type.params.stage_id': opts['typeParamsStageId'],
-        'type.params.activity_type_id': opts['typeParamsActivityTypeId'],
+        'type.params.activity_type_id': this.apiClient.buildCollectionParam(opts['typeParamsActivityTypeId'], 'csv'),
         'period.start': opts['periodStart'],
         'period.end': opts['periodEnd']
       };
@@ -307,9 +307,9 @@ var GoalsApi = /*#__PURE__*/function () {
      * @param {Number} opts.expectedOutcomeTarget The numeric value of the outcome. If provided, everyone's goals will be returned.
      * @param {module:model/String} opts.expectedOutcomeTrackingMetric The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
      * @param {Number} opts.expectedOutcomeCurrencyId The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsPipelineId The ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
+     * @param {Array.<Number>} opts.typeParamsPipelineId An array of pipeline IDs or `null` for all pipelines. If provided, everyone's goals will be returned.
      * @param {Number} opts.typeParamsStageId The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsActivityTypeId The ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
+     * @param {Array.<Number>} opts.typeParamsActivityTypeId An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone's goals will be returned.
      * @param {Date} opts.periodStart The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
      * @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalsResponse200}
@@ -325,7 +325,7 @@ var GoalsApi = /*#__PURE__*/function () {
     /**
      * Update existing goal
      * Updates an existing goal.
-     * @param {String} id The ID of the goal to be updated
+     * @param {String} id The ID of the goal
      * @param {Object} opts Optional parameters
      * @param {module:model/BasicGoal} opts.basicGoal 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateGoalResponse200} and HTTP response
@@ -370,7 +370,7 @@ var GoalsApi = /*#__PURE__*/function () {
     /**
      * Update existing goal
      * Updates an existing goal.
-     * @param {String} id The ID of the goal to be updated
+     * @param {String} id The ID of the goal
      * @param {Object} opts Optional parameters
      * @param {module:model/BasicGoal} opts.basicGoal 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateGoalResponse200}

package/dist/model/BasicGoal.js

@@ -118,7 +118,7 @@ BasicGoal.prototype['title'] = undefined;
 
 BasicGoal.prototype['assignee'] = undefined;
 /**
- * The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
+ * The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.”
  * @member {Object} type
  */
 

package/dist/model/NewGoal.js

@@ -126,7 +126,7 @@ NewGoal.prototype['title'] = undefined;
 
 NewGoal.prototype['assignee'] = undefined;
 /**
- * The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
+ * The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.”
  * @member {Object} type
  */
 
@@ -163,7 +163,7 @@ _BasicGoal["default"].prototype['title'] = undefined;
 
 _BasicGoal["default"].prototype['assignee'] = undefined;
 /**
- * The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
+ * The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. The `pipeline_id` and `activity_type_id` need to be given as an array of integers. To track the goal in all pipelines, set `pipeline_id` as `null` and similarly, to track the goal for all activities, set `activity_type_id` as `null`.”
  * @member {Object} type
  */
 

package/dist/model/Params.js

@@ -66,10 +66,15 @@ var Params = /*#__PURE__*/function () {
         obj = obj || new Params();
 
         if (data.hasOwnProperty('pipeline_id')) {
-          obj['pipeline_id'] = _ApiClient["default"].convertToType(data['pipeline_id'], 'String');
+          obj['pipeline_id'] = _ApiClient["default"].convertToType(data['pipeline_id'], ['Number']);
           delete data['pipeline_id'];
         }
 
+        if (data.hasOwnProperty('activity_type_id')) {
+          obj['activity_type_id'] = _ApiClient["default"].convertToType(data['activity_type_id'], ['Number']);
+          delete data['activity_type_id'];
+        }
+
         if (Object.keys(data).length > 0) {
           Object.assign(obj, data);
         }
@@ -81,11 +86,17 @@ var Params = /*#__PURE__*/function () {
   return Params;
 }();
 /**
- * The pipeline ID of the goal
- * @member {String} pipeline_id
+ * The IDs of pipelines of the goal
+ * @member {Array.<Number>} pipeline_id
  */
 
 
 Params.prototype['pipeline_id'] = undefined;
+/**
+ * The IDs of activity types of the goal
+ * @member {Array.<Number>} activity_type_id
+ */
+
+Params.prototype['activity_type_id'] = undefined;
 var _default = Params;
 exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipedrive",
-  "version": "17.4.0",
+  "version": "17.5.0",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "main": "dist/index.js",