pipedrive 13.1.0 → 13.1.1

package/CHANGELOG.md

@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## 13.1.1
+### Changed
+- Changed person-related endpoints to include `marketing_status` body parameter: `POST /v1/persons`, `PUT /v1/persons/{id}`
+
 ## 13.1.0
 ### Fixed
 - Fixed runtime error for `FilesApi.addFile`

package/README.md

@@ -925,6 +925,7 @@ Class | Method | HTTP request | Description
  - [Pipedrive.MailThreadParticipant](docs/MailThreadParticipant.md)
  - [Pipedrive.MailThreadPut](docs/MailThreadPut.md)
  - [Pipedrive.MailThreadPutAllOf](docs/MailThreadPutAllOf.md)
+ - [Pipedrive.MarketingStatus](docs/MarketingStatus.md)
  - [Pipedrive.MergeDealsRequest](docs/MergeDealsRequest.md)
  - [Pipedrive.MergeOrganizationsRequest](docs/MergeOrganizationsRequest.md)
  - [Pipedrive.MergePersonDealRelatedInfo](docs/MergePersonDealRelatedInfo.md)

package/dist/api/DealsApi.js

@@ -1040,7 +1040,7 @@ var DealsApi = /*#__PURE__*/function () {
     }
     /**
      * List participants of a deal
-     * Lists the participants associated with a deal.
+     * Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Number} id The ID of the deal
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -1089,7 +1089,7 @@ var DealsApi = /*#__PURE__*/function () {
     }
     /**
      * List participants of a deal
-     * Lists the participants associated with a deal.
+     * Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Number} id The ID of the deal
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -1247,7 +1247,7 @@ var DealsApi = /*#__PURE__*/function () {
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
      * @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
-     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
+     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DealFlowResponse} and HTTP response
      */
 
@@ -1300,7 +1300,7 @@ var DealsApi = /*#__PURE__*/function () {
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
      * @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
-     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
+     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DealFlowResponse}
      */
 

package/dist/api/OrganizationsApi.js

@@ -780,7 +780,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * List persons of an organization
-     * Lists persons associated with an organization.
+     * Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Number} id The ID of the organization
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
@@ -829,7 +829,7 @@ var OrganizationsApi = /*#__PURE__*/function () {
     }
     /**
      * List persons of an organization
-     * Lists persons associated with an organization.
+     * Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Number} id The ID of the organization
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)

package/dist/api/PersonFieldsApi.js

@@ -274,7 +274,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Get all person fields
-     * Returns data about all person fields.
+     * Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
@@ -315,7 +315,7 @@ var PersonFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Get all person fields
-     * Returns data about all person fields.
+     * Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page

package/dist/api/PersonsApi.js

@@ -84,7 +84,7 @@ var PersonsApi = /*#__PURE__*/function () {
   }
   /**
    * Add a person
-   * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
+   * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
    * @param {Object} opts Optional parameters
    * @param {module:model/NewPerson} opts.newPerson 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddPersonResponse} and HTTP response
@@ -122,7 +122,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Add a person
-     * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
+     * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
      * @param {Object} opts Optional parameters
      * @param {module:model/NewPerson} opts.newPerson 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddPersonResponse}
@@ -515,7 +515,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Get details of a person
-     * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
+     * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @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/GetPersonDetailsResponse} and HTTP response
      */
@@ -558,7 +558,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Get details of a person
-     * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
+     * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
      * @param {Number} id The ID of the person
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetPersonDetailsResponse}
      */
@@ -977,13 +977,13 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * List updates about a person
-     * Lists updates about a person.
+     * Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.
      * @param {Number} id The ID of the person
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
      * @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
-     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
+     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PersonFlowResponse} and HTTP response
      */
 
@@ -1030,13 +1030,13 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * List updates about a person
-     * Lists updates about a person.
+     * Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.
      * @param {Number} id The ID of the person
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
      * @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
-     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
+     * @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PersonFlowResponse}
      */
 
@@ -1317,7 +1317,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Update a person
-     * Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+     * Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
      * @param {Number} id The ID of the person
      * @param {Object} opts Optional parameters
      * @param {module:model/BasicPerson} opts.basicPerson 
@@ -1362,7 +1362,7 @@ var PersonsApi = /*#__PURE__*/function () {
     }
     /**
      * Update a person
-     * Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+     * Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field.
      * @param {Number} id The ID of the person
      * @param {Object} opts Optional parameters
      * @param {module:model/BasicPerson} opts.basicPerson 

package/dist/index.js

@@ -2615,6 +2615,12 @@ Object.defineProperty(exports, "MailboxApi", {
     return _MailboxApi["default"];
   }
 });
+Object.defineProperty(exports, "MarketingStatus", {
+  enumerable: true,
+  get: function get() {
+    return _MarketingStatus["default"];
+  }
+});
 Object.defineProperty(exports, "MergeDealsRequest", {
   enumerable: true,
   get: function get() {
@@ -5140,6 +5146,8 @@ var _MailThreadPut = _interopRequireDefault(require("./model/MailThreadPut"));
 
 var _MailThreadPutAllOf = _interopRequireDefault(require("./model/MailThreadPutAllOf"));
 
+var _MarketingStatus = _interopRequireDefault(require("./model/MarketingStatus"));
+
 var _MergeDealsRequest = _interopRequireDefault(require("./model/MergeDealsRequest"));
 
 var _MergeOrganizationsRequest = _interopRequireDefault(require("./model/MergeOrganizationsRequest"));

package/dist/model/BasicPerson.js

@@ -17,6 +17,8 @@ var _BasePersonItemPhone = _interopRequireDefault(require("./BasePersonItemPhone
 
 var _BasicPersonEmail = _interopRequireDefault(require("./BasicPersonEmail"));
 
+var _MarketingStatus = _interopRequireDefault(require("./MarketingStatus"));
+
 var _VisibleTo = _interopRequireDefault(require("./VisibleTo"));
 
 /**
@@ -100,6 +102,11 @@ var BasicPerson = /*#__PURE__*/function () {
           delete data['visible_to'];
         }
 
+        if (data.hasOwnProperty('marketing_status')) {
+          obj['marketing_status'] = _ApiClient["default"].convertToType(data['marketing_status'], _MarketingStatus["default"]);
+          delete data['marketing_status'];
+        }
+
         if (Object.keys(data).length > 0) {
           Object.assign(obj, data);
         }
@@ -147,5 +154,11 @@ BasicPerson.prototype['phone'] = undefined;
  */
 
 BasicPerson.prototype['visible_to'] = undefined;
+/**
+ * If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
+ * @member {module:model/MarketingStatus} marketing_status
+ */
+
+BasicPerson.prototype['marketing_status'] = undefined;
 var _default = BasicPerson;
 exports["default"] = _default;

package/dist/model/MarketingStatus.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+/**
+* Enum class MarketingStatus.
+* @enum {}
+* @readonly
+*/
+var MarketingStatus = /*#__PURE__*/function () {
+  function MarketingStatus() {
+    (0, _classCallCheck2["default"])(this, MarketingStatus);
+    (0, _defineProperty2["default"])(this, "no_consent", "no_consent");
+    (0, _defineProperty2["default"])(this, "unsubscribed", "unsubscribed");
+    (0, _defineProperty2["default"])(this, "subscribed", "subscribed");
+    (0, _defineProperty2["default"])(this, "archived", "archived");
+  }
+
+  (0, _createClass2["default"])(MarketingStatus, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>MarketingStatus</code> enum value from a Javascript object name.
+    * @param {Object} data The plain JavaScript object containing the name of the enum value.
+    * @return {module:model/MarketingStatus} The enum <code>MarketingStatus</code> value.
+    */
+    function constructFromObject(object) {
+      return object;
+    }
+    /**
+    * Initializes the fields of this object.
+    * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+    * Only for internal use.
+    */
+
+  }, {
+    key: "initialize",
+    value: function initialize(obj) {}
+  }]);
+  return MarketingStatus;
+}();
+
+exports["default"] = MarketingStatus;

package/dist/model/NewPerson.js

@@ -19,6 +19,8 @@ var _BasicPerson = _interopRequireDefault(require("./BasicPerson"));
 
 var _BasicPersonEmail = _interopRequireDefault(require("./BasicPersonEmail"));
 
+var _MarketingStatus = _interopRequireDefault(require("./MarketingStatus"));
+
 var _NewPersonAllOf = _interopRequireDefault(require("./NewPersonAllOf"));
 
 var _VisibleTo = _interopRequireDefault(require("./VisibleTo"));
@@ -118,6 +120,11 @@ var NewPerson = /*#__PURE__*/function () {
           delete data['visible_to'];
         }
 
+        if (data.hasOwnProperty('marketing_status')) {
+          obj['marketing_status'] = _ApiClient["default"].convertToType(data['marketing_status'], _MarketingStatus["default"]);
+          delete data['marketing_status'];
+        }
+
         if (data.hasOwnProperty('add_time')) {
           obj['add_time'] = _ApiClient["default"].convertToType(data['add_time'], 'String');
           delete data['add_time'];
@@ -170,6 +177,12 @@ NewPerson.prototype['phone'] = undefined;
  */
 
 NewPerson.prototype['visible_to'] = undefined;
+/**
+ * If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
+ * @member {module:model/MarketingStatus} marketing_status
+ */
+
+NewPerson.prototype['marketing_status'] = undefined;
 /**
  * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
  * @member {String} add_time
@@ -212,7 +225,13 @@ _BasicPerson["default"].prototype['phone'] = undefined;
  * @member {module:model/VisibleTo} visible_to
  */
 
-_BasicPerson["default"].prototype['visible_to'] = undefined; // Implement NewPersonAllOf interface:
+_BasicPerson["default"].prototype['visible_to'] = undefined;
+/**
+ * If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>
+ * @member {module:model/MarketingStatus} marketing_status
+ */
+
+_BasicPerson["default"].prototype['marketing_status'] = undefined; // Implement NewPersonAllOf interface:
 
 /**
  * The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

package/package.json

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