pipedrive 18.1.1 → 18.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -278,7 +278,7 @@ var CallLogsApi = /*#__PURE__*/function () {
278
278
  * Returns all call logs assigned to a particular user.
279
279
  * @param {Object} opts Optional parameters
280
280
  * @param {Number} opts.start Pagination start (default to 0)
281
- * @param {Number} opts.limit Items shown per page
281
+ * @param {Number} opts.limit For pagination, the limit of entries to be returned. The upper limit is 50.
282
282
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BaseResponse} and HTTP response
283
283
  */
284
284
  }, {
@@ -317,7 +317,7 @@ var CallLogsApi = /*#__PURE__*/function () {
317
317
  * Returns all call logs assigned to a particular user.
318
318
  * @param {Object} opts Optional parameters
319
319
  * @param {Number} opts.start Pagination start (default to 0)
320
- * @param {Number} opts.limit Items shown per page
320
+ * @param {Number} opts.limit For pagination, the limit of entries to be returned. The upper limit is 50.
321
321
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BaseResponse}
322
322
  */
323
323
  }, {
@@ -67,7 +67,7 @@ var PermissionSetsApi = /*#__PURE__*/function () {
67
67
  }
68
68
  }
69
69
  }
70
- var authNames = ['api_key'];
70
+ var authNames = ['api_key', 'oauth2'];
71
71
  var accepts = ['application/json'];
72
72
  var returnType = _SinglePermissionSetsItem["default"];
73
73
  return this.apiClient.callApi('/permissionSets/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -128,7 +128,7 @@ var PermissionSetsApi = /*#__PURE__*/function () {
128
128
  }
129
129
  }
130
130
  }
131
- var authNames = ['api_key'];
131
+ var authNames = ['api_key', 'oauth2'];
132
132
  var accepts = ['application/json'];
133
133
  var returnType = _UserAssignmentsToPermissionSet["default"];
134
134
  return this.apiClient.callApi('/permissionSets/{id}/assignments', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -182,7 +182,7 @@ var PermissionSetsApi = /*#__PURE__*/function () {
182
182
  }
183
183
  }
184
184
  }
185
- var authNames = ['api_key'];
185
+ var authNames = ['api_key', 'oauth2'];
186
186
  var accepts = ['application/json'];
187
187
  var returnType = _PermissionSets["default"];
188
188
  return this.apiClient.callApi('/permissionSets', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -87,7 +87,7 @@ var RolesApi = /*#__PURE__*/function () {
87
87
  }
88
88
  }
89
89
  }
90
- var authNames = ['api_key'];
90
+ var authNames = ['api_key', 'oauth2'];
91
91
  var accepts = ['application/json'];
92
92
  var returnType = _PostRoleSettings["default"];
93
93
  return this.apiClient.callApi('/roles/{id}/settings', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -141,7 +141,7 @@ var RolesApi = /*#__PURE__*/function () {
141
141
  }
142
142
  }
143
143
  }
144
- var authNames = ['api_key'];
144
+ var authNames = ['api_key', 'oauth2'];
145
145
  var accepts = ['application/json'];
146
146
  var returnType = _PostRoles["default"];
147
147
  return this.apiClient.callApi('/roles', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -202,7 +202,7 @@ var RolesApi = /*#__PURE__*/function () {
202
202
  }
203
203
  }
204
204
  }
205
- var authNames = ['api_key'];
205
+ var authNames = ['api_key', 'oauth2'];
206
206
  var accepts = ['application/json'];
207
207
  var returnType = _PostRoleAssignment["default"];
208
208
  return this.apiClient.callApi('/roles/{id}/assignments', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -259,7 +259,7 @@ var RolesApi = /*#__PURE__*/function () {
259
259
  }
260
260
  }
261
261
  }
262
- var authNames = ['api_key'];
262
+ var authNames = ['api_key', 'oauth2'];
263
263
  var accepts = ['application/json'];
264
264
  var returnType = _DeleteRole["default"];
265
265
  return this.apiClient.callApi('/roles/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -319,7 +319,7 @@ var RolesApi = /*#__PURE__*/function () {
319
319
  }
320
320
  }
321
321
  }
322
- var authNames = ['api_key'];
322
+ var authNames = ['api_key', 'oauth2'];
323
323
  var accepts = ['application/json'];
324
324
  var returnType = _DeleteRoleAssignment["default"];
325
325
  return this.apiClient.callApi('/roles/{id}/assignments', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -376,7 +376,7 @@ var RolesApi = /*#__PURE__*/function () {
376
376
  }
377
377
  }
378
378
  }
379
- var authNames = ['api_key'];
379
+ var authNames = ['api_key', 'oauth2'];
380
380
  var accepts = ['application/json'];
381
381
  var returnType = _GetRole["default"];
382
382
  return this.apiClient.callApi('/roles/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -437,7 +437,7 @@ var RolesApi = /*#__PURE__*/function () {
437
437
  }
438
438
  }
439
439
  }
440
- var authNames = ['api_key'];
440
+ var authNames = ['api_key', 'oauth2'];
441
441
  var accepts = ['application/json'];
442
442
  var returnType = _GetRoleAssignments["default"];
443
443
  return this.apiClient.callApi('/roles/{id}/assignments', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -495,7 +495,7 @@ var RolesApi = /*#__PURE__*/function () {
495
495
  }
496
496
  }
497
497
  }
498
- var authNames = ['api_key'];
498
+ var authNames = ['api_key', 'oauth2'];
499
499
  var accepts = ['application/json'];
500
500
  var returnType = _GetRoleSettings["default"];
501
501
  return this.apiClient.callApi('/roles/{id}/settings', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -548,7 +548,7 @@ var RolesApi = /*#__PURE__*/function () {
548
548
  }
549
549
  }
550
550
  }
551
- var authNames = ['api_key'];
551
+ var authNames = ['api_key', 'oauth2'];
552
552
  var accepts = ['application/json'];
553
553
  var returnType = _GetRoles["default"];
554
554
  return this.apiClient.callApi('/roles', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -607,7 +607,7 @@ var RolesApi = /*#__PURE__*/function () {
607
607
  }
608
608
  }
609
609
  }
610
- var authNames = ['api_key'];
610
+ var authNames = ['api_key', 'oauth2'];
611
611
  var accepts = ['application/json'];
612
612
  var returnType = _PutRole["default"];
613
613
  return this.apiClient.callApi('/roles/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
@@ -133,7 +133,7 @@ var CallLogObject = /*#__PURE__*/function () {
133
133
  CallLogObject.prototype['user_id'] = undefined;
134
134
 
135
135
  /**
136
- * If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity.
136
+ * If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity.
137
137
  * @member {Number} activity_id
138
138
  */
139
139
  CallLogObject.prototype['activity_id'] = undefined;
@@ -153,7 +153,7 @@ var ResponseCallLogObject = /*#__PURE__*/function () {
153
153
  ResponseCallLogObject.prototype['user_id'] = undefined;
154
154
 
155
155
  /**
156
- * If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity.
156
+ * If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity.
157
157
  * @member {Number} activity_id
158
158
  */
159
159
  ResponseCallLogObject.prototype['activity_id'] = undefined;
@@ -249,7 +249,7 @@ ResponseCallLogObject.prototype['company_id'] = undefined;
249
249
  */
250
250
  _CallLogObject["default"].prototype['user_id'] = undefined;
251
251
  /**
252
- * If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity.
252
+ * If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity.
253
253
  * @member {Number} activity_id
254
254
  */
255
255
  _CallLogObject["default"].prototype['activity_id'] = undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "18.1.1",
3
+ "version": "18.1.3",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
package/CHANGELOG.md DELETED
@@ -1,464 +0,0 @@
1
- # Changelog
2
- All notable changes to this project will be documented in this file.
3
-
4
- The Changelog file gives an overview of all of the notable changes affecting the project.
5
- The file format of it is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/), and the project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6
-
7
- For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).
8
-
9
- ## [Unreleased]
10
-
11
- ## [18.1.1] - 2023-01-25
12
- ### Fixed
13
- - Updated `user_id` description for `POST /webhooks/`
14
- ### Fixed
15
- - Adds support for snake_case query params reported in pipedrive/client-nodejs#410
16
-
17
- ## [18.1.0] - 2023-01-20
18
- ### Changed
19
- - Removed `location_lat` and `location_long` fields from the following endpoints activity details response:
20
- - GET /v1/activities
21
- - GET /v1/activities/{id}
22
- - POST /v1/activities
23
- - PUT /v1/activities/{id}
24
-
25
- ### Fixed
26
- - Fixed a typo in `GET /itemSearch/field`
27
- - Fixed mistakenly documented response field for `GET /v1/deals/{id}/followers` from `person_id` to `deal_id`.
28
-
29
- ### Added
30
- - Optional `lead_id` parameter to `POST /v1/files`
31
- - `lead_id` and `lead_name` to the `/v1/files` endpoints
32
-
33
- ### Removed
34
- - Removed deprecated endpoints that will be deleted:
35
- - `GET /roles/{id}/roles`
36
- - Removed `followers_count` from Product-related entities and endpoints based on this [post](https://developers.pipedrive.com/changelog/post/removal-of-codefollowers_countcode-response-field-from-products-endpoints-and-webhook). Changing the following endpoints:
37
- - GET /deals/{id}/products
38
- - GET /products
39
- - GET /products/{id}
40
- - POST /products
41
- - PUT /products/{id}
42
-
43
- ## [18.0.3] - 2023-01-11
44
- ### Updated dependencies
45
- - Updated `json5` from 2.2.1 to 2.2.3
46
- - Updated `qs` from 6.9.3 to 6.11.0
47
- - Updated `formidable` from 2.0.1 to 2.1.1
48
- - Updated `decode-uri-component` from 0.2.0 to 0.2.2
49
- - Updated `minimatch` from 3.0.4 to 3.1.2
50
- - Updated `mocha` from 8.4.0 to 10.1.0
51
-
52
- ## [18.0.2] - 2022-12-22
53
- ### Fixed
54
- - Fixed a typo in `GET /itemSearch/field`
55
-
56
- ## [18.0.1] - 2022-12-15
57
- ### Fixed
58
- - Move @babel/runtime from devDependencies to dependencies to fix a runtime error
59
-
60
- ## 18.0.0
61
- ### Security
62
- - Removed `.instance` static property from sdk client to prevent race conditions when using it as a singleton
63
- See the updated examples in the readme to get an overview of the necessary code changes.
64
-
65
- ## 17.5.2
66
- ### Changed
67
- - Updated endpoint descriptions to warn about permanently removing deleted entities:
68
- - `DELETE /activities`
69
- - `DELETE /activities/{id}`
70
- - `DELETE /deals`
71
- - `DELETE /deals/{id}`
72
- - `DELETE /files/{id}`
73
- - `DELETE /organizations`
74
- - `DELETE /organizations/{id}`
75
- - `DELETE /persons`
76
- - `DELETE /persons/{id}`
77
- - `DELETE /products/{id}`
78
- - Updated `conditions` parameter description for `POST /filters` and `PUT /filters/{id}`
79
-
80
- ## 17.5.1
81
- ### Fixed
82
- - Fixed custom field value (it should return null if the value is null)
83
-
84
- ## 17.5.0
85
- ### Changed
86
- - Updated `type.params.pipeline_id` and `type.params.activity_type_id` description, type and response example for goals queries
87
-
88
- ## 17.4.0
89
- ### Changed
90
- - Added `pipeline` and `stage` objects to the `related_objects` section in the following endpoints:
91
- - `GET /v1/deals`
92
- - `GET /v1/deals/{id}`
93
- - `GET /v1/organizations/{id}/deals`
94
- - `GET /v1/persons/{id}/deals`
95
- - `GET /v1/products/{id}/deals`
96
- - `POST /v1/deals`
97
- - `PUT /v1/deals/{id}`
98
-
99
- ## 17.3.1
100
- ### Changed
101
- - Changed the content type to `application/json` in the following endpoints:
102
- - `POST /activityTypes`
103
- - `PUT /activityTypes/{id}`
104
-
105
- ## 17.3.0
106
- ### Changed
107
- - Removed query `include_deleted_files` parameter for these endpoints based on this [post](https://developers.pipedrive.com/changelog/post/permanent-deletion-logic-for-6-core-entities)
108
- - `GET /files`
109
- - `GET /deals/{id}/files`
110
- - `GET /organizations/{id}/files`
111
- - `GET /persons/{id}/files`
112
- - `GET /products/{id}/files`
113
-
114
- ## 17.2.0
115
- ### Removed
116
- - Removed deprecated endpoints that will be deleted:
117
- - `POST /users/{id}/roleAssignments`
118
- - `DELETE /users/{id}/roleAssignments`
119
-
120
- ## 17.1.5
121
- ### Changed
122
- - Added and updated the descriptions of roles endpoints
123
-
124
- ## 17.1.4
125
- ### Changed
126
- - Changed the content type to `application/json` in the following endpoints:
127
- - `DELETE /roles/{id}/assignments`
128
- - `POST /roles/{id}/settings`
129
- - `PUT /roles/{id}`
130
- - `POST /roles`
131
- - `POST /roles/{id}/assignments`
132
- - `PUT /users/{id}`
133
-
134
- ## 17.1.3
135
- ### Changed
136
- - Updated `PUT /users/{:id}`: required parameter `active_flag` has no default value
137
-
138
- ## 17.1.2
139
- ### Changed
140
- - Changed `PUT /goals/{id}` content type to `application/json`
141
-
142
- ## 17.1.1
143
- ### Changed
144
- - Description for product requests
145
-
146
- ## 17.1.0
147
- ### Removed
148
- - Removed deprecated endpoints that were deleted:
149
- - `GET /globalMessages`
150
- - `DELETE /globalMessages/{id}`
151
-
152
- ## 17.0.0
153
- ### Changed
154
- - Updated `PUT /organizations/{id}`: parameter `name` is not required
155
- - Updated `PUT /notes/{id}`: parameter `content` is not required
156
- - Changed models related to the endpoints to reflect the changes
157
-
158
- ## 16.2.0
159
- ### Changed
160
- - Removed `matches_filters` field from the POST `/deals` and PUT `/deals/{id}` endpoints response
161
- - Description for `GET/v1/filters/helpers` endpoint
162
- - Changed `POST /v1/users` request body type from `application/x-www-form-urlencoded` to `application/json`
163
- - Added `access` field to responses from `GET /v1/users`, `GET /v1/users/{id}`, etc.
164
- - Added optional `access` parameter and made `name` optional in `POST /v1/users`
165
- - Added `app`, `type` and `description` fields to responses from `GET /v1/permissionSets` and `GET v1/permissionSets/{id}`
166
- - Added optional `app` parameter to `GET /v1/permissionSets`
167
- - Deprecated `is_admin` and `signup_flow_variation` fields in responses from `GET /v1/users`, `GET /v1/users/{id}`, etc.
168
-
169
- ## 16.1.0
170
- ### Added
171
- - Added `person_id` and `organization_id` query parameters to GET `/v1/leads`
172
-
173
- ## 16.0.4
174
- ### Changed
175
- - Description for api/v1/channels endpoints
176
-
177
- ## 16.0.3
178
- ### Fixed
179
- - Fixed issue with custom monetary field currency
180
-
181
- ## 16.0.1
182
- ### Added
183
- - Added restriction of maximum 16 conditions per filter.
184
- ### Changed
185
- - Removed support for `NOT LIKE '%$%': does not contain, LIKE '%$': ends with, NOT LIKE '%$': does not end with` varchar and title filter conditions.
186
-
187
- ## 16.0.0
188
- ### Changed
189
- - Changed `id` parameter data type to `string` for GET `/permissionSets/{id}` and GET `/permissionSets/{id}/assignments` endpoints
190
- - Changed `id` field data type to `string` for response from GET `/permissionSets` and GET `/permissionSets/{id}` endpoints
191
- - Changed `permission_set_id` field data type to `string` for response GET `/permissionSets/{id}/assignments` endpoints
192
- - Removed `id` field from response for GET `/permissionSets/{id}/assignments` endpoints
193
-
194
- ## 15.0.3
195
- ### Changed
196
- - Added deprecated flags to `GET /globalMessages` and `DELETE /globalMessages/{id}`
197
-
198
- ## 15.0.2
199
- ### Added
200
- - Added `primary_email` field to response of `GET /v1/persons`, `GET /v1/persons/{id}` endpoints
201
-
202
- ## 15.0.1
203
- ### Changed
204
- - Update the following dependencies:
205
- - `superagent`
206
-
207
- ## 15.0.0
208
- ### Fixed
209
- - Renamed file with long name and it's class.
210
-
211
- Old name:
212
- AnyOfRecentsActivityRecentsActivityTypeRecentsDealRecentsFileRecentsFilterRecentsNoteRecentsPersonRecentsOrganizationRecentsPipelineRecentsProductRecentsStageRecentsUser
213
- New name:
214
- AnyOfRecents
215
-
216
- ## 14.0.1
217
- ### Fixed
218
- - Updated `PUT /persons/{id}`: parameter `name` is not required
219
-
220
- ## 14.0.0
221
- ### Changed
222
- - Moved `v1/teams*` endpoints to `v1/legacyTeams*` as they're being deprecated because we are preparing for an upgraded version of the Teams API, which requires migrating the current functionality to a new path URL `v1/legacyTeams*`.
223
- The functionality and [OAuth scopes](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations) of all the Teams API endpoints will remain the same.
224
-
225
- ## 13.3.4
226
- ### Changed
227
- - Updated `PUT /productFields/{id}`: parameter `name` is not
228
-
229
- ## 13.3.3
230
- ### Changed
231
- - Added babel/runtime to dependencies
232
-
233
- ## 13.3.2
234
- ### Changed
235
- - Moved the following dependencies to devDependencies:
236
- - `@babel/cli`
237
- - `@babel/runtime`
238
- - `jest-environment-node`
239
-
240
- ## 13.3.1
241
- ### Fixed
242
- - Date formatting in responses in the following entities and their respective fields:
243
- - **activities**: `due_date`
244
- - **deals**: `expected_close_date`
245
- - **leads**: `expected_close_date`
246
- - **subscriptions**: `due_at`, `start_date`, `end_date`
247
-
248
- Those fields will be formatted as "2020-07-13" instead of "2020-07-13T00:00:00.000Z" in the request response.
249
-
250
- ## 13.3.0
251
- ### Added
252
- - Added `GET /billing/subscriptions/addons` endpoint
253
-
254
- ## 13.2.9
255
- ### Changed
256
- - Added missing oauth scopes to /products/{id}/permittedUsers endpoint
257
-
258
- ## 13.2.8
259
- ### Fixed
260
- - Changed rotten_flag type to boolean in `StagesApi`
261
-
262
- ## 13.2.7
263
- ### Changed
264
- - Added `everyone` parameter to `GET /v1/stages/{id}` endpoint
265
- - Updated `/v1/deals` endpoint `stage_id` and added `pipeline_id` descriptions
266
-
267
- ## 13.2.6
268
- ### Changed
269
- - Updated `POST /products`: parameter `name` is required
270
- - Updated `PUT /deals/:dealId/products`: parameter `quantity` and `item_price` are required
271
- - Updated `POST /deals/:dealId/products`: parameter `quantity` and `item_price` are required
272
- -
273
-
274
- ## 13.2.5
275
- ### Changed
276
- - Updated `POST /notes`: parameter `content` is required
277
- - Updated `POST /organizations`: parameter `name` is required
278
- - Updated `POST /persons`: parameter `name` is required
279
- - Updated `DELETE /persons`: parameter `ids` is required
280
- - Updated `visible_to` parameter for `POST /deals` and `PUT /deals/{id}` to include type `number`
281
- - Updated `visible_to` parameter for `POST /persons` and `PUT /persons/{id}` to include type `number`
282
- - Updated `visible_to` parameter for `POST /organizations` and `PUT /organizations/{id}` to include type `number`
283
-
284
- ## 13.2.4
285
- ### Fixed
286
- - Added quotation marks to fix formatting for Organizations endpoint `visible_to` parameter
287
- - Updated `prices` parameter description in Products endpoint
288
-
289
- ## 13.2.3
290
- ### Changed
291
- - Update `visible_to` parameter for `POST /deals` and `PUT /deals/{id}`. Differentiate options by plans
292
- - Update `visible_to` parameter for `POST /persons` and `PUT /persons/{id}`. Differentiate options by plans
293
- - Update `visible_to` parameter for `POST /organizations` and `PUT /organizations/{id}`. Differentiate options by plans
294
-
295
- ## 13.2.1
296
- ### Fixed
297
- - Fixed wrong field name normalization for custom fields keys
298
-
299
- ## 13.2.0
300
- ### Changed
301
- - Deprecate /v1/mailbox/mailMessages/{id} & /v1/mailbox/mailThreads/{id} response data property write_flag
302
-
303
- ## 13.1.3
304
- ### Fixed
305
- - Fix replaceCamelCaseObj is not defined reference issue in ApiClient
306
-
307
- ## 13.1.2
308
- ### Fixed
309
- - Styling fixes: capitalization, tutorial links' texts, code-highlighting in descriptions
310
-
311
- ## 13.1.1
312
- ### Changed
313
- - Changed person-related endpoints to include `marketing_status` body parameter: `POST /v1/persons`, `PUT /v1/persons/{id}`
314
-
315
- ## 13.1.0
316
- ### Fixed
317
- - Fixed runtime error for `FilesApi.addFile`
318
- - Fixed missing required parameters check
319
- - Fixed camelCase support for application/json endpoints
320
-
321
- ## 13.0.12
322
- ### Fixed
323
- - Fixed capitalization, punctuation, grammar, articles in all endpoint descriptions
324
-
325
- ## 13.0.11
326
- ### Added
327
- - Added leadField to field_type options for `GET /v1/itemSearch/field`
328
-
329
- ## 13.0.10
330
- ### Fixed
331
- - Fix `POST /organizationRelationships` 'required' labels not showing
332
-
333
- ## 13.0.9
334
- ### Added
335
- - Added `tax` parameter on add product to the deal.
336
- * POST /v1/deals/{id}/products
337
- * PUT /v1/deals/{id}/products/{product_attachment_id}
338
- - Improved `follower_id` description
339
- * DELETE /v1/products/{id}/followers/{follower_id}
340
-
341
- ## 13.0.8
342
- ### Changed
343
- - Improve Products `price` description
344
-
345
- ## 13.0.7
346
- ### Changed
347
- - Changed/improve Products `visible_to` type, and differentiate options by plans
348
- * POST /products
349
- * PUT /products/{id}
350
-
351
- ## 13.0.6
352
- ### Fixed
353
- - Fixed `POST /roles/{id}/settings` `value` parameter description
354
- ### Added
355
- - Added type to `POST /roles/{id}/settings` `value` parameter
356
- - Added description to `POST /roles/{id}/settings`
357
-
358
- ## 13.0.5
359
- ### Changed
360
- - Changed Organization `custom_fields` type to a string array
361
-
362
- ## 13.0.4
363
- ### Fixed
364
- - Fixed typo in `ids` query parameter description in GET /products
365
-
366
- ## 13.0.3
367
- ### Changed
368
- - Changed/improved `subscription_url` body parameter description
369
- * POST /webhooks
370
-
371
- ## 13.0.2
372
- ### Fixed
373
- - Fixed items type for `email` and `phone` body parameters
374
- * POST /persons
375
-
376
- ## 13.0.1
377
- ### Added
378
- - Added `filter_id` to `GET /products` query parameters that was wrongfully removed in 0.1.18
379
-
380
- ## 13.0.0
381
- ### Removed
382
- - Removed `int` type from `POST /v1/organizationFields` field_type values
383
- - Removed `int` type from `POST /v1/personFields` field_type values
384
- - Removed `int` type from `POST /v1/dealFields` field_type values
385
-
386
- ## 12.2.0
387
- ### Changed
388
- - Changed notes and comments endpoints additional_data to match the correct pagination response
389
- structure
390
- * GET /notes
391
- * GET /notes/:id/comments
392
-
393
- ## 12.1.0
394
- ### Removed
395
- * Removed deprecated endpoints that were deleted:
396
- * GET /deals/find
397
- * GET /persons/find
398
- * GET /organizations/find
399
- * GET /products/find
400
- * GET /searchResults
401
- * GET /searchResults/field
402
-
403
- ## 12.0.3
404
- ### Changed
405
- - Changed addDeal POST endpoint to include required person_id or org_id
406
-
407
- ## 12.0.2
408
- ### Fixed
409
- * Use /api/v1 path when accessing the API using company domain
410
-
411
- ## 12.0.1
412
- ### Fixed
413
- * Fixed UNKNOWN_BASE_TYPE error related to updateStage
414
-
415
- ## 12.0.0
416
- ### Added
417
- * Support for endpoints added and updated endpoints changed after March 31, 2021
418
- * Support for multiple instances [issue #176](https://github.com/pipedrive/client-nodejs/issues/176)
419
- * Convenience functions regarding OAuth 2.0 lifecycle including `buildAuthorizationUrl`, `authorize` and `refreshToken`
420
- * Support for changing the host URL [issue #228](https://github.com/pipedrive/client-nodejs/issues/228)
421
- * Support for both snake_case and camelCase in request parameters
422
- * `UpdateProductResponse` for `PUT /products/{id}`
423
- * `Team` (singular) schema for endpoints that deal with a single team
424
- * Support for custom fields for `Content-Type: application/x-www-form-urlencoded` type requests
425
- * Added note field to call logs.
426
- * Added pagination parameters documentation for endpoints:
427
- * api/v1/DealFields#getDealFields
428
- * api/v1/OrganizationFields#getOrganizationFields
429
- * api/v1/PersonFields#getPersonFields
430
- * api/v1/ProductFields#getProductFields
431
- ### Changed
432
- * Changed POST/PUT for a lot of endpoints to accept `application/json` instead of `application/x-www-form-urlencoded`
433
- * Added required fields to the OrganizationRelationship and Notes POST endpoints
434
- * Updated `MailThreadPut` schema to represent `object` in response instead of an `array`
435
- * Updated description for `MailThreadOne`
436
- * Split `Product` schema into `BaseProduct` and `ProductWithArrayPrices` or `ProductWithObjectPrices` to represent `prices` property with `array` type and `object` type respectively
437
- * Use the new `ProductWithObjectPrices` in `UpdateProductResponse`
438
- * `TeamSuccess` response schema to refer to `Team` (singular) instead of `Teams` (plural)
439
- * Extended `DELETE /calllogs/{id}` security with `api_key` property.
440
- * Extended `POST /callLogs/{id}/recordings` security with `api_key` property.
441
- * Extended `GET /v1/roles/{id}/settings` response with `lead_default_visibility` property.
442
- * Extended `POST /v1/roles/{id}/settings` request payload with `lead_default_visibility` property.
443
- * Deleted `MailThreads` and `MailMessages` from API operation groups and combined them under `Mailbox` group.
444
- * Extracted `LeadLabels` and `LeadSources` API operation groups from `Leads` group.
445
- * Deleted `MailThreads` and `MailMessages` from API operation groups and combined them under `Mailbox` group.
446
- * Extracted `LeadLabels` and `LeadSources` API operation groups from `Leads` group.
447
- * Updated documentation for search endpoint: include Lead as one of the possible returned entities in related objects
448
- * Changed POST /v1/webhooks to accept `application/json` instead of `application/x-www-form-urlencoded` to reflect the reality
449
- ### Removed
450
- * Deleted deprecated `note` field from all lead related documents.
451
- * Deleted unused files (copied latest auto-generated version)
452
- ### Fixed
453
- * Fixed GET /goals/:id/results `period.start` parameter description with specified possible dates
454
- * Fixed GET /goals/:id/results `period.end` parameter description with specified possible dates
455
- * Fixed `GET /goal/:id/results` error handling in cases when period.start or period.end dates are out of possible range
456
- * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal
457
- * Fixed typo in lead example response (`crrency` to `currency`)
458
-
459
- [Unreleased]: https://github.com/pipedrive/api-docs/compare/v18.1.1...HEAD
460
- [18.1.1]: https://github.com/pipedrive/api-docs/compare/v18.1.0...v18.1.1
461
- [18.1.0]: https://github.com/pipedrive/api-docs/compare/v18.0.3...v18.1.0
462
- [18.0.3]: https://github.com/pipedrive/api-docs/compare/v18.0.2...v18.0.3
463
- [18.0.2]: https://github.com/pipedrive/api-docs/compare/v18.0.1...v18.0.2
464
- [18.0.1]: https://github.com/pipedrive/api-docs/compare/v1.0.0...v18.0.1