pipedrive 16.0.3 → 16.0.4

package/CHANGELOG.md

@@ -7,7 +7,12 @@ 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]
-## 16.0.2
+
+## 16.0.4
+### Changed
+- Description for api/v1/channels endpoints
+
+## 16.0.3
 ### Fixed
 - Fixed issue with custom monetary field currency
 

package/dist/api/ChannelsApi.js

@@ -58,7 +58,7 @@ var ChannelsApi = /*#__PURE__*/function () {
   }
   /**
    * Add a channel
-   * Adds a new messaging, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. Read more in [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
+   * Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
    * @param {Object} opts Optional parameters
    * @param {module:model/ChannelObject} opts.channelObject 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ChannelObjectResponse} and HTTP response
@@ -105,7 +105,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Add a channel
-     * Adds a new messaging, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. Read more in [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
+     * Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {Object} opts Optional parameters
      * @param {module:model/ChannelObject} opts.channelObject 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ChannelObjectResponse}
@@ -120,7 +120,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a channel
-     * Deletes an existing messengers channel and all related entities (conversations and messages).
+     * Deletes an existing messenger’s channel and all related entities (conversations and messages). To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {String} id The ID of the channel provided by the integration
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteChannelSuccess} and HTTP response
      */
@@ -163,7 +163,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a channel
-     * Deletes an existing messengers channel and all related entities (conversations and messages).
+     * Deletes an existing messenger’s channel and all related entities (conversations and messages). To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {String} id The ID of the channel provided by the integration
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteChannelSuccess}
      */
@@ -177,7 +177,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a conversation
-     * Deletes an existing conversation.
+     * Deletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {String} channelId The ID of the channel provided by the integration
      * @param {String} conversationId The ID of the conversation provided by the integration
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteConversationSuccess} and HTTP response
@@ -227,7 +227,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a conversation
-     * Deletes an existing conversation.
+     * Deletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {String} channelId The ID of the channel provided by the integration
      * @param {String} conversationId The ID of the conversation provided by the integration
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteConversationSuccess}
@@ -242,7 +242,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Receives an incoming message
-     * Adds a message to a conversation.
+     * Adds a message to a conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {Object} opts Optional parameters
      * @param {module:model/MessageObject} opts.messageObject 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MessageObject} and HTTP response
@@ -308,7 +308,7 @@ var ChannelsApi = /*#__PURE__*/function () {
     }
     /**
      * Receives an incoming message
-     * Adds a message to a conversation.
+     * Adds a message to a conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).
      * @param {Object} opts Optional parameters
      * @param {module:model/MessageObject} opts.messageObject 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MessageObject}

package/package.json

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