Release v17.5.2 from PR #381

Author: Jenkins User

CHANGELOG.md

@@ -7,6 +7,22 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
 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).
 
 ## [Unreleased]
+
+## 17.5.2
+### Changed
+- Updated endpoint descriptions to warn about permanently removing deleted entities:
+  - `DELETE /activities`
+  - `DELETE /activities/{id}`
+  - `DELETE /deals`
+  - `DELETE /deals/{id}`
+  - `DELETE /files/{id}`
+  - `DELETE /organizations`
+  - `DELETE /organizations/{id}`
+  - `DELETE /persons`
+  - `DELETE /persons/{id}`
+  - `DELETE /products/{id}`
+- Updated `conditions` parameter description for `POST /filters` and `PUT /filters/{id}`
+
 ## 17.5.1
 ### Fixed
 - Fixed custom field value (it should return null if the value is null)

docs/ActivitiesApi.md

@@ -74,7 +74,7 @@ Name | Type | Description  | Notes
 
 Delete multiple activities in bulk
 
-Marks multiple activities as deleted.
+Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
 
 ### Example
 
@@ -127,7 +127,7 @@ Name | Type | Description  | Notes
 
 Delete an activity
 
-Marks an activity as deleted.
+Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
 
 ### Example
 

docs/AddFilterRequest.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of the filter | 
-**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. | 
+**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. | 
 **type** | [**FilterType**](FilterType.md) | The type of filter to create | 
 
 

docs/DealsApi.md

@@ -266,7 +266,7 @@ Name | Type | Description  | Notes
 
 Delete a deal
 
-Marks a deal as deleted.
+Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
 
 ### Example
 
@@ -484,7 +484,7 @@ Name | Type | Description  | Notes
 
 Delete multiple deals in bulk
 
-Marks multiple deals as deleted.
+Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
 
 ### Example
 

docs/FilesApi.md

@@ -147,7 +147,7 @@ Name | Type | Description  | Notes
 
 Delete a file
 
-Marks a file as deleted.
+Marks a file as deleted. After 30 days, the file will be permanently deleted.
 
 ### Example
 

docs/OrganizationsApi.md

@@ -143,7 +143,7 @@ Name | Type | Description  | Notes
 
 Delete an organization
 
-Marks an organization as deleted.
+Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
 
 ### Example
 
@@ -248,7 +248,7 @@ Name | Type | Description  | Notes
 
 Delete multiple organizations in bulk
 
-Marks multiple organizations as deleted.
+Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
 
 ### Example
 
@@ -301,7 +301,7 @@ Name | Type | Description  | Notes
 
 Get details of an organization
 
-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.
+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.
 
 ### Example
 

docs/PersonsApi.md

@@ -210,7 +210,7 @@ Name | Type | Description  | Notes
 
 Delete a person
 
-Marks a person as deleted.
+Marks a person as deleted. After 30 days, the person will be permanently deleted.
 
 ### Example
 
@@ -368,7 +368,7 @@ Name | Type | Description  | Notes
 
 Delete multiple persons in bulk
 
-Marks multiple persons as deleted.
+Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
 
 ### Example
 

docs/ProductsApi.md

@@ -137,7 +137,7 @@ Name | Type | Description  | Notes
 
 Delete a product
 
-Marks a product as deleted.
+Marks a product as deleted. After 30 days, the product will be permanently deleted.
 
 ### Example
 

docs/UpdateFilterRequest.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of the filter | [optional] 
-**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. | 
+**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. |