Skip to content

11.0.0

Compare
Choose a tag to compare
@ksvirkou-hubspot ksvirkou-hubspot released this 06 Mar 13:15
· 109 commits to master since this release
258baf2

Major change for SDK

  • Update Php version >=7.4

Automation Action client

  • Changed type of $extension_action_definition_input input param from ExtensionActionDefinition to PublicActionDefinition in automation()->actions()->definitionsApi()->create().
  • Renamed and changed type the third input param of automation()->actions()->definitionsApi()->update() from ExtensionActionDefinitionPatch $extension_action_definition_patch to PublicActionDefinition $public_action_definition_patch.
  • Changed the return type from ExtensionActionDefinition|Error to PublicActionDefinition|Error of create(), getById() and update() methods of automation()->actions()->definitionsApi().
  • Changed the return type from CollectionResponseExtensionActionDefinitionForwardPaging|Error to CollectionResponsePublicActionDefinitionForwardPaging|Error of getPage() method of automation()->actions()->definitionsApi().
  • Changed the return type from ActionFunctionIdentifier|Error to PublicActionFunctionIdentifier|Error of createOrReplaceByFunctionType() and createOrReplace() methods of automation()->actions()->functionsApi().
  • Changed the return type from ActionFunction|Error to PublicActionFunction|Error of getByFunctionType() and getById() methods of automation()->actions()->functionsApi().
  • Changed the return type from CollectionResponseActionFunctionIdentifierNoPaging|Error to CollectionResponsePublicActionFunctionIdentifierNoPaging|Error of getPage() method of automation()->actions()->functionsApi().
  • Changed the return type from ActionRevision|Error to PublicActionRevision|Error of getById() method of automation()->actions()->revisionsApi().
  • Changed the return type from CollectionResponseActionRevisionForwardPaging|Error to CollectionResponsePublicActionRevisionForwardPaging|Error of getPage() method of automation()->actions()->revisionsApi().
  • Added automation_field_type param to HubSpot\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 = null to $user_id = null, $event_type = null, $object_type = null, $object_id = null, $after = null, $before = null, $limit = null, $sort = null in cms()->auditLogs()->auditLogsApi()->getPage().
  • Removed params scope_to_scope_group_pks, trial_scopes and trial_scope_to_scope_group_pks from HubSpot\Client\Auth\OAuth\Model\AccessTokenInfoResponse.
  • Added prev param to HubSpot\Client\Cms\AuditLogs\Model\Paging.
  • Added property param to getById() and getPage() methods of cms()->blogs()->authors()->blogAuthorsApi(), cms()->blogs()->blogPosts()->blogPostsApi() and cms()->blogs()->tags()->blogTagsApi().
  • Change return type from Error to void of attachToLangGroup(), detachFromLangGroup() and updateLangs() methods of cms()->blogs()->authors()->blogAuthorsApi(), cms()->blogs()->blogPosts()->blogPostsApi() and cms()->blogs()->tags()->blogTagsApi().
  • Removed languages constants from AttachToLangPrimaryRequestVNext and UpdateLanguagesRequestVNext objects for all CMS blogs clients.
  • Changed type from object to string in StandardError:category for all CMS blogs clients.
  • Removed background position's constants from HubSpot\Client\Cms\Blogs\BlogPosts\Model\BackgroundImage.
  • Changed type from int to string in HubSpot\Client\Cms\Hubdb\Model\HubDbTableRowV3BatchUpdateRequest:id.
  • Renamed method get() to download() of cms()->sourceCode()->contentApi().
  • Renamed method replace() to createOrUpdate() of cms()->sourceCode()->contentApi().
  • Added param properties to cms()->sourceCode()->metadataApi()->get().
  • Added param hash to HubSpot\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_id and $to_object_id params from int to string in crm()->associations()->v4()->basicApi()->archive().
  • Changed type of $object_id and $to_object_id params from int to string in crm()->associations()->v4()->basicApi()->create().
  • Changed type of $from_object_id and $to_object_id params from int to string in crm()->associations()->v4()->basicApi()->createDefault().
  • Changed type of $object_id param from int to string in crm()->associations()->v4()->basicApi()->getPage().
  • Changed type from StandardError1[] to StandardError[] in HubSpot\Client\Crm\Associations\v4\Model\BatchResponsePublicDefaultAssociation:errors.
  • Changed type of to_object_id and from_object_id params from int to string in HubSpot\Client\Crm\Associations\v4\Model\LabelsBetweenObjectPair.
  • Changed type from int to string in HubSpot\Client\Crm\Associations\v4\Model\MultiAssociatedObjectWithLabel:to_object_id.
  • Changed type from ErrorCategory to string in HubSpot\Client\Crm\Associations\v4\Model\StandardError:category.
  • Renamed method delete() to archive() of crm()->associations()->v4()->schema()->definitionsApi().
  • Added param inverseLabel to HubSpot\Client\Crm\Associations\v4\Model\PublicAssociationDefinitionCreateRequest and HubSpot\Client\Crm\Associations\v4\Model\PublicAssociationDefinitionUpdateRequest.
  • Changed type from ErrorCategory to string in HubSpot\Client\Crm\Associations\Model\StandardError:category.
  • Changed type from int to string in PublicObjectSearchRequest:after in all CRM objects clients.
  • Added param id_property to SimplePublicObjectBatchInput in all CRM objects clients.
  • Removed crm()->objects()->associationsApi().
  • Renamed param from $postal_mail to $postal_mail_id in archive(), getById() and update() of crm()->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_id to $card_id, $app_id in crm()->extensions()->cards()->cardsApi()->archive().
  • Changed the return type from CardResponse|Error to PublicCardResponse|Error of create(), getById() and update() methods of crm()->extensions()->cards()->cardsApi().
  • Changed the return type from CardListResponse|Error to PublicCardListResponse|Error of getAll() method of crm()->extensions()->cards()->cardsApi().
  • Changed the order of input params from $app_id, $card_id to $card_id, $app_id in crm()->extensions()->cards()->cardsApi()->getById().
  • Changed the order of input params from $app_id, $card_id, $card_patch_request to $card_id, $app_id, $card_patch_request in crm()->extensions()->cards()->cardsApi()->update().
  • Added serverless_function and card_type params to HubSpot\Client\Crm\Extensions\Cards\Model\CardFetchBody and HubSpot\Client\Crm\Extensions\Cards\Model\CardFetchBodyPatch.
  • Added NAME_MARKETING_EVENTS const to HubSpot\Client\Crm\Extensions\Cards\Model\CardObjectTypeBody.
  • Added audit_history param to HubSpot\Client\Crm\Extensions\Cards\Model\PublicCardResponse.
  • Added fetch_accounts_uri param to HubSpot\Client\Crm\Extensions\Videoconferencing\Model\ExternalSettings.
  • Added import_template and import_source params to HubSpot\Client\Crm\Imports\Model\PublicImportResponse.
  • Renamed method delete() to remove() of crm()->lists()->listsApi().
  • Renamed method deleteAll() to removeAll() of crm()->lists()->listsApi().
  • Added param $validate_deal_stage_usages_before_delete to crm()->pipelines()->pipelinesApi()->archive(), crm()->pipelines()->pipelinesApi()->replace() and crm()->pipelines()->pipelinesApi()->update().
  • Added write_permissions param to HubSpot\Client\Crm\Pipelines\Model\PipelineStage.
  • Added description param to HubSpot\Client\Crm\Schemas\Model\ObjectSchema, HubSpot\Client\Crm\Schemas\Model\ObjectSchemaEgg, HubSpot\Client\Crm\Schemas\Model\ObjectTypeDefinition and HubSpot\Client\Crm\Schemas\Model\ObjectTypeDefinitionPatch.
  • Added option_sort_strategy, show_currency_symbol, form_field, referenced_object_type, text_display_hint, searchable_in_global_search and number_display_hint params to HubSpot\Client\Crm\Schemas\Model\ObjectTypePropertyCreate.
  • Added calculation_formula param to HubSpot\Client\Crm\Schemas\Model\Property.
  • Changed the return type from BatchResponseTimelineEventResponse|BatchResponseTimelineEventResponseWithErrors|Error to void of createBatch() method of crm()-timeline()->eventsApi().
  • Changed type from ErrorCategory to string in HubSpot\Client\Crm\Timeline\Model\StandardError:category.
  • Removed hapikey from crm()->extensions()->videoconferencing() API client.
  • Added crm()->extensions()->calling()->recordingSettingsApi() API.

Marketing clients

  • Added marketing()->events()->basicApi() API.
  • Added marketing()->events()->batchApi() API.
  • Moved method archive from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->basicApi().
  • Moved method create from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->basicApi().
  • Moved method doCancel from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->basicApi().
  • Moved method getById from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->basicApi().
  • Moved method replace from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->basicApi().
  • Moved method update from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->basicApi().
  • Moved and rename method archiveBatch => archive from marketing()->events()->marketingEventsExternalApi()->archiveBatch() to marketing()->events()->batchApi()->archive().
  • Moved method doUpsert from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->batchApi().
  • Moved method doEmailUpsertById from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->subscriberStateChanges().
  • Moved method doUpsertById from marketing()->events()->marketingEventsExternalApi() to marketing()->events()->subscriberStateChanges.
  • Renamed marketing()->events()->settingsExternalApi() => marketing()->events()->settingsApi().
  • Added is_large_value param to HubSpot\Client\Marketing\Events\Model\PropertyValue.
  • Changed type from ErrorCategory to string in HubSpot\Client\Marketing\Events\Model\StandardError:category.
  • Changed type from object to HubSpotFormDefinitionAllOfLegalConsentOptions in HubSpot\Client\Marketing\Forms\Model\CollectionResponseFormDefinitionBaseForwardPagingResultsInner:legal_consent_options, HubSpot\Client\Marketing\Forms\Model\FormDefinitionBase:legal_consent_options, HubSpot\Client\Marketing\Forms\Model\FormDefinitionCreateRequestBase:legal_consent_options, HubSpot\Client\Marketing\Forms\Model\HubSpotFormDefinition:legal_consent_options and HubSpot\Client\Marketing\Forms\Model\HubSpotFormDefinitionCreateRequest:legal_consent_options.
  • Added lifecycle_stages param to HubSpot\Client\Marketing\Forms\Model\HubSpotFormConfiguration.

Events, Files and Settings clients

  • Changed input params from $occurred_after = null, $occurred_before = null, $object_type = null, $object_id = null, $event_type = null, $after = null, $before = null, $limit = null, $sort = null to $object_type = null, $event_type = null, $occurred_after = null, $occurred_before = null, $object_id = null, $index_table_name = null, $index_specific_metadata = null, $after = null, $before = null, $limit = null, $sort = null, $object_property_propname = null, $property_propname = null, $id = null in events()->eventsApi()->getPage().
  • Added prev param to HubSpot\Client\Events\Model\Paging.
  • Renamed behavioralEventsTrackingApi API to customEventDataApi in events()->send() API client.
  • Added method getMetadata() to files()->filesApi().
  • Added expires_at param to HubSpot\Client\Files\Model\File and HubSpot\Client\Files\Model\FileUpdateInput.
  • Changed type from ErrorCategory to string in HubSpot\Client\Files\Model\StandardError:category.
  • Added role_ids, send_welcome_email and super_admin params to HubSpot\Client\Settings\Users\Model\PublicUser.