diff --git a/CHANGELOG.md b/CHANGELOG.md
index 360e96f2..3691841a 100644
--- a/CHANGELOG.md
+++ b/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)
diff --git a/docs/versions/v2/Api/ActivitiesApi.md b/docs/versions/v2/Api/ActivitiesApi.md
index 95d544d9..8585d13a 100644
--- a/docs/versions/v2/Api/ActivitiesApi.md
+++ b/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
diff --git a/docs/versions/v2/Api/ActivityFieldsApi.md b/docs/versions/v2/Api/ActivityFieldsApi.md
index 33e18af8..8be1f106 100644
--- a/docs/versions/v2/Api/ActivityFieldsApi.md
+++ b/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]
diff --git a/docs/versions/v2/Api/DealFieldsApi.md b/docs/versions/v2/Api/DealFieldsApi.md
index 83a1fb1c..930beb05 100644
--- a/docs/versions/v2/Api/DealFieldsApi.md
+++ b/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]
diff --git a/docs/versions/v2/Api/DealsApi.md b/docs/versions/v2/Api/DealsApi.md
index 5a998fe5..d10d813e 100644
--- a/docs/versions/v2/Api/DealsApi.md
+++ b/docs/versions/v2/Api/DealsApi.md
@@ -517,7 +517,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealsApi(
$config
);
$filter_id = 56; // int | If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored.
$person_id = 56; // int | If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
$org_id = 56; // int | If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
@@ -528,8 +528,8 @@ $updated_since = 'updated_since_example'; // string | If set, only deals with an
$updated_until = 'updated_until_example'; // string | If set, only deals 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`.
$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
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$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
@@ -546,7 +546,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter_id** | **int**| If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored. | [optional]
**person_id** | **int**| If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. | [optional]
**org_id** | **int**| If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. | [optional]
@@ -557,8 +557,8 @@ Name | Type | Description | Notes
**updated_until** | **string**| If set, only deals 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`. | [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]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [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]
@@ -612,8 +612,8 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealsApi(
$config
);
$id = 56; // int | The ID of the deal
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$include_option_labels = True; // bool | When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id
$include_labels = True; // bool | When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
@@ -630,8 +630,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The ID of the deal |
- **include_fields** | **string**| Optional comma separated string array of additional fields to include | [optional]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**include_option_labels** | **bool**| When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id | [optional]
**include_labels** | **bool**| When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' | [optional]
@@ -889,7 +889,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\DealsApi(
$config
);
$filter_id = 56; // int | If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored.
$person_id = 56; // int | If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
$org_id = 56; // int | If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
@@ -900,8 +900,8 @@ $updated_since = 'updated_since_example'; // string | If set, only deals with an
$updated_until = 'updated_until_example'; // string | If set, only deals 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`.
$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
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$include_option_labels = True; // bool | When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id
$include_labels = True; // bool | When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
$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.
@@ -920,7 +920,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter_id** | **int**| If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored. | [optional]
**person_id** | **int**| If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. | [optional]
**org_id** | **int**| If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. | [optional]
@@ -931,8 +931,8 @@ Name | Type | Description | Notes
**updated_until** | **string**| If set, only deals 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`. | [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]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**include_option_labels** | **bool**| When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id | [optional]
**include_labels** | **bool**| When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' | [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]
diff --git a/docs/versions/v2/Api/OrganizationFieldsApi.md b/docs/versions/v2/Api/OrganizationFieldsApi.md
index 78a8cf16..185dd620 100644
--- a/docs/versions/v2/Api/OrganizationFieldsApi.md
+++ b/docs/versions/v2/Api/OrganizationFieldsApi.md
@@ -311,7 +311,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\OrganizationFieldsApi(
$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->getOrganizationField($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\OrganizationFieldsApi(
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]
diff --git a/docs/versions/v2/Api/OrganizationsApi.md b/docs/versions/v2/Api/OrganizationsApi.md
index 684aa430..cf15ada2 100644
--- a/docs/versions/v2/Api/OrganizationsApi.md
+++ b/docs/versions/v2/Api/OrganizationsApi.md
@@ -313,8 +313,8 @@ $apiInstance = new Pipedrive\versions\v2\Api\OrganizationsApi(
$config
);
$id = 56; // int | The ID of the organization
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$include_option_labels = True; // bool | When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id
$include_labels = True; // bool | When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
@@ -331,8 +331,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The ID of the organization |
- **include_fields** | **string**| Optional comma separated string array of additional fields to include | [optional]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**include_option_labels** | **bool**| When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id | [optional]
**include_labels** | **bool**| When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' | [optional]
@@ -524,14 +524,14 @@ $apiInstance = new Pipedrive\versions\v2\Api\OrganizationsApi(
$config
);
$filter_id = 56; // int | If supplied, only organizations 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 organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
$updated_since = 'updated_since_example'; // string | If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
$updated_until = 'updated_until_example'; // string | If set, only organizations 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`.
$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
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$include_option_labels = True; // bool | When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id
$include_labels = True; // bool | When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
$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.
@@ -550,14 +550,14 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter_id** | **int**| If supplied, only organizations 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 organizations owned by the specified user are returned. If filter_id is provided, this is ignored. | [optional]
**updated_since** | **string**| If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | [optional]
**updated_until** | **string**| If set, only organizations 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`. | [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]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**include_option_labels** | **bool**| When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id | [optional]
**include_labels** | **bool**| When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' | [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]
diff --git a/docs/versions/v2/Api/PersonFieldsApi.md b/docs/versions/v2/Api/PersonFieldsApi.md
index b1dde83c..1099262c 100644
--- a/docs/versions/v2/Api/PersonFieldsApi.md
+++ b/docs/versions/v2/Api/PersonFieldsApi.md
@@ -311,7 +311,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\PersonFieldsApi(
$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->getPersonField($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\PersonFieldsApi(
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]
diff --git a/docs/versions/v2/Api/PersonsApi.md b/docs/versions/v2/Api/PersonsApi.md
index a98de521..c7ffc434 100644
--- a/docs/versions/v2/Api/PersonsApi.md
+++ b/docs/versions/v2/Api/PersonsApi.md
@@ -314,8 +314,8 @@ $apiInstance = new Pipedrive\versions\v2\Api\PersonsApi(
$config
);
$id = 56; // int | The ID of the person
-$include_fields = 'include_fields_example'; // string | Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$include_option_labels = True; // bool | When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id
$include_labels = True; // bool | When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
@@ -332,8 +332,8 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| The ID of the person |
- **include_fields** | **string**| Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. | [optional]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**include_option_labels** | **bool**| When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id | [optional]
**include_labels** | **bool**| When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' | [optional]
@@ -590,7 +590,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\PersonsApi(
$config
);
$filter_id = 56; // int | If supplied, only persons 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 persons owned by the specified user are returned. If filter_id is provided, this is ignored.
$org_id = 56; // int | If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
$deal_id = 56; // int | If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
@@ -598,8 +598,8 @@ $updated_since = 'updated_since_example'; // string | If set, only persons with
$updated_until = 'updated_until_example'; // string | If set, only persons 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`.
$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. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
-$custom_fields = 'custom_fields_example'; // string | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
+$include_fields = array('include_fields_example'); // string[] | Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled.
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$include_option_labels = True; // bool | When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id
$include_labels = True; // bool | When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }'
$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.
@@ -618,7 +618,7 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter_id** | **int**| If supplied, only persons 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 persons owned by the specified user are returned. If filter_id is provided, this is ignored. | [optional]
**org_id** | **int**| If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. | [optional]
**deal_id** | **int**| If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. | [optional]
@@ -626,8 +626,8 @@ Name | Type | Description | Notes
**updated_until** | **string**| If set, only persons 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`. | [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. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. | [optional]
- **custom_fields** | **string**| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
+ **include_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. | [optional]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**include_option_labels** | **bool**| When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id | [optional]
**include_labels** | **bool**| When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' | [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]
diff --git a/docs/versions/v2/Api/ProductFieldsApi.md b/docs/versions/v2/Api/ProductFieldsApi.md
index a1617098..2c030331 100644
--- a/docs/versions/v2/Api/ProductFieldsApi.md
+++ b/docs/versions/v2/Api/ProductFieldsApi.md
@@ -311,7 +311,7 @@ $apiInstance = new Pipedrive\versions\v2\Api\ProductFieldsApi(
$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->getProductField($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\ProductFieldsApi(
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]
diff --git a/docs/versions/v2/Api/ProductsApi.md b/docs/versions/v2/Api/ProductsApi.md
index c4294064..9cabfd6e 100644
--- a/docs/versions/v2/Api/ProductsApi.md
+++ b/docs/versions/v2/Api/ProductsApi.md
@@ -893,7 +893,7 @@ Name | Type | Description | Notes
## `getProducts()`
```php
-getProducts($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields): \Pipedrive\versions\v2\Model\ProductsResponse
+getProducts($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since): \Pipedrive\versions\v2\Model\ProductsResponse
```
Get all products
@@ -923,17 +923,17 @@ $apiInstance = new Pipedrive\versions\v2\Api\ProductsApi(
$config
);
$owner_id = 56; // int | If supplied, only products owned by the given user will be 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.
+$custom_fields = array('custom_fields_example'); // string[] | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.
A maximum of 15 keys is allowed.
$filter_id = 56; // int | The ID of the filter to use
$cursor = 'cursor_example'; // string | For pagination, the marker (an opaque string value) representing the first item on the next page
$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.
$sort_by = 'id'; // string | The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`.
$sort_direction = 'asc'; // string | The sorting direction. Supported values: `asc`, `desc`.
$updated_since = 'updated_since_example'; // string | If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-$custom_fields = 'custom_fields_example'; // string | Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.
A maximum of 15 keys is allowed.
try {
- $result = $apiInstance->getProducts($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields);
+ $result = $apiInstance->getProducts($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProductsApi->getProducts: ', $e->getMessage(), PHP_EOL;
@@ -945,14 +945,14 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**owner_id** | **int**| If supplied, only products owned by the given user will be 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]
+ **custom_fields** | [**string[]**](../Model/string.md)| Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
**filter_id** | **int**| The ID of the filter to use | [optional]
**cursor** | **string**| For pagination, the marker (an opaque string value) representing the first item on the next page | [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]
**sort_by** | **string**| The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. | [optional] [default to 'id']
**sort_direction** | **string**| The sorting direction. Supported values: `asc`, `desc`. | [optional] [default to 'asc']
**updated_since** | **string**| If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. | [optional]
- **custom_fields** | **string**| Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. | [optional]
### Return type
diff --git a/lib/versions/v2/Api/ActivitiesApi.php b/lib/versions/v2/Api/ActivitiesApi.php
index 84a8b5ba..d2153b51 100644
--- a/lib/versions/v2/Api/ActivitiesApi.php
+++ b/lib/versions/v2/Api/ActivitiesApi.php
@@ -711,7 +711,7 @@ public function deleteActivityRequest($id): Request
* Get all activities
*
* @param int|null $filter_id If supplied, only activities matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $lead_id If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. (optional)
@@ -722,7 +722,7 @@ public function deleteActivityRequest($id): Request
* @param string|null $updated_until 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -742,7 +742,7 @@ public function getActivities($filter_id = null, $ids = null, $owner_id = null,
* Get all activities
*
* @param int|null $filter_id If supplied, only activities matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $lead_id If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. (optional)
@@ -753,7 +753,7 @@ public function getActivities($filter_id = null, $ids = null, $owner_id = null,
* @param string|null $updated_until 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -857,7 +857,7 @@ public function getActivitiesWithHttpInfo($filter_id = null, $ids = null, $owner
* Get all activities
*
* @param int|null $filter_id If supplied, only activities matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $lead_id If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. (optional)
@@ -868,7 +868,7 @@ public function getActivitiesWithHttpInfo($filter_id = null, $ids = null, $owner
* @param string|null $updated_until 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -891,7 +891,7 @@ function ($response) {
* Get all activities
*
* @param int|null $filter_id If supplied, only activities matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $lead_id If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. (optional)
@@ -902,7 +902,7 @@ function ($response) {
* @param string|null $updated_until 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -952,7 +952,7 @@ function ($exception) {
* Create request for operation 'getActivities'
*
* @param int|null $filter_id If supplied, only activities matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $lead_id If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. (optional)
@@ -963,7 +963,7 @@ function ($exception) {
* @param string|null $updated_until 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -972,6 +972,11 @@ function ($exception) {
*/
public function getActivitiesRequest($filter_id = null, $ids = null, $owner_id = null, $deal_id = null, $lead_id = null, $person_id = null, $org_id = null, $done = null, $updated_since = null, $updated_until = null, $sort_by = 'id', $sort_direction = 'asc', $include_fields = null, $limit = null, $cursor = null): Request
{
+ if ($ids !== null && count($ids) > 100) {
+ throw new \InvalidArgumentException('invalid value for "$ids" when calling ActivitiesApi.getActivities, number of items must be less than or equal to 100.');
+ }
+
+
$resourcePath = '/activities';
$formParams = [];
@@ -991,7 +996,7 @@ public function getActivitiesRequest($filter_id = null, $ids = null, $owner_id =
// query params
/* @phpstan-ignore-next-line */
if (is_array($ids)) {
- $ids = ObjectSerializer::serializeCollection($ids, '', true);
+ $ids = ObjectSerializer::serializeCollection($ids, 'form', true);
}
if ($ids !== null) {
$queryParams['ids'] = $ids;
@@ -1079,7 +1084,7 @@ public function getActivitiesRequest($filter_id = null, $ids = null, $owner_id =
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1182,7 +1187,7 @@ public function getActivitiesRequest($filter_id = null, $ids = null, $owner_id =
* Get details of an activity
*
* @param int $id The ID of the activity (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1200,7 +1205,7 @@ public function getActivity($id, $include_fields = null)
* Get details of an activity
*
* @param int $id The ID of the activity (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1302,7 +1307,7 @@ public function getActivityWithHttpInfo($id, $include_fields = null)
* Get details of an activity
*
* @param int $id The ID of the activity (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1323,7 +1328,7 @@ function ($response) {
* Get details of an activity
*
* @param int $id The ID of the activity (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1371,7 +1376,7 @@ function ($exception) {
* Create request for operation 'getActivity'
*
* @param int $id The ID of the activity (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
@@ -1386,6 +1391,7 @@ public function getActivityRequest($id, $include_fields = null): Request
);
}
+
$resourcePath = '/activities/{id}';
$formParams = [];
$queryParams = [];
@@ -1396,7 +1402,7 @@ public function getActivityRequest($id, $include_fields = null): Request
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
diff --git a/lib/versions/v2/Api/ActivityFieldsApi.php b/lib/versions/v2/Api/ActivityFieldsApi.php
index 2fa33f4e..d04d3077 100644
--- a/lib/versions/v2/Api/ActivityFieldsApi.php
+++ b/lib/versions/v2/Api/ActivityFieldsApi.php
@@ -128,7 +128,7 @@ public function getConfig(): Configuration
* Get one activity field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -146,7 +146,7 @@ public function getActivityField($field_code, $include_fields = null)
* Get one activity field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -248,7 +248,7 @@ public function getActivityFieldWithHttpInfo($field_code, $include_fields = null
* Get one activity field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -269,7 +269,7 @@ function ($response) {
* Get one activity field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -317,7 +317,7 @@ function ($exception) {
* Create request for operation 'getActivityField'
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
@@ -332,6 +332,7 @@ public function getActivityFieldRequest($field_code, $include_fields = null): Re
);
}
+
$resourcePath = '/activityFields/{field_code}';
$formParams = [];
$queryParams = [];
@@ -342,7 +343,7 @@ public function getActivityFieldRequest($field_code, $include_fields = null): Re
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -436,7 +437,7 @@ public function getActivityFieldRequest($field_code, $include_fields = null): Re
*
* Get all activity fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -455,7 +456,7 @@ public function getActivityFields($include_fields = null, $limit = null, $cursor
*
* Get all activity fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -558,7 +559,7 @@ public function getActivityFieldsWithHttpInfo($include_fields = null, $limit = n
*
* Get all activity fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -580,7 +581,7 @@ function ($response) {
*
* Get all activity fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -629,7 +630,7 @@ function ($exception) {
/**
* Create request for operation 'getActivityFields'
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -639,6 +640,7 @@ function ($exception) {
public function getActivityFieldsRequest($include_fields = null, $limit = null, $cursor = null): Request
{
+
$resourcePath = '/activityFields';
$formParams = [];
$queryParams = [];
@@ -649,7 +651,7 @@ public function getActivityFieldsRequest($include_fields = null, $limit = null,
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
diff --git a/lib/versions/v2/Api/DealFieldsApi.php b/lib/versions/v2/Api/DealFieldsApi.php
index 1791e501..ca6013c1 100644
--- a/lib/versions/v2/Api/DealFieldsApi.php
+++ b/lib/versions/v2/Api/DealFieldsApi.php
@@ -1346,7 +1346,7 @@ public function deleteDealFieldOptionsRequest($field_code, $request_body): Reque
* Get one deal field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1364,7 +1364,7 @@ public function getDealField($field_code, $include_fields = null)
* Get one deal field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1466,7 +1466,7 @@ public function getDealFieldWithHttpInfo($field_code, $include_fields = null)
* Get one deal field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1487,7 +1487,7 @@ function ($response) {
* Get one deal field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1535,7 +1535,7 @@ function ($exception) {
* Create request for operation 'getDealField'
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
@@ -1550,6 +1550,7 @@ public function getDealFieldRequest($field_code, $include_fields = null): Reques
);
}
+
$resourcePath = '/dealFields/{field_code}';
$formParams = [];
$queryParams = [];
@@ -1560,7 +1561,7 @@ public function getDealFieldRequest($field_code, $include_fields = null): Reques
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1654,7 +1655,7 @@ public function getDealFieldRequest($field_code, $include_fields = null): Reques
*
* Get all deal fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1673,7 +1674,7 @@ public function getDealFields($include_fields = null, $limit = null, $cursor = n
*
* Get all deal fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1776,7 +1777,7 @@ public function getDealFieldsWithHttpInfo($include_fields = null, $limit = null,
*
* Get all deal fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1798,7 +1799,7 @@ function ($response) {
*
* Get all deal fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1847,7 +1848,7 @@ function ($exception) {
/**
* Create request for operation 'getDealFields'
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1857,6 +1858,7 @@ function ($exception) {
public function getDealFieldsRequest($include_fields = null, $limit = null, $cursor = null): Request
{
+
$resourcePath = '/dealFields';
$formParams = [];
$queryParams = [];
@@ -1867,7 +1869,7 @@ public function getDealFieldsRequest($include_fields = null, $limit = null, $cur
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
diff --git a/lib/versions/v2/Api/DealsApi.php b/lib/versions/v2/Api/DealsApi.php
index 39056c5c..07660a12 100644
--- a/lib/versions/v2/Api/DealsApi.php
+++ b/lib/versions/v2/Api/DealsApi.php
@@ -2263,7 +2263,7 @@ public function getAdditionalDiscountsRequest($id): Request
* Get all archived deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -2274,8 +2274,8 @@ public function getAdditionalDiscountsRequest($id): Request
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -2295,7 +2295,7 @@ public function getArchivedDeals($filter_id = null, $ids = null, $owner_id = nul
* Get all archived deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -2306,8 +2306,8 @@ public function getArchivedDeals($filter_id = null, $ids = null, $owner_id = nul
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -2411,7 +2411,7 @@ public function getArchivedDealsWithHttpInfo($filter_id = null, $ids = null, $ow
* Get all archived deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -2422,8 +2422,8 @@ public function getArchivedDealsWithHttpInfo($filter_id = null, $ids = null, $ow
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -2446,7 +2446,7 @@ function ($response) {
* Get all archived deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -2457,8 +2457,8 @@ function ($response) {
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -2508,7 +2508,7 @@ function ($exception) {
* Create request for operation 'getArchivedDeals'
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -2519,8 +2519,8 @@ function ($exception) {
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -2529,6 +2529,15 @@ function ($exception) {
*/
public function getArchivedDealsRequest($filter_id = null, $ids = null, $owner_id = null, $person_id = null, $org_id = null, $pipeline_id = null, $stage_id = null, $status = null, $updated_since = null, $updated_until = null, $sort_by = 'id', $sort_direction = 'asc', $include_fields = null, $custom_fields = null, $limit = null, $cursor = null): Request
{
+ if ($ids !== null && count($ids) > 100) {
+ throw new \InvalidArgumentException('invalid value for "$ids" when calling DealsApi.getArchivedDeals, number of items must be less than or equal to 100.');
+ }
+
+
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling DealsApi.getArchivedDeals, number of items must be less than or equal to 15.');
+ }
+
$resourcePath = '/deals/archived';
$formParams = [];
@@ -2548,7 +2557,7 @@ public function getArchivedDealsRequest($filter_id = null, $ids = null, $owner_i
// query params
/* @phpstan-ignore-next-line */
if (is_array($ids)) {
- $ids = ObjectSerializer::serializeCollection($ids, '', true);
+ $ids = ObjectSerializer::serializeCollection($ids, 'form', true);
}
if ($ids !== null) {
$queryParams['ids'] = $ids;
@@ -2636,7 +2645,7 @@ public function getArchivedDealsRequest($filter_id = null, $ids = null, $owner_i
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -2644,7 +2653,7 @@ public function getArchivedDealsRequest($filter_id = null, $ids = null, $owner_i
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
@@ -2747,8 +2756,8 @@ public function getArchivedDealsRequest($filter_id = null, $ids = null, $owner_i
* Get details of a deal
*
* @param int $id The ID of the deal (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -2768,8 +2777,8 @@ public function getDeal($id, $include_fields = null, $custom_fields = null, $inc
* Get details of a deal
*
* @param int $id The ID of the deal (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -2873,8 +2882,8 @@ public function getDealWithHttpInfo($id, $include_fields = null, $custom_fields
* Get details of a deal
*
* @param int $id The ID of the deal (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -2897,8 +2906,8 @@ function ($response) {
* Get details of a deal
*
* @param int $id The ID of the deal (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -2948,8 +2957,8 @@ function ($exception) {
* Create request for operation 'getDeal'
*
* @param int $id The ID of the deal (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -2966,6 +2975,11 @@ public function getDealRequest($id, $include_fields = null, $custom_fields = nul
);
}
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling DealsApi.getDeal, number of items must be less than or equal to 15.');
+ }
+
+
$resourcePath = '/deals/{id}';
$formParams = [];
$queryParams = [];
@@ -2976,7 +2990,7 @@ public function getDealRequest($id, $include_fields = null, $custom_fields = nul
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -2984,7 +2998,7 @@ public function getDealRequest($id, $include_fields = null, $custom_fields = nul
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
@@ -4003,7 +4017,7 @@ public function getDealFollowersChangelogRequest($id, $limit = null, $cursor = n
* Get all deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -4014,8 +4028,8 @@ public function getDealFollowersChangelogRequest($id, $limit = null, $cursor = n
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -4037,7 +4051,7 @@ public function getDeals($filter_id = null, $ids = null, $owner_id = null, $pers
* Get all deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -4048,8 +4062,8 @@ public function getDeals($filter_id = null, $ids = null, $owner_id = null, $pers
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -4155,7 +4169,7 @@ public function getDealsWithHttpInfo($filter_id = null, $ids = null, $owner_id =
* Get all deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -4166,8 +4180,8 @@ public function getDealsWithHttpInfo($filter_id = null, $ids = null, $owner_id =
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -4192,7 +4206,7 @@ function ($response) {
* Get all deals
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -4203,8 +4217,8 @@ function ($response) {
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -4256,7 +4270,7 @@ function ($exception) {
* Create request for operation 'getDeals'
*
* @param int|null $filter_id If supplied, only deals matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $person_id If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
@@ -4267,8 +4281,8 @@ function ($exception) {
* @param string|null $updated_until If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -4279,6 +4293,15 @@ function ($exception) {
*/
public function getDealsRequest($filter_id = null, $ids = null, $owner_id = null, $person_id = null, $org_id = null, $pipeline_id = null, $stage_id = null, $status = null, $updated_since = null, $updated_until = null, $sort_by = 'id', $sort_direction = 'asc', $include_fields = null, $custom_fields = null, $include_option_labels = null, $include_labels = null, $limit = null, $cursor = null): Request
{
+ if ($ids !== null && count($ids) > 100) {
+ throw new \InvalidArgumentException('invalid value for "$ids" when calling DealsApi.getDeals, number of items must be less than or equal to 100.');
+ }
+
+
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling DealsApi.getDeals, number of items must be less than or equal to 15.');
+ }
+
$resourcePath = '/deals';
$formParams = [];
@@ -4298,7 +4321,7 @@ public function getDealsRequest($filter_id = null, $ids = null, $owner_id = null
// query params
/* @phpstan-ignore-next-line */
if (is_array($ids)) {
- $ids = ObjectSerializer::serializeCollection($ids, '', true);
+ $ids = ObjectSerializer::serializeCollection($ids, 'form', true);
}
if ($ids !== null) {
$queryParams['ids'] = $ids;
@@ -4386,7 +4409,7 @@ public function getDealsRequest($filter_id = null, $ids = null, $owner_id = null
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -4394,7 +4417,7 @@ public function getDealsRequest($filter_id = null, $ids = null, $owner_id = null
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
diff --git a/lib/versions/v2/Api/OrganizationFieldsApi.php b/lib/versions/v2/Api/OrganizationFieldsApi.php
index c2f6c4dd..75a85376 100644
--- a/lib/versions/v2/Api/OrganizationFieldsApi.php
+++ b/lib/versions/v2/Api/OrganizationFieldsApi.php
@@ -1346,7 +1346,7 @@ public function deleteOrganizationFieldOptionsRequest($field_code, $request_body
* Get one organization field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1364,7 +1364,7 @@ public function getOrganizationField($field_code, $include_fields = null)
* Get one organization field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1466,7 +1466,7 @@ public function getOrganizationFieldWithHttpInfo($field_code, $include_fields =
* Get one organization field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1487,7 +1487,7 @@ function ($response) {
* Get one organization field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1535,7 +1535,7 @@ function ($exception) {
* Create request for operation 'getOrganizationField'
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
@@ -1550,6 +1550,7 @@ public function getOrganizationFieldRequest($field_code, $include_fields = null)
);
}
+
$resourcePath = '/organizationFields/{field_code}';
$formParams = [];
$queryParams = [];
@@ -1560,7 +1561,7 @@ public function getOrganizationFieldRequest($field_code, $include_fields = null)
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1654,7 +1655,7 @@ public function getOrganizationFieldRequest($field_code, $include_fields = null)
*
* Get all organization fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1673,7 +1674,7 @@ public function getOrganizationFields($include_fields = null, $limit = null, $cu
*
* Get all organization fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1776,7 +1777,7 @@ public function getOrganizationFieldsWithHttpInfo($include_fields = null, $limit
*
* Get all organization fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1798,7 +1799,7 @@ function ($response) {
*
* Get all organization fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1847,7 +1848,7 @@ function ($exception) {
/**
* Create request for operation 'getOrganizationFields'
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1857,6 +1858,7 @@ function ($exception) {
public function getOrganizationFieldsRequest($include_fields = null, $limit = null, $cursor = null): Request
{
+
$resourcePath = '/organizationFields';
$formParams = [];
$queryParams = [];
@@ -1867,7 +1869,7 @@ public function getOrganizationFieldsRequest($include_fields = null, $limit = nu
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
diff --git a/lib/versions/v2/Api/OrganizationsApi.php b/lib/versions/v2/Api/OrganizationsApi.php
index 4f55d619..77bd9121 100644
--- a/lib/versions/v2/Api/OrganizationsApi.php
+++ b/lib/versions/v2/Api/OrganizationsApi.php
@@ -1334,8 +1334,8 @@ public function deleteOrganizationFollowerRequest($id, $follower_id): Request
* Get details of a organization
*
* @param int $id The ID of the organization (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1355,8 +1355,8 @@ public function getOrganization($id, $include_fields = null, $custom_fields = nu
* Get details of a organization
*
* @param int $id The ID of the organization (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1460,8 +1460,8 @@ public function getOrganizationWithHttpInfo($id, $include_fields = null, $custom
* Get details of a organization
*
* @param int $id The ID of the organization (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1484,8 +1484,8 @@ function ($response) {
* Get details of a organization
*
* @param int $id The ID of the organization (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1535,8 +1535,8 @@ function ($exception) {
* Create request for operation 'getOrganization'
*
* @param int $id The ID of the organization (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1553,6 +1553,11 @@ public function getOrganizationRequest($id, $include_fields = null, $custom_fiel
);
}
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling OrganizationsApi.getOrganization, number of items must be less than or equal to 15.');
+ }
+
+
$resourcePath = '/organizations/{id}';
$formParams = [];
$queryParams = [];
@@ -1563,7 +1568,7 @@ public function getOrganizationRequest($id, $include_fields = null, $custom_fiel
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1571,7 +1576,7 @@ public function getOrganizationRequest($id, $include_fields = null, $custom_fiel
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
@@ -2326,14 +2331,14 @@ public function getOrganizationFollowersChangelogRequest($id, $limit = null, $cu
* Get all organizations
*
* @param int|null $filter_id If supplied, only organizations matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $updated_since If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|null $updated_until If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2355,14 +2360,14 @@ public function getOrganizations($filter_id = null, $ids = null, $owner_id = nul
* Get all organizations
*
* @param int|null $filter_id If supplied, only organizations matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $updated_since If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|null $updated_until If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2468,14 +2473,14 @@ public function getOrganizationsWithHttpInfo($filter_id = null, $ids = null, $ow
* Get all organizations
*
* @param int|null $filter_id If supplied, only organizations matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $updated_since If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|null $updated_until If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2500,14 +2505,14 @@ function ($response) {
* Get all organizations
*
* @param int|null $filter_id If supplied, only organizations matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $updated_since If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|null $updated_until If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2559,14 +2564,14 @@ function ($exception) {
* Create request for operation 'getOrganizations'
*
* @param int|null $filter_id If supplied, only organizations matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param string|null $updated_since If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|null $updated_until If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2577,6 +2582,15 @@ function ($exception) {
*/
public function getOrganizationsRequest($filter_id = null, $ids = null, $owner_id = null, $updated_since = null, $updated_until = null, $sort_by = 'id', $sort_direction = 'asc', $include_fields = null, $custom_fields = null, $include_option_labels = null, $include_labels = null, $limit = null, $cursor = null): Request
{
+ if ($ids !== null && count($ids) > 100) {
+ throw new \InvalidArgumentException('invalid value for "$ids" when calling OrganizationsApi.getOrganizations, number of items must be less than or equal to 100.');
+ }
+
+
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling OrganizationsApi.getOrganizations, number of items must be less than or equal to 15.');
+ }
+
$resourcePath = '/organizations';
$formParams = [];
@@ -2596,7 +2610,7 @@ public function getOrganizationsRequest($filter_id = null, $ids = null, $owner_i
// query params
/* @phpstan-ignore-next-line */
if (is_array($ids)) {
- $ids = ObjectSerializer::serializeCollection($ids, '', true);
+ $ids = ObjectSerializer::serializeCollection($ids, 'form', true);
}
if ($ids !== null) {
$queryParams['ids'] = $ids;
@@ -2644,7 +2658,7 @@ public function getOrganizationsRequest($filter_id = null, $ids = null, $owner_i
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -2652,7 +2666,7 @@ public function getOrganizationsRequest($filter_id = null, $ids = null, $owner_i
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
diff --git a/lib/versions/v2/Api/PersonFieldsApi.php b/lib/versions/v2/Api/PersonFieldsApi.php
index 12e76dc7..c705b5d1 100644
--- a/lib/versions/v2/Api/PersonFieldsApi.php
+++ b/lib/versions/v2/Api/PersonFieldsApi.php
@@ -1346,7 +1346,7 @@ public function deletePersonFieldOptionsRequest($field_code, $request_body): Req
* Get one person field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1364,7 +1364,7 @@ public function getPersonField($field_code, $include_fields = null)
* Get one person field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1466,7 +1466,7 @@ public function getPersonFieldWithHttpInfo($field_code, $include_fields = null)
* Get one person field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1487,7 +1487,7 @@ function ($response) {
* Get one person field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1535,7 +1535,7 @@ function ($exception) {
* Create request for operation 'getPersonField'
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
@@ -1550,6 +1550,7 @@ public function getPersonFieldRequest($field_code, $include_fields = null): Requ
);
}
+
$resourcePath = '/personFields/{field_code}';
$formParams = [];
$queryParams = [];
@@ -1560,7 +1561,7 @@ public function getPersonFieldRequest($field_code, $include_fields = null): Requ
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1654,7 +1655,7 @@ public function getPersonFieldRequest($field_code, $include_fields = null): Requ
*
* Get all person fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1673,7 +1674,7 @@ public function getPersonFields($include_fields = null, $limit = null, $cursor =
*
* Get all person fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1776,7 +1777,7 @@ public function getPersonFieldsWithHttpInfo($include_fields = null, $limit = nul
*
* Get all person fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1798,7 +1799,7 @@ function ($response) {
*
* Get all person fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1847,7 +1848,7 @@ function ($exception) {
/**
* Create request for operation 'getPersonFields'
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1857,6 +1858,7 @@ function ($exception) {
public function getPersonFieldsRequest($include_fields = null, $limit = null, $cursor = null): Request
{
+
$resourcePath = '/personFields';
$formParams = [];
$queryParams = [];
@@ -1867,7 +1869,7 @@ public function getPersonFieldsRequest($include_fields = null, $limit = null, $c
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
diff --git a/lib/versions/v2/Api/PersonsApi.php b/lib/versions/v2/Api/PersonsApi.php
index a4c2475e..e348b7fb 100644
--- a/lib/versions/v2/Api/PersonsApi.php
+++ b/lib/versions/v2/Api/PersonsApi.php
@@ -1334,8 +1334,8 @@ public function deletePersonFollowerRequest($id, $follower_id): Request
* Get details of a person
*
* @param int $id The ID of the person (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1355,8 +1355,8 @@ public function getPerson($id, $include_fields = null, $custom_fields = null, $i
* Get details of a person
*
* @param int $id The ID of the person (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1460,8 +1460,8 @@ public function getPersonWithHttpInfo($id, $include_fields = null, $custom_field
* Get details of a person
*
* @param int $id The ID of the person (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1484,8 +1484,8 @@ function ($response) {
* Get details of a person
*
* @param int $id The ID of the person (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1535,8 +1535,8 @@ function ($exception) {
* Create request for operation 'getPerson'
*
* @param int $id The ID of the person (required)
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
*
@@ -1553,6 +1553,11 @@ public function getPersonRequest($id, $include_fields = null, $custom_fields = n
);
}
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling PersonsApi.getPerson, number of items must be less than or equal to 15.');
+ }
+
+
$resourcePath = '/persons/{id}';
$formParams = [];
$queryParams = [];
@@ -1563,7 +1568,7 @@ public function getPersonRequest($id, $include_fields = null, $custom_fields = n
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1571,7 +1576,7 @@ public function getPersonRequest($id, $include_fields = null, $custom_fields = n
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
@@ -2622,7 +2627,7 @@ public function getPersonPictureRequest($id): Request
* Get all persons
*
* @param int|null $filter_id If supplied, only persons matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
@@ -2630,8 +2635,8 @@ public function getPersonPictureRequest($id): Request
* @param string|null $updated_until If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2653,7 +2658,7 @@ public function getPersons($filter_id = null, $ids = null, $owner_id = null, $or
* Get all persons
*
* @param int|null $filter_id If supplied, only persons matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
@@ -2661,8 +2666,8 @@ public function getPersons($filter_id = null, $ids = null, $owner_id = null, $or
* @param string|null $updated_until If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2768,7 +2773,7 @@ public function getPersonsWithHttpInfo($filter_id = null, $ids = null, $owner_id
* Get all persons
*
* @param int|null $filter_id If supplied, only persons matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
@@ -2776,8 +2781,8 @@ public function getPersonsWithHttpInfo($filter_id = null, $ids = null, $owner_id
* @param string|null $updated_until If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2802,7 +2807,7 @@ function ($response) {
* Get all persons
*
* @param int|null $filter_id If supplied, only persons matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
@@ -2810,8 +2815,8 @@ function ($response) {
* @param string|null $updated_until If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2863,7 +2868,7 @@ function ($exception) {
* Create request for operation 'getPersons'
*
* @param int|null $filter_id If supplied, only persons matching the specified filter are returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
* @param int|null $owner_id If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $org_id If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. (optional)
* @param int|null $deal_id If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. (optional)
@@ -2871,8 +2876,8 @@ function ($exception) {
* @param string|null $updated_until If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `update_time`, `add_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
- * @param string|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
- * @param string|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. (optional)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param bool|null $include_option_labels When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id (optional)
* @param bool|null $include_labels When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' (optional)
* @param int|null $limit 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)
@@ -2883,6 +2888,15 @@ function ($exception) {
*/
public function getPersonsRequest($filter_id = null, $ids = null, $owner_id = null, $org_id = null, $deal_id = null, $updated_since = null, $updated_until = null, $sort_by = 'id', $sort_direction = 'asc', $include_fields = null, $custom_fields = null, $include_option_labels = null, $include_labels = null, $limit = null, $cursor = null): Request
{
+ if ($ids !== null && count($ids) > 100) {
+ throw new \InvalidArgumentException('invalid value for "$ids" when calling PersonsApi.getPersons, number of items must be less than or equal to 100.');
+ }
+
+
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling PersonsApi.getPersons, number of items must be less than or equal to 15.');
+ }
+
$resourcePath = '/persons';
$formParams = [];
@@ -2902,7 +2916,7 @@ public function getPersonsRequest($filter_id = null, $ids = null, $owner_id = nu
// query params
/* @phpstan-ignore-next-line */
if (is_array($ids)) {
- $ids = ObjectSerializer::serializeCollection($ids, '', true);
+ $ids = ObjectSerializer::serializeCollection($ids, 'form', true);
}
if ($ids !== null) {
$queryParams['ids'] = $ids;
@@ -2966,7 +2980,7 @@ public function getPersonsRequest($filter_id = null, $ids = null, $owner_id = nu
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -2974,7 +2988,7 @@ public function getPersonsRequest($filter_id = null, $ids = null, $owner_id = nu
// query params
/* @phpstan-ignore-next-line */
if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
}
if ($custom_fields !== null) {
$queryParams['custom_fields'] = $custom_fields;
diff --git a/lib/versions/v2/Api/ProductFieldsApi.php b/lib/versions/v2/Api/ProductFieldsApi.php
index fd959200..31fb0516 100644
--- a/lib/versions/v2/Api/ProductFieldsApi.php
+++ b/lib/versions/v2/Api/ProductFieldsApi.php
@@ -1346,7 +1346,7 @@ public function deleteProductFieldOptionsRequest($field_code, $request_body): Re
* Get one product field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1364,7 +1364,7 @@ public function getProductField($field_code, $include_fields = null)
* Get one product field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
@@ -1466,7 +1466,7 @@ public function getProductFieldWithHttpInfo($field_code, $include_fields = null)
* Get one product field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1487,7 +1487,7 @@ function ($response) {
* Get one product field
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
@@ -1535,7 +1535,7 @@ function ($exception) {
* Create request for operation 'getProductField'
*
* @param string $field_code The unique code identifying the field (required)
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
@@ -1550,6 +1550,7 @@ public function getProductFieldRequest($field_code, $include_fields = null): Req
);
}
+
$resourcePath = '/productFields/{field_code}';
$formParams = [];
$queryParams = [];
@@ -1560,7 +1561,7 @@ public function getProductFieldRequest($field_code, $include_fields = null): Req
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
@@ -1654,7 +1655,7 @@ public function getProductFieldRequest($field_code, $include_fields = null): Req
*
* Get all product fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1673,7 +1674,7 @@ public function getProductFields($include_fields = null, $limit = null, $cursor
*
* Get all product fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1776,7 +1777,7 @@ public function getProductFieldsWithHttpInfo($include_fields = null, $limit = nu
*
* Get all product fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1798,7 +1799,7 @@ function ($response) {
*
* Get all product fields
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1847,7 +1848,7 @@ function ($exception) {
/**
* Create request for operation 'getProductFields'
*
- * @param string|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
+ * @param string[]|null $include_fields Optional comma separated string array of additional data namespaces to include in response (optional)
* @param int|null $limit 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)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
*
@@ -1857,6 +1858,7 @@ function ($exception) {
public function getProductFieldsRequest($include_fields = null, $limit = null, $cursor = null): Request
{
+
$resourcePath = '/productFields';
$formParams = [];
$queryParams = [];
@@ -1867,7 +1869,7 @@ public function getProductFieldsRequest($include_fields = null, $limit = null, $
// query params
/* @phpstan-ignore-next-line */
if (is_array($include_fields)) {
- $include_fields = ObjectSerializer::serializeCollection($include_fields, '', true);
+ $include_fields = ObjectSerializer::serializeCollection($include_fields, 'form', true);
}
if ($include_fields !== null) {
$queryParams['include_fields'] = $include_fields;
diff --git a/lib/versions/v2/Api/ProductsApi.php b/lib/versions/v2/Api/ProductsApi.php
index ff7ded3a..6599c58f 100644
--- a/lib/versions/v2/Api/ProductsApi.php
+++ b/lib/versions/v2/Api/ProductsApi.php
@@ -4107,22 +4107,22 @@ public function getProductVariationsRequest($id, $cursor = null, $limit = null):
* Get all products
*
* @param int|null $owner_id If supplied, only products owned by the given user will be returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $filter_id The ID of the filter to use (optional)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
* @param int|null $limit 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
* @param string|null $updated_since If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
- * @param string|null $custom_fields Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
* @return \Pipedrive\versions\v2\Model\ProductsResponse
*/
- public function getProducts($owner_id = null, $ids = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null, $custom_fields = null)
+ public function getProducts($owner_id = null, $ids = null, $custom_fields = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null)
{
- list($response) = $this->getProductsWithHttpInfo($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields);
+ list($response) = $this->getProductsWithHttpInfo($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since);
return $response;
}
@@ -4132,22 +4132,22 @@ public function getProducts($owner_id = null, $ids = null, $filter_id = null, $c
* Get all products
*
* @param int|null $owner_id If supplied, only products owned by the given user will be returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $filter_id The ID of the filter to use (optional)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
* @param int|null $limit 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
* @param string|null $updated_since If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
- * @param string|null $custom_fields Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException|GuzzleException
* @return array of \Pipedrive\versions\v2\Model\ProductsResponse, HTTP status code, HTTP response headers (array of strings)
*/
- public function getProductsWithHttpInfo($owner_id = null, $ids = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null, $custom_fields = null)
+ public function getProductsWithHttpInfo($owner_id = null, $ids = null, $custom_fields = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null)
{
- $request = $this->getProductsRequest($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields);
+ $request = $this->getProductsRequest($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since);
try {
$options = $this->createHttpClientOption();
@@ -4156,7 +4156,7 @@ public function getProductsWithHttpInfo($owner_id = null, $ids = null, $filter_i
} catch (RequestException $e) {
if ($e->getCode() === 401 && $this->config->isRefreshPossible()) {
$this->config->refreshToken();
- $request = $this->getProductsRequest($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields);
+ $request = $this->getProductsRequest($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since);
$response = $this->client->send($request, $options);
} else {
throw new ApiException(
@@ -4241,21 +4241,21 @@ public function getProductsWithHttpInfo($owner_id = null, $ids = null, $filter_i
* Get all products
*
* @param int|null $owner_id If supplied, only products owned by the given user will be returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $filter_id The ID of the filter to use (optional)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
* @param int|null $limit 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
* @param string|null $updated_since If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
- * @param string|null $custom_fields Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
*/
- public function getProductsAsync($owner_id = null, $ids = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null, $custom_fields = null): PromiseInterface
+ public function getProductsAsync($owner_id = null, $ids = null, $custom_fields = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null): PromiseInterface
{
- return $this->getProductsAsyncWithHttpInfo($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields)
+ return $this->getProductsAsyncWithHttpInfo($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since)
->then(
function ($response) {
return $response[0];
@@ -4269,22 +4269,22 @@ function ($response) {
* Get all products
*
* @param int|null $owner_id If supplied, only products owned by the given user will be returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $filter_id The ID of the filter to use (optional)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
* @param int|null $limit 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
* @param string|null $updated_since If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
- * @param string|null $custom_fields Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return PromiseInterface
*/
- public function getProductsAsyncWithHttpInfo($owner_id = null, $ids = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null, $custom_fields = null): PromiseInterface
+ public function getProductsAsyncWithHttpInfo($owner_id = null, $ids = null, $custom_fields = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null): PromiseInterface
{
$returnType = '\Pipedrive\versions\v2\Model\ProductsResponse';
- $request = $this->getProductsRequest($owner_id, $ids, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since, $custom_fields);
+ $request = $this->getProductsRequest($owner_id, $ids, $custom_fields, $filter_id, $cursor, $limit, $sort_by, $sort_direction, $updated_since);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
@@ -4324,20 +4324,28 @@ function ($exception) {
* Create request for operation 'getProducts'
*
* @param int|null $owner_id If supplied, only products owned by the given user will be returned (optional)
- * @param string|null $ids 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)
+ * @param string[]|null $ids 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)
+ * @param string[]|null $custom_fields Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. (optional)
* @param int|null $filter_id The ID of the filter to use (optional)
* @param string|null $cursor For pagination, the marker (an opaque string value) representing the first item on the next page (optional)
* @param int|null $limit 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)
* @param string|'id' $sort_by The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`. (optional, default to 'id')
* @param string|'asc' $sort_direction The sorting direction. Supported values: `asc`, `desc`. (optional, default to 'asc')
* @param string|null $updated_since If set, only products with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. (optional)
- * @param string|null $custom_fields Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. (optional)
*
* @throws InvalidArgumentException|OAuthProviderException
* @return Request
*/
- public function getProductsRequest($owner_id = null, $ids = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null, $custom_fields = null): Request
+ public function getProductsRequest($owner_id = null, $ids = null, $custom_fields = null, $filter_id = null, $cursor = null, $limit = null, $sort_by = 'id', $sort_direction = 'asc', $updated_since = null): Request
{
+ if ($ids !== null && count($ids) > 100) {
+ throw new \InvalidArgumentException('invalid value for "$ids" when calling ProductsApi.getProducts, number of items must be less than or equal to 100.');
+ }
+
+ if ($custom_fields !== null && count($custom_fields) > 15) {
+ throw new \InvalidArgumentException('invalid value for "$custom_fields" when calling ProductsApi.getProducts, number of items must be less than or equal to 15.');
+ }
+
$resourcePath = '/products';
$formParams = [];
@@ -4357,13 +4365,21 @@ public function getProductsRequest($owner_id = null, $ids = null, $filter_id = n
// query params
/* @phpstan-ignore-next-line */
if (is_array($ids)) {
- $ids = ObjectSerializer::serializeCollection($ids, '', true);
+ $ids = ObjectSerializer::serializeCollection($ids, 'form', true);
}
if ($ids !== null) {
$queryParams['ids'] = $ids;
}
// query params
/* @phpstan-ignore-next-line */
+ if (is_array($custom_fields)) {
+ $custom_fields = ObjectSerializer::serializeCollection($custom_fields, 'form', true);
+ }
+ if ($custom_fields !== null) {
+ $queryParams['custom_fields'] = $custom_fields;
+ }
+ // query params
+ /* @phpstan-ignore-next-line */
if (is_array($filter_id)) {
$filter_id = ObjectSerializer::serializeCollection($filter_id, '', true);
}
@@ -4410,14 +4426,6 @@ public function getProductsRequest($owner_id = null, $ids = null, $filter_id = n
if ($updated_since !== null) {
$queryParams['updated_since'] = $updated_since;
}
- // query params
- /* @phpstan-ignore-next-line */
- if (is_array($custom_fields)) {
- $custom_fields = ObjectSerializer::serializeCollection($custom_fields, '', true);
- }
- if ($custom_fields !== null) {
- $queryParams['custom_fields'] = $custom_fields;
- }