Skip to content

Commit 3026981

Browse files
pipedrive-github-actions-bot[bot]pipedrive-botdmitriyeff
authored
Build 325 - version-major (#291)
* Build 319 - version-minor * Build 325 - version-major * Release v16.0.0 --------- Co-authored-by: pipedrive-bot <pipedrive-bot@pipedrive.com> Co-authored-by: Denis <deniss.dmitrijevs@pipedrive.com>
1 parent 760e589 commit 3026981

191 files changed

Lines changed: 52893 additions & 7957 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,92 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
66

77
## [Unreleased]
88
### Added
9+
- Added projects v2 API
10+
- Added project boards v2 API
11+
- Added project phases v2 API
12+
- Added project tasks v2 API
13+
- Added project search v2 API
14+
- Added project templates v2 API
15+
- Added project fields v2 API
16+
- Added `include_option_labels` parameter for v2 GET deal, person and organization endpoints
17+
- Added `include_labels` parameter to v2 GET deal, person, and organization endpoints
918
- Added `source_deal_id` field to Lead schema to track the deal ID when a lead is converted from a deal
10-
- Added `source_lead_id` field to v2 Deal schema to track the lead ID when a deal is converted from a lead
19+
- Added `source_lead_id` field to v2 Deal schema to track the lead ID when a lead is converted from a lead
1120
- Added `include_field_code` query parameter to Filters endpoints:
1221
- `GET /v1/filters/{id}`
1322
- `PUT /v1/filters/{id}`
1423
- `POST /v1/filters`
1524
- When set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name. The value is `null` if the field code cannot be resolved.
25+
- Added `assignee_ids` field to Tasks endpoints:
26+
- `GET /v1/tasks`
27+
- `GET /v1/tasks/{id}`
28+
- `POST /v1/tasks`
29+
- `PUT /v1/tasks/{id}`
30+
### Removed
31+
- Removed deprecated v1 endpoints that have v2 equivalents. See the [deprecation announcement](https://developers.pipedrive.com/changelog/post/deprecation-of-selected-api-v1-endpoints) for details. Please migrate to the corresponding v2 endpoints listed below:
32+
- `GET /v1/activities``GET /api/v2/activities`
33+
- `GET /v1/activities/collection``GET /api/v2/activities`
34+
- `GET /v1/activities/{id}``GET /api/v2/activities/{id}`
35+
- `POST /v1/activities``POST /api/v2/activities`
36+
- `PUT /v1/activities/{id}``PATCH /api/v2/activities/{id}`
37+
- `DELETE /v1/activities/{id}``DELETE /api/v2/activities/{id}`
38+
- `GET /v1/deals``GET /api/v2/deals`
39+
- `GET /v1/deals/collection``GET /api/v2/deals`
40+
- `GET /v1/deals/{id}``GET /api/v2/deals/{id}`
41+
- `GET /v1/deals/search``GET /api/v2/deals/search`
42+
- `POST /v1/deals``POST /api/v2/deals`
43+
- `PUT /v1/deals/{id}``PATCH /api/v2/deals/{id}`
44+
- `DELETE /v1/deals/{id}``DELETE /api/v2/deals/{id}`
45+
- `GET /v1/deals/{id}/activities``GET /api/v2/activities?deal_id={id}`
46+
- `GET /v1/deals/{id}/persons``GET /api/v2/persons?deal_id={id}`
47+
- `GET /v1/deals/{id}/products``GET /api/v2/deals/{id}/products`
48+
- `POST /v1/deals/{id}/products``POST /api/v2/deals/{id}/products`
49+
- `PUT /v1/deals/{id}/products/{product_attachment_id}``PATCH /api/v2/deals/{id}/products/{product_attachment_id}`
50+
- `DELETE /v1/deals/{id}/products/{product_attachment_id}``DELETE /api/v2/deals/{id}/products/{product_attachment_id}`
51+
- `GET /v1/itemSearch``GET /api/v2/itemSearch`
52+
- `GET /v1/itemSearch/field``GET /api/v2/itemSearch/field`
53+
- `GET /v1/organizations``GET /api/v2/organizations`
54+
- `GET /v1/organizations/collection``GET /api/v2/organizations`
55+
- `GET /v1/organizations/{id}``GET /api/v2/organizations/{id}`
56+
- `GET /v1/organizations/search``GET /api/v2/organizations/search`
57+
- `POST /v1/organizations``POST /api/v2/organizations`
58+
- `PUT /v1/organizations/{id}``PATCH /api/v2/organizations/{id}`
59+
- `DELETE /v1/organizations/{id}``DELETE /api/v2/organizations/{id}`
60+
- `GET /v1/organizations/{id}/deals``GET /api/v2/deals?org_id={id}`
61+
- `GET /v1/organizations/{id}/activities``GET /api/v2/activities?org_id={id}`
62+
- `GET /v1/organizations/{id}/persons``GET /api/v2/persons?org_id={id}`
63+
- `GET /v1/persons``GET /api/v2/persons`
64+
- `GET /v1/persons/collection``GET /api/v2/persons`
65+
- `GET /v1/persons/{id}``GET /api/v2/persons/{id}`
66+
- `GET /v1/persons/search``GET /api/v2/persons/search`
67+
- `POST /v1/persons``POST /api/v2/persons`
68+
- `PUT /v1/persons/{id}``PATCH /api/v2/persons/{id}`
69+
- `DELETE /v1/persons/{id}``DELETE /api/v2/persons/{id}`
70+
- `GET /v1/persons/{id}/deals``GET /api/v2/deals?person_id={id}`
71+
- `GET /v1/persons/{id}/activities``GET /api/v2/activities?person_id={id}`
72+
- `GET /v1/pipelines``GET /api/v2/pipelines`
73+
- `GET /v1/pipelines/{id}``GET /api/v2/pipelines/{id}`
74+
- `POST /v1/pipelines``POST /api/v2/pipelines`
75+
- `PUT /v1/pipelines/{id}``PATCH /api/v2/pipelines/{id}`
76+
- `DELETE /v1/pipelines/{id}``DELETE /api/v2/pipelines/{id}`
77+
- `GET /v1/products``GET /api/v2/products`
78+
- `GET /v1/products/{id}``GET /api/v2/products/{id}`
79+
- `GET /v1/products/search``GET /api/v2/products/search`
80+
- `POST /v1/products``POST /api/v2/products`
81+
- `PUT /v1/products/{id}``PATCH /api/v2/products/{id}`
82+
- `DELETE /v1/products/{id}``DELETE /api/v2/products/{id}`
83+
- `GET /v1/stages``GET /api/v2/stages`
84+
- `GET /v1/stages/{id}``GET /api/v2/stages/{id}`
85+
- `POST /v1/stages``POST /api/v2/stages`
86+
- `PUT /v1/stages/{id}``PATCH /api/v2/stages/{id}`
87+
- `DELETE /v1/stages/{id}``DELETE /api/v2/stages/{id}`
88+
### Fixed
89+
- Made `picture_id`, `org_id`, `label`, `last_name`, `cc_email`, `last_incoming_mail_time`, and `last_outgoing_mail_time` nullable in person and organization schemas to match real API behavior
1690
### Changed
1791
- Changed `board_id` and `phase_id` to be optional in `POST /api/v1/projects`
1892

93+
## [16.0.0](https://github.com/pipedrive/client-php/compare/15.7.0...16.0.0) (2026-05-05)
94+
1995
## [15.7.0](https://github.com/pipedrive/client-php/compare/15.6.0...15.7.0) (2026-05-05)
2096

2197
## [15.6.0](https://github.com/pipedrive/client-php/compare/15.5.0...15.6.0) (2026-05-05)

docs/versions/v1/Api/NotesApi.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ Name | Type | Description | Notes
484484
## `getNotes()`
485485

486486
```php
487-
getNotes($user_id, $lead_id, $deal_id, $person_id, $org_id, $project_id, $start, $limit, $sort, $start_date, $end_date, $updated_since, $pinned_to_lead_flag, $pinned_to_deal_flag, $pinned_to_organization_flag, $pinned_to_person_flag, $pinned_to_project_flag): \Pipedrive\versions\v1\Model\GetNotes
487+
getNotes($user_id, $lead_id, $deal_id, $person_id, $org_id, $project_id, $task_id, $start, $limit, $sort, $start_date, $end_date, $updated_since, $pinned_to_lead_flag, $pinned_to_deal_flag, $pinned_to_organization_flag, $pinned_to_person_flag, $pinned_to_project_flag, $pinned_to_task_flag): \Pipedrive\versions\v1\Model\GetNotes
488488
```
489489

490490
Get all notes
@@ -519,6 +519,7 @@ $deal_id = 56; // int | The ID of the deal which notes to fetch. If omitted, not
519519
$person_id = 56; // int | The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
520520
$org_id = 56; // int | The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
521521
$project_id = 56; // int | The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
522+
$task_id = 56; // int | The ID of the task which notes to fetch. If omitted, notes about all tasks will be returned.
522523
$start = 0; // int | Pagination start
523524
$limit = 56; // int | Items shown per page
524525
$sort = 'sort_example'; // string | 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). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
@@ -530,9 +531,10 @@ $pinned_to_deal_flag = new \Pipedrive\versions\v1\Model\\Pipedrive\versions\v1\M
530531
$pinned_to_organization_flag = new \Pipedrive\versions\v1\Model\\Pipedrive\versions\v1\Model\NumberBoolean(); // \Pipedrive\versions\v1\Model\NumberBoolean | If set, the results are filtered by note to organization pinning state
531532
$pinned_to_person_flag = new \Pipedrive\versions\v1\Model\\Pipedrive\versions\v1\Model\NumberBoolean(); // \Pipedrive\versions\v1\Model\NumberBoolean | If set, the results are filtered by note to person pinning state
532533
$pinned_to_project_flag = new \Pipedrive\versions\v1\Model\\Pipedrive\versions\v1\Model\NumberBoolean(); // \Pipedrive\versions\v1\Model\NumberBoolean | If set, the results are filtered by note to project pinning state
534+
$pinned_to_task_flag = new \Pipedrive\versions\v1\Model\\Pipedrive\versions\v1\Model\NumberBoolean(); // \Pipedrive\versions\v1\Model\NumberBoolean | If set, the results are filtered by note to task pinning state
533535

534536
try {
535-
$result = $apiInstance->getNotes($user_id, $lead_id, $deal_id, $person_id, $org_id, $project_id, $start, $limit, $sort, $start_date, $end_date, $updated_since, $pinned_to_lead_flag, $pinned_to_deal_flag, $pinned_to_organization_flag, $pinned_to_person_flag, $pinned_to_project_flag);
537+
$result = $apiInstance->getNotes($user_id, $lead_id, $deal_id, $person_id, $org_id, $project_id, $task_id, $start, $limit, $sort, $start_date, $end_date, $updated_since, $pinned_to_lead_flag, $pinned_to_deal_flag, $pinned_to_organization_flag, $pinned_to_person_flag, $pinned_to_project_flag, $pinned_to_task_flag);
536538
print_r($result);
537539
} catch (Exception $e) {
538540
echo 'Exception when calling NotesApi->getNotes: ', $e->getMessage(), PHP_EOL;
@@ -549,6 +551,7 @@ Name | Type | Description | Notes
549551
**person_id** | **int**| The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned. | [optional]
550552
**org_id** | **int**| The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned. | [optional]
551553
**project_id** | **int**| The ID of the project which notes to fetch. If omitted, notes about all projects will be returned. | [optional]
554+
**task_id** | **int**| The ID of the task which notes to fetch. If omitted, notes about all tasks will be returned. | [optional]
552555
**start** | **int**| Pagination start | [optional] [default to 0]
553556
**limit** | **int**| Items shown per page | [optional]
554557
**sort** | **string**| The field names and sorting mode separated by a comma (&#x60;field_name_1 ASC&#x60;, &#x60;field_name_2 DESC&#x60;). Only first-level field keys are supported (no nested keys). Supported fields: &#x60;id&#x60;, &#x60;user_id&#x60;, &#x60;deal_id&#x60;, &#x60;person_id&#x60;, &#x60;org_id&#x60;, &#x60;content&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;. | [optional]
@@ -560,6 +563,7 @@ Name | Type | Description | Notes
560563
**pinned_to_organization_flag** | [**\Pipedrive\versions\v1\Model\NumberBoolean**](../Model/.md)| If set, the results are filtered by note to organization pinning state | [optional]
561564
**pinned_to_person_flag** | [**\Pipedrive\versions\v1\Model\NumberBoolean**](../Model/.md)| If set, the results are filtered by note to person pinning state | [optional]
562565
**pinned_to_project_flag** | [**\Pipedrive\versions\v1\Model\NumberBoolean**](../Model/.md)| If set, the results are filtered by note to project pinning state | [optional]
566+
**pinned_to_task_flag** | [**\Pipedrive\versions\v1\Model\NumberBoolean**](../Model/.md)| If set, the results are filtered by note to task pinning state | [optional]
563567

564568
### Return type
565569

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Pipedrive\versions\v1\ProjectBoardsApi
2+
3+
All URIs are relative to https://api.pipedrive.com/v1.
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getProjectsBoard()**](ProjectBoardsApi.md#getProjectsBoard) | **GET** /projects/boards/{id} | Get details of a board
8+
[**getProjectsBoards()**](ProjectBoardsApi.md#getProjectsBoards) | **GET** /projects/boards | Get all project boards
9+
10+
11+
## `getProjectsBoard()`
12+
13+
```php
14+
getProjectsBoard($id): \Pipedrive\versions\v1\Model\GetProjectBoardResponse
15+
```
16+
17+
Get details of a board
18+
19+
Returns the details of a specific project board.
20+
21+
### Example
22+
23+
```php
24+
<?php
25+
require_once(__DIR__ . '/vendor/autoload.php');
26+
27+
28+
// Configure API key authorization: api_key
29+
$config = (new Pipedrive\versions\v1\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
30+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
31+
// $config = (new Pipedrive\versions\v1\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');
32+
33+
// Configure OAuth2 access token for authorization: oauth2
34+
$config = (new Pipedrive\versions\v1\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
35+
36+
37+
$apiInstance = new Pipedrive\versions\v1\Api\ProjectBoardsApi(
38+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
39+
// This is optional, `GuzzleHttp\Client` will be used as default.
40+
new GuzzleHttp\Client(),
41+
$config
42+
);
43+
$id = 56; // int | The ID of the project board
44+
45+
try {
46+
$result = $apiInstance->getProjectsBoard($id);
47+
print_r($result);
48+
} catch (Exception $e) {
49+
echo 'Exception when calling ProjectBoardsApi->getProjectsBoard: ', $e->getMessage(), PHP_EOL;
50+
}
51+
```
52+
53+
### Parameters
54+
55+
Name | Type | Description | Notes
56+
------------- | ------------- | ------------- | -------------
57+
**id** | **int**| The ID of the project board |
58+
59+
### Return type
60+
61+
[**\Pipedrive\versions\v1\Model\GetProjectBoardResponse**](../Model/GetProjectBoardResponse.md)
62+
63+
### Authorization
64+
65+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
66+
67+
### HTTP request headers
68+
69+
- **Content-Type**: Not defined
70+
- **Accept**: `application/json`
71+
72+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
73+
[[Back to Model list]](../README.md#documentation-for-models)
74+
[[Back to README]](../README.md)
75+
76+
## `getProjectsBoards()`
77+
78+
```php
79+
getProjectsBoards(): \Pipedrive\versions\v1\Model\GetProjectBoardsResponse
80+
```
81+
82+
Get all project boards
83+
84+
Returns all projects boards that are not deleted.
85+
86+
### Example
87+
88+
```php
89+
<?php
90+
require_once(__DIR__ . '/vendor/autoload.php');
91+
92+
93+
// Configure API key authorization: api_key
94+
$config = (new Pipedrive\versions\v1\Configuration())->setApiKey('x-api-token', 'YOUR_API_KEY');
95+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
96+
// $config = (new Pipedrive\versions\v1\Configuration())->setApiKeyPrefix('x-api-token', 'Bearer');
97+
98+
// Configure OAuth2 access token for authorization: oauth2
99+
$config = (new Pipedrive\versions\v1\Configuration())->setAccessToken('YOUR_ACCESS_TOKEN');
100+
101+
102+
$apiInstance = new Pipedrive\versions\v1\Api\ProjectBoardsApi(
103+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
104+
// This is optional, `GuzzleHttp\Client` will be used as default.
105+
new GuzzleHttp\Client(),
106+
$config
107+
);
108+
109+
try {
110+
$result = $apiInstance->getProjectsBoards();
111+
print_r($result);
112+
} catch (Exception $e) {
113+
echo 'Exception when calling ProjectBoardsApi->getProjectsBoards: ', $e->getMessage(), PHP_EOL;
114+
}
115+
```
116+
117+
### Parameters
118+
119+
This endpoint does not need any parameter.
120+
121+
### Return type
122+
123+
[**\Pipedrive\versions\v1\Model\GetProjectBoardsResponse**](../Model/GetProjectBoardsResponse.md)
124+
125+
### Authorization
126+
127+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
128+
129+
### HTTP request headers
130+
131+
- **Content-Type**: Not defined
132+
- **Accept**: `application/json`
133+
134+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
135+
[[Back to Model list]](../README.md#documentation-for-models)
136+
[[Back to README]](../README.md)

0 commit comments

Comments
 (0)