Skip to content

Releases: HubSpot/hubspot-api-php

14.0.6

22 Apr 14:03
d871d6f

Choose a tag to compare

OAuth

  • Added code_verifier and scope as optional parameters to oauth()->tokensApi()->create().
  • Added refresh_token field to HubSpot\Client\Oauth\Model\TokenResponseIF.
  • Fixed JSON attribute mappings in HubSpot\Client\Oauth\Model\TokenResponseIF to 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 from CollectionResponseSimplePublicObjectWithAssociations to CollectionResponseSimplePublicObjectWithAssociationsForwardPaging.
  • crm()->objects()->batchApi()->create() now returns HTTP 201 instead of 200, and handles HTTP 207 (partial success) responses with new BatchResponseSimplePublicObjectWithErrors model.
  • crm()->objects()->batchApi()->read() and update() now handle HTTP 207 (partial success) responses, returning BatchResponseSimplePublicObjectWithErrors.
  • crm()->objects()->batchApi()->upsert() now handles HTTP 207 (partial success) responses, returning BatchResponseSimplePublicUpsertObjectWithErrors.
  • HubSpot\Client\Crm\Objects\Model\BatchResponseSimplePublicObject no longer includes errors and numErrors fields — those are available on the new BatchResponseSimplePublicObjectWithErrors model.
  • HubSpot\Client\Crm\Objects\Model\BatchResponseSimplePublicUpsertObject no longer includes errors and numErrors fields — those are available on the new BatchResponseSimplePublicUpsertObjectWithErrors model.
  • Renamed model CollectionResponseSimplePublicObjectWithAssociations to CollectionResponseSimplePublicObjectWithAssociationsForwardPaging.
  • Added new models: BatchResponseSimplePublicObjectWithErrors, BatchResponseSimplePublicUpsertObjectWithErrors, ForwardPaging.

14.0.5

02 Apr 14:13
915c8af

Choose a tag to compare

CRM Associations V4

  • Updated the return type of the response object in crm()->associations()->v4()->batchApi()->archive() and archiveLabels() to void instead of BatchResponseVoid|Error. The BatchResponseVoid model has been removed.
  • crm()->associations()->v4()->batchApi()->create() now handles HTTP 207 (partial success) responses, returning new BatchResponseLabelsBetweenObjectPairWithErrors model.
  • crm()->associations()->v4()->batchApi()->getPage() now handles HTTP 207 (partial success) responses, returning new BatchResponsePublicAssociationMultiWithLabelWithErrors model.
  • HubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPair model no longer includes errors and numErrors fields — those are available on the new HubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPairWithErrors model.
  • Added new models: HubSpot\Client\Crm\Associations\V4\Model\BatchResponseLabelsBetweenObjectPairWithErrors, HubSpot\Client\Crm\Associations\V4\Model\BatchResponsePublicAssociationMultiWithLabelWithErrors.

14.0.4

24 Mar 12:50

Choose a tag to compare

What's Changed

  • Corrected parameter names for forms in Files and CRM Imports clients.

14.0.3

04 Mar 15:39
93447ce

Choose a tag to compare

CRM Association V4

  • Updated crm()->associations()->v4()->basicApi()->create() method to return status code 201.
  • Updated the return type of the response object in crm()->associations()->v4()->basicApi()->create() to return LabelsBetweenObjectPair | Error instead of CreatedResponseLabelsBetweenObjectPair | Error.
  • Updated the return type of the response object in crm()->associations()->v4()->basicApi()->getPage() to return CollectionResponseMultiAssociatedObjectWithLabelForwardPaging | Error instead of CollectionResponseMultiAssociatedObjectWithLabel | Error.

14.0.2

27 Feb 19:57
97177fc

Choose a tag to compare

CRM Objects

  • Updated all batch create methods of CRM objects to return status code 201.

14.0.1

25 Feb 12:41
bf28ba8

Choose a tag to compare

CRM Objects

  • Updated all create methods of CRM objects to return status code 201.

14.0.0

23 Feb 14:02
5adb6b7

Choose a tag to compare

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().
  • Removed crm()->lists()->foldersApi() and moved 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()->properties()->groupsApi()->getAll(), crm()->properties()->groupsApi()->getByName().
  • Added data_sensitivity and locale options to crm()->properties()->coreApi()->getAll() and crm()->properties()->coreApi()->getByName().
  • Added data_sensitivity property to HubSpot\Client\Crm\Properties\Model\BatchReadInputPropertyName, HubSpot\Client\Crm\Properties\Model\Property, HubSpot\Client\Crm\Properties\Model\PropertyCreate.
  • Added properties errors and num_errors to HubSpot\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() and crm()->objects()
    to return CollectionResponseSimplePublicObjectWithAssociations | Error instead of
    CollectionResponseSimplePublicObjectWithAssociationsForwardPaging | Error.
  • Updated the return type of batchApi()->create(), batchApi()->read() and batchApi()->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() and crm()->objects()
    by removing BatchResponseSimplePublicObjectWithErrors from 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() and crm()->objects()
    by removing BatchResponseSimplePublicUpsertObjectWithErrors from 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() and crm()->objects()
    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...
Read more

13.2.0

22 Dec 08:49
da53d40

Choose a tag to compare

Updates

  • Updated ObjectType enum.

13.1.1

17 Nov 12:50
a42faf6

Choose a tag to compare

What's Changed

  • Fixed typing in ObjectTypeIDs enum.

13.1.0

13 Nov 07:54
78fef56

Choose a tag to compare

What's Changed

  • Added new association types to AssociationTypes Enum. #509
  • Fix Implicitly marking parameter as nullable in CRM Objects. #518
  • Add ObjectTypeIDs enum. #519