pipedrive 17.5.1 → 17.5.2

package/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)

package/dist/api/ActivitiesApi.js

@@ -109,7 +109,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple activities in bulk
-     * Marks multiple activities as deleted.
+     * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
      * @param {String} ids The comma-separated IDs of activities that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteActivitiesResponse200} and HTTP response
      */
@@ -152,7 +152,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple activities in bulk
-     * Marks multiple activities as deleted.
+     * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
      * @param {String} ids The comma-separated IDs of activities that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteActivitiesResponse200}
      */
@@ -166,7 +166,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete an activity
-     * Marks an activity as deleted.
+     * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
      * @param {Number} id The ID of the activity
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteActivityResponse200} and HTTP response
      */
@@ -209,7 +209,7 @@ var ActivitiesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete an activity
-     * Marks an activity as deleted.
+     * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
      * @param {Number} id The ID of the activity
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteActivityResponse200}
      */

package/dist/api/DealsApi.js

@@ -350,7 +350,7 @@ var DealsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a deal
-     * Marks a deal as deleted.
+     * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @param {Number} id The ID of the deal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteDeal} and HTTP response
      */
@@ -393,7 +393,7 @@ var DealsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a deal
-     * Marks a deal as deleted.
+     * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @param {Number} id The ID of the deal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteDeal}
      */
@@ -602,7 +602,7 @@ var DealsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple deals in bulk
-     * Marks multiple deals as deleted.
+     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
      * @param {String} ids The comma-separated IDs that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteMultipleDeals} and HTTP response
      */
@@ -645,7 +645,7 @@ var DealsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple deals in bulk
-     * Marks multiple deals as deleted.
+     * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
      * @param {String} ids The comma-separated IDs that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteMultipleDeals}
      */

package/dist/api/FilesApi.js

@@ -216,7 +216,7 @@ var FilesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a file
-     * Marks a file as deleted.
+     * Marks a file as deleted. After 30 days, the file will be permanently deleted.
      * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteFile} and HTTP response
      */
@@ -259,7 +259,7 @@ var FilesApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a file
-     * Marks a file as deleted.
+     * Marks a file as deleted. After 30 days, the file will be permanently deleted.
      * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteFile}
      */

package/dist/api/OrganizationsApi.js

@@ -202,7 +202,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete an organization
-     * Marks an organization as deleted.
+     * Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
      * @param {Number} id The ID of the organization
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OrganizationDeleteResponse} and HTTP response
      */
@@ -245,7 +245,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete an organization
-     * Marks an organization as deleted.
+     * Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
      * @param {Number} id The ID of the organization
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OrganizationDeleteResponse}
      */
@@ -324,7 +324,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple organizations in bulk
-     * Marks multiple organizations as deleted.
+     * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
      * @param {String} ids The comma-separated IDs that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OrganizationsDeleteResponse} and HTTP response
      */
@@ -367,7 +367,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple organizations in bulk
-     * Marks multiple organizations as deleted.
+     * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
      * @param {String} ids The comma-separated IDs that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OrganizationsDeleteResponse}
      */
@@ -381,7 +381,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * 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.
      * @param {Number} id The ID of the organization
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OrganizationDetailsGetResponse} and HTTP response
      */
@@ -424,7 +424,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * 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.
      * @param {Number} id The ID of the organization
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OrganizationDetailsGetResponse}
      */

package/dist/api/PersonsApi.js

@@ -282,7 +282,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a person
-     * Marks a person as deleted.
+     * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @param {Number} id The ID of the person
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
      */
@@ -325,7 +325,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a person
-     * Marks a person as deleted.
+     * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @param {Number} id The ID of the person
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
      */
@@ -461,7 +461,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple persons in bulk
-     * Marks multiple persons as deleted.
+     * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
      * @param {String} ids The comma-separated IDs that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonsInBulkResponse} and HTTP response
      */
@@ -504,7 +504,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete multiple persons in bulk
-     * Marks multiple persons as deleted.
+     * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
      * @param {String} ids The comma-separated IDs that will be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonsInBulkResponse}
      */

package/dist/api/ProductsApi.js

@@ -184,7 +184,7 @@ var ProductsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a product
-     * Marks a product as deleted.
+     * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @param {Number} id The ID of the product
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductResponse} and HTTP response
      */
@@ -227,7 +227,7 @@ var ProductsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a product
-     * Marks a product as deleted.
+     * Marks a product as deleted. After 30 days, the product will be permanently deleted.
      * @param {Number} id The ID of the product
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductResponse}
      */

package/dist/model/AddFilterRequest.js

@@ -38,7 +38,7 @@ var AddFilterRequest = /*#__PURE__*/function () {
    * Constructs a new <code>AddFilterRequest</code>.
    * @alias module:model/AddFilterRequest
    * @param name {String} The name of the filter
-   * @param 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.
+   * @param 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.
    * @param type {module:model/FilterType} The type of filter to create
    */
   function AddFilterRequest(name, conditions, type) {
@@ -106,7 +106,7 @@ var AddFilterRequest = /*#__PURE__*/function () {
 
 AddFilterRequest.prototype['name'] = undefined;
 /**
- * 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.
+ * 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.
  * @member {Object} conditions
  */
 

package/dist/model/UpdateFilterRequest.js

@@ -35,7 +35,7 @@ var UpdateFilterRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>UpdateFilterRequest</code>.
    * @alias module:model/UpdateFilterRequest
-   * @param 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.
+   * @param 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.
    */
   function UpdateFilterRequest(conditions) {
     (0, _classCallCheck2["default"])(this, UpdateFilterRequest);
@@ -95,7 +95,7 @@ var UpdateFilterRequest = /*#__PURE__*/function () {
 
 UpdateFilterRequest.prototype['name'] = undefined;
 /**
- * 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.
+ * 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.
  * @member {Object} conditions
  */
 

package/package.json

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