Releases: HubSpot/hubspot-api-python
v9.0.0
Automation Actions client
- Updated
automation.actions.definitions_api.create()
method to acceptpublic_action_definition_egg
instead ofextension_action_definition_input
and returnedPublicActionDefinition
insteadExtensionActionDefinition
. - Updated
automation.actions.definitions_api.get_by_id()
method to returnPublicActionDefinition
instead ofExtensionActionDefinition
. - Updated
automation.actions.definitions_api.get_page()
method to returnCollectionResponsePublicActionDefinitionForwardPaging
instead ofCollectionResponseExtensionActionDefinitionForwardPaging
. - Updated
automation.actions.definitions_api.update()
method to acceptpublic_action_definition_patch
instead ofextension_action_definition_patch
and returnedPublicActionDefinition
insteadExtensionActionDefinition
. - Updated
automation.actions.functions_api.create_or_replace()
method to returnPublicActionFunctionIdentifier
instead ofActionFunctionIdentifier
. - Updated
automation.actions.functions_api.create_or_replace_by_function_type()
method to returnPublicActionFunctionIdentifier
instead ofActionFunctionIdentifier
. - Updated
automation.actions.functions_api.get_by_function_type()
method to returnPublicActionFunction
instead ofActionFunction
. - Updated
automation.actions.functions_api.get_by_id()
method to returnPublicActionFunction
instead ofActionFunction
. - Updated
automation.actions.functions_api.get_page()
method to returnCollectionResponsePublicActionFunctionIdentifierNoPaging
instead ofCollectionResponseActionFunctionIdentifierNoPaging
. - Updated
automation.actions.revisions_api.get_by_id()
method to returnPublicActionRevision
instead ofActionRevision
. - Updated
automation.actions.revisions_api.get_page()
method to returnCollectionResponsePublicActionRevisionForwardPaging
instead ofCollectionResponseActionRevisionForwardPaging
. - Added new function type
POST_ACTION_EXECUTION
toautomation.actions.models.PublicActionFunctionIdentifier
andautomation.actions.models.PublicActionFunction
. - Added new param
automation_field_type
toautomation.actions.models.InputFieldDefinition
. - Added
automation.actions.models.OutputFieldDefinition
. - Added
automation.actions.models.PublicExecutionTranslationRule
. - Added new params to
automation.actions.models.FieldTypeDefinition
:
{
"help_text": "str",
"referenced_object_type": "str",
"name": "str",
"options": "list[Option]",
"description": "str",
"external_options_reference_type": "str",
"label": "str",
"type": "str",
"field_type": "str",
"options_url": "str",
"external_options": "bool",
}
CMS clients
- Changed
attach_to_lang_group()
,detach_from_lang_group()
andupdate_langs()
methods of all Api clients(cms.blogs.authors.blog_authors_api
,cms.blogs.blog_posts.blog_posts_api
andcms.blogs.tags.blog_tags_api
) returnNone
instead ofError
. - Added new param
_property
tocms.blogs.authors.blog_authors_api.get_by_id()
andcms.blogs.authors.blog_authors_api.get_page()
. - Renamed
cms.source_code.content_api.get()
method tocms.source_code.content_api.download()
. - Renamed
cms.source_code.content_api.replace()
method tocms.source_code.content_api.create_or_update()
. - Added new param
hash
tocms.source_code.models.AssetFileMetadata
. - Added new param
properties
tocms.source_code.metadata_api.get()
.
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 the type of parameter
category
fromErrorCategory
tostring
incrm.associations.models.StandardError
. - Renamed
crm.associations.v4.schema.definitions_api.delete()
method tocrm.associations.v4.schema.definitions_api.archive()
. - Changed the type of parameters
object_id
andcrm.associations.v4.basic_api.to_object_id
incrm.associations.v4.basic_api.archive()
,crm.associations.v4.basic_api.create()
andcrm.associations.v4.basic_api.create_default()
methods fromstring
toint
. - Changed the type of parameter
object_id
incrm.associations.v4.basic_api.get_page()
method fromstring
toint
. - Changed the type of parameters
to_object_id
andfrom_object_id
incrm.associations.v4.models.LabelsBetweenObjectPair
tostring
. - Changed the type of parameter
to_object_id
incrm.associations.v4.models.MultiAssociatedObjectWithLabel
tostring
. - Changed the type of property
category
inErrorCategory
tostring
incrm.associations.v4.models.StandardError
. - Changed the type of property
errors
incrm.associations.v4.models.BatchResponsePublicDefaultAssociation
fromStandardError1[]
toStandardError[]
. - Added parameter
inverse_label
tocrm.associations.v4.models.PublicAssociationDefinitionCreateRequest
andcrm.associations.v4.models.PublicAssociationDefinitionUpdateRequest
. - Updated
crm.time_line.events_api.create_batch()
method to returnNone
instedBatchResponseTimelineEventResponse
. - Changed the type of parameter
category
fromErrorCategory
tostring
incrm.time_line.models.StandardError
. - Removed
crm.objects.associations_api
. - Renamed param
postal_mail
topostal_mail_id
incrm.objects.postal_mail.basic_api()
. - Changed the type of parameter
after
fromint
tostring
in all CRM modelsPublicObjectSearchRequest
. - Added new param
id_property
in all CRM modelsSimplePublicObjectBatchInput
.
CRM Extensions client
- Changed parameter order in
crm.extinsions.cards_api.archive()
method from(app_id, card_id)
to(card_id, app_id)
. - Updated
crm.extinsions.cards_api.create()
method to returnPublicCardResponse
insteadCardResponse
. - Updated
crm.extinsions.cards_api.get_all()
method to returnPublicCardListResponse
insteadCardListResponse
. - Changed parameter order in
crm.extinsions.cards_api.get_by_id()
method from(app_id, card_id)
to(card_id, app_id)
and method returnPublicCardResponse
insteadCardResponse
. - Changed parameter order in
crm.extinsions.cards_api.update()
method from(app_id, card_id, card_patch_request)
to(card_id, app_id, card_patch_request)
and method returnPublicCardResponse
insteadCardResponse
. - Added new params
serverless_function
andcard_type
tocrm.extinsions.models.CardFetchBody
andcrm.extinsions.models.CardFetchBodyPatch
. - Added new param
audit_history
tocrm.extinsions.models.PublicCardResponse
. - Added new allowable value
marketing_events
tocrm.extinsions.models.CardObjectTypeBody
. - Added
developer_hapikey
tocrm.extinsions.videoconferencing.settings_api
. - Added new param
fetch_accounts_uri
tocrm.extinsions.videoconferencing.models.ExternalSettings
. - Marked
CRM Extensions Accounting Apis
as deprecated.
CRM clients
- Added
import_template
andimport_source
params tocrm.imports.models.PublicImportResponse
. - Renamed Api client from
crm.lists.memberships_api()
tocrm.lists.list_app_membership_api()
. - Renamed Api client from
crm.lists.lists_api()
tocrm.lists.list_app_api()
. - Changed the type of parameters
list_id
andlist_ids: list[]
fromint
tostring
in all methods of apicrm.lists.list_app_api()
. - Changed the type of parameters
list_id
,request_body: list[]
andsource_list_id
fromint
tostring
in all methods of apicrm.lists.list_app_membership_api()
. - Renamed method
crm.lists.memberships_api.add_remove()
tocrm.lists.list_app_membership_api.add_and_remove()
. - Renamed
crm.lists.models.CollectionResponseLong
tocrm.lists.models.CollectionResponseJoinTimeAndRecordId
. - Changed the type of parameter
results: list[int]
toresults: list[JoinTimeAndRecordId]
incrm.lists.models.CollectionResponseJoinTimeAndRecordId
. - Changed the type of parameter
list_id
,business_unit_id
,subscription_ids: list[]
,email_id
,app_id
,updated_by_id
,rtype: list[]
,record_ids_to_remove: list[]
,record_ids_to_add: list[]
,record_ids_removed: list[]
,records_ids_added: list[]
andrecord_ids_missing: list[]
fromint
tostring
in allcrm.lists.models
in which these parameters are present. - Added param
validate_deal_stage_usages_before_delete
tocrm.pipelines.pipelines_api.archive()
,crm.pipelines.pipelines_api.replace()
andcrm.pipelines.pipelines_api.update()
methods. - Added
write_permissions
param tocrm.pipelines.models.PipelineStage
. - Added
description
param tocrm.schemas.models.ObjectTypeDefinitionPatch
. - Added new params:
option_sort_strategy
,show_currency_symbol
,form_field
,referenced_object_type
,text_display_hint
,searchable_in_global_search
andnumber_display_hint
tocrm.schemas.models.ObjectTypePropertyCreate
.
Marketing client
- Moved methods
archive()
,create()
,do_cancel()
,get_by_id()
,replace()
andupdate()
frommarketing.events.marketing_events_external_api()
tomarketing.events.basic_api
. - Moved method
do_upsert()
frommarketing.events.marketing_events_external_api()
tomarketing.events.batch_api()
. - Moved and renamed method
archive_batch()
toarchive()
frommarketing.events.marketing_events_external_api.archive_batch()
tomarketing.events.batch_api.archive()
. - Moved methods
do_email_upsert_by_id()
anddo_upsert_by_id()
frommarketing.events.marketing_events_external_api()
tomarketing.events.subscriber_state_changes()
. - Renamed Api
marketing.events.settings_external_api()
tomarketing.events.settings_api()
. - Added new param
is_large_value
tomarketing.events.models.PropertyValue
. - Changed the type of parameter
category
fromErrorCategory
tostring
inmarketing.events.models.StandardError
. - Added new param
lifecycle_stages
to `marketing.forms....
Added new parameters to the `PublicUser` model in `settings.users.models`
- Added new parameters to the
PublicUser
model insettings.users.models
:super_admin
: boolean.send_welcome_email
: boolean.
8.2.0
Added:
- cms.pages Api client.
- crm.lists Api client.
- crm.objects.goals Api client.
- crm.objects.taxes Api client.
- events.send Api client.
- settings.business_units Api client.
Fix initializing `developer_hapikey`
Merge pull request #239 from HubSpot/feature/8.1.1 8.1.1
8.1.0
Removed hapikey
from
-
automation.actions.callbacks_api
Api. -
cms
(all Api clients). -
communication_preferences
(all Api clients). -
conversations
(all API clients). -
crm
(all Api clients). -
events
(all Api clients). -
files
(all Api clients). -
marketing.events.settings_external_api
Api. -
marketing.transactional
Api client.
Updated -
Change type from
object
tostring
incms/hubdb/models/StandardError.category
. -
Change type from
StandardError[]
toStandardError1[]
incrm/associations/v4/models/BatchResponseSimplePublicObjectWithErrors.errors
. -
Change type from
ErrorCategory
tostring
incrm/companies/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/contacts/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/deals/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/lineitems/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/calls/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/communications/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/emails/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/feedback_submissions/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/meetings/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/notes/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/postal_mail/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/objects/tasks/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/products/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/properties/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/quotes/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
incrm/tickets/models/StandardError.category
. -
Change type from
ErrorCategory
tostring
inwebhooks/models/StandardError.category
. -
example in README(SimplePublicObjectInputForCreate)
v8.0.0
Fix utils.get_auth_url()
(don’t add empty scopes or optional scopes to OAuth url)
Removed deprecated Webhooks util
- Removed deprecated
webhooks
util. - add more association types
- add custom exceptions for Signature
- Update README
Add missing crm.associations.v4.basic_api Api.
- add missing crm.associations.v4.basic_api Api.
Update associations clients
Added
- crm.associations.v4.basic_api Api.
Updated
- crm.associations.types_api -> crm.associations.schema.types_api.
- crm.associations.v4.definitions_api -> crm.associations.v4.schema.definitions_api.
Added crm.objects.communications API client
Merge pull request #197 from HubSpot/feature/8.0.0-beta-3 8.0.0-beta.3