fix(deps): update dependency hubspot-api-client to v12

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
hubspot-api-client	>=6.1.0,<7 → >=12,<13

---

Release Notes

HubSpot/hubspot-api-python (hubspot-api-client)

v12.0.0

Compare Source

v11.1.0

Compare Source

v11.0.0

v10.0.0

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 int to string.
• Changed the type of parameter object_id in crm.associations.v4.basic_api.get_page() method from int to string.
• 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.models.HubSpotFormConfiguration.
• Changed the type of parameter legal_consent_options from object to HubSpotFormDefinitionAllOfLegalConsentOptions in all marketing.forms.models where parameter exists.
• Changed the field_type parameter, now defaults to payment_link_radio instead file in DependentFieldDependentField in marketing.forms.models.
• Renamed marketing.forms.models.HubSpotFormDefinitionPatchRequestLegalConsentOptions to marketing.forms.models.HubSpotFormDefinitionAllOfLegalConsentOptions.
• Added new parameter other to allowed_values in marketing.forms.models.

Events, Files and OAuth clients

• Moved client from files.files to files.
• Added new method files.files_api.get_metadata().
• Added new param expires_at to files.models.File and files.models.FileUpdateInput.
• Changed the type of parameter category from ErrorCategory to string in files.models.StandardError.
• Added new query params: index_table_name, index_table_name,object_property_propname, property_propname and id to get_page() method.
• Renamed events.send_api.behavioral_events_tracking_api() to events.send_api.custom_event_data_api().
• Added new param prev to events.models.Paging.
• Removed params scope_to_scope_group_pks, trial_scopes, trial_scope_to_scope_group_pks from oauth.models.AccessTokenInfoResponse.

Client APIs

• Added crm.extensions.calling.recording_settings_api API.
• Added crm.companies.gdpr_api API.
• Added crm.deals.gdpr_api API.
• Added crm.objects.line_items.gdpr_api API.
• Added crm.objects.calls.gdpr_api API.
• Added crm.objects.communications.gdpr_api API.
• Added crm.objects.emails.gdpr_api API.
• Added crm.objects.feedback_submissions.gdpr_api API.
• Added crm.objects.meetings.gdpr_api API.
• Added crm.objects.notes.gdpr_api API.
• Added crm.objects.postal_mail.gdpr_api API.
• Added crm.objects.tasks.gdpr_api API.
• Added crm.objects.products.gdpr_api API.
• Added crm.objects.quotes.gdpr_api API.
• Added crm.objects.tickets.gdpr_api API.
• Added crm.line_items.gdpr_api API.
• Added marketing.events.basic_api API.
• Added marketing.events.batch_api API.
• Added marketing.events.subscriber_state_changes_api API.

v8.2.1

Updated

• Added new parameters to the PublicUser model in settings.users.models:
• super_admin: boolean.
• send_welcome_email: boolean.

v8.2.0

Compare Source

v8.1.1

v8.1.0

v8.0.0

Compare Source

v7.5.0

Compare Source

Added

• Update models for crm.properties API client

v7.4.0

Compare Source

Added

• crm.associations.v4 API client
• crm.imports.public_imports_api API client
• crm.extensions.cards.sample_response_api API client
• possibility to set limit param for fetch_all func

Fixed

• Fix auth.oauth.refresh_tokens_api.archive_refresh_token method

v7.3.1

Compare Source

Added

• added search by date example in README.

Fixed

• fixed access to crm.associations.types_api

v7.3.0

Compare Source

Added

• Signature's util 'HubSpot.utils.signature'
• test coverage for regen

Deprecated

• webhook's util 'HubSpot.utils.webhooks'

v7.2.2

Compare Source

v7.2.1

Compare Source

v7.2.0

Compare Source

Added

• crm.objects.calls API client

v7.1.0

Compare Source

Changed

• Added Private App access token to cms.domains and crm.imports

Fixed

• Fix all association APIs

v7.0.0

Compare Source

Changed (Breaking changes)

• marketing.events updates

---

Configuration

📅 Schedule: Branch creation - "every weekend" in timezone US/Eastern, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[renovate]

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: uv.lock

Command failed: uv lock --upgrade-package hubspot-api-client
Using CPython 3.13.12
  × No solution found when resolving dependencies:
  ╰─▶ Because mitol-django-hubspot-api==2023.12.19 depends
      on hubspot-api-client==6.1.0 and your project depends
      on hubspot-api-client>=12,<13, we can conclude that
      mitol-django-hubspot-api==2023.12.19 and your project are incompatible.
      And because your project depends on
      mitol-django-hubspot-api==2023.12.19, we can conclude that your
      project's requirements are unsatisfiable.

[sentry]

Bug: The upgrade to hubspot-api-client="^12.0.0" conflicts with the mitol-django-hubspot-api dependency, which requires version 6.1.0. This will cause a dependency resolution failure.
_{Severity: CRITICAL}

Suggested Fix

Resolve the dependency conflict. This can be done by either finding a version of mitol-django-hubspot-api that is compatible with hubspot-api-client@v12.0.0 or by downgrading the hubspot-api-client version to one that is compatible with the currently pinned mitol-django-hubspot-api.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: pyproject.toml#L39

Potential issue: The `pyproject.toml` file specifies an upgrade for `hubspot-api-client`
to version `^12.0.0`. However, another dependency, `mitol-django-hubspot-api` at version
`2023.12.19`, has a strict requirement for `hubspot-api-client = "6.1.0"`. This creates
a direct conflict that will cause dependency resolution tools like Poetry to fail. The
application will not be able to be deployed or run because the dependencies cannot be
installed as specified. This conflict must be resolved before the code can be used.

[sentry]

Bug: The upgrade to hubspot-api-client v12.0.0 changes method signatures. Calls to crm.objects.batch_api.create() and update() using positional arguments will fail as the new version expects keyword arguments.
_{Severity: CRITICAL}

Suggested Fix

Update the calls to crm.objects.batch_api.create() and crm.objects.batch_api.update() in hubspot_xpro/tasks.py to use keyword arguments as required by v12.0.0 of the hubspot-api-client. For example, change create(hubspot_type, batch_input) to create(batch_input_simple_public_object_input=batch_input). Also, update the corresponding mocks in the test files to match the new signature.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: pyproject.toml#L39

Potential issue: After upgrading `hubspot-api-client` to v12.0.0, the method signatures
for batch operations have changed. Functions like `crm.objects.batch_api.create()` and
`crm.objects.batch_api.update()` in `hubspot_xpro/tasks.py` are called with positional
arguments. However, the v12 API expects these calls to use a keyword argument, such as
`batch_input_simple_public_object_input=...`. This mismatch will lead to a `TypeError`
at runtime when these batch synchronization tasks are executed, causing them to fail.
The existing tests do not catch this because they mock the API using the old, incorrect
signature.

[sentry]

Bug: The update to hubspot-api-python v12 may introduce breaking changes. The class BatchInputSimplePublicObjectInput might have been renamed or removed, which is not reflected in the code.
_{Severity: HIGH}

Suggested Fix

Before merging, verify the correct class name for BatchInputSimplePublicObjectInput in hubspot-api-python v12. Update the import and usage in hubspot_xpro/tasks.py to the new class name if it has changed. The code change should accompany the dependency version bump.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: pyproject.toml#L38

Potential issue: The `hubspot-api-python` library is being upgraded from v6 to v12, a
major version jump known to include breaking changes. Specifically, classes like
`BatchInputSimplePublicObjectInputForCreate` were renamed. While it's not confirmed if
the `BatchInputSimplePublicObjectInput` class used in `hubspot_xpro/tasks.py` was also
renamed or removed, this is a high-risk change. If the class no longer exists as
imported, it will cause an `ImportError` on application startup or an `AttributeError`
at runtime when batch operations are executed. The existing tests mock the HubSpot API
and would not detect this issue.