Skip to content

Commit d342611

Browse files
author
pipedrive-bot
committed
Build 1502 - version-patch
1 parent 42e3378 commit d342611

17 files changed

+52
-39
lines changed

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
77
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).
88

99
## [Unreleased]
10+
### Changed
11+
- Updated endpoint descriptions to warn about permanently removing deleted entities:
12+
- `DELETE /activities`
13+
- `DELETE /activities/{id}`
14+
- `DELETE /deals`
15+
- `DELETE /deals/{id}`
16+
- `DELETE /files/{id}`
17+
- `DELETE /organizations`
18+
- `DELETE /organizations/{id}`
19+
- `DELETE /persons`
20+
- `DELETE /persons/{id}`
21+
- `DELETE /products/{id}`
22+
- Updated `conditions` parameter description for `POST /filters` and `PUT /filters/{id}`
1023
## 17.5.1
1124
### Fixed
1225
- Fixed custom field value (it should return null if the value is null)

‎docs/ActivitiesApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Name | Type | Description | Notes
7474
7575
Delete multiple activities in bulk
7676

77-
Marks multiple activities as deleted.
77+
Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
7878

7979
### Example
8080

@@ -127,7 +127,7 @@ Name | Type | Description | Notes
127127
128128
Delete an activity
129129

130-
Marks an activity as deleted.
130+
Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
131131

132132
### Example
133133

‎docs/AddFilterRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**name** | **String** | The name of the filter |
8-
**conditions** | **Object** | The conditions of the filter as a JSON object. It requires a minimum structure as follows: `{\"glue\":\"and\",\"conditions\":[{\"glue\":\"and\",\"conditions\": [CONDITION_OBJECTS]},{\"glue\":\"or\",\"conditions\":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{\"object\":\"\",\"field_id\":\"\", \"operator\":\"\",\"value\":\"\", \"extra_value\":\"\"}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `\"person\"`, `\"deal\"`, `\"organization\"`, `\"product\"`, `\"activity\"` and you can use these types of operators depending on what type of a field you have: `\"IS NOT NULL\"`, `\"IS NULL\"`, `\"<=\"`, `\">=\"`, `\"<\"`, `\">\"`, `\"!=\"`, `\"=\"`, `\"LIKE '$%'\"`, `\"LIKE '%$%'\"`, `\"NOT LIKE '$%'\"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application. |
8+
**conditions** | **Object** | The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter. It requires a minimum structure as follows: `{\"glue\":\"and\",\"conditions\":[{\"glue\":\"and\",\"conditions\": [CONDITION_OBJECTS]},{\"glue\":\"or\",\"conditions\":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{\"object\":\"\",\"field_id\":\"\", \"operator\":\"\",\"value\":\"\", \"extra_value\":\"\"}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `\"person\"`, `\"deal\"`, `\"organization\"`, `\"product\"`, `\"activity\"` and you can use these types of operators depending on what type of a field you have: `\"IS NOT NULL\"`, `\"IS NULL\"`, `\"<=\"`, `\">=\"`, `\"<\"`, `\">\"`, `\"!=\"`, `\"=\"`, `\"LIKE '$%'\"`, `\"LIKE '%$%'\"`, `\"NOT LIKE '$%'\"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application. |
99
**type** | [**FilterType**](FilterType.md) | The type of filter to create |
1010

1111

‎docs/DealsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ Name | Type | Description | Notes
266266
267267
Delete a deal
268268

269-
Marks a deal as deleted.
269+
Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
270270

271271
### Example
272272

@@ -484,7 +484,7 @@ Name | Type | Description | Notes
484484
485485
Delete multiple deals in bulk
486486

487-
Marks multiple deals as deleted.
487+
Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
488488

489489
### Example
490490

‎docs/FilesApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Name | Type | Description | Notes
147147
148148
Delete a file
149149

150-
Marks a file as deleted.
150+
Marks a file as deleted. After 30 days, the file will be permanently deleted.
151151

152152
### Example
153153

‎docs/OrganizationsApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Name | Type | Description | Notes
143143
144144
Delete an organization
145145

146-
Marks an organization as deleted.
146+
Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
147147

148148
### Example
149149

@@ -248,7 +248,7 @@ Name | Type | Description | Notes
248248
249249
Delete multiple organizations in bulk
250250

251-
Marks multiple organizations as deleted.
251+
Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
252252

253253
### Example
254254

@@ -301,7 +301,7 @@ Name | Type | Description | Notes
301301
302302
Get details of an organization
303303

304-
Returns details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
304+
Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
305305

306306
### Example
307307

‎docs/PersonsApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Name | Type | Description | Notes
210210
211211
Delete a person
212212

213-
Marks a person as deleted.
213+
Marks a person as deleted. After 30 days, the person will be permanently deleted.
214214

215215
### Example
216216

@@ -368,7 +368,7 @@ Name | Type | Description | Notes
368368
369369
Delete multiple persons in bulk
370370

371-
Marks multiple persons as deleted.
371+
Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
372372

373373
### Example
374374

‎docs/ProductsApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Name | Type | Description | Notes
137137
138138
Delete a product
139139

140-
Marks a product as deleted.
140+
Marks a product as deleted. After 30 days, the product will be permanently deleted.
141141

142142
### Example
143143

‎docs/UpdateFilterRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**name** | **String** | The name of the filter | [optional]
8-
**conditions** | **Object** | The conditions of the filter as a JSON object. It requires a minimum structure as follows: `{\"glue\":\"and\",\"conditions\":[{\"glue\":\"and\",\"conditions\": [CONDITION_OBJECTS]},{\"glue\":\"or\",\"conditions\":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{\"object\":\"\",\"field_id\":\"\", \"operator\":\"\",\"value\":\"\", \"extra_value\":\"\"}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `\"person\"`, `\"deal\"`, `\"organization\"`, `\"product\"`, `\"activity\"` and you can use these types of operators depending on what type of a field you have: `\"IS NOT NULL\"`, `\"IS NULL\"`, `\"<=\"`, `\">=\"`, `\"<\"`, `\">\"`, `\"!=\"`, `\"=\"`, `\"LIKE '$%'\"`, `\"LIKE '%$%'\"`, `\"NOT LIKE '$%'\"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application. |
8+
**conditions** | **Object** | The conditions of the filter as a JSON object. Please note that a maximum of 16 conditions is allowed per filter. It requires a minimum structure as follows: `{\"glue\":\"and\",\"conditions\":[{\"glue\":\"and\",\"conditions\": [CONDITION_OBJECTS]},{\"glue\":\"or\",\"conditions\":[CONDITION_OBJECTS]}]}`. Replace `CONDITION_OBJECTS` with JSON objects of the following structure: `{\"object\":\"\",\"field_id\":\"\", \"operator\":\"\",\"value\":\"\", \"extra_value\":\"\"}` or leave the array empty. Depending on the object type you should use another API endpoint to get `field_id`. There are five types of objects you can choose from: `\"person\"`, `\"deal\"`, `\"organization\"`, `\"product\"`, `\"activity\"` and you can use these types of operators depending on what type of a field you have: `\"IS NOT NULL\"`, `\"IS NULL\"`, `\"<=\"`, `\">=\"`, `\"<\"`, `\">\"`, `\"!=\"`, `\"=\"`, `\"LIKE '$%'\"`, `\"LIKE '%$%'\"`, `\"NOT LIKE '$%'\"`. To get a better understanding of how filters work try creating them directly from the Pipedrive application. |
99

1010

‎src/api/ActivitiesApi.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export default class ActivitiesApi {
108108

109109
/**
110110
* Delete multiple activities in bulk
111-
* Marks multiple activities as deleted.
111+
* Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
112112
* @param {String} ids The comma-separated IDs of activities that will be deleted
113113
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteActivitiesResponse200} and HTTP response
114114
*/
@@ -160,7 +160,7 @@ export default class ActivitiesApi {
160160

161161
/**
162162
* Delete multiple activities in bulk
163-
* Marks multiple activities as deleted.
163+
* Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
164164
* @param {String} ids The comma-separated IDs of activities that will be deleted
165165
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteActivitiesResponse200}
166166
*/
@@ -174,7 +174,7 @@ export default class ActivitiesApi {
174174

175175
/**
176176
* Delete an activity
177-
* Marks an activity as deleted.
177+
* Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
178178
* @param {Number} id The ID of the activity
179179
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteActivityResponse200} and HTTP response
180180
*/
@@ -226,7 +226,7 @@ export default class ActivitiesApi {
226226

227227
/**
228228
* Delete an activity
229-
* Marks an activity as deleted.
229+
* Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
230230
* @param {Number} id The ID of the activity
231231
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteActivityResponse200}
232232
*/

0 commit comments

Comments
 (0)