11.0.0

Associations

• Added assiciations.v4.report_api Api.
• Added assiciations.v4.schema.definition_configurations_api Api.

Marketing Events

• Added marketing.events.list_associations_api Api.
• Renamed method create_by_contact_email to record_by_contact_emails in marketing.events.attendance_subscriber_state_changes_api.
• Renamed method create_by_contact_id to record_by_contact_ids in marketing.events.attendance_subscriber_state_changes_api.
• Remove parameters attendance_state_calculation_timestamp and import_status to marketing.events.models.marketing_event_update_request_params.

Other changes

• Added api_request Api(for requests by curl).
• Enhance get_all method.
• Added possibility change all configuration params("proxy", "proxy_headers" and ect.).
• Fix call crm.tickets.merge_api.
• Update README.
• Update requires.
• Update Makefile.

10.0.0

CMS

• Added parameter campaign_name to cms.blogs.blog_posts.models.content_language_variation.
• Added parameter breakpoint_styles to cms.blogs.blog_posts.models.styles.
• Added parameter name to cms.hubdb.rows_api.clone_draft_table_row().
• Added parameter archived to cms.hubdb.rows_api.get_draft_table_row_by_id() and cms.hubdb.rows_api.get_table_row().
• Added parameters offset and archived to cms.hubdb.rows_api.get_table_rows() and cms.hubdb.rows_api.read_draft_table_rows().
• Added parameter content_type parameter to cms.hubdb.tables_api.export_table() and cms.hubdb.tables_api.get_all_tables().
• Added parameter is_get_localized_schema parameter to cms.hubdb.tables_api.get_draft_table_details_by_id(), cms.hubdb.tables_api.get_table_details() and cms.hubdb.tables_api.update_draft_table().
• Added parameters created_by_user_id, updated_by, updated_by_user_id, created_at, created_by and updated_at to cms.hubdb.models.column and cms.hubdb.models.option.
• Added parameter is_hubspot_defined to cms.hubdb.models.hub_db_table_clone_request.
• Added do_async() and get_async_status() methods to cms.source_code.extract_api.
• Changed the response object type from CollectionResponseWithTotalHubDbTableRowV3ForwardPaging to UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3 for cms.hubdb.rows_api.get_table_rows() and cms.hubdb.rows_api.read_draft_table_rows().
• Changed parameter batch_input_string: BatchInputString to batch_input_hub_db_table_row_batch_clone_request: BatchInputHubDbTableRowBatchCloneRequest in cms.hubdb.rows_api.clone_draft_table_row().
• Updated language validation: Added a predefined list of allowed_values for stricter validation for cms.blogs.blog_posts.models.attach_to_lang_primary_request_v_next.
• Updated type validation: Expanded allowed_values for validation for cms.hubdb.models.column_request.
• Removed cms.source_code.extract_api.extract_by_path() method.
• Removed cms.source_code.source_code_extract_api.

CRM

• Added crm.objects.leads Api client.
• Added method upsert to crm.companies.batch_api, crm.contacts.batch_api, crm.deals.batch_api, crm.line_items.batch_api, crm.objects.batch_api, crm.objects.calls.batch_api, crm.objects.communications.batch_api, crm.objects.emails.batch_api, crm.objects.meetings.batch_api, crm.objects.notes.batch_api, crm.objects.postal_mail.batch_api, crm.objects.tasks.batch_api, crm.objects.taxes.batch_api, crm.products.batch_api, crm.quotes.batch_api, crm.tickets.batch_api.
• Added parameter object_write_trace_id to models: simple_public_object_input, simple_public_object_batch_input, simple_public_object_input_for_create for crm.companies, crm.contacts, crm.deals, crm.line_items, crm.objects, crm.objects.calls, crm.objects.communications, crm.objects.emails, crm.objects.meetings, crm.objects.notes, crm.objects.postal_mail, crm.objects.tasks, crm.objects.taxes, crm.products, crm.quotes, crm.tickets.
• Added method mark_as_ready() to crm.extensions.calling.recording_settings_api.
• Added parameters created_by_user_id and updated_by_user_id to crm.schemas.models.object_schema.
• Added parameter clear_description to crm.schemas.models.object_type_definition_patch.
• Added parameter supports_inbound_calling to crm.extensions.calling.models.settings_patch_request, crm.extensions.calling.models.settings_request and crm.extensions.calling.models.settings_response.
• Changed association_category and association_type_id parameters can be None in crm.companies.models.association_spec, crm.contacts.models.association_spec, crm.deals.models.association_spec, crm.tickets.models.association_spec.
• Changed types and to parameters can be None in crm.companies.models.public_associations_for_object, crm.contacts.models.public_associations_for_object, crm.deals.models.public_associations_for_object, and crm.tickets.models.public_associations_for_object.
• Changed id parameters can be None in crm.companies.models.public_object_id, crm.contacts.models.public_object_id, crm.deals.models.public_object_id, and crm.tickets.models.public_object_id.
• Changed limit, after, sorts, properties, and filter_groups parameters can be None in crm.companies.models.public_object_search_request, crm.contacts.models.public_object_search_request, crm.deals.models.public_object_search_request, crm.line_items.models.public_object_search_request, crm.objects.models.public_object_search_request, crm.objects.calls.models.public_object_search_request, crm.objects.communications.models.public_object_search_request, crm.objects.emails.models.public_object_search_request, crm.objects.goals.models.public_object_search_request, crm.objects.postal_mail.models.public_object_search_request, crm.objects.tasks.models.public_object_search_request, crm.objects.taxes.models.public_object_search_request, crm.products.models.public_object_search_request, crm.quotes.models.public_object_search_request, and crm.tickets.models.public_object_search_request.
• Changed associations parameters can be None in crm.companies.models.simple_public_object_input_for_create, crm.contacts.models.simple_public_object_input_for_create, crm.deals.models.simple_public_object_input_for_create, and crm.tickets.models.simple_public_object_input_for_create.
• Renamed public_object_api to merge_api in crm.companies, crm.contacts, crm.deals and crm.tickets.
• Removed archive, create and update methods from crm.objects.goals.basic_api and crm.objects.goals.batch_api.
• Removed GDPRApi:
  crm.companies.gdpr_api, crm.deals.gdpr_api, crm.line_items.gdpr_api, crm.objects.gdpr_api, crm.objects.calls.gdpr_api, crm.objects.communications.gdpr_api, crm.objects.emails.gdpr_api, crm.objects.goals.gdpr_api, crm.objects.meetings.gdpr_api, crm.objects.notes.gdpr_api, crm.objects.postal_mail.gdpr_api, crm.objects.tasks.gdpr_api, crm.objects.taxes.gdpr_api, crm.products.gdpr_api, crm.quotes.gdpr_api, crm.tickets.gdpr_api.
• Removed PublicObjectApi:
  crm.line_items.public_object_api, crm.objects.public_object_api, crm.objects.calls.public_object_api, crm.objects.communications.public_object_api, crm.objects.emails.public_object_api, crm.objects.goals.public_object_api, crm.objects.meetings.public_object_api, crm.objects.notes.public_object_api, crm.objects.postal_mail.public_object_api, crm.objects.tasks.public_object_api, crm.objects.taxes.public_object_api, crm.products.public_object_api, crm.quotes.public_object_api.
• Removed crm.schemas.public_object_schemas_api.
• Removed crm.extensions.accounting API client.

CRM Lists

• Added crm.objects.lists.folders_api Api.
• Added crm.lists.mapping_api Api.
• Added crm.lists.memberships_api.get_lists() and crm.lists.memberships_api.get_page_ordered_by_added_to_list_date().
• Added parameter custom_properties to crm.lists.models.list_create_request.
• Added parameters list_ids, processing_types and sort to crm.lists.models.list_search_request.
• Added parameters coalescing_refine_by to crm.lists.models.public_unified_events_filter_branch.
• Changed response object type CollectionResponseLong to ApiCollectionResponseJoinTimeAndRecordId of crm.lists.membershipsApi.get_page().
• Changed offset and additional_properties parameters can be None in crm.lists.models.list_search_request.
• Rename model from PublicEventAnalyticsFilterCoalescingRefineBy to PublicFormSubmissionFilterCoalescingRefineBy.
• Rename model from PublicPropertyFilterOperation to PublicSurveyMonkeyValueFilterValueComparison.
• Renamed Api client from crm.lists.list_app_membership_api to crm.lists.memberships_api.
• Renamed Api client from crm.lists.list_app_api to crm.lists.lists_api.

Marketing

• Added marketing.events.participant_state_api Api.
• Added new methods batch_archive, batch_upsert, cancel and complete to marketing.events.basic_api.
• Added parameter event_completed to marketing.events.models.marketing_event_public_default_response,marketing.events.models.marketing_event_create_request_params, marketing.events.models.marketing_event_default_response, marketing.events.models.marketing_event_public_read_response.
• Added parameters attendance_state_calculation_timestamp, event_completed and import_status to marketing.events.models.marketing_event_update_request_params.
• Added parameters data_sensitivity, unit and is_encrypted to marketing.events.models.property_value.
• Updated source validation: Expanded allowed_values for validation for marketing.events.models.property_value.
• Renamed method create to create_by_contact_id in marketing.events.attendance_subscriber_state_changes_api.
• Renamed method create_by_email to create_by_contact_email in marketing.events.attendance_subscriber_state_changes_api.
• Renamed method get_by_id to get_details in marketing.events.basic_api.
• Renamed method replace to upsert in marketing.events.basic_api.
• Renamed method create to update in marketing.events.settings_api.
• Renamed method do_email_upsert_by_id to upsert_by_contact_email in marketing.events.subscriber_state_changes_api.
• Renamed method do_upsert_by_id to upsert_by_contact_id in marketing.events.subscriber_state_changes_api.
• Moved method do_search from marketing.events.search_api to marketing.events.basic_api.
• Removed marketing.events.batch_api.
• Removed marketing.events.marketing_events_external_api.
• Removed marketing.events.search_api.

Events and OAuth

• Added events.api.default_api Api.
• Moved client from `auth.oauth...

v9.0.0

Automation Actions client

• Updated automation.actions.definitions_api.create() method to accept public_action_definition_egg instead of extension_action_definition_input and returned PublicActionDefinition instead ExtensionActionDefinition.
• Updated automation.actions.definitions_api.get_by_id() method to return PublicActionDefinition instead of ExtensionActionDefinition.
• Updated automation.actions.definitions_api.get_page() method to return CollectionResponsePublicActionDefinitionForwardPaging instead of CollectionResponseExtensionActionDefinitionForwardPaging.
• Updated automation.actions.definitions_api.update() method to accept public_action_definition_patch instead of extension_action_definition_patch and returned PublicActionDefinition instead ExtensionActionDefinition.
• Updated automation.actions.functions_api.create_or_replace() method to return PublicActionFunctionIdentifier instead of ActionFunctionIdentifier.
• Updated automation.actions.functions_api.create_or_replace_by_function_type() method to return PublicActionFunctionIdentifier instead of ActionFunctionIdentifier.
• Updated automation.actions.functions_api.get_by_function_type() method to return PublicActionFunction instead of ActionFunction.
• Updated automation.actions.functions_api.get_by_id() method to return PublicActionFunction instead of ActionFunction.
• Updated automation.actions.functions_api.get_page() method to return CollectionResponsePublicActionFunctionIdentifierNoPaging instead of CollectionResponseActionFunctionIdentifierNoPaging.
• Updated automation.actions.revisions_api.get_by_id() method to return PublicActionRevision instead of ActionRevision.
• Updated automation.actions.revisions_api.get_page() method to return CollectionResponsePublicActionRevisionForwardPaging instead of CollectionResponseActionRevisionForwardPaging.
• Added new function type POST_ACTION_EXECUTION to automation.actions.models.PublicActionFunctionIdentifier and automation.actions.models.PublicActionFunction.
• Added new param automation_field_type to automation.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() and update_langs() methods of all Api clients(cms.blogs.authors.blog_authors_api, cms.blogs.blog_posts.blog_posts_api and cms.blogs.tags.blog_tags_api) return None instead of Error.
• Added new param _property to cms.blogs.authors.blog_authors_api.get_by_id() and cms.blogs.authors.blog_authors_api.get_page().
• Renamed cms.source_code.content_api.get() method to cms.source_code.content_api.download().
• Renamed cms.source_code.content_api.replace() method to cms.source_code.content_api.create_or_update().
• Added new param hash to cms.source_code.models.AssetFileMetadata.
• Added new param properties to cms.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 from ErrorCategory to string in crm.associations.models.StandardError.
• Renamed crm.associations.v4.schema.definitions_api.delete() method to crm.associations.v4.schema.definitions_api.archive().
• Changed the type of parameters object_id and crm.associations.v4.basic_api.to_object_id in crm.associations.v4.basic_api.archive(), crm.associations.v4.basic_api.create() and crm.associations.v4.basic_api.create_default() methods from string to int.
• Changed the type of parameter object_id in crm.associations.v4.basic_api.get_page() method from string to int.
• Changed the type of parameters to_object_id and from_object_id in crm.associations.v4.models.LabelsBetweenObjectPair to string.
• Changed the type of parameter to_object_id in crm.associations.v4.models.MultiAssociatedObjectWithLabel to string.
• Changed the type of property category in ErrorCategory to string in crm.associations.v4.models.StandardError.
• Changed the type of property errors in crm.associations.v4.models.BatchResponsePublicDefaultAssociation from StandardError1[] to StandardError[].
• Added parameter inverse_label to crm.associations.v4.models.PublicAssociationDefinitionCreateRequest and crm.associations.v4.models.PublicAssociationDefinitionUpdateRequest.
• Updated crm.time_line.events_api.create_batch() method to return None insted BatchResponseTimelineEventResponse.
• Changed the type of parameter category from ErrorCategory to string in crm.time_line.models.StandardError.
• Removed crm.objects.associations_api.
• Renamed param postal_mail to postal_mail_id in crm.objects.postal_mail.basic_api().
• Changed the type of parameter after from int to string in all CRM models PublicObjectSearchRequest.
• Added new param id_property in all CRM models SimplePublicObjectBatchInput.

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 return PublicCardResponse instead CardResponse.
• Updated crm.extinsions.cards_api.get_all() method to return PublicCardListResponse instead CardListResponse.
• Changed parameter order in crm.extinsions.cards_api.get_by_id() method from (app_id, card_id) to (card_id, app_id) and method return PublicCardResponse instead CardResponse.
• 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 return PublicCardResponse instead CardResponse.
• Added new params serverless_function and card_type to crm.extinsions.models.CardFetchBody and crm.extinsions.models.CardFetchBodyPatch.
• Added new param audit_history to crm.extinsions.models.PublicCardResponse.
• Added new allowable value marketing_events to crm.extinsions.models.CardObjectTypeBody.
• Added developer_hapikey to crm.extinsions.videoconferencing.settings_api.
• Added new param fetch_accounts_uri to crm.extinsions.videoconferencing.models.ExternalSettings.
• Marked CRM Extensions Accounting Apis as deprecated.

CRM clients

• Added import_template and import_source params to crm.imports.models.PublicImportResponse.
• Renamed Api client from crm.lists.memberships_api() to crm.lists.list_app_membership_api().
• Renamed Api client from crm.lists.lists_api() to crm.lists.list_app_api().
• Changed the type of parameters list_id and list_ids: list[] from int to string in all methods of api crm.lists.list_app_api().
• Changed the type of parameters list_id, request_body: list[] and source_list_id from int to string in all methods of api crm.lists.list_app_membership_api().
• Renamed method crm.lists.memberships_api.add_remove() to crm.lists.list_app_membership_api.add_and_remove().
• Renamed crm.lists.models.CollectionResponseLong to crm.lists.models.CollectionResponseJoinTimeAndRecordId.
• Changed the type of parameter results: list[int] to results: list[JoinTimeAndRecordId] in crm.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[] and record_ids_missing: list[] from int to string in all crm.lists.models in which these parameters are present.
• Added param validate_deal_stage_usages_before_delete to crm.pipelines.pipelines_api.archive(), crm.pipelines.pipelines_api.replace() and crm.pipelines.pipelines_api.update() methods.
• Added write_permissions param to crm.pipelines.models.PipelineStage.
• Added description param to crm.schemas.models.ObjectTypeDefinitionPatch.
• Added new params: option_sort_strategy, show_currency_symbol, form_field, referenced_object_type, text_display_hint, searchable_in_global_search
  and number_display_hint to crm.schemas.models.ObjectTypePropertyCreate.

Marketing client

• Moved methods archive(), create(), do_cancel(), get_by_id(), replace() and update() from marketing.events.marketing_events_external_api() to marketing.events.basic_api.
• Moved method do_upsert() from marketing.events.marketing_events_external_api() to marketing.events.batch_api().
• Moved and renamed method archive_batch() to archive() from marketing.events.marketing_events_external_api.archive_batch() to marketing.events.batch_api.archive().
• Moved methods do_email_upsert_by_id() and do_upsert_by_id() from marketing.events.marketing_events_external_api() to marketing.events.subscriber_state_changes().
• Renamed Api marketing.events.settings_external_api() to marketing.events.settings_api().
• Added new param is_large_value to marketing.events.models.PropertyValue.
• Changed the type of parameter category from ErrorCategory to string in marketing.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 in settings.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 to string in cms/hubdb/models/StandardError.category.

• Change type from StandardError[] to StandardError1[] in crm/associations/v4/models/BatchResponseSimplePublicObjectWithErrors.errors.

• Change type from ErrorCategory to string in crm/companies/models/StandardError.category.

• Change type from ErrorCategory to string in crm/contacts/models/StandardError.category.

• Change type from ErrorCategory to string in crm/deals/models/StandardError.category.

• Change type from ErrorCategory to string in crm/lineitems/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/calls/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/communications/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/emails/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/feedback_submissions/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/meetings/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/notes/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/postal_mail/models/StandardError.category.

• Change type from ErrorCategory to string in crm/objects/tasks/models/StandardError.category.

• Change type from ErrorCategory to string in crm/products/models/StandardError.category.

• Change type from ErrorCategory to string in crm/properties/models/StandardError.category.

• Change type from ErrorCategory to string in crm/quotes/models/StandardError.category.

• Change type from ErrorCategory to string in crm/tickets/models/StandardError.category.

• Change type from ErrorCategory to string in webhooks/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.