Build 2333 - version-minor

.openapi-generator/FILES

@@ -181,6 +181,9 @@ docs/Model/CallLogResponse410.md
 docs/Model/CallLogResponse500.md
 docs/Model/CallLogsResponse.md
 docs/Model/CallLogsResponseAdditionalData.md
+docs/Model/ChangelogResponse.md
+docs/Model/ChangelogResponseAllOf.md
+docs/Model/ChangelogResponseAllOfData.md
 docs/Model/ChannelObject.md
 docs/Model/ChannelObjectResponse.md
 docs/Model/ChannelObjectResponseData.md
@@ -1025,6 +1028,9 @@ lib/Model/CallLogResponse410.php
 lib/Model/CallLogResponse500.php
 lib/Model/CallLogsResponse.php
 lib/Model/CallLogsResponseAdditionalData.php
+lib/Model/ChangelogResponse.php
+lib/Model/ChangelogResponseAllOf.php
+lib/Model/ChangelogResponseAllOfData.php
 lib/Model/ChannelObject.php
 lib/Model/ChannelObjectResponse.php
 lib/Model/ChannelObjectResponseData.php

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Added documentation for new endpoints `/deals/{id}/changelog`, `/persons/{id}/changelog` and `/organizations/{id}/changelog`.
 
 ## [6.6.0](https://github.com/pipedrive/client-php/compare/6.5.1...6.6.0) (2024-04-02)
 

README.md

@@ -345,6 +345,7 @@ Class | Method | HTTP request | Description
 *DealsApi* | [**duplicateDeal**](docs/Api/DealsApi.md#duplicatedeal) | **POST** /deals/{id}/duplicate | Duplicate deal
 *DealsApi* | [**getDeal**](docs/Api/DealsApi.md#getdeal) | **GET** /deals/{id} | Get details of a deal
 *DealsApi* | [**getDealActivities**](docs/Api/DealsApi.md#getdealactivities) | **GET** /deals/{id}/activities | List activities associated with a deal
+*DealsApi* | [**getDealChangelog**](docs/Api/DealsApi.md#getdealchangelog) | **GET** /deals/{id}/changelog | List updates about deal field values
 *DealsApi* | [**getDealFiles**](docs/Api/DealsApi.md#getdealfiles) | **GET** /deals/{id}/files | List files attached to a deal
 *DealsApi* | [**getDealFollowers**](docs/Api/DealsApi.md#getdealfollowers) | **GET** /deals/{id}/followers | List followers of a deal
 *DealsApi* | [**getDealMailMessages**](docs/Api/DealsApi.md#getdealmailmessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
@@ -441,6 +442,7 @@ Class | Method | HTTP request | Description
 *OrganizationsApi* | [**deleteOrganizations**](docs/Api/OrganizationsApi.md#deleteorganizations) | **DELETE** /organizations | Delete multiple organizations in bulk
 *OrganizationsApi* | [**getOrganization**](docs/Api/OrganizationsApi.md#getorganization) | **GET** /organizations/{id} | Get details of an organization
 *OrganizationsApi* | [**getOrganizationActivities**](docs/Api/OrganizationsApi.md#getorganizationactivities) | **GET** /organizations/{id}/activities | List activities associated with an organization
+*OrganizationsApi* | [**getOrganizationChangelog**](docs/Api/OrganizationsApi.md#getorganizationchangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values
 *OrganizationsApi* | [**getOrganizationDeals**](docs/Api/OrganizationsApi.md#getorganizationdeals) | **GET** /organizations/{id}/deals | List deals associated with an organization
 *OrganizationsApi* | [**getOrganizationFiles**](docs/Api/OrganizationsApi.md#getorganizationfiles) | **GET** /organizations/{id}/files | List files attached to an organization
 *OrganizationsApi* | [**getOrganizationFollowers**](docs/Api/OrganizationsApi.md#getorganizationfollowers) | **GET** /organizations/{id}/followers | List followers of an organization
@@ -471,6 +473,7 @@ Class | Method | HTTP request | Description
 *PersonsApi* | [**deletePersons**](docs/Api/PersonsApi.md#deletepersons) | **DELETE** /persons | Delete multiple persons in bulk
 *PersonsApi* | [**getPerson**](docs/Api/PersonsApi.md#getperson) | **GET** /persons/{id} | Get details of a person
 *PersonsApi* | [**getPersonActivities**](docs/Api/PersonsApi.md#getpersonactivities) | **GET** /persons/{id}/activities | List activities associated with a person
+*PersonsApi* | [**getPersonChangelog**](docs/Api/PersonsApi.md#getpersonchangelog) | **GET** /persons/{id}/changelog | List updates about person field values
 *PersonsApi* | [**getPersonDeals**](docs/Api/PersonsApi.md#getpersondeals) | **GET** /persons/{id}/deals | List deals associated with a person
 *PersonsApi* | [**getPersonFiles**](docs/Api/PersonsApi.md#getpersonfiles) | **GET** /persons/{id}/files | List files attached to a person
 *PersonsApi* | [**getPersonFollowers**](docs/Api/PersonsApi.md#getpersonfollowers) | **GET** /persons/{id}/followers | List followers of a person
@@ -716,6 +719,9 @@ Class | Method | HTTP request | Description
  - [CallLogResponse500](docs/Model/CallLogResponse500.md)
  - [CallLogsResponse](docs/Model/CallLogsResponse.md)
  - [CallLogsResponseAdditionalData](docs/Model/CallLogsResponseAdditionalData.md)
+ - [ChangelogResponse](docs/Model/ChangelogResponse.md)
+ - [ChangelogResponseAllOf](docs/Model/ChangelogResponseAllOf.md)
+ - [ChangelogResponseAllOfData](docs/Model/ChangelogResponseAllOfData.md)
  - [ChannelObject](docs/Model/ChannelObject.md)
  - [ChannelObjectResponse](docs/Model/ChannelObjectResponse.md)
  - [ChannelObjectResponseData](docs/Model/ChannelObjectResponseData.md)

docs/Api/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
@@ -835,6 +836,75 @@ Name | Type | Description  | Notes
 [[Back to Model list]](../../README.md#models)
 [[Back to README]](../../README.md)
 
+## `getDealChangelog()`
+
+```php
+getDealChangelog($id, $cursor, $limit): \Pipedrive\Model\ChangelogResponse
+```
+
+List updates about deal field values
+
+Lists updates about field values of a deal.
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure API key authorization: api_key
+$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
+
+// Configure OAuth2 access token for authorization: oauth2
+$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Pipedrive\Api\DealsApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$id = 56; // int | The ID of the deal
+$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
+$limit = 56; // int | Items shown per page
+
+try {
+    $result = $apiInstance->getDealChangelog($id, $cursor, $limit);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DealsApi->getDealChangelog: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| 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** | **int**| Items shown per page | [optional]
+
+### Return type
+
+[**\Pipedrive\Model\ChangelogResponse**](../Model/ChangelogResponse.md)
+
+### Authorization
+
+[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
 ## `getDealFiles()`
 
 ```php

docs/Api/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
@@ -492,6 +493,75 @@ Name | Type | Description  | Notes
 [[Back to Model list]](../../README.md#models)
 [[Back to README]](../../README.md)
 
+## `getOrganizationChangelog()`
+
+```php
+getOrganizationChangelog($id, $cursor, $limit): \Pipedrive\Model\ChangelogResponse
+```
+
+List updates about organization field values
+
+Lists updates about field values of an organization.
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure API key authorization: api_key
+$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
+
+// Configure OAuth2 access token for authorization: oauth2
+$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Pipedrive\Api\OrganizationsApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$id = 56; // int | The ID of the organization
+$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
+$limit = 56; // int | Items shown per page
+
+try {
+    $result = $apiInstance->getOrganizationChangelog($id, $cursor, $limit);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling OrganizationsApi->getOrganizationChangelog: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| 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** | **int**| Items shown per page | [optional]
+
+### Return type
+
+[**\Pipedrive\Model\ChangelogResponse**](../Model/ChangelogResponse.md)
+
+### Authorization
+
+[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
 ## `getOrganizationDeals()`
 
 ```php

docs/Api/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
@@ -634,6 +635,75 @@ Name | Type | Description  | Notes
 [[Back to Model list]](../../README.md#models)
 [[Back to README]](../../README.md)
 
+## `getPersonChangelog()`
+
+```php
+getPersonChangelog($id, $cursor, $limit): \Pipedrive\Model\ChangelogResponse
+```
+
+List updates about person field values
+
+Lists updates about field values of a person.
+
+### Example
+
+```php
+<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+
+// Configure API key authorization: api_key
+$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
+
+// Configure OAuth2 access token for authorization: oauth2
+$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
+
+
+$apiInstance = new Pipedrive\Api\PersonsApi(
+    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
+    // This is optional, `GuzzleHttp\Client` will be used as default.
+    new GuzzleHttp\Client(),
+    $config
+);
+$id = 56; // int | The ID of the person
+$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
+$limit = 56; // int | Items shown per page
+
+try {
+    $result = $apiInstance->getPersonChangelog($id, $cursor, $limit);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling PersonsApi->getPersonChangelog: ', $e->getMessage(), PHP_EOL;
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| 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** | **int**| Items shown per page | [optional]
+
+### Return type
+
+[**\Pipedrive\Model\ChangelogResponse**](../Model/ChangelogResponse.md)
+
+### Authorization
+
+[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
 ## `getPersonDeals()`
 
 ```php

docs/Model/ActivityTypeObjectResponse.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **key_string** | **string** | A string that is generated by the API based on the given name of the activity type upon creation | [optional]
 **active_flag** | **bool** | The active flag of the activity type | [optional]
 **is_custom_flag** | **bool** | Whether the activity type is a custom one or not | [optional]
-**add_time** | **string** | The creation time of the activity type | [optional]
-**update_time** | **string** | The update time of the activity type | [optional]
+**add_time** | **\DateTime** | The creation time of the activity type | [optional]
+**update_time** | **\DateTime** | The update time of the activity type | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/ChangelogResponse.md

@@ -0,0 +1,11 @@
+# # ChangelogResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **bool** | If the response is successful or not | [optional]
+**data** | [**\Pipedrive\Model\ChangelogResponseAllOfData[]**](ChangelogResponseAllOfData.md) |  | [optional]
+**additional_data** | [**\Pipedrive\Model\AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/ChangelogResponseAllOf.md

@@ -0,0 +1,10 @@
+# # ChangelogResponseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Pipedrive\Model\ChangelogResponseAllOfData[]**](ChangelogResponseAllOfData.md) |  | [optional]
+**additional_data** | [**\Pipedrive\Model\AdditionalDataWithCursorPagination**](AdditionalDataWithCursorPagination.md) |  | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/ChangelogResponseAllOfData.md

@@ -0,0 +1,16 @@
+# # ChangelogResponseAllOfData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_key** | **string** | The key of the field that was changed | [optional]
+**old_value** | **string** | The value of the field before the change | [optional]
+**new_value** | **string** | The value of the field after the change | [optional]
+**actor_user_id** | **int** | The ID of the user who made the change | [optional]
+**time** | **string** | The date and time of the change | [optional]
+**change_source** | **string** | The source of change, for example 'app', 'mobile', 'api', etc. | [optional]
+**change_source_user_agent** | **string** | The user agent from which the change was made | [optional]
+**is_bulk_update_flag** | **bool** | Whether the change was made as part of a bulk update | [optional]
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/Field.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **name** | **string** | The name of the field | [optional]
 **order_nr** | **int** | The order number of the field | [optional]
 **field_type** | [**FieldTypeAsString**](FieldTypeAsString.md) |  | [optional]
-**add_time** | **string** | The creation time of the field | [optional]
-**update_time** | **string** | The update time of the field | [optional]
+**add_time** | **\DateTime** | The creation time of the field | [optional]
+**update_time** | **\DateTime** | The update time of the field | [optional]
 **last_updated_by_user_id** | **int** | The ID of the user who created or most recently updated the field, only applicable for custom fields | [optional]
 **active_flag** | **bool** | The active flag of the field | [optional]
 **edit_flag** | **bool** | The edit flag of the field | [optional]