Release v22.4.0 from PR #511

CHANGELOG.md

@@ -8,6 +8,10 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## [22.4.0] - 2024-01-05
+### Added
+- Added documentation for `/meetings/userProviderLinks` endpoints
+
 ## [22.3.0] - 2023-10-17
 - Add `Projects`, `ProjectTemplates` and `Tasks` public routes.
 
@@ -585,7 +589,8 @@ structure
 * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal
 * Fixed typo in lead example response (`crrency` to `currency`)
 
-[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.3.0...HEAD
+[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.4.0...HEAD
+[22.4.0]: https://github.com/pipedrive/api-docs/compare/v22.3.0...v22.4.0
 [22.3.0]: https://github.com/pipedrive/api-docs/compare/v22.2.0...v22.3.0
 [22.2.0]: https://github.com/pipedrive/api-docs/compare/v22.1.0...v22.2.0
 [22.1.0]: https://github.com/pipedrive/api-docs/compare/v22.0.2...v22.1.0

README.md

@@ -449,6 +449,8 @@ Class | Method | HTTP request | Description
 *Pipedrive.MailboxApi* | [**getMailThreadMessages**](https://github.com/pipedrive/client-nodejs/blob/master/docs/MailboxApi.md#getMailThreadMessages) | **GET** /mailbox/mailThreads/{id}/mailMessages | Get all mail messages of mail thread
 *Pipedrive.MailboxApi* | [**getMailThreads**](https://github.com/pipedrive/client-nodejs/blob/master/docs/MailboxApi.md#getMailThreads) | **GET** /mailbox/mailThreads | Get mail threads
 *Pipedrive.MailboxApi* | [**updateMailThreadDetails**](https://github.com/pipedrive/client-nodejs/blob/master/docs/MailboxApi.md#updateMailThreadDetails) | **PUT** /mailbox/mailThreads/{id} | Update mail thread details
+*Pipedrive.MeetingsApi* | [**deleteUserProviderLink**](https://github.com/pipedrive/client-nodejs/blob/master/docs/MeetingsApi.md#deleteUserProviderLink) | **DELETE** /meetings/userProviderLinks/{id} | Delete the link between a user and the installed video call integration
+*Pipedrive.MeetingsApi* | [**saveUserProviderLink**](https://github.com/pipedrive/client-nodejs/blob/master/docs/MeetingsApi.md#saveUserProviderLink) | **POST** /meetings/userProviderLinks | Link a user with the installed video call integration
 *Pipedrive.NoteFieldsApi* | [**getNoteFields**](https://github.com/pipedrive/client-nodejs/blob/master/docs/NoteFieldsApi.md#getNoteFields) | **GET** /noteFields | Get all note fields
 *Pipedrive.NotesApi* | [**addNote**](https://github.com/pipedrive/client-nodejs/blob/master/docs/NotesApi.md#addNote) | **POST** /notes | Add a note
 *Pipedrive.NotesApi* | [**addNoteComment**](https://github.com/pipedrive/client-nodejs/blob/master/docs/NotesApi.md#addNoteComment) | **POST** /notes/{id}/comments | Add a comment to a note
@@ -933,6 +935,7 @@ Class | Method | HTTP request | Description
  - [Pipedrive.GetComments](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetComments.md)
  - [Pipedrive.GetDeal](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDeal.md)
  - [Pipedrive.GetDealAdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDealAdditionalData.md)
+ - [Pipedrive.GetDealRelatedObjects](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDealRelatedObjects.md)
  - [Pipedrive.GetDeals](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDeals.md)
  - [Pipedrive.GetDealsCollection](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDealsCollection.md)
  - [Pipedrive.GetDealsConversionRatesInPipeline](https://github.com/pipedrive/client-nodejs/blob/master/docs/GetDealsConversionRatesInPipeline.md)
@@ -1230,6 +1233,7 @@ Class | Method | HTTP request | Description
  - [Pipedrive.PipelineDetailsAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/PipelineDetailsAllOf.md)
  - [Pipedrive.PostComment](https://github.com/pipedrive/client-nodejs/blob/master/docs/PostComment.md)
  - [Pipedrive.PostDealParticipants](https://github.com/pipedrive/client-nodejs/blob/master/docs/PostDealParticipants.md)
+ - [Pipedrive.PostDealParticipantsRelatedObjects](https://github.com/pipedrive/client-nodejs/blob/master/docs/PostDealParticipantsRelatedObjects.md)
  - [Pipedrive.PostGoalResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/PostGoalResponse.md)
  - [Pipedrive.PostNote](https://github.com/pipedrive/client-nodejs/blob/master/docs/PostNote.md)
  - [Pipedrive.PostRoleAssignment](https://github.com/pipedrive/client-nodejs/blob/master/docs/PostRoleAssignment.md)
@@ -1391,6 +1395,10 @@ Class | Method | HTTP request | Description
  - [Pipedrive.UserPermissions](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserPermissions.md)
  - [Pipedrive.UserPermissionsAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserPermissionsAllOf.md)
  - [Pipedrive.UserPermissionsItem](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserPermissionsItem.md)
+ - [Pipedrive.UserProviderLinkCreateRequest](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserProviderLinkCreateRequest.md)
+ - [Pipedrive.UserProviderLinkErrorResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserProviderLinkErrorResponse.md)
+ - [Pipedrive.UserProviderLinkSuccessResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserProviderLinkSuccessResponse.md)
+ - [Pipedrive.UserProviderLinkSuccessResponseData](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserProviderLinkSuccessResponseData.md)
  - [Pipedrive.UserSettings](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserSettings.md)
  - [Pipedrive.UserSettingsAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserSettingsAllOf.md)
  - [Pipedrive.UserSettingsItem](https://github.com/pipedrive/client-nodejs/blob/master/docs/UserSettingsItem.md)

docs/CallLogObject.md

@@ -15,7 +15,8 @@ Name | Type | Description | Notes
 **endTime** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | 
 **personId** | **Number** | The ID of the person this call is associated with | [optional] 
 **orgId** | **Number** | The ID of the organization this call is associated with | [optional] 
-**dealId** | **Number** | The ID of the deal this call is associated with | [optional] 
+**dealId** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] 
+**leadId** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] 
 **note** | **String** | The note for the call log in HTML format | [optional] 
 
 

docs/DealsApi.md

@@ -1081,7 +1081,7 @@ let opts = {
   'start': 0, // Number | Pagination start
   'limit': 56, // Number | Items shown per page
   'allChanges': "allChanges_example", // String | Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
-  'items': "items_example" // String | 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)
+  'items': "items_example" // String | 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).
 };
 apiInstance.getDealUpdates(id, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -1100,7 +1100,7 @@ Name | Type | Description  | Notes
  **start** | **Number**| Pagination start | [optional] [default to 0]
  **limit** | **Number**| Items shown per page | [optional] 
  **allChanges** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates. | [optional] 
- **items** | **String**| 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) | [optional] 
+ **items** | **String**| 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). | [optional] 
 
 ### Return type
 
@@ -1134,6 +1134,9 @@ let api_key = apiClient.authentications['api_key'];
 api_key.apiKey = 'YOUR API KEY';
 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
 //api_key.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: oauth2
+let oauth2 = apiClient.authentications['oauth2'];
+oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Pipedrive.DealsApi(apiClient);
 let id = 56; // Number | The ID of the deal
@@ -1158,7 +1161,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 
@@ -1326,7 +1329,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Pipedrive.DealsApi(apiClient);
 let opts = {
-  'status': "status_example", // String | Only fetch deals with a specific status. open = Open, won = Won, lost = Lost
+  'status': "status_example", // String | Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
   'filterId': 56, // Number | <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
   'userId': 56, // Number | Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
   'stageId': 56 // Number | Only deals within the given stage will be returned
@@ -1344,7 +1347,7 @@ apiInstance.getDealsSummary(opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **status** | **String**| Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost | [optional] 
+ **status** | **String**| Only fetch deals with a specific status. open &#x3D; Open, won &#x3D; Won, lost &#x3D; Lost. | [optional] 
  **filterId** | **Number**| &lt;code&gt;user_id&lt;/code&gt; will not be considered. Only deals matching the given filter will be returned. | [optional] 
  **userId** | **Number**| Only deals matching the given user will be returned. &#x60;user_id&#x60; will not be considered if you use &#x60;filter_id&#x60;. | [optional] 
  **stageId** | **Number**| Only deals within the given stage will be returned | [optional] 
@@ -1386,7 +1389,7 @@ let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Pipedrive.DealsApi(apiClient);
-let startDate = new Date("2013-10-20"); // Date | The date when the first interval starts. Format: YYYY-MM-DD
+let startDate = new Date("2013-10-20"); // Date | The date when the first interval starts. Format: YYYY-MM-DD.
 let interval = "interval_example"; // String | The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
 let amount = 56; // Number | The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
 let fieldKey = "fieldKey_example"; // String | The date field key which deals will be retrieved from
@@ -1410,7 +1413,7 @@ apiInstance.getDealsTimeline(startDate, interval, amount, fieldKey, opts).then((
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **startDate** | **Date**| The date when the first interval starts. Format: YYYY-MM-DD | 
+ **startDate** | **Date**| The date when the first interval starts. Format: YYYY-MM-DD. | 
  **interval** | **String**| The type of the interval&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;day&#x60;&lt;/td&gt;&lt;td&gt;Day&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;week&#x60;&lt;/td&gt;&lt;td&gt;A full week (7 days) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;month&#x60;&lt;/td&gt;&lt;td&gt;A full month (depending on the number of days in given month) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;quarter&#x60;&lt;/td&gt;&lt;td&gt;A full quarter (3 months) starting from &#x60;start_date&#x60;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt; | 
  **amount** | **Number**| The number of given intervals, starting from &#x60;start_date&#x60;, to fetch. E.g. 3 (months). | 
  **fieldKey** | **String**| The date field key which deals will be retrieved from | 
@@ -1637,6 +1640,9 @@ let api_key = apiClient.authentications['api_key'];
 api_key.apiKey = 'YOUR API KEY';
 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
 //api_key.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: oauth2
+let oauth2 = apiClient.authentications['oauth2'];
+oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Pipedrive.DealsApi(apiClient);
 let id = 56; // Number | The ID of the deal
@@ -1667,7 +1673,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 

docs/FiltersApi.md

@@ -246,6 +246,9 @@ let api_key = apiClient.authentications['api_key'];
 api_key.apiKey = 'YOUR API KEY';
 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
 //api_key.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: oauth2
+let oauth2 = apiClient.authentications['oauth2'];
+oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Pipedrive.FiltersApi(apiClient);
 apiInstance.getFilterHelpers().then((data) => {
@@ -266,7 +269,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 

docs/GetDeal.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **success** | **Boolean** | If the response is successful or not | [optional] 
 **data** | [**DealNonStrictWithDetails**](DealNonStrictWithDetails.md) |  | [optional] 
 **additionalData** | [**GetDealAdditionalData**](GetDealAdditionalData.md) |  | [optional] 
-**relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) |  | [optional] 
+**relatedObjects** | [**GetDealRelatedObjects**](GetDealRelatedObjects.md) |  | [optional] 
 
 

docs/GetDealRelatedObjects.md

@@ -0,0 +1,11 @@
+# Pipedrive.GetDealRelatedObjects
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**RelatedUserData**](RelatedUserData.md) |  | [optional] 
+**person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) |  | [optional] 
+**organization** | [**RelatedOrganizationDataWithActiveFlag**](RelatedOrganizationDataWithActiveFlag.md) |  | [optional] 
+
+

docs/GetDealsRelatedObjects.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**user** | [**DealUserData**](DealUserData.md) |  | [optional] 
-**organization** | [**DealOrganizationData**](DealOrganizationData.md) |  | [optional] 
-**person** | [**DealPersonData**](DealPersonData.md) |  | [optional] 
+**user** | [**RelatedUserData**](RelatedUserData.md) |  | [optional] 
+**organization** | [**RelatedOrganizationDataWithActiveFlag**](RelatedOrganizationDataWithActiveFlag.md) |  | [optional] 
+**person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) |  | [optional]