Releases: HubSpot/hubspot-api-php
Releases · HubSpot/hubspot-api-php
14.0.6
OAuth
- Added
code_verifierandscopeas optional parameters tooauth()->tokensApi()->create(). - Added
refresh_tokenfield toHubSpot\Client\Oauth\Model\TokenResponseIF. - Fixed JSON attribute mappings in
HubSpot\Client\Oauth\Model\TokenResponseIFto use snake_case keys (access_token,expires_in,hub_id,token_type) matching the actual API response.
CRM Objects
crm()->objects()->basicApi()->create()now returns HTTP 201 instead of 200.crm()->objects()->basicApi()->getPage()return type changed fromCollectionResponseSimplePublicObjectWithAssociationstoCollectionResponseSimplePublicObjectWithAssociationsForwardPaging.crm()->objects()->batchApi()->create()now returns HTTP 201 instead of 200, and handles HTTP 207 (partial success) responses with newBatchResponseSimplePublicObjectWithErrorsmodel.crm()->objects()->batchApi()->read()andupdate()now handle HTTP 207 (partial success) responses, returningBatchResponseSimplePublicObjectWithErrors.crm()->objects()->batchApi()->upsert()now handles HTTP 207 (partial success) responses, returningBatchResponseSimplePublicUpsertObjectWithErrors.HubSpot\Client\Crm\Objects\Model\BatchResponseSimplePublicObjectno longer includeserrorsandnumErrorsfields — those are available on the newBatchResponseSimplePublicObjectWithErrorsmodel.HubSpot\Client\Crm\Objects\Model\BatchResponseSimplePublicUpsertObjectno longer includeserrorsandnumErrorsfields — those are available on the newBatchResponseSimplePublicUpsertObjectWithErrorsmodel.- Renamed model
CollectionResponseSimplePublicObjectWithAssociationstoCollectionResponseSimplePublicObjectWithAssociationsForwardPaging. - Added new models:
BatchResponseSimplePublicObjectWithErrors,BatchResponseSimplePublicUpsertObjectWithErrors,ForwardPaging.
14.0.5
CRM Associations V4
- Updated the return type of the response object in
crm()->associations()->v4()->batchApi()->archive()andarchiveLabels()tovoidinstead ofBatchResponseVoid|Error. TheBatchResponseVoidmodel has been removed. crm()->associations()->v4()->batchApi()->create()now handles HTTP 207 (partial success) responses, returning newBatchResponseLabelsBetweenObjectPairWithErrorsmodel.crm()->associations()->v4()->batchApi()->getPage()now handles HTTP 207 (partial success) responses, returning newBatchResponsePublicAssociationMultiWithLabelWithErrorsmodel.HubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPairmodel no longer includeserrorsandnumErrorsfields — those are available on the newHubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPairWithErrorsmodel.- Added new models:
HubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPairWithErrors,HubSpot\Client\Crm\Associations\V4\Model\BatchResponsePublicAssociationMultiWithLabelWithErrors.
14.0.4
What's Changed
- Corrected parameter names for forms in Files and CRM Imports clients.
14.0.3
CRM Association V4
- Updated
crm()->associations()->v4()->basicApi()->create()method to return status code201. - Updated the return type of the response object in
crm()->associations()->v4()->basicApi()->create()to returnLabelsBetweenObjectPair | Errorinstead ofCreatedResponseLabelsBetweenObjectPair | Error. - Updated the return type of the response object in
crm()->associations()->v4()->basicApi()->getPage()to returnCollectionResponseMultiAssociatedObjectWithLabelForwardPaging | Errorinstead ofCollectionResponseMultiAssociatedObjectWithLabel | Error.
14.0.2
CRM Objects
- Updated all batch create methods of CRM objects to return status code
201.
14.0.1
CRM Objects
- Updated all create methods of CRM objects to return status code
201.
14.0.0
CMS Source Code and HubDB
- Changed the return type of the response object in
cms()->sourceCode()->contentApi()->download()from\HubSpot\Client\Cms\SourceCode\Model\Errorto\SplFileObject|\HubSpot\Client\Cms\SourceCode\Model\Error. - Added the
$environmentparameter as the first argument to thecms()->sourceCode()->contentApi()->doValidate()method. - Added
removeTableVersion()method tocms()->hubdb()->tablesApi(). - Added
is_get_localized_schemaoption tocms()->hubdb()->tablesApi()->getAllDraftTables()andcms()->hubdb()->tablesApi()->getAllTables(). - Added
max_number_of_charactersandmax_number_of_optionsproperties toHubSpot\Client\Cms\Hubdb\Model\ColumnRequest. - Added
deleted_atproperty toHubSpot\Client\Cms\Hubdb\Model\HubDbTableV3.
CRM
- Added
pipeline_idoption tocrm()->pipelines()->pipelineStageAuditsApi()->getAudit(). - Made
metadataproperty required inHubSpot\Client\Crm\Pipelines\Model\PipelineStage,HubSpot\Client\Crm\Pipelines\Model\PipelineStageInputandHubSpot\Client\Crm\Pipelines\Model\PipelineStagePatchInput. - Added
getById()method tocrm()->exports()->publicExportsApi(). - Added
filter_groupsproperty toHubSpot\Client\Crm\Exports\Model\PublicCrmSearchRequest. - Added
include_labeled_associationsandinclude_primary_display_property_for_associated_objectsproperties toHubSpot\Client\Crm\Exports\Model\PublicExportListRequest,HubSpot\Client\Crm\Exports\Model\PublicExportViewRequestandHubSpot\Client\Crm\Exports\Model\PublicExportRequest. - Removed
public_crm_search_requestproperty fromHubSpot\Client\Crm\Exports\Model\PublicExportListRequest. - Removed
list_idproperty fromHubSpot\Client\Crm\Exports\Model\PublicExportViewRequest. - Renamed method
crm()->extensions()->calling()->channelConnectionSettingsApi()->archive()tocrm()->extensions()->calling()->channelConnectionSettingsApi()->remove(). - Renamed method
crm()->extensions()->calling()->channelConnectionSettingsApi()->getById()tocrm()->extensions()->calling()->channelConnectionSettingsApi()->get(). - Renamed method
crm()->extensions()->calling()->recordingSettingsApi()->getUrlFormat()tocrm()->extensions()->calling()->recordingSettingsApi()->get(). - Renamed method
crm()->extensions()->calling()->recordingSettingsApi()->registerUrlFormat()tocrm()->extensions()->calling()->recordingSettingsApi()->create(). - Renamed method
crm()->extensions()->calling()->recordingSettingsApi()->updateUrlFormat()tocrm()->extensions()->calling()->recordingSettingsApi()->update(). - Renamed method
crm()->extensions()->calling()->settingsApi()->archive()tocrm()->extensions()->calling()->settingsApi()->remove(). - Renamed method
crm()->extensions()->calling()->settingsApi()->getById()tocrm()->extensions()->calling()->settingsApi()->get(). - Renamed
crm()->lists()->mappingApi()tocrm()->lists()->idMappingApi(). - Removed
crm()->lists()->foldersApi()and moved all methods intocrm()->lists()->listManagementApi(). - Moved
getPageOrderedByAddedToListDate()method tocrm()->lists()->joinOrderApi(). - Added
getConversionDetails(),scheduleOrUpdateConversion()andcancelConversion()methods tocrm()->lists()->listManagementApi(). - Added
list_permissionsandmembership_settingsproperties toHubSpot\Client\Crm\Lists\Model\ListCreateRequestandHubSpot\Client\Crm\Lists\Model\PublicObjectList. - Added
is_public_listproperty toHubSpot\Client\Crm\Lists\Model\RecordListMembership. - Changed property type from
filter_branch:PublicPropertyAssociationFilterBranchFilterBranchesInnertofilter_branch:ListFilterUpdateRequestFilterBranchinHubSpot\Client\Crm\Lists\Model\ListFilterUpdateRequestandHubSpot\Client\Crm\Lists\Model\PublicObjectList. - Updated the return type of the response object in
crm()->properties()->batchApi()->create(),crm()->properties()->batchApi()->read()by removingBatchResponsePropertyWithErrorsfrom the possible return types. - Added
localeoption tocrm()->properties()->batchApi()->read(),crm()->properties()->groupsApi()->getAll(),crm()->properties()->groupsApi()->getByName(). - Added
data_sensitivityandlocaleoptions tocrm()->properties()->coreApi()->getAll()andcrm()->properties()->coreApi()->getByName(). - Added
data_sensitivityproperty toHubSpot\Client\Crm\Properties\Model\BatchReadInputPropertyName,HubSpot\Client\Crm\Properties\Model\Property,HubSpot\Client\Crm\Properties\Model\PropertyCreate. - Added properties
errorsandnum_errorstoHubSpot\Client\Crm\Properties\Model\BatchResponseProperty.
CRM Objects
- Updated the return type of
basicApi()->getPage()in
crm()->deals(),crm()->lineItems(),crm()->quotes(),crm()->tickets(),
crm()->commerce()->invoices(),crm()->objects()->calls(),
crm()->objects()->communications(),crm()->objects()->emails(),
crm()->objects()->feedbackSubmissions(),crm()->objects()->goals(),
crm()->objects()->meetings(),crm()->objects()->notes(),
crm()->objects()->postalMail(),crm()->objects()->tasks(),
crm()->objects()->taxes()andcrm()->objects()
to returnCollectionResponseSimplePublicObjectWithAssociations | Errorinstead of
CollectionResponseSimplePublicObjectWithAssociationsForwardPaging | Error. - Updated the return type of
batchApi()->create(),batchApi()->read()andbatchApi()->update()in
crm()->companies(),crm()->deals(),crm()->lineItems(),crm()->quotes(),
crm()->tickets(),crm()->commerce()->invoices(),crm()->objects()->calls(),
crm()->objects()->communications(),crm()->objects()->emails(),
crm()->objects()->feedbackSubmissions()(read only),crm()->objects()->goals(),
crm()->objects()->leads(),crm()->objects()->meetings(),crm()->objects()->notes(),
crm()->objects()->postalMail(),crm()->objects()->tasks(),
crm()->objects()->taxes()andcrm()->objects()
by removingBatchResponseSimplePublicObjectWithErrorsfrom the possible return types. - Updated the return type of
batchApi()->upsert()in
crm()->companies(),crm()->deals(),crm()->lineItems(),crm()->quotes(),
crm()->tickets(),crm()->commerce()->invoices(),crm()->objects()->calls(),
crm()->objects()->communications(),crm()->objects()->emails(),
crm()->objects()->goals(),crm()->objects()->leads(),crm()->objects()->meetings(),
crm()->objects()->notes(),crm()->objects()->postalMail(),crm()->objects()->tasks(),
crm()->objects()->taxes()andcrm()->objects()
by removingBatchResponseSimplePublicUpsertObjectWithErrorsfrom the possible return types. - Updated the return type of
searchApi()->doSearch()in
crm()->companies(),crm()->deals(),crm()->lineItems(),crm()->quotes(),
crm()->tickets(),crm()->commerce()->invoices(),crm()->objects()->calls(),
crm()->objects()->communications(),crm()->objects()->emails(),
crm()->objects()->feedbackSubmissions(),crm()->objects()->goals(),
crm()->objects()->leads(),crm()->objects()->meetings(),crm()->objects()->notes(),
crm()->objects()->postalMail(),crm()->objects()->tasks(),
crm()->objects()->taxes()andcrm()->objects()
to returnCollectionResponseWithTotalSimplePublicObject | Errorinstead of
CollectionResponseWithTotalSimplePublicObjectForwardPaging | Error. - Added properties
errorsandnum_errorsto
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...
13.2.0
Updates
- Updated ObjectType enum.
13.1.1
What's Changed
- Fixed typing in
ObjectTypeIDsenum.