diff --git a/CHANGELOG.md b/CHANGELOG.md index 10e204bb..2ae55ad2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,86 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased](https://github.com/HubSpot/hubspot-api-php/compare/13.2.0...HEAD) +## [Unreleased](https://github.com/HubSpot/hubspot-api-php/compare/14.0.0...HEAD) + +## [14.0.0](https://github.com/HubSpot/hubspot-api-php/releases/tag/14.0.0) - 2026-02-12 + +### CMS Source Code and HubDB + +- Changed the return type of the response object in `cms()->sourceCode()->contentApi()->download()` from `\HubSpot\Client\Cms\SourceCode\Model\Error` to `\SplFileObject|\HubSpot\Client\Cms\SourceCode\Model\Error`. +- Added the `$environment` parameter as the first argument to the `cms()->sourceCode()->contentApi()->doValidate()` method. +- Added `removeTableVersion()` method to `cms()->hubdb()->tablesApi()`. +- Added `is_get_localized_schema` option to `cms()->hubdb()->tablesApi()->getAllDraftTables()` and `cms()->hubdb()->tablesApi()->getAllTables()`. +- Added `max_number_of_characters` and `max_number_of_options` properties to `HubSpot\Client\Cms\Hubdb\Model\ColumnRequest`. +- Added `deleted_at` property to `HubSpot\Client\Cms\Hubdb\Model\HubDbTableV3`. + +### CRM + +- Added `pipeline_id` option to `crm()->pipelines()->pipelineStageAuditsApi()->getAudit()`. +- Made `metadata` property required in `HubSpot\Client\Crm\Pipelines\Model\PipelineStage`, `HubSpot\Client\Crm\Pipelines\Model\PipelineStageInput` and `HubSpot\Client\Crm\Pipelines\Model\PipelineStagePatchInput`. +- Added `getById()` method to `crm()->exports()->publicExportsApi()`. +- Added `filter_groups` property to `HubSpot\Client\Crm\Exports\Model\PublicCrmSearchRequest`. +- Added `include_labeled_associations` and `include_primary_display_property_for_associated_objects` properties to `HubSpot\Client\Crm\Exports\Model\PublicExportListRequest`, `HubSpot\Client\Crm\Exports\Model\PublicExportViewRequest` and `HubSpot\Client\Crm\Exports\Model\PublicExportRequest`. +- Removed `public_crm_search_request` property from `HubSpot\Client\Crm\Exports\Model\PublicExportListRequest`. +- Removed `list_id` property from `HubSpot\Client\Crm\Exports\Model\PublicExportViewRequest`. +- Renamed method `crm()->extensions()->calling()->channelConnectionSettingsApi()->archive()` to `crm()->extensions()->calling()->channelConnectionSettingsApi()->remove()`. +- Renamed method `crm()->extensions()->calling()->channelConnectionSettingsApi()->getById()` to `crm()->extensions()->calling()->channelConnectionSettingsApi()->get()`. +- Renamed method `crm()->extensions()->calling()->recordingSettingsApi()->getUrlFormat()` to `crm()->extensions()->calling()->recordingSettingsApi()->get()`. +- Renamed method `crm()->extensions()->calling()->recordingSettingsApi()->registerUrlFormat()` to `crm()->extensions()->calling()->recordingSettingsApi()->create()`. +- Renamed method `crm()->extensions()->calling()->recordingSettingsApi()->updateUrlFormat()` to `crm()->extensions()->calling()->recordingSettingsApi()->update()`. +- Renamed method `crm()->extensions()->calling()->settingsApi()->archive()` to `crm()->extensions()->calling()->settingsApi()->remove()`. +- Renamed method `crm()->extensions()->calling()->settingsApi()->getById()` to `crm()->extensions()->calling()->settingsApi()->get()`. +- Renamed `crm()->lists()->mappingApi()` to `crm()->lists()->idMappingApi()`. +- Deleted `crm()->lists()->foldersApi()` and move all methods into `crm()->lists()->listManagementApi()`. +- Moved `getPageOrderedByAddedToListDate()` method to `crm()->lists()->joinOrderApi()`. +- Added `getConversionDetails()`, `scheduleOrUpdateConversion()` and `cancelConversion()` methods to `crm()->lists()->listManagementApi()`. +- Added `list_permissions` and `membership_settings` properties to `HubSpot\Client\Crm\Lists\Model\ListCreateRequest` and `HubSpot\Client\Crm\Lists\Model\PublicObjectList`. +- Added `is_public_list` property to `HubSpot\Client\Crm\Lists\Model\RecordListMembership`. +- Changed property type from `filter_branch:PublicPropertyAssociationFilterBranchFilterBranchesInner` to `filter_branch:ListFilterUpdateRequestFilterBranch` in `HubSpot\Client\Crm\Lists\Model\ListFilterUpdateRequest` and `HubSpot\Client\Crm\Lists\Model\PublicObjectList`. +- Updated the return type of the response object in `crm()->properties()->batchApi()->create()`, `crm()->properties()->batchApi()->read()` by removing `BatchResponsePropertyWithErrors` from the possible return types. +- Added `locale` option to `crm()->properties()->batchApi()->read()`. + +### CRM Objects + +- Updated the return type of the response object in `crm()->deals()->basicApi()->getPage()`, `crm()->lineItems()->basicApi()->getPage()`, `crm()->quotes()->basicApi()->getPage()`, `crm()->tickets()->basicApi()->getPage()`, `crm()->commerce()->invoices()->basicApi()->getPage()`, `crm()->objects()->calls()->basicApi()->getPage()`, `crm()->objects()->communications()->basicApi()->getPage()`, `crm()->objects()->emails()->basicApi()->getPage()`, `crm()->objects()->feedbackSubmissions()->basicApi()->getPage()`, `crm()->objects()->goals()->basicApi()->getPage()`, `crm()->objects()->leads()->basicApi()->getPage()`, `crm()->objects()->meetings()->basicApi()->getPage()`, `crm()->objects()->notes()->basicApi()->getPage()`, `crm()->objects()->postalMail()->basicApi()->getPage()`, `crm()->objects()->tasks()->basicApi()->getPage()`, `crm()->objects()->taxes()->basicApi()->getPage()`, `crm()->objects()->basicApi()->getPage()` to return `CollectionResponseSimplePublicObjectWithAssociations | Error` instead of `CollectionResponseSimplePublicObjectWithAssociationsForwardPaging | Error`. +- Updated the return type of the response object in `crm()->companies()->batchApi()->create()`, `crm()->companies()->batchApi()->read()`, `crm()->companies()->batchApi()->update()`, `crm()->deals()->batchApi()->create()`, `crm()->deals()->batchApi()->read()`, `crm()->deals()->batchApi()->update()`, `crm()->lineItems()->batchApi()->create()`, `crm()->lineItems()->batchApi()->read()`, `crm()->lineItems()->batchApi()->update()` , `crm()->quotes()->batchApi()->create()`, `crm()->quotes()->batchApi()->read()`, `crm()->quotes()->batchApi()->update()` , `crm()->tickets()->batchApi()->create()`, `crm()->tickets()->batchApi()->read()`, `crm()->tickets()->batchApi()->update()`, `crm()->commerce()->invoices()->batchApi()->create()`, `crm()->commerce()->invoices()->batchApi()->read()`, `crm()->commerce()->invoices()->batchApi()->update()`, `crm()->objects()->calls()->batchApi()->create()`, `crm()->objects()->calls()->batchApi()->read()`, `crm()->objects()->calls()->batchApi()->update()`, `crm()->objects()->communications()->batchApi()->create()`, `crm()->objects()->communications()->batchApi()->read()`, `crm()->objects()->communications()->batchApi()->update()`, `crm()->objects()->emails()->batchApi()->create()`, `crm()->objects()->emails()->batchApi()->read()`, `crm()->objects()->emails()->batchApi()->update()`, `crm()->objects()->feedbackSubmissions()->batchApi()->read()`, `crm()->objects()->goals()->batchApi()->create()`, `crm()->objects()->goals()->batchApi()->read()`, `crm()->objects()->goals()->batchApi()->update()`, `crm()->objects()->leads()->batchApi()->create()`, `crm()->objects()->leads()->batchApi()->read()`, `crm()->objects()->leads()->batchApi()->update()`, `crm()->objects()->meetings()->batchApi()->create()`, `crm()->objects()->meetings()->batchApi()->read()`, `crm()->objects()->meetings()->batchApi()->update()`, `crm()->objects()->notes()->batchApi()->create()`, `crm()->objects()->notes()->batchApi()->read()`, `crm()->objects()->notes()->batchApi()->update()`, `crm()->objects()->postalMail()->batchApi()->create()`, `crm()->objects()->postalMail()->batchApi()->read()`, `crm()->objects()->postalMail()->batchApi()->update()`, `crm()->objects()->tasks()->batchApi()->create()`, `crm()->objects()->tasks()->batchApi()->read()`, `crm()->objects()->tasks()->batchApi()->update()`, `crm()->objects()->taxes()->batchApi()->create()`, `crm()->objects()->taxes()->batchApi()->read()`, `crm()->objects()->taxes()->batchApi()->update()`, `crm()->objects()->batchApi()->create()`, `crm()->objects()->batchApi()->read()`, `crm()->objects()->batchApi()->update()` by removing `BatchResponseSimplePublicObjectWithErrors` from the possible return types. +- Updated the return type of the response object in `crm()->companies()->batchApi()->upsert()`, `crm()->deals()->batchApi()->upsert()`, `crm()->lineItems()->batchApi()->upsert()`, `crm()->quotes()->batchApi()->upsert()`, `crm()->tickets()->batchApi()->upsert()`, `crm()->commerce()->invoices()->batchApi()->upsert()`, `crm()->objects()->calls()->batchApi()->upsert()`, `crm()->objects()->communications()->batchApi()->upsert()`, `crm()->objects()->emails()->batchApi()->upsert()`, `crm()->objects()->goals()->batchApi()->upsert()` , `crm()->objects()->meetings()->batchApi()->upsert()` , `crm()->objects()->notes()->batchApi()->upsert()` , `crm()->objects()->postalMail()->batchApi()->upsert()`, `crm()->objects()->tasks()->batchApi()->upsert()`, `crm()->objects()->taxes()->batchApi()->upsert()`, `crm()->objects()->batchApi()->upsert()` by removing `BatchResponseSimplePublicUpsertObjectWithErrors` from the possible return types. +- Updated the return type of the response object in `crm()->companies()->searchApi()->doSearch()`, `crm()->deals()->searchApi()->doSearch()`, `crm()->lineItems()->searchApi()->doSearch()`, `crm()->quotes()->searchApi()->doSearch()`, `crm()->tickets()->searchApi()->doSearch()`, `crm()->commerce()->invoices()->searchApi()->doSearch()`, `crm()->objects()->calls()->searchApi()->doSearch()`, `crm()->objects()->communications()->searchApi()->doSearch()`, `crm()->objects()->emails()->searchApi()->doSearch()`, `crm()->objects()->feedbackSubmissions()->searchApi()->doSearch()`, `crm()->objects()->goals()->searchApi()->doSearch()`, `crm()->objects()->leads()->searchApi()->doSearch()`, `crm()->objects()->meetings()->searchApi()->doSearch()`, `crm()->objects()->notes()->searchApi()->doSearch()`, `crm()->objects()->postalMail()->searchApi()->doSearch()`, `crm()->objects()->tasks()->searchApi()->doSearch()`, `crm()->objects()->taxes()->searchApi()->doSearch()`, `crm()->objects()->searchApi()->doSearch()` to return `CollectionResponseWithTotalSimplePublicObject | Error` instead of `CollectionResponseWithTotalSimplePublicObjectForwardPaging | Error`. +- Added properties `errors` and `num_errors` to `HubSpot\Client\Crm\Companies\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Companies\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Deals\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Deals\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\LineItems\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\LineItems\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Quotes\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Quotes\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Tickets\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Tickets\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Commerce\Invoices\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Commerce\Invoices\Model\BatchResponseSimplePublicUpsertObject`,`HubSpot\Client\Crm\Objects\Calls\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Calls\Model\BatchResponseSimplePublicUpsertObject`,`HubSpot\Client\Crm\Objects\Communications\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Communications\Model\BatchResponseSimplePublicUpsertObject`,`HubSpot\Client\Crm\Objects\Emails\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Emails\Model\BatchResponseSimplePublicUpsertObject`,`HubSpot\Client\Crm\Objects\FeedbackSubmissions\Model\BatchResponseSimplePublicObject`,`HubSpot\Client\Crm\Objects\Goals\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Goals\Model\BatchResponseSimplePublicUpsertObject`,`HubSpot\Client\Crm\Objects\Leads\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Meetings\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Meetings\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\Notes\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Notes\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\PostalMail\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\PostalMail\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\Tasks\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Tasks\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\Taxes\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Taxes\Model\BatchResponseSimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\Model\BatchResponseSimplePublicObject`, `HubSpot\Client\Crm\Objects\Model\BatchResponseSimplePublicUpsertObject`. +- Added property `url` to `HubSpot\Client\Crm\Companies\Model\SimplePublicObject`, `HubSpot\Client\Crm\Companies\Model\SimplePublicObjectWithAssociations`, +`HubSpot\Client\Crm\Companies\Model\SimplePublicUpsertObject`, `HubSpot\Client\Crm\Deals\Model\SimplePublicObjectWithAssociations`, +`HubSpot\Client\Crm\Deals\Model\SimplePublicUpsertObject`, `HubSpot\Client\Crm\LineItems\Model\SimplePublicObjectWithAssociations`, +`HubSpot\Client\Crm\LineItems\Model\SimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\Notes\Model\SimplePublicObjectWithAssociations`, +`HubSpot\Client\Crm\Objects\Notes\Model\SimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\PostalMail\Model\SimplePublicObject`, `HubSpot\Client\Crm\Objects\PostalMail\Model\SimplePublicObjectWithAssociations`, +`HubSpot\Client\Crm\Objects\PostalMail\Model\SimplePublicUpsertObject`, `HubSpot\Client\Crm\Objects\Model\SimplePublicObject`, `HubSpot\Client\Crm\Objects\Model\SimplePublicObjectWithAssociations`, +`HubSpot\Client\Crm\Objects\Model\SimplePublicUpsertObject`. +- Removed `crm()->objects()->leads()->batchApi()->upsert()` method. + +### CRM Associations V3 + +- Changed the return type of the response object in `crm()->associations()->batchApi()->create()` from `\HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociation|\HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociationWithErrors|\HubSpot\Client\Crm\Associations\Model\Error` to `\HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociation|\HubSpot\Client\Crm\Associations\Model\Error`. +- Changed the return type of the response object in `crm()->associations()->batchApi()->read()` from `\HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociationMulti|\HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociationMultiWithErrors|\HubSpot\Client\Crm\Associations\Model\Error` to `\HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociationMulti|\HubSpot\Client\Crm\Associations\Model\Error`. +- Added properties `errors` and `num_errors` to `HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociation`, `HubSpot\Client\Crm\Associations\Model\BatchResponsePublicAssociationMulti`. + +### CRM Associations V4 + +- Updated the return type of the response object in `crm()->associations()->v4()->basicApi()->create()` to return `CreatedResponseLabelsBetweenObjectPair | Error` instead of `LabelsBetweenObjectPair | Error`. +- Updated the return type of the response object in `crm()->associations()->v4()->basicApi()->getPage()` to return `CollectionResponseMultiAssociatedObjectWithLabel | Error` instead of `CollectionResponseMultiAssociatedObjectWithLabelForwardPaging | Error`. +- Updated the return type of the response object in `crm()->associations()->v4()->batchApi()->archive()` and `crm()->associations()->v4()->batchApi()->archiveLabels()` to return `\HubSpot\Client\Crm\Associations\V4\Model\BatchResponseVoid|\HubSpot\Client\Crm\Associations\V4\Model\Error` instead of `void`. +- Updated the return type of the response object in `crm()->associations()->v4()->batchApi()->create()` by removing `BatchResponseLabelsBetweenObjectPairWithErrors` from the possible return types. +- Updated the return type of the response object in `crm()->associations()->v4()->batchApi()->getPage()` by removing `BatchResponsePublicAssociationMultiWithLabelWithErrors` from the possible return types. +- Updated the return type of the response object in `crm()->associations()->v4()->schema()->definitionConfigurationsApi()->batchCreate()` by removing `BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors` from the possible return types. +- Updated the return type of the response object in `crm()->associations()->v4()->schema()->definitionConfigurationsApi()->batchRemove()` to return `\HubSpot\Client\Crm\Associations\V4\Schema\Model\BatchResponseVoid|\HubSpot\Client\Crm\Associations\V4\Schema\Model\Error` instead of `void`. +- Updated the return type of the response object in `crm()->associations()->v4()->schema()->definitionConfigurationsApi()->batchUpdate()` by removing `BatchResponsePublicAssociationDefinitionConfigurationUpdateResultWithErrors` from the possible return types. +- Renamed `getAll()` to `getPage()` in `crm()->associations()->v4()->schema()->definitionConfigurationsApi()`, and updated the return type from `CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging | Error` to `CollectionResponsePublicAssociationDefinitionUserConfiguration | Error`. +- Renamed `getAllBetweenTwoObjectTypes()` to `getPageBetweenTwoObjectTypes()` in `crm()->associations()->v4()->schema()->definitionConfigurationsApi()`, and updated the return type from `CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging | Error` to `CollectionResponsePublicAssociationDefinitionUserConfiguration | Error`. +- Changed the return type of `crm()->associations()->v4()->schema()->definitionsApi()->create()` from `CollectionResponseAssociationSpecWithLabelNoPaging | Error` to `CollectionResponseAssociationSpecWithLabel | Error`. +- Renamed `getAll()` to `getPage()` in `crm()->associations()->v4()->schema()->definitionsApi()`, and updated the return type from `CollectionResponseAssociationSpecWithLabelNoPaging | Error` to `CollectionResponseAssociationSpecWithLabel | Error`. +- Changed the order of parameters in `crm()->associations()->v4()->schema()->definitionsApi()->remove()` from +`$from_object_type, $to_object_type, $association_type_id` +to +`$association_type_id, $from_object_type, $to_object_type`. +- Added properties `errors` and `num_errors` to `HubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPair`, `HubSpot\Client\Crm\Associations\V4\Model\BatchResponsePublicAssociationMultiWithLabel`, `HubSpot\Client\Crm\Associations\V4\Schema\Model\BatchResponsePublicAssociationDefinitionConfigurationUpdateResult` and `HubSpot\Client\Crm\Associations\V4\Schema\Model\BatchResponsePublicAssociationDefinitionUserConfiguration`. ## [13.2.0](https://github.com/HubSpot/hubspot-api-php/releases/tag/13.2.0) - 2025-12-17