pipedrive 17.0.0 → 17.1.2
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +14 -0
- package/README.md +0 -9
- package/dist/api/GoalsApi.js +8 -23
- package/dist/index.js +0 -64
- package/dist/model/AddProductRequestBody.js +2 -2
- package/dist/model/ProductRequest.js +1 -1
- package/dist/model/RecentDataProduct.js +1 -1
- package/dist/model/UpdateProductRequestBody.js +2 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
@@ -8,6 +8,20 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
|
|
8
8
|
|
9
9
|
## [Unreleased]
|
10
10
|
|
11
|
+
## 17.1.2
|
12
|
+
### Changed
|
13
|
+
- Changed `PUT /goals/{id}` content type to `application/json`
|
14
|
+
|
15
|
+
## 17.1.1
|
16
|
+
### Changed
|
17
|
+
- Description for product requests
|
18
|
+
|
19
|
+
## 17.1.0
|
20
|
+
### Removed
|
21
|
+
- Removed deprecated endpoints that were deleted:
|
22
|
+
- `GET /globalMessages`
|
23
|
+
- `DELETE /globalMessages/{id}`
|
24
|
+
|
11
25
|
## 17.0.0
|
12
26
|
### Changed
|
13
27
|
- Updated `PUT /organizations/{id}`: parameter `name` is not required
|
package/README.md
CHANGED
@@ -335,8 +335,6 @@ Class | Method | HTTP request | Description
|
|
335
335
|
*Pipedrive.FiltersApi* | [**getFilterHelpers**](docs/FiltersApi.md#getFilterHelpers) | **GET** /filters/helpers | Get all filter helpers
|
336
336
|
*Pipedrive.FiltersApi* | [**getFilters**](docs/FiltersApi.md#getFilters) | **GET** /filters | Get all filters
|
337
337
|
*Pipedrive.FiltersApi* | [**updateFilter**](docs/FiltersApi.md#updateFilter) | **PUT** /filters/{id} | Update filter
|
338
|
-
*Pipedrive.GlobalMessagesApi* | [**deleteGlobalMessage**](docs/GlobalMessagesApi.md#deleteGlobalMessage) | **DELETE** /globalMessages/{id} | Dismiss a global message
|
339
|
-
*Pipedrive.GlobalMessagesApi* | [**getGlobalMessages**](docs/GlobalMessagesApi.md#getGlobalMessages) | **GET** /globalMessages | Get global messages
|
340
338
|
*Pipedrive.GoalsApi* | [**addGoal**](docs/GoalsApi.md#addGoal) | **POST** /goals | Add a new goal
|
341
339
|
*Pipedrive.GoalsApi* | [**deleteGoal**](docs/GoalsApi.md#deleteGoal) | **DELETE** /goals/{id} | Delete existing goal
|
342
340
|
*Pipedrive.GoalsApi* | [**getGoalResult**](docs/GoalsApi.md#getGoalResult) | **GET** /goals/{id}/results | Get result of a goal
|
@@ -855,13 +853,6 @@ Class | Method | HTTP request | Description
|
|
855
853
|
- [Pipedrive.GetRolesAllOf](docs/GetRolesAllOf.md)
|
856
854
|
- [Pipedrive.GetStageDeals](docs/GetStageDeals.md)
|
857
855
|
- [Pipedrive.GetStages](docs/GetStages.md)
|
858
|
-
- [Pipedrive.GlobalMessageBaseResponse](docs/GlobalMessageBaseResponse.md)
|
859
|
-
- [Pipedrive.GlobalMessageData](docs/GlobalMessageData.md)
|
860
|
-
- [Pipedrive.GlobalMessageDelete](docs/GlobalMessageDelete.md)
|
861
|
-
- [Pipedrive.GlobalMessageDeleteAllOf](docs/GlobalMessageDeleteAllOf.md)
|
862
|
-
- [Pipedrive.GlobalMessageGet](docs/GlobalMessageGet.md)
|
863
|
-
- [Pipedrive.GlobalMessageGetAllOf](docs/GlobalMessageGetAllOf.md)
|
864
|
-
- [Pipedrive.GlobalMessageUserData](docs/GlobalMessageUserData.md)
|
865
856
|
- [Pipedrive.GoalResults](docs/GoalResults.md)
|
866
857
|
- [Pipedrive.GoalType](docs/GoalType.md)
|
867
858
|
- [Pipedrive.GoalsResponseComponent](docs/GoalsResponseComponent.md)
|
package/dist/api/GoalsApi.js
CHANGED
@@ -17,6 +17,8 @@ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
17
17
|
|
18
18
|
var _AddOrUpdateGoalResponse = _interopRequireDefault(require("../model/AddOrUpdateGoalResponse200"));
|
19
19
|
|
20
|
+
var _BasicGoal = _interopRequireDefault(require("../model/BasicGoal"));
|
21
|
+
|
20
22
|
var _DeleteGoalResponse = _interopRequireDefault(require("../model/DeleteGoalResponse200"));
|
21
23
|
|
22
24
|
var _GetGoalResultResponse = _interopRequireDefault(require("../model/GetGoalResultResponse200"));
|
@@ -325,12 +327,7 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
325
327
|
* Updates an existing goal.
|
326
328
|
* @param {String} id The ID of the goal to be updated
|
327
329
|
* @param {Object} opts Optional parameters
|
328
|
-
* @param {
|
329
|
-
* @param {Object.<String, Object>} opts.assignee Who this goal is assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
|
330
|
-
* @param {Object.<String, Object>} opts.type 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`.
|
331
|
-
* @param {Object.<String, Object>} opts.expectedOutcome The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
|
332
|
-
* @param {Object.<String, Object>} opts.duration The date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
|
333
|
-
* @param {module:model/String} opts.interval The interval of the goal
|
330
|
+
* @param {module:model/BasicGoal} opts.basicGoal
|
334
331
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateGoalResponse200} and HTTP response
|
335
332
|
*/
|
336
333
|
|
@@ -338,7 +335,7 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
338
335
|
key: "updateGoalWithHttpInfo",
|
339
336
|
value: function updateGoalWithHttpInfo(id, opts) {
|
340
337
|
opts = opts || {};
|
341
|
-
var postBody =
|
338
|
+
var postBody = opts['basicGoal']; // verify the required parameter 'id' is set
|
342
339
|
|
343
340
|
if (id === undefined || id === null) {
|
344
341
|
throw new Error("Missing the required parameter 'id' when calling updateGoal");
|
@@ -349,16 +346,9 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
349
346
|
};
|
350
347
|
var queryParams = {};
|
351
348
|
var headerParams = {};
|
352
|
-
var formParams = {
|
353
|
-
|
354
|
-
|
355
|
-
'type': opts['type'],
|
356
|
-
'expected_outcome': opts['expectedOutcome'],
|
357
|
-
'duration': opts['duration'],
|
358
|
-
'interval': opts['interval']
|
359
|
-
};
|
360
|
-
var formParamArray = ['title', 'assignee', 'type', 'expectedOutcome', 'duration', 'interval'];
|
361
|
-
var contentTypes = ['application/x-www-form-urlencoded'];
|
349
|
+
var formParams = {};
|
350
|
+
var formParamArray = [];
|
351
|
+
var contentTypes = ['application/json'];
|
362
352
|
var isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
|
363
353
|
var isJSON = contentTypes.includes('application/json');
|
364
354
|
|
@@ -382,12 +372,7 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
382
372
|
* Updates an existing goal.
|
383
373
|
* @param {String} id The ID of the goal to be updated
|
384
374
|
* @param {Object} opts Optional parameters
|
385
|
-
* @param {
|
386
|
-
* @param {Object.<String, Object>} opts.assignee Who this goal is assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
|
387
|
-
* @param {Object.<String, Object>} opts.type 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`.
|
388
|
-
* @param {Object.<String, Object>} opts.expectedOutcome The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
|
389
|
-
* @param {Object.<String, Object>} opts.duration The date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
|
390
|
-
* @param {module:model/String} opts.interval The interval of the goal
|
375
|
+
* @param {module:model/BasicGoal} opts.basicGoal
|
391
376
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateGoalResponse200}
|
392
377
|
*/
|
393
378
|
|
package/dist/index.js
CHANGED
@@ -2129,54 +2129,6 @@ Object.defineProperty(exports, "GetStages", {
|
|
2129
2129
|
return _GetStages["default"];
|
2130
2130
|
}
|
2131
2131
|
});
|
2132
|
-
Object.defineProperty(exports, "GlobalMessageBaseResponse", {
|
2133
|
-
enumerable: true,
|
2134
|
-
get: function get() {
|
2135
|
-
return _GlobalMessageBaseResponse["default"];
|
2136
|
-
}
|
2137
|
-
});
|
2138
|
-
Object.defineProperty(exports, "GlobalMessageData", {
|
2139
|
-
enumerable: true,
|
2140
|
-
get: function get() {
|
2141
|
-
return _GlobalMessageData["default"];
|
2142
|
-
}
|
2143
|
-
});
|
2144
|
-
Object.defineProperty(exports, "GlobalMessageDelete", {
|
2145
|
-
enumerable: true,
|
2146
|
-
get: function get() {
|
2147
|
-
return _GlobalMessageDelete["default"];
|
2148
|
-
}
|
2149
|
-
});
|
2150
|
-
Object.defineProperty(exports, "GlobalMessageDeleteAllOf", {
|
2151
|
-
enumerable: true,
|
2152
|
-
get: function get() {
|
2153
|
-
return _GlobalMessageDeleteAllOf["default"];
|
2154
|
-
}
|
2155
|
-
});
|
2156
|
-
Object.defineProperty(exports, "GlobalMessageGet", {
|
2157
|
-
enumerable: true,
|
2158
|
-
get: function get() {
|
2159
|
-
return _GlobalMessageGet["default"];
|
2160
|
-
}
|
2161
|
-
});
|
2162
|
-
Object.defineProperty(exports, "GlobalMessageGetAllOf", {
|
2163
|
-
enumerable: true,
|
2164
|
-
get: function get() {
|
2165
|
-
return _GlobalMessageGetAllOf["default"];
|
2166
|
-
}
|
2167
|
-
});
|
2168
|
-
Object.defineProperty(exports, "GlobalMessageUserData", {
|
2169
|
-
enumerable: true,
|
2170
|
-
get: function get() {
|
2171
|
-
return _GlobalMessageUserData["default"];
|
2172
|
-
}
|
2173
|
-
});
|
2174
|
-
Object.defineProperty(exports, "GlobalMessagesApi", {
|
2175
|
-
enumerable: true,
|
2176
|
-
get: function get() {
|
2177
|
-
return _GlobalMessagesApi["default"];
|
2178
|
-
}
|
2179
|
-
});
|
2180
2132
|
Object.defineProperty(exports, "GoalResults", {
|
2181
2133
|
enumerable: true,
|
2182
2134
|
get: function get() {
|
@@ -5216,20 +5168,6 @@ var _GetStageDeals = _interopRequireDefault(require("./model/GetStageDeals"));
|
|
5216
5168
|
|
5217
5169
|
var _GetStages = _interopRequireDefault(require("./model/GetStages"));
|
5218
5170
|
|
5219
|
-
var _GlobalMessageBaseResponse = _interopRequireDefault(require("./model/GlobalMessageBaseResponse"));
|
5220
|
-
|
5221
|
-
var _GlobalMessageData = _interopRequireDefault(require("./model/GlobalMessageData"));
|
5222
|
-
|
5223
|
-
var _GlobalMessageDelete = _interopRequireDefault(require("./model/GlobalMessageDelete"));
|
5224
|
-
|
5225
|
-
var _GlobalMessageDeleteAllOf = _interopRequireDefault(require("./model/GlobalMessageDeleteAllOf"));
|
5226
|
-
|
5227
|
-
var _GlobalMessageGet = _interopRequireDefault(require("./model/GlobalMessageGet"));
|
5228
|
-
|
5229
|
-
var _GlobalMessageGetAllOf = _interopRequireDefault(require("./model/GlobalMessageGetAllOf"));
|
5230
|
-
|
5231
|
-
var _GlobalMessageUserData = _interopRequireDefault(require("./model/GlobalMessageUserData"));
|
5232
|
-
|
5233
5171
|
var _GoalResults = _interopRequireDefault(require("./model/GoalResults"));
|
5234
5172
|
|
5235
5173
|
var _GoalType = _interopRequireDefault(require("./model/GoalType"));
|
@@ -5984,8 +5922,6 @@ var _FilesApi = _interopRequireDefault(require("./api/FilesApi"));
|
|
5984
5922
|
|
5985
5923
|
var _FiltersApi = _interopRequireDefault(require("./api/FiltersApi"));
|
5986
5924
|
|
5987
|
-
var _GlobalMessagesApi = _interopRequireDefault(require("./api/GlobalMessagesApi"));
|
5988
|
-
|
5989
5925
|
var _GoalsApi = _interopRequireDefault(require("./api/GoalsApi"));
|
5990
5926
|
|
5991
5927
|
var _ItemSearchApi = _interopRequireDefault(require("./api/ItemSearchApi"));
|
@@ -190,7 +190,7 @@ AddProductRequestBody.prototype['visible_to'] = undefined;
|
|
190
190
|
|
191
191
|
AddProductRequestBody.prototype['owner_id'] = undefined;
|
192
192
|
/**
|
193
|
-
* An 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,
|
193
|
+
* An 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, a default price of 0 and a default currency based on the company's currency will be assigned.
|
194
194
|
* @member {Array.<Object>} prices
|
195
195
|
*/
|
196
196
|
|
@@ -245,7 +245,7 @@ _ProductRequest["default"].prototype['visible_to'] = undefined;
|
|
245
245
|
|
246
246
|
_ProductRequest["default"].prototype['owner_id'] = undefined;
|
247
247
|
/**
|
248
|
-
* An 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,
|
248
|
+
* An 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, a default price of 0 and a default currency based on the company's currency will be assigned.
|
249
249
|
* @member {Array.<Object>} prices
|
250
250
|
*/
|
251
251
|
|
@@ -161,7 +161,7 @@ ProductRequest.prototype['visible_to'] = undefined;
|
|
161
161
|
|
162
162
|
ProductRequest.prototype['owner_id'] = undefined;
|
163
163
|
/**
|
164
|
-
* An 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,
|
164
|
+
* An 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, a default price of 0 and a default currency based on the company's currency will be assigned.
|
165
165
|
* @member {Array.<Object>} prices
|
166
166
|
*/
|
167
167
|
|
@@ -258,7 +258,7 @@ RecentDataProduct.prototype['add_time'] = undefined;
|
|
258
258
|
|
259
259
|
RecentDataProduct.prototype['update_time'] = undefined;
|
260
260
|
/**
|
261
|
-
* 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,
|
261
|
+
* 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, a default price of 0 and a default currency based on the company's currency will be assigned.
|
262
262
|
* @member {Array.<Object>} prices
|
263
263
|
*/
|
264
264
|
|
@@ -190,7 +190,7 @@ UpdateProductRequestBody.prototype['visible_to'] = undefined;
|
|
190
190
|
|
191
191
|
UpdateProductRequestBody.prototype['owner_id'] = undefined;
|
192
192
|
/**
|
193
|
-
* An 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,
|
193
|
+
* An 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, a default price of 0 and a default currency based on the company's currency will be assigned.
|
194
194
|
* @member {Array.<Object>} prices
|
195
195
|
*/
|
196
196
|
|
@@ -245,7 +245,7 @@ _ProductRequest["default"].prototype['visible_to'] = undefined;
|
|
245
245
|
|
246
246
|
_ProductRequest["default"].prototype['owner_id'] = undefined;
|
247
247
|
/**
|
248
|
-
* An 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,
|
248
|
+
* An 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, a default price of 0 and a default currency based on the company's currency will be assigned.
|
249
249
|
* @member {Array.<Object>} prices
|
250
250
|
*/
|
251
251
|
|