Build 2333 - version-minor

CHANGELOG.md

@@ -7,6 +7,8 @@ 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]
+### Added
+- Added documentation for new endpoints `/deals/{id}/changelog`, `/persons/{id}/changelog` and `/organizations/{id}/changelog`.
 
 ## [22.5.0] - 2024-02-02
 ### Added

README.md

@@ -391,6 +391,7 @@ Class | Method | HTTP request | Description
 *Pipedrive.DealsApi* | [**duplicateDeal**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#duplicateDeal) | **POST** /deals/{id}/duplicate | Duplicate deal
 *Pipedrive.DealsApi* | [**getDeal**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDeal) | **GET** /deals/{id} | Get details of a deal
 *Pipedrive.DealsApi* | [**getDealActivities**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealActivities) | **GET** /deals/{id}/activities | List activities associated with a deal
+*Pipedrive.DealsApi* | [**getDealChangelog**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealChangelog) | **GET** /deals/{id}/changelog | List updates about deal field values
 *Pipedrive.DealsApi* | [**getDealFiles**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealFiles) | **GET** /deals/{id}/files | List files attached to a deal
 *Pipedrive.DealsApi* | [**getDealFollowers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
 *Pipedrive.DealsApi* | [**getDealMailMessages**](https://github.com/pipedrive/client-nodejs/blob/master/docs/DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
@@ -487,6 +488,7 @@ Class | Method | HTTP request | Description
 *Pipedrive.OrganizationsApi* | [**deleteOrganizations**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#deleteOrganizations) | **DELETE** /organizations | Delete multiple organizations in bulk
 *Pipedrive.OrganizationsApi* | [**getOrganization**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganization) | **GET** /organizations/{id} | Get details of an organization
 *Pipedrive.OrganizationsApi* | [**getOrganizationActivities**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationActivities) | **GET** /organizations/{id}/activities | List activities associated with an organization
+*Pipedrive.OrganizationsApi* | [**getOrganizationChangelog**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationChangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values
 *Pipedrive.OrganizationsApi* | [**getOrganizationDeals**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationDeals) | **GET** /organizations/{id}/deals | List deals associated with an organization
 *Pipedrive.OrganizationsApi* | [**getOrganizationFiles**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationFiles) | **GET** /organizations/{id}/files | List files attached to an organization
 *Pipedrive.OrganizationsApi* | [**getOrganizationFollowers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/OrganizationsApi.md#getOrganizationFollowers) | **GET** /organizations/{id}/followers | List followers of an organization
@@ -517,6 +519,7 @@ Class | Method | HTTP request | Description
 *Pipedrive.PersonsApi* | [**deletePersons**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#deletePersons) | **DELETE** /persons | Delete multiple persons in bulk
 *Pipedrive.PersonsApi* | [**getPerson**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPerson) | **GET** /persons/{id} | Get details of a person
 *Pipedrive.PersonsApi* | [**getPersonActivities**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonActivities) | **GET** /persons/{id}/activities | List activities associated with a person
+*Pipedrive.PersonsApi* | [**getPersonChangelog**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonChangelog) | **GET** /persons/{id}/changelog | List updates about person field values
 *Pipedrive.PersonsApi* | [**getPersonDeals**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonDeals) | **GET** /persons/{id}/deals | List deals associated with a person
 *Pipedrive.PersonsApi* | [**getPersonFiles**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonFiles) | **GET** /persons/{id}/files | List files attached to a person
 *Pipedrive.PersonsApi* | [**getPersonFollowers**](https://github.com/pipedrive/client-nodejs/blob/master/docs/PersonsApi.md#getPersonFollowers) | **GET** /persons/{id}/followers | List followers of a person
@@ -762,6 +765,9 @@ Class | Method | HTTP request | Description
  - [Pipedrive.CallLogResponse500](https://github.com/pipedrive/client-nodejs/blob/master/docs/CallLogResponse500.md)
  - [Pipedrive.CallLogsResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/CallLogsResponse.md)
  - [Pipedrive.CallLogsResponseAdditionalData](https://github.com/pipedrive/client-nodejs/blob/master/docs/CallLogsResponseAdditionalData.md)
+ - [Pipedrive.ChangelogResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChangelogResponse.md)
+ - [Pipedrive.ChangelogResponseAllOf](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChangelogResponseAllOf.md)
+ - [Pipedrive.ChangelogResponseAllOfData](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChangelogResponseAllOfData.md)
  - [Pipedrive.ChannelObject](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChannelObject.md)
  - [Pipedrive.ChannelObjectResponse](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChannelObjectResponse.md)
  - [Pipedrive.ChannelObjectResponseData](https://github.com/pipedrive/client-nodejs/blob/master/docs/ChannelObjectResponseData.md)

docs/ActivityTypeObjectResponse.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **keyString** | **String** | A string that is generated by the API based on the given name of the activity type upon creation | [optional] 
 **activeFlag** | **Boolean** | The active flag of the activity type | [optional] 
 **isCustomFlag** | **Boolean** | Whether the activity type is a custom one or not | [optional] 
-**addTime** | **String** | The creation time of the activity type | [optional] 
-**updateTime** | **String** | The update time of the activity type | [optional] 
+**addTime** | **Date** | The creation time of the activity type | [optional] 
+**updateTime** | **Date** | The update time of the activity type | [optional] 
 
 

docs/ChangelogResponse.md

@@ -0,0 +1,11 @@
+# Pipedrive.ChangelogResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** | If the response is successful or not | [optional] 
+**data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) |  | [optional] 
+**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) |  | [optional] 
+
+

docs/ChangelogResponseAllOf.md

@@ -0,0 +1,10 @@
+# Pipedrive.ChangelogResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[ChangelogResponseAllOfData]**](ChangelogResponseAllOfData.md) |  | [optional] 
+**additionalData** | [**AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) |  | [optional] 
+
+

docs/ChangelogResponseAllOfData.md

@@ -0,0 +1,16 @@
+# Pipedrive.ChangelogResponseAllOfData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fieldKey** | **String** | The key of the field that was changed | [optional] 
+**oldValue** | **String** | The value of the field before the change | [optional] 
+**newValue** | **String** | The value of the field after the change | [optional] 
+**actorUserId** | **Number** | The ID of the user who made the change | [optional] 
+**time** | **String** | The date and time of the change | [optional] 
+**changeSource** | **String** | The source of change, for example 'app', 'mobile', 'api', etc. | [optional] 
+**changeSourceUserAgent** | **String** | The user agent from which the change was made | [optional] 
+**isBulkUpdateFlag** | **Boolean** | Whether the change was made as part of a bulk update | [optional] 
+
+

docs/DealsApi.md

@@ -16,6 +16,7 @@ Method | HTTP request | Description
 [**duplicateDeal**](DealsApi.md#duplicateDeal) | **POST** /deals/{id}/duplicate | Duplicate deal
 [**getDeal**](DealsApi.md#getDeal) | **GET** /deals/{id} | Get details of a deal
 [**getDealActivities**](DealsApi.md#getDealActivities) | **GET** /deals/{id}/activities | List activities associated with a deal
+[**getDealChangelog**](DealsApi.md#getDealChangelog) | **GET** /deals/{id}/changelog | List updates about deal field values
 [**getDealFiles**](DealsApi.md#getDealFiles) | **GET** /deals/{id}/files | List files attached to a deal
 [**getDealFollowers**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
 [**getDealMailMessages**](DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
@@ -702,6 +703,65 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getDealChangelog
+
+> ChangelogResponse getDealChangelog(id, opts)
+
+List updates about deal field values
+
+Lists updates about field values of a deal.
+
+### Example
+
+```javascript
+import Pipedrive from 'pipedrive';
+let apiClient = new Pipedrive.ApiClient();
+// Configure API key authorization: api_key
+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
+let opts = {
+  'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
+  'limit': 56 // Number | Items shown per page
+};
+apiInstance.getDealChangelog(id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Number**| The ID of the deal | 
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] 
+ **limit** | **Number**| Items shown per page | [optional] 
+
+### Return type
+
+[**ChangelogResponse**](ChangelogResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## getDealFiles
 
 > ListFilesResponse getDealFiles(id, opts)

docs/Field.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **name** | **String** | The name of the field | [optional] 
 **orderNr** | **Number** | The order number of the field | [optional] 
 **fieldType** | [**FieldTypeAsString**](FieldTypeAsString.md) |  | [optional] 
-**addTime** | **String** | The creation time of the field | [optional] 
-**updateTime** | **String** | The update time of the field | [optional] 
+**addTime** | **Date** | The creation time of the field | [optional] 
+**updateTime** | **Date** | The update time of the field | [optional] 
 **lastUpdatedByUserId** | **Number** | The ID of the user who created or most recently updated the field, only applicable for custom fields | [optional] 
 **activeFlag** | **Boolean** | The active flag of the field | [optional] 
 **editFlag** | **Boolean** | The edit flag of the field | [optional] 

docs/OrganizationsApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**deleteOrganizations**](OrganizationsApi.md#deleteOrganizations) | **DELETE** /organizations | Delete multiple organizations in bulk
 [**getOrganization**](OrganizationsApi.md#getOrganization) | **GET** /organizations/{id} | Get details of an organization
 [**getOrganizationActivities**](OrganizationsApi.md#getOrganizationActivities) | **GET** /organizations/{id}/activities | List activities associated with an organization
+[**getOrganizationChangelog**](OrganizationsApi.md#getOrganizationChangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values
 [**getOrganizationDeals**](OrganizationsApi.md#getOrganizationDeals) | **GET** /organizations/{id}/deals | List deals associated with an organization
 [**getOrganizationFiles**](OrganizationsApi.md#getOrganizationFiles) | **GET** /organizations/{id}/files | List files attached to an organization
 [**getOrganizationFollowers**](OrganizationsApi.md#getOrganizationFollowers) | **GET** /organizations/{id}/followers | List followers of an organization
@@ -415,6 +416,65 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getOrganizationChangelog
+
+> ChangelogResponse getOrganizationChangelog(id, opts)
+
+List updates about organization field values
+
+Lists updates about field values of an organization.
+
+### Example
+
+```javascript
+import Pipedrive from 'pipedrive';
+let apiClient = new Pipedrive.ApiClient();
+// Configure API key authorization: api_key
+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.OrganizationsApi(apiClient);
+let id = 56; // Number | The ID of the organization
+let opts = {
+  'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
+  'limit': 56 // Number | Items shown per page
+};
+apiInstance.getOrganizationChangelog(id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Number**| The ID of the organization | 
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] 
+ **limit** | **Number**| Items shown per page | [optional] 
+
+### Return type
+
+[**ChangelogResponse**](ChangelogResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## getOrganizationDeals
 
 > ListDealsResponse getOrganizationDeals(id, opts)

docs/PaymentItem.md

@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **revenueMovementType** | **String** | Represents the movement of revenue in comparison with the previous payment. Possible values are: `New` - first payment of the subscription. `Recurring` - no movement. `Expansion` - current payment amount > previous payment amount. `Contraction` - current payment amount < previous payment amount. `Churn` - last payment of the subscription. | [optional] 
 **paymentType** | **String** | The type of the payment. Possible values are: `Recurring` - payments occur over fixed intervals of time, `Additional` - extra payment not the recurring payment of the recurring subscription, `Installment` - payment of the installment subscription. | [optional] 
 **description** | **String** | The description of the payment | [optional] 
-**addTime** | **String** | The creation time of the payment | [optional] 
-**updateTime** | **String** | The update time of the payment | [optional] 
+**addTime** | **Date** | The creation time of the payment | [optional] 
+**updateTime** | **Date** | The update time of the payment | [optional] 
 
 
 

docs/PersonsApi.md

@@ -13,6 +13,7 @@ Method | HTTP request | Description
 [**deletePersons**](PersonsApi.md#deletePersons) | **DELETE** /persons | Delete multiple persons in bulk
 [**getPerson**](PersonsApi.md#getPerson) | **GET** /persons/{id} | Get details of a person
 [**getPersonActivities**](PersonsApi.md#getPersonActivities) | **GET** /persons/{id}/activities | List activities associated with a person
+[**getPersonChangelog**](PersonsApi.md#getPersonChangelog) | **GET** /persons/{id}/changelog | List updates about person field values
 [**getPersonDeals**](PersonsApi.md#getPersonDeals) | **GET** /persons/{id}/deals | List deals associated with a person
 [**getPersonFiles**](PersonsApi.md#getPersonFiles) | **GET** /persons/{id}/files | List files attached to a person
 [**getPersonFollowers**](PersonsApi.md#getPersonFollowers) | **GET** /persons/{id}/followers | List followers of a person
@@ -535,6 +536,65 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getPersonChangelog
+
+> ChangelogResponse getPersonChangelog(id, opts)
+
+List updates about person field values
+
+Lists updates about field values of a person.
+
+### Example
+
+```javascript
+import Pipedrive from 'pipedrive';
+let apiClient = new Pipedrive.ApiClient();
+// Configure API key authorization: api_key
+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.PersonsApi(apiClient);
+let id = 56; // Number | The ID of the person
+let opts = {
+  'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
+  'limit': 56 // Number | Items shown per page
+};
+apiInstance.getPersonChangelog(id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Number**| The ID of the person | 
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] 
+ **limit** | **Number**| Items shown per page | [optional] 
+
+### Return type
+
+[**ChangelogResponse**](ChangelogResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## getPersonDeals
 
 > ListDealsResponse getPersonDeals(id, opts)

docs/SubscriptionItem.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **endDate** | **Date** | The end date of the subscription | [optional] 
 **lifetimeValue** | **Number** | The total value of all payments | [optional] 
 **finalStatus** | **String** | The final status of the subscription | [optional] 
-**addTime** | **String** | The creation time of the subscription | [optional] 
-**updateTime** | **String** | The update time of the subscription | [optional] 
+**addTime** | **Date** | The creation time of the subscription | [optional] 
+**updateTime** | **Date** | The update time of the subscription | [optional]