Releases: HubSpot/hubspot-api-php
Releases · HubSpot/hubspot-api-php
11.2.0
Changes:
- Added
crm()->objects()->leads()api client
11.1.0
CRM Lists Beta
- Cnanged type of
list_id,app_id,email_idandbusiness_unit_idfrominttostringin whole client. - Added method
getLists()tocrm()->lists()->membershipsApi(). - Changed the return type from
CollectionResponseLong|ErrortoApiCollectionResponseJoinTimeAndRecordId|ErrorofgetPage()method ofcrm()->lists()->membershipsApi(). - Changed type from
inttostringinHubSpot\Client\Crm\Lists\Model\PublicObjectList:updated_by_idandHubSpot\Client\Crm\Lists\Model\PublicObjectList:created_by_id.
11.0.0
Major change for SDK
- Update Php version >=7.4
Automation Action client
- Changed type of
$extension_action_definition_inputinput param fromExtensionActionDefinitiontoPublicActionDefinitioninautomation()->actions()->definitionsApi()->create(). - Renamed and changed type the third input param of
automation()->actions()->definitionsApi()->update()fromExtensionActionDefinitionPatch $extension_action_definition_patchtoPublicActionDefinition $public_action_definition_patch. - Changed the return type from
ExtensionActionDefinition|ErrortoPublicActionDefinition|Errorofcreate(),getById()andupdate()methods ofautomation()->actions()->definitionsApi(). - Changed the return type from
CollectionResponseExtensionActionDefinitionForwardPaging|ErrortoCollectionResponsePublicActionDefinitionForwardPaging|ErrorofgetPage()method ofautomation()->actions()->definitionsApi(). - Changed the return type from
ActionFunctionIdentifier|ErrortoPublicActionFunctionIdentifier|ErrorofcreateOrReplaceByFunctionType()andcreateOrReplace()methods ofautomation()->actions()->functionsApi(). - Changed the return type from
ActionFunction|ErrortoPublicActionFunction|ErrorofgetByFunctionType()andgetById()methods ofautomation()->actions()->functionsApi(). - Changed the return type from
CollectionResponseActionFunctionIdentifierNoPaging|ErrortoCollectionResponsePublicActionFunctionIdentifierNoPaging|ErrorofgetPage()method ofautomation()->actions()->functionsApi(). - Changed the return type from
ActionRevision|ErrortoPublicActionRevision|ErrorofgetById()method ofautomation()->actions()->revisionsApi(). - Changed the return type from
CollectionResponseActionRevisionForwardPaging|ErrortoCollectionResponsePublicActionRevisionForwardPaging|ErrorofgetPage()method ofautomation()->actions()->revisionsApi(). - Added
automation_field_typeparam toHubSpot\Client\Automation\Actions\Model\InputFieldDefinition. - Added new params to
HubSpot\Client\Automation\Actions\Model\FieldTypeDefinition:
'help_text' => 'string',
'name' => 'string',
'description' => 'string',
'external_options_reference_type' => 'string',
'label' => 'string',
'type' => 'string',
'field_type' => 'string',
'options_url' => 'string',
'external_options' => 'bool'CMS clients
- Changed the order of input params from
$object_id = null, $user_id = null, $after = null, $before = null, $sort = null, $event_type = null, $limit = null, $object_type = nullto$user_id = null, $event_type = null, $object_type = null, $object_id = null, $after = null, $before = null, $limit = null, $sort = nullincms()->auditLogs()->auditLogsApi()->getPage(). - Removed params
scope_to_scope_group_pks,trial_scopesandtrial_scope_to_scope_group_pksfromHubSpot\Client\Auth\OAuth\Model\AccessTokenInfoResponse. - Added
prevparam toHubSpot\Client\Cms\AuditLogs\Model\Paging. - Added
propertyparam togetById()andgetPage()methods ofcms()->blogs()->authors()->blogAuthorsApi(),cms()->blogs()->blogPosts()->blogPostsApi()andcms()->blogs()->tags()->blogTagsApi(). - Change return type from
ErrortovoidofattachToLangGroup(),detachFromLangGroup()andupdateLangs()methods ofcms()->blogs()->authors()->blogAuthorsApi(),cms()->blogs()->blogPosts()->blogPostsApi()andcms()->blogs()->tags()->blogTagsApi(). - Removed languages constants from
AttachToLangPrimaryRequestVNextandUpdateLanguagesRequestVNextobjects for all CMS blogs clients. - Changed type from
objecttostringinStandardError:categoryfor all CMS blogs clients. - Removed background position's constants from
HubSpot\Client\Cms\Blogs\BlogPosts\Model\BackgroundImage. - Changed type from
inttostringinHubSpot\Client\Cms\Hubdb\Model\HubDbTableRowV3BatchUpdateRequest:id. - Renamed method
get()todownload()ofcms()->sourceCode()->contentApi(). - Renamed method
replace()tocreateOrUpdate()ofcms()->sourceCode()->contentApi(). - Added param
propertiestocms()->sourceCode()->metadataApi()->get(). - Added param
hashtoHubSpot\Client\Cms\SourceCode\Model\AssetFileMetadata.
CRM Associations and Objects clients
Note
Please note that CRM Objects includes: companies, contacts, deals, line items, all CRM objects crm->objects(), products, quotes and tickets
- Changed type of
$object_idand$to_object_idparams frominttostringincrm()->associations()->v4()->basicApi()->archive(). - Changed type of
$object_idand$to_object_idparams frominttostringincrm()->associations()->v4()->basicApi()->create(). - Changed type of
$from_object_idand$to_object_idparams frominttostringincrm()->associations()->v4()->basicApi()->createDefault(). - Changed type of
$object_idparam frominttostringincrm()->associations()->v4()->basicApi()->getPage(). - Changed type from
StandardError1[]toStandardError[]inHubSpot\Client\Crm\Associations\v4\Model\BatchResponsePublicDefaultAssociation:errors. - Changed type of
to_object_idandfrom_object_idparams frominttostringinHubSpot\Client\Crm\Associations\v4\Model\LabelsBetweenObjectPair. - Changed type from
inttostringinHubSpot\Client\Crm\Associations\v4\Model\MultiAssociatedObjectWithLabel:to_object_id. - Changed type from
ErrorCategorytostringinHubSpot\Client\Crm\Associations\v4\Model\StandardError:category. - Renamed method
delete()toarchive()ofcrm()->associations()->v4()->schema()->definitionsApi(). - Added param
inverseLabeltoHubSpot\Client\Crm\Associations\v4\Model\PublicAssociationDefinitionCreateRequestandHubSpot\Client\Crm\Associations\v4\Model\PublicAssociationDefinitionUpdateRequest. - Changed type from
ErrorCategorytostringinHubSpot\Client\Crm\Associations\Model\StandardError:category. - Changed type from
inttostringinPublicObjectSearchRequest:afterin all CRM objects clients. - Added param
id_propertytoSimplePublicObjectBatchInputin all CRM objects clients. - Removed
crm()->objects()->associationsApi(). - Renamed param from
$postal_mailto$postal_mail_idinarchive(),getById()andupdate()ofcrm()->objects()->postalMail()->basicApi().
Added APIs to CRM Objects clients
crm()->companies()->gdprApi()API.crm()->deals()->gdprApi()API.crm()->line_items()->gdprApi()API.crm()->objects()->calls()->gdprApi()API.crm()->objects()->communications()->gdprApi()API.crm()->objects()->emails()->gdprApi()API.crm()->objects()->feedbackSubmissions()->gdprApi()API.crm()->objects()->meetings()->gdprApi()API.crm()->objects()->notes()->gdprApi()API.crm()->objects()->postalMail.gdprApi()API.crm()->objects()->tasks()->gdprApi()API.crm()->products()->gdprApi()API.crm()->quotes()->gdprApi()API.crm()->tickets()->gdprApi()API.
The other CRM clients
- Changed the order of input params from
$app_id, $card_idto$card_id, $app_idincrm()->extensions()->cards()->cardsApi()->archive(). - Changed the return type from
CardResponse|ErrortoPublicCardResponse|Errorofcreate(),getById()andupdate()methods ofcrm()->extensions()->cards()->cardsApi(). - Changed the return type from
CardListResponse|ErrortoPublicCardListResponse|ErrorofgetAll()method ofcrm()->extensions()->cards()->cardsApi(). - Changed the order of input params from
$app_id, $card_idto$card_id, $app_idincrm()->extensions()->cards()->cardsApi()->getById(). - Changed the order of input params from
$app_id, $card_id, $card_patch_requestto$card_id, $app_id, $card_patch_requestincrm()->extensions()->cards()->cardsApi()->update(). - Added
serverless_functionandcard_typeparams toHubSpot\Client\Crm\Extensions\Cards\Model\CardFetchBodyandHubSpot\Client\Crm\Extensions\Cards\Model\CardFetchBodyPatch. - Added
NAME_MARKETING_EVENTSconst toHubSpot\Client\Crm\Extensions\Cards\Model\CardObjectTypeBody. - Added
audit_historyparam toHubSpot\Client\Crm\Extensions\Cards\Model\PublicCardResponse. - Added
fetch_accounts_uriparam toHubSpot\Client\Crm\Extensions\Videoconferencing\Model\ExternalSettings. - Added
import_templateandimport_sourceparams toHubSpot\Client\Crm\Imports\Model\PublicImportResponse. - Renamed method
delete()toremove()ofcrm()->lists()->listsApi(). - Renamed method
deleteAll()toremoveAll()ofcrm()->lists()->listsApi(). - Added param
$validate_deal_stage_usages_before_deletetocrm()->pipelines()->pipelinesApi()->archive(),crm()->pipelines()->pipelinesApi()->replace()andcrm()->pipelines()->pipelinesApi()->update(). - Added
write_permissionsparam toHubSpot\Client\Crm\Pipelines\Model\PipelineStage. - Added
descriptionparam toHubSpot\Client\Crm\Schemas\Model\ObjectSchema,HubSpot\Client\Crm\Schemas\Model\ObjectSchemaEgg,HubSpot\Client\Crm\Schemas\Model\ObjectTypeDefinitionandHubSpot\Client\Crm\Schemas\Model\ObjectTypeDefinitionPatch. - Added
option_sort_strategy,show_currency_symbol,form_field,referenced_object_type,text_display_hint,searchable_in_global_searchandnumber_display_hintparams toHubSpot\Client\Crm\Schemas\Model\ObjectTypePropertyCreate. - Added
calculation_formulaparam toHubSpot\Client\Crm\Schemas\Model\Property. - Changed the return type from
BatchResponseTimelineEventResponse|BatchResponseTimelineEventResponseWithErrors|ErrortovoidofcreateBatch()method ofcrm()-timeline()->eventsApi(). - Changed type from
ErrorCategorytostringinHubSpot\Client\Crm\Timeline\Model\StandardError:category. - Removed
hapikeyfromcrm()->extensions()->videoconferencing()...
10.3.0
Updated:
- Added
cms()->pages()api client. - Added
crm()->lists()api client. - Added
crm()->objects()->goals()api client. - Added
crm()->objects()->taxes()api client. - Added
events()->send()api client. - Added
settings()->businessUnits()api client. - Fixed non ascii chars.
10.2.0
Changes:
- Added
marketing()->forms()api client. - Removed composer.lock.
10.1.2
Merge pull request #278 from HubSpot/feature/bumpVersion 10.1.2
10.1.1
Merge pull request #276 from HubSpot/bump/version 10.1.1
10.1.0
Removed hapikey from:
- automation()->actions()->callbacksApi() Api.
- cms() (all Api clients).
- communicationPreferences() (all Api clients).
- conversations() (all API clients).
- crm() (all Api clients).
- events() (all Api clients).
- files() (all Api clients).
- marketing()->events()->settingsExternalApi() Api.
- marketing()->transactional() Api client.
Updated:
- Cnange type from object to string in HubSpot\Client\Cms\Hubdb\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Associations\V4\Model\StandardError[] to \HubSpot\Client\Crm\Associations\V4\Model\StandardError1[] in \HubSpot\Client\Crm\Associations\V4\Model\BatchResponseSimplePublicObjectWithErrors::errors.
- Cnange type from \HubSpot\Client\Crm\Companies\Model\ErrorCategory to string inHubSpot\Client\Crm\Companies\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Contacts\Model\ErrorCategory to string inHubSpot\Client\Crm\Contacts\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Deals\Model\ErrorCategory to string inHubSpot\Client\Crm\Deals\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\LineItems\Model\ErrorCategory to string inHubSpot\Client\Crm\LineItems\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Calls\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Calls\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Communications\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Communications\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Emails\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Emails\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\FeedbackSubmissions\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\FeedbackSubmissions\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Meetings\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Meetings\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Notes\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Notes\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\PostalMail\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\PostalMail\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Objects\Tasks\Model\ErrorCategory to string inHubSpot\Client\Crm\Objects\Tasks\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Products\Model\ErrorCategory to string inHubSpot\Client\Crm\Products\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Properties\Model\ErrorCategory to string inHubSpot\Client\Crm\Properties\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Quotes\Model\ErrorCategory to string inHubSpot\Client\Crm\Quotes\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Crm\Tickets\Model\ErrorCategory to string inHubSpot\Client\Crm\Tickets\Model\StandardError::category.
- Cnange type from \HubSpot\Client\Webhooks\Model\ErrorCategory to string inHubSpot\Client\Webhooks\Model\StandardError::category.
Fix HubSpot\Enums\AssociationTypes enum.
Merge pull request #263 from HubSpot/feature/FixAssociationTypesEnum Fix AssociationTypes enum
10.0.0
Fixed Utils\OAuth2::getAuthUrl() (don't add empty scopes or optional scopes to OAuth url).