pipedrive 16.0.1 → 16.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/dist/ApiClient.js +1 -1
- package/dist/api/ChannelsApi.js +8 -8
- package/dist/api/LeadsApi.js +6 -0
- package/package.json +1 -1
    
        package/CHANGELOG.md
    CHANGED
    
    | @@ -7,6 +7,19 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e | |
| 7 7 | 
             
            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).
         | 
| 8 8 |  | 
| 9 9 | 
             
            ## [Unreleased]
         | 
| 10 | 
            +
             | 
| 11 | 
            +
            ## 16.1.0
         | 
| 12 | 
            +
            ### Added
         | 
| 13 | 
            +
            - Added `person_id` and `organization_id` query parameters to GET `/v1/leads`
         | 
| 14 | 
            +
             | 
| 15 | 
            +
            ## 16.0.4
         | 
| 16 | 
            +
            ### Changed
         | 
| 17 | 
            +
            - Description for api/v1/channels endpoints
         | 
| 18 | 
            +
             | 
| 19 | 
            +
            ## 16.0.3
         | 
| 20 | 
            +
            ### Fixed
         | 
| 21 | 
            +
            - Fixed issue with custom monetary field currency
         | 
| 22 | 
            +
             | 
| 10 23 | 
             
            ## 16.0.1
         | 
| 11 24 | 
             
            ### Added
         | 
| 12 25 | 
             
            - Added restriction of maximum 16 conditions per filter.
         | 
    
        package/dist/ApiClient.js
    CHANGED
    
    | @@ -690,7 +690,7 @@ var ApiClient = /*#__PURE__*/function () { | |
| 690 690 | 
             
                    var keyValue = obj[key];
         | 
| 691 691 | 
             
                    var isArray = Array.isArray(keyValue);
         | 
| 692 692 | 
             
                    var isObject = (0, _typeof2["default"])(keyValue) === 'object' && !isArray;
         | 
| 693 | 
            -
                    var isHash = /^[a-f0-9]{40} | 
| 693 | 
            +
                    var isHash = /^[a-f0-9]{40}$|^[a-f0-9]{40}_[a-z0-9]+$/i.test(key);
         | 
| 694 694 | 
             
                    if (isArray) keyValue = keyValue.map(function (kv) {
         | 
| 695 695 | 
             
                      return (0, _typeof2["default"])(kv) === 'object' ? _this3.replaceCamelCaseObj(kv) : kv;
         | 
| 696 696 | 
             
                    });
         | 
    
        package/dist/api/ChannelsApi.js
    CHANGED
    
    | @@ -58,7 +58,7 @@ var ChannelsApi = /*#__PURE__*/function () { | |
| 58 58 | 
             
              }
         | 
| 59 59 | 
             
              /**
         | 
| 60 60 | 
             
               * Add a channel
         | 
| 61 | 
            -
               * 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.  | 
| 61 | 
            +
               * 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).
         | 
| 62 62 | 
             
               * @param {Object} opts Optional parameters
         | 
| 63 63 | 
             
               * @param {module:model/ChannelObject} opts.channelObject 
         | 
| 64 64 | 
             
               * @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 () { | |
| 105 105 | 
             
                }
         | 
| 106 106 | 
             
                /**
         | 
| 107 107 | 
             
                 * Add a channel
         | 
| 108 | 
            -
                 * 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.  | 
| 108 | 
            +
                 * 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).
         | 
| 109 109 | 
             
                 * @param {Object} opts Optional parameters
         | 
| 110 110 | 
             
                 * @param {module:model/ChannelObject} opts.channelObject 
         | 
| 111 111 | 
             
                 * @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 () { | |
| 120 120 | 
             
                }
         | 
| 121 121 | 
             
                /**
         | 
| 122 122 | 
             
                 * Delete a channel
         | 
| 123 | 
            -
                 * Deletes an existing  | 
| 123 | 
            +
                 * 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).
         | 
| 124 124 | 
             
                 * @param {String} id The ID of the channel provided by the integration
         | 
| 125 125 | 
             
                 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteChannelSuccess} and HTTP response
         | 
| 126 126 | 
             
                 */
         | 
| @@ -163,7 +163,7 @@ var ChannelsApi = /*#__PURE__*/function () { | |
| 163 163 | 
             
                }
         | 
| 164 164 | 
             
                /**
         | 
| 165 165 | 
             
                 * Delete a channel
         | 
| 166 | 
            -
                 * Deletes an existing  | 
| 166 | 
            +
                 * 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).
         | 
| 167 167 | 
             
                 * @param {String} id The ID of the channel provided by the integration
         | 
| 168 168 | 
             
                 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteChannelSuccess}
         | 
| 169 169 | 
             
                 */
         | 
| @@ -177,7 +177,7 @@ var ChannelsApi = /*#__PURE__*/function () { | |
| 177 177 | 
             
                }
         | 
| 178 178 | 
             
                /**
         | 
| 179 179 | 
             
                 * Delete a conversation
         | 
| 180 | 
            -
                 * Deletes an existing conversation.
         | 
| 180 | 
            +
                 * 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).
         | 
| 181 181 | 
             
                 * @param {String} channelId The ID of the channel provided by the integration
         | 
| 182 182 | 
             
                 * @param {String} conversationId The ID of the conversation provided by the integration
         | 
| 183 183 | 
             
                 * @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 () { | |
| 227 227 | 
             
                }
         | 
| 228 228 | 
             
                /**
         | 
| 229 229 | 
             
                 * Delete a conversation
         | 
| 230 | 
            -
                 * Deletes an existing conversation.
         | 
| 230 | 
            +
                 * 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).
         | 
| 231 231 | 
             
                 * @param {String} channelId The ID of the channel provided by the integration
         | 
| 232 232 | 
             
                 * @param {String} conversationId The ID of the conversation provided by the integration
         | 
| 233 233 | 
             
                 * @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 () { | |
| 242 242 | 
             
                }
         | 
| 243 243 | 
             
                /**
         | 
| 244 244 | 
             
                 * Receives an incoming message
         | 
| 245 | 
            -
                 * Adds a message to a conversation.
         | 
| 245 | 
            +
                 * 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).
         | 
| 246 246 | 
             
                 * @param {Object} opts Optional parameters
         | 
| 247 247 | 
             
                 * @param {module:model/MessageObject} opts.messageObject 
         | 
| 248 248 | 
             
                 * @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 () { | |
| 308 308 | 
             
                }
         | 
| 309 309 | 
             
                /**
         | 
| 310 310 | 
             
                 * Receives an incoming message
         | 
| 311 | 
            -
                 * Adds a message to a conversation.
         | 
| 311 | 
            +
                 * 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).
         | 
| 312 312 | 
             
                 * @param {Object} opts Optional parameters
         | 
| 313 313 | 
             
                 * @param {module:model/MessageObject} opts.messageObject 
         | 
| 314 314 | 
             
                 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MessageObject}
         | 
    
        package/dist/api/LeadsApi.js
    CHANGED
    
    | @@ -230,6 +230,8 @@ var LeadsApi = /*#__PURE__*/function () { | |
| 230 230 | 
             
                 * @param {Number} opts.start For pagination, the position that represents the first result for the page
         | 
| 231 231 | 
             
                 * @param {module:model/String} opts.archivedStatus Filtering based on the archived status of a lead. If not provided, `All` is used.
         | 
| 232 232 | 
             
                 * @param {Number} opts.ownerId If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
         | 
| 233 | 
            +
                 * @param {Number} opts.personId If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
         | 
| 234 | 
            +
                 * @param {Number} opts.organizationId If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
         | 
| 233 235 | 
             
                 * @param {Number} opts.filterId The ID of the filter to use
         | 
| 234 236 | 
             
                 * @param {module:model/String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
         | 
| 235 237 | 
             
                 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLeadsResponse200} and HTTP response
         | 
| @@ -246,6 +248,8 @@ var LeadsApi = /*#__PURE__*/function () { | |
| 246 248 | 
             
                    'start': opts['start'],
         | 
| 247 249 | 
             
                    'archived_status': opts['archivedStatus'],
         | 
| 248 250 | 
             
                    'owner_id': opts['ownerId'],
         | 
| 251 | 
            +
                    'person_id': opts['personId'],
         | 
| 252 | 
            +
                    'organization_id': opts['organizationId'],
         | 
| 249 253 | 
             
                    'filter_id': opts['filterId'],
         | 
| 250 254 | 
             
                    'sort': opts['sort']
         | 
| 251 255 | 
             
                  };
         | 
| @@ -279,6 +283,8 @@ var LeadsApi = /*#__PURE__*/function () { | |
| 279 283 | 
             
                 * @param {Number} opts.start For pagination, the position that represents the first result for the page
         | 
| 280 284 | 
             
                 * @param {module:model/String} opts.archivedStatus Filtering based on the archived status of a lead. If not provided, `All` is used.
         | 
| 281 285 | 
             
                 * @param {Number} opts.ownerId If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
         | 
| 286 | 
            +
                 * @param {Number} opts.personId If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
         | 
| 287 | 
            +
                 * @param {Number} opts.organizationId If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
         | 
| 282 288 | 
             
                 * @param {Number} opts.filterId The ID of the filter to use
         | 
| 283 289 | 
             
                 * @param {module:model/String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
         | 
| 284 290 | 
             
                 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLeadsResponse200}
         |