Build 346 - version-major

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Removed `deprecated: true` from LegacyTeams endpoints (`GET`/`POST /v1/legacyTeams`, `GET`/`PUT /v1/legacyTeams/{id}`, `GET`/`POST`/`DELETE /v1/legacyTeams/{id}/users`, `GET /v1/legacyTeams/user/{id}`) and updated the tag description to remove outdated deprecation notice
 
 ### Fixed
+- Fixed the comma-separated `include_fields` query parameter across v2 collection/detail endpoints (`GET /api/v2/activities`, `GET /api/v2/activities/{id}`, `GET /api/v2/activityFields`, `GET /api/v2/activityFields/{field_code}`, `GET /api/v2/deals`, `GET /api/v2/deals/{id}`, `GET /api/v2/dealFields`, `GET /api/v2/dealFields/{field_code}`, `GET /api/v2/organizations`, `GET /api/v2/organizations/{id}`, `GET /api/v2/organizationFields`, `GET /api/v2/organizationFields/{field_code}`, `GET /api/v2/persons`, `GET /api/v2/persons/{id}`, `GET /api/v2/personFields`, `GET /api/v2/personFields/{field_code}`, `GET /api/v2/productFields`, and `GET /api/v2/productFields/{field_code}`) that was typed as `type: string` with an enum of comma-joined value combinations despite accepting comma-separated lists — changed to `type: array` of enumerated strings with `uniqueItems: true`, `style: form`, `explode: false`
+- Fixed the comma-separated `custom_fields` query parameter on v2 collection/detail endpoints (`GET /api/v2/deals`, `GET /api/v2/deals/archived`, `GET /api/v2/deals/{id}`, `GET /api/v2/organizations`, `GET /api/v2/organizations/{id}`, `GET /api/v2/persons`, `GET /api/v2/persons/{id}`, and `GET /api/v2/products`) and the `ids` query parameter on v2 collection endpoints (`GET /api/v2/activities`, `GET /api/v2/deals`, `GET /api/v2/deals/archived`, `GET /api/v2/organizations`, `GET /api/v2/persons`, and `GET /api/v2/products`) that were typed as `type: string` despite accepting comma-separated lists — changed to `type: array` of strings (`custom_fields` capped at 15 items, `ids` at 100) with `uniqueItems: true`, `style: form`, `explode: false`
 - Fixed `has_pic` field type in v1 deal creator schema (`DealNonStrictModeFields`, used by `GET`/`POST /v1/deals` and related endpoints) — changed from `boolean` to `integer` since the API returns `0`/`1`, not `true`/`false`
 - Fixed `code` field type in v2 product search results (`GET /api/v2/products/search`) — changed from `integer` to `string` and made nullable to match actual API responses
 - Fixed `value` field type in v2 deal search results (`DealSearchItem`, used by `GET /api/v2/deals/search`) — changed from `integer` to `number` and made nullable to match actual API responses
@@ -23,6 +25,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Reworded the `im`, `notes`, `birthday`, and `job_title` field descriptions and the `addPerson`/`updatePerson` operation descriptions (which also cover `postal_address`) to disclose that these fields 403 when contact sync isn't enabled, rather than only describing when they're present on read.
 - Fixed OAuth scopes on six v2 deal sub-resource write operations (`POST /api/v2/deals/{id}/discounts`, `PATCH`/`DELETE /api/v2/deals/{id}/discounts/{discount_id}`, `POST /api/v2/deals/{id}/installments`, `PATCH`/`DELETE /api/v2/deals/{id}/installments/{installment_id}`) that incorrectly listed `deals:read` alongside `deals:full`, copied from their sibling GET operations - these are now `deals:full` only, matching their read-write nature
 
+## [17.8.1](https://github.com/pipedrive/client-php/compare/17.8.0...17.8.1) (2026-09-17)
+
 ## [17.8.0](https://github.com/pipedrive/client-php/compare/17.7.0...17.8.0) (2026-09-17)
 
 ## [17.7.0](https://github.com/pipedrive/client-php/compare/17.6.3...17.7.0) (2026-09-17)

docs/versions/v2/Api/ActivitiesApi.md

@@ -174,7 +174,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivitiesApi(
     $config
 );
 $filter_id = 56; // int | If supplied, only activities matching the specified filter are returned
-$ids = 'ids_example'; // string | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
+$ids = array('ids_example'); // string[] | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
 $owner_id = 56; // int | If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
 $deal_id = 56; // int | If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
 $lead_id = 'lead_id_example'; // string | If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
@@ -185,7 +185,7 @@ $updated_since = 'updated_since_example'; // string | If set, only activities wi
 $updated_until = 'updated_until_example'; // string | If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
 $sort_by = 'id'; // string | The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
 $sort_direction = 'asc'; // string | The sorting direction. Supported values: `asc`, `desc`.
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
 $limit = 100; // int | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
 $cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -202,7 +202,7 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **filter_id** | **int**| If supplied, only activities matching the specified filter are returned | [optional]
- **ids** | **string**| Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. | [optional]
+ **ids** | [**string[]**](../Model/string.md)| Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. | [optional]
  **owner_id** | **int**| If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. | [optional]
  **deal_id** | **int**| If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. | [optional]
  **lead_id** | **string**| If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. | [optional]
@@ -213,7 +213,7 @@ Name | Type | Description  | Notes
  **updated_until** | **string**| If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | [optional]
  **sort_by** | **string**| The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. | [optional] [default to 'id']
  **sort_direction** | **string**| The sorting direction. Supported values: `asc`, `desc`. | [optional] [default to 'asc']
- **include_fields** | **string**| Optional comma separated string array of additional fields to include | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
  **limit** | **int**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | [optional]
  **cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
 
@@ -267,7 +267,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivitiesApi(
     $config
 );
 $id = 56; // int | The ID of the activity
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
 
 try {
     $result = $apiInstance->getActivity($id, $include_fields);
@@ -282,7 +282,7 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **int**| The ID of the activity |
- **include_fields** | **string**| Optional comma separated string array of additional fields to include | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
 
 ### Return type
 

docs/versions/v2/Api/ActivityFieldsApi.md

@@ -41,7 +41,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivityFieldsApi(
     $config
 );
 $field_code = 'field_code_example'; // string | The unique code identifying the field
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response
 
 try {
     $result = $apiInstance->getActivityField($field_code, $include_fields);
@@ -56,7 +56,7 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **field_code** | **string**| The unique code identifying the field |
- **include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]
 
 ### Return type
 
@@ -107,7 +107,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ActivityFieldsApi(
     new GuzzleHttp\Client(),
     $config
 );
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response
 $limit = 100; // int | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
 $cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -123,7 +123,7 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]
  **limit** | **int**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | [optional]
  **cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]
 

docs/versions/v2/Api/DealFieldsApi.md

@@ -311,7 +311,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealFieldsApi(
     $config
 );
 $field_code = 'field_code_example'; // string | The unique code identifying the field
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response
 
 try {
     $result = $apiInstance->getDealField($field_code, $include_fields);
@@ -326,7 +326,7 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **field_code** | **string**| The unique code identifying the field |
- **include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]
 
 ### Return type
 
@@ -377,7 +377,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealFieldsApi(
     new GuzzleHttp\Client(),
     $config
 );
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional data namespaces to include in response
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional data namespaces to include in response
 $limit = 100; // int | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
 $cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
 
@@ -393,7 +393,7 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **include_fields** | **string**| Optional comma separated string array of additional data namespaces to include in response | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional data namespaces to include in response | [optional]
  **limit** | **int**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | [optional]
  **cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional]