Skip to content

Commit b159c88

Browse files
siirimangussiirimangus
authored
Merge pull request #111 from pipedrive/2252
Build 2252 - version-minor
2 parents 6bdab4b + 0658dfc commit b159c88

11 files changed

+1708
-0
lines changed

‎.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ docs/Model/DealOrganizationDataWithId.md
211211
docs/Model/DealOrganizationDataWithIdAllOf.md
212212
docs/Model/DealParticipantCountInfo.md
213213
docs/Model/DealParticipants.md
214+
docs/Model/DealParticipantsChangelog.md
214215
docs/Model/DealPersonData.md
215216
docs/Model/DealPersonDataEmail.md
216217
docs/Model/DealPersonDataPhone.md
@@ -616,6 +617,8 @@ docs/Model/OwnerAllOf.md
616617
docs/Model/PaginationDetails.md
617618
docs/Model/PaginationDetailsAllOf.md
618619
docs/Model/Params.md
620+
docs/Model/ParticipantsChangelog.md
621+
docs/Model/ParticipantsChangelogItem.md
619622
docs/Model/PaymentItem.md
620623
docs/Model/PaymentsResponse.md
621624
docs/Model/PaymentsResponseAllOf.md
@@ -1052,6 +1055,7 @@ lib/Model/DealOrganizationDataWithId.php
10521055
lib/Model/DealOrganizationDataWithIdAllOf.php
10531056
lib/Model/DealParticipantCountInfo.php
10541057
lib/Model/DealParticipants.php
1058+
lib/Model/DealParticipantsChangelog.php
10551059
lib/Model/DealPersonData.php
10561060
lib/Model/DealPersonDataEmail.php
10571061
lib/Model/DealPersonDataPhone.php
@@ -1458,6 +1462,8 @@ lib/Model/OwnerAllOf.php
14581462
lib/Model/PaginationDetails.php
14591463
lib/Model/PaginationDetailsAllOf.php
14601464
lib/Model/Params.php
1465+
lib/Model/ParticipantsChangelog.php
1466+
lib/Model/ParticipantsChangelogItem.php
14611467
lib/Model/PaymentItem.php
14621468
lib/Model/PaymentsResponse.php
14631469
lib/Model/PaymentsResponseAllOf.php

‎CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
66

77
## [Unreleased]
88

9+
## [6.6.0](https://github.com/pipedrive/client-php/compare/6.5.1...6.6.0) (2024-04-02)
10+
11+
### Added
12+
- Documentation for new endpoint `/deals/{id}/participantsChangelog`
13+
914
## [6.5.1](https://github.com/pipedrive/client-php/compare/6.5.0...6.5.1) (2024-04-02)
1015

1116
### Added

‎README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,7 @@ Class | Method | HTTP request | Description
349349
*DealsApi* | [**getDealFollowers**](docs/Api/DealsApi.md#getdealfollowers) | **GET** /deals/{id}/followers | List followers of a deal
350350
*DealsApi* | [**getDealMailMessages**](docs/Api/DealsApi.md#getdealmailmessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
351351
*DealsApi* | [**getDealParticipants**](docs/Api/DealsApi.md#getdealparticipants) | **GET** /deals/{id}/participants | List participants of a deal
352+
*DealsApi* | [**getDealParticipantsChangelog**](docs/Api/DealsApi.md#getdealparticipantschangelog) | **GET** /deals/{id}/participantsChangelog | List updates about participants of a deal
352353
*DealsApi* | [**getDealPersons**](docs/Api/DealsApi.md#getdealpersons) | **GET** /deals/{id}/persons | List all persons associated with a deal
353354
*DealsApi* | [**getDealProducts**](docs/Api/DealsApi.md#getdealproducts) | **GET** /deals/{id}/products | List products attached to a deal
354355
*DealsApi* | [**getDealUpdates**](docs/Api/DealsApi.md#getdealupdates) | **GET** /deals/{id}/flow | List updates about a deal
@@ -745,6 +746,7 @@ Class | Method | HTTP request | Description
745746
- [DealOrganizationDataWithIdAllOf](docs/Model/DealOrganizationDataWithIdAllOf.md)
746747
- [DealParticipantCountInfo](docs/Model/DealParticipantCountInfo.md)
747748
- [DealParticipants](docs/Model/DealParticipants.md)
749+
- [DealParticipantsChangelog](docs/Model/DealParticipantsChangelog.md)
748750
- [DealPersonData](docs/Model/DealPersonData.md)
749751
- [DealPersonDataEmail](docs/Model/DealPersonDataEmail.md)
750752
- [DealPersonDataPhone](docs/Model/DealPersonDataPhone.md)
@@ -1150,6 +1152,8 @@ Class | Method | HTTP request | Description
11501152
- [PaginationDetails](docs/Model/PaginationDetails.md)
11511153
- [PaginationDetailsAllOf](docs/Model/PaginationDetailsAllOf.md)
11521154
- [Params](docs/Model/Params.md)
1155+
- [ParticipantsChangelog](docs/Model/ParticipantsChangelog.md)
1156+
- [ParticipantsChangelogItem](docs/Model/ParticipantsChangelogItem.md)
11531157
- [PaymentItem](docs/Model/PaymentItem.md)
11541158
- [PaymentsResponse](docs/Model/PaymentsResponse.md)
11551159
- [PaymentsResponseAllOf](docs/Model/PaymentsResponseAllOf.md)

‎docs/Api/DealsApi.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Method | HTTP request | Description
2020
[**getDealFollowers()**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
2121
[**getDealMailMessages()**](DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
2222
[**getDealParticipants()**](DealsApi.md#getDealParticipants) | **GET** /deals/{id}/participants | List participants of a deal
23+
[**getDealParticipantsChangelog()**](DealsApi.md#getDealParticipantsChangelog) | **GET** /deals/{id}/participantsChangelog | List updates about participants of a deal
2324
[**getDealPersons()**](DealsApi.md#getDealPersons) | **GET** /deals/{id}/persons | List all persons associated with a deal
2425
[**getDealProducts()**](DealsApi.md#getDealProducts) | **GET** /deals/{id}/products | List products attached to a deal
2526
[**getDealUpdates()**](DealsApi.md#getDealUpdates) | **GET** /deals/{id}/flow | List updates about a deal
@@ -1108,6 +1109,75 @@ Name | Type | Description | Notes
11081109
[[Back to Model list]](../../README.md#models)
11091110
[[Back to README]](../../README.md)
11101111

1112+
## `getDealParticipantsChangelog()`
1113+
1114+
```php
1115+
getDealParticipantsChangelog($id, $limit, $cursor): \Pipedrive\Model\ParticipantsChangelog
1116+
```
1117+
1118+
List updates about participants of a deal
1119+
1120+
List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
1121+
1122+
### Example
1123+
1124+
```php
1125+
<?php
1126+
require_once(__DIR__ . '/vendor/autoload.php');
1127+
1128+
1129+
// Configure API key authorization: api_key
1130+
$config = (new Pipedrive\Configuration())->setApiKey('api_token', 'YOUR_API_KEY');
1131+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1132+
// $config = (new Pipedrive\Configuration())->setApiKeyPrefix('api_token', 'Bearer');
1133+
1134+
// Configure OAuth2 access token for authorization: oauth2
1135+
$config = (new Pipedrive\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
1136+
1137+
1138+
$apiInstance = new Pipedrive\Api\DealsApi(
1139+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
1140+
// This is optional, `GuzzleHttp\Client` will be used as default.
1141+
new GuzzleHttp\Client(),
1142+
$config
1143+
);
1144+
$id = 56; // int | The ID of the deal
1145+
$limit = 56; // int | Items shown per page
1146+
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
1147+
1148+
try {
1149+
$result = $apiInstance->getDealParticipantsChangelog($id, $limit, $cursor);
1150+
print_r($result);
1151+
} catch (Exception $e) {
1152+
echo 'Exception when calling DealsApi->getDealParticipantsChangelog: ', $e->getMessage(), PHP_EOL;
1153+
}
1154+
```
1155+
1156+
### Parameters
1157+
1158+
Name | Type | Description | Notes
1159+
------------- | ------------- | ------------- | -------------
1160+
**id** | **int**| The ID of the deal |
1161+
**limit** | **int**| Items shown per page | [optional]
1162+
**cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
1163+
1164+
### Return type
1165+
1166+
[**\Pipedrive\Model\ParticipantsChangelog**](../Model/ParticipantsChangelog.md)
1167+
1168+
### Authorization
1169+
1170+
[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2)
1171+
1172+
### HTTP request headers
1173+
1174+
- **Content-Type**: Not defined
1175+
- **Accept**: `application/json`
1176+
1177+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
1178+
[[Back to Model list]](../../README.md#models)
1179+
[[Back to README]](../../README.md)
1180+
11111181
## `getDealPersons()`
11121182

11131183
```php

‎docs/Model/DealParticipantsChangelog.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # DealParticipantsChangelog
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**actor_user_id** | **int** | The ID of the user | [optional]
8+
**person_id** | **int** | The ID of the person | [optional]
9+
**action** | **string** | Deal participant action type | [optional]
10+
**time** | **string** | The deal participant action log time | [optional]
11+
12+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/ParticipantsChangelog.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# # ParticipantsChangelog
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**success** | **bool** | If the request was successful or not | [optional]
8+
**data** | [**\Pipedrive\Model\ParticipantsChangelogItem[]**](ParticipantsChangelogItem.md) | The array of participant changelog | [optional]
9+
**additional_data** | [**\Pipedrive\Model\AdditionalData**](AdditionalData.md) | | [optional]
10+
11+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

‎docs/Model/ParticipantsChangelogItem.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# # ParticipantsChangelogItem
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**actor_user_id** | **int** | The ID of the user | [optional]
8+
**person_id** | **int** | The ID of the person | [optional]
9+
**action** | **string** | Deal participant action type | [optional]
10+
**time** | **string** | The deal participant action log time | [optional]
11+
12+
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

0 commit comments

Comments
 (0)