Skip to content

Commit 671d96b

Browse files
Merge pull request #300 from HubSpot/feature/9.0.0
Feature/9.0.0
2 parents db17b98 + 67caf3c commit 671d96b

File tree

1,297 files changed

+55794
-69752
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,297 files changed

+55794
-69752
lines changed

CHANGELOG.md

Lines changed: 150 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,161 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased](https://github.com/HubSpot/hubspot-api-python/compare/v8.2.1...HEAD)
8+
## [Unreleased](https://github.com/HubSpot/hubspot-api-python/compare/v9.0.0...HEAD)
9+
10+
## [9.0.0](https://github.com/HubSpot/hubspot-api-python/compare/v8.2.1...v9.0.0) - 2024-02-20
11+
12+
### Automation Actions client
13+
14+
- Updated `automation.actions.definitions_api.create()` method to accept `public_action_definition_egg` instead of `extension_action_definition_input` and returned `PublicActionDefinition` instead `ExtensionActionDefinition`.
15+
- Updated `automation.actions.definitions_api.get_by_id()` method to return `PublicActionDefinition` instead of `ExtensionActionDefinition`.
16+
- Updated `automation.actions.definitions_api.get_page()` method to return `CollectionResponsePublicActionDefinitionForwardPaging` instead of `CollectionResponseExtensionActionDefinitionForwardPaging`.
17+
- Updated `automation.actions.definitions_api.update()` method to accept `public_action_definition_patch` instead of `extension_action_definition_patch` and returned `PublicActionDefinition` instead `ExtensionActionDefinition`.
18+
- Updated `automation.actions.functions_api.create_or_replace()` method to return `PublicActionFunctionIdentifier` instead of `ActionFunctionIdentifier`.
19+
- Updated `automation.actions.functions_api.create_or_replace_by_function_type()` method to return `PublicActionFunctionIdentifier` instead of `ActionFunctionIdentifier`.
20+
- Updated `automation.actions.functions_api.get_by_function_type()` method to return `PublicActionFunction` instead of `ActionFunction`.
21+
- Updated `automation.actions.functions_api.get_by_id()` method to return `PublicActionFunction` instead of `ActionFunction`.
22+
- Updated `automation.actions.functions_api.get_page()` method to return `CollectionResponsePublicActionFunctionIdentifierNoPaging` instead of `CollectionResponseActionFunctionIdentifierNoPaging`.
23+
- Updated `automation.actions.revisions_api.get_by_id()` method to return `PublicActionRevision` instead of `ActionRevision`.
24+
- Updated `automation.actions.revisions_api.get_page()` method to return `CollectionResponsePublicActionRevisionForwardPaging` instead of `CollectionResponseActionRevisionForwardPaging`.
25+
- Added new function type `POST_ACTION_EXECUTION` to `automation.actions.models.PublicActionFunctionIdentifier` and `automation.actions.models.PublicActionFunction`.
26+
- Added new param `automation_field_type` to `automation.actions.models.InputFieldDefinition`.
27+
- Added `automation.actions.models.OutputFieldDefinition`.
28+
- Added `automation.actions.models.PublicExecutionTranslationRule`.
29+
- Added new params to `automation.actions.models.FieldTypeDefinition`:
30+
31+
```python
32+
{
33+
"help_text": "str",
34+
"referenced_object_type": "str",
35+
"name": "str",
36+
"options": "list[Option]",
37+
"description": "str",
38+
"external_options_reference_type": "str",
39+
"label": "str",
40+
"type": "str",
41+
"field_type": "str",
42+
"options_url": "str",
43+
"external_options": "bool",
44+
}
45+
```
46+
47+
### CMS clients
48+
49+
- 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`.
50+
- Added new param `_property` to `cms.blogs.authors.blog_authors_api.get_by_id()` and `cms.blogs.authors.blog_authors_api.get_page()`.
51+
- Renamed `cms.source_code.content_api.get()` method to `cms.source_code.content_api.download()`.
52+
- Renamed `cms.source_code.content_api.replace()` method to `cms.source_code.content_api.create_or_update()`.
53+
- Added new param `hash` to `cms.source_code.models.AssetFileMetadata`.
54+
- Added new param `properties` to `cms.source_code.metadata_api.get()`.
55+
56+
### CRM Associations and Objects clients
57+
58+
> [!NOTE]
59+
> Please note that CRM Objects includes: companies, contacts, deals, line items, all CRM objects `crm.objects`, products, quotes and tickets
60+
61+
- Changed the type of parameter `category` from `ErrorCategory` to `string` in `crm.associations.models.StandardError`.
62+
- Renamed `crm.associations.v4.schema.definitions_api.delete()` method to `crm.associations.v4.schema.definitions_api.archive()`.
63+
- 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`.
64+
- Changed the type of parameter `object_id` in `crm.associations.v4.basic_api.get_page()` method from `string` to `int`.
65+
- Changed the type of parameters `to_object_id` and `from_object_id` in `crm.associations.v4.models.LabelsBetweenObjectPair` to `string`.
66+
- Changed the type of parameter `to_object_id` in `crm.associations.v4.models.MultiAssociatedObjectWithLabel` to `string`.
67+
- Changed the type of property `category` in `ErrorCategory` to `string` in `crm.associations.v4.models.StandardError`.
68+
- Changed the type of property `errors` in `crm.associations.v4.models.BatchResponsePublicDefaultAssociation` from `StandardError1[]` to `StandardError[]`.
69+
- Added parameter `inverse_label` to `crm.associations.v4.models.PublicAssociationDefinitionCreateRequest` and `crm.associations.v4.models.PublicAssociationDefinitionUpdateRequest`.
70+
- Updated `crm.time_line.events_api.create_batch()` method to return `None` insted `BatchResponseTimelineEventResponse`.
71+
- Changed the type of parameter `category` from `ErrorCategory` to `string` in `crm.time_line.models.StandardError`.
72+
- Removed `crm.objects.associations_api`.
73+
- Renamed param `postal_mail` to `postal_mail_id` in `crm.objects.postal_mail.basic_api()`.
74+
- Changed the type of parameter `after` from `int` to `string` in all CRM models `PublicObjectSearchRequest`.
75+
- Added new param `id_property` in all CRM models `SimplePublicObjectBatchInput`.
76+
77+
### CRM Extensions client
78+
79+
- Changed parameter order in `crm.extinsions.cards_api.archive()` method from `(app_id, card_id)` to `(card_id, app_id)`.
80+
- Updated `crm.extinsions.cards_api.create()` method to return `PublicCardResponse` instead `CardResponse`.
81+
- Updated `crm.extinsions.cards_api.get_all()` method to return `PublicCardListResponse` instead `CardListResponse`.
82+
- 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`.
83+
- 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`.
84+
- Added new params `serverless_function` and `card_type` to `crm.extinsions.models.CardFetchBody` and `crm.extinsions.models.CardFetchBodyPatch`.
85+
- Added new param `audit_history` to `crm.extinsions.models.PublicCardResponse`.
86+
- Added new allowable value `marketing_events` to `crm.extinsions.models.CardObjectTypeBody`.
87+
- Added `developer_hapikey` to `crm.extinsions.videoconferencing.settings_api`.
88+
- Added new param `fetch_accounts_uri` to `crm.extinsions.videoconferencing.models.ExternalSettings`.
89+
- Marked `CRM Extensions Accounting Apis` as deprecated.
90+
91+
### CRM clients
92+
93+
- Added `import_template` and `import_source` params to `crm.imports.models.PublicImportResponse`.
94+
- Renamed Api client from `crm.lists.memberships_api()` to `crm.lists.list_app_membership_api()`.
95+
- Renamed Api client from `crm.lists.lists_api()` to `crm.lists.list_app_api()`.
96+
- 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()`.
97+
- 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()`.
98+
- Renamed method `crm.lists.memberships_api.add_remove()` to `crm.lists.list_app_membership_api.add_and_remove()`.
99+
- Renamed `crm.lists.models.CollectionResponseLong` to `crm.lists.models.CollectionResponseJoinTimeAndRecordId`.
100+
- Changed the type of parameter `results: list[int]` to `results: list[JoinTimeAndRecordId]` in `crm.lists.models.CollectionResponseJoinTimeAndRecordId`.
101+
- 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.
102+
- 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.
103+
- Added `write_permissions` param to `crm.pipelines.models.PipelineStage`.
104+
- Added `description` param to `crm.schemas.models.ObjectTypeDefinitionPatch`.
105+
- Added new params: `option_sort_strategy`, `show_currency_symbol`, `form_field`, `referenced_object_type`, `text_display_hint`, `searchable_in_global_search`
106+
and `number_display_hint` to `crm.schemas.models.ObjectTypePropertyCreate`.
107+
108+
### Marketing client
109+
110+
- Moved methods `archive()`, `create()`, `do_cancel()`, `get_by_id()`, `replace()` and `update()` from `marketing.events.marketing_events_external_api()` to `marketing.events.basic_api`.
111+
- Moved method `do_upsert()` from `marketing.events.marketing_events_external_api()` to `marketing.events.batch_api()`.
112+
- Moved and renamed method `archive_batch()` to `archive()` from `marketing.events.marketing_events_external_api.archive_batch()` to `marketing.events.batch_api.archive()`.
113+
- 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()`.
114+
- Renamed Api `marketing.events.settings_external_api()` to `marketing.events.settings_api()`.
115+
- Added new param `is_large_value` to `marketing.events.models.PropertyValue`.
116+
- Changed the type of parameter `category` from `ErrorCategory` to `string` in `marketing.events.models.StandardError`.
117+
- Added new param `lifecycle_stages` to `marketing.forms.models.HubSpotFormConfiguration`.
118+
- Changed the type of parameter `legal_consent_options` from `object` to `HubSpotFormDefinitionAllOfLegalConsentOptions` in all `marketing.forms.models` where parameter exists.
119+
- Changed the `field_type` parameter, now defaults to `payment_link_radio` instead `file` in `DependentFieldDependentField` in `marketing.forms.models`.
120+
- Renamed `marketing.forms.models.HubSpotFormDefinitionPatchRequestLegalConsentOptions` to `marketing.forms.models.HubSpotFormDefinitionAllOfLegalConsentOptions`.
121+
- Added new parameter `other` to `allowed_values` in `marketing.forms.models`.
122+
123+
### Events, Files and OAuth clients
124+
125+
- Moved client from `files.files` to `files`.
126+
- Added new method `files.files_api.get_metadata()`.
127+
- Added new param `expires_at` to `files.models.File` and `files.models.FileUpdateInput`.
128+
- Changed the type of parameter `category` from `ErrorCategory` to `string` in `files.models.StandardError`.
129+
- Added new query params: `index_table_name`, `index_table_name`,`object_property_propname`, `property_propname` and `id` to `get_page()` method.
130+
- Renamed `events.send_api.behavioral_events_tracking_api()` to `events.send_api.custom_event_data_api()`.
131+
- Added new param `prev` to `events.models.Paging`.
132+
- Removed params `scope_to_scope_group_pks, trial_scopes, trial_scope_to_scope_group_pks` from `oauth.models.AccessTokenInfoResponse`.
133+
134+
### Client APIs
135+
136+
- Added `crm.extensions.calling.recording_settings_api` API.
137+
- Added `crm.companies.gdpr_api` API.
138+
- Added `crm.deals.gdpr_api` API.
139+
- Added `crm.objects.line_items.gdpr_api` API.
140+
- Added `crm.objects.calls.gdpr_api` API.
141+
- Added `crm.objects.communications.gdpr_api` API.
142+
- Added `crm.objects.emails.gdpr_api` API.
143+
- Added `crm.objects.feedback_submissions.gdpr_api` API.
144+
- Added `crm.objects.meetings.gdpr_api` API.
145+
- Added `crm.objects.notes.gdpr_api` API.
146+
- Added `crm.objects.postal_mail.gdpr_api` API.
147+
- Added `crm.objects.tasks.gdpr_api` API.
148+
- Added `crm.objects.products.gdpr_api` API.
149+
- Added `crm.objects.quotes.gdpr_api` API.
150+
- Added `crm.objects.tickets.gdpr_api` API.
151+
- Added `crm.line_items.gdpr_api` API.
152+
- Added `marketing.events.basic_api` API.
153+
- Added `marketing.events.batch_api` API.
154+
- Added `marketing.events.subscriber_state_changes_api` API.
9155

10156
## [8.2.1](https://github.com/HubSpot/hubspot-api-python/compare/v8.2.0...v8.2.1) - 2024-01-25
11157

12158
### Updated
13159

14160
- Added new parameters to the `PublicUser` model in `settings.users.models`:
15-
- `super_admin`: boolean.
16-
- `send_welcome_email`: boolean.
161+
- `super_admin`: boolean.
162+
- `send_welcome_email`: boolean.
17163

18164
## [8.2.0](https://github.com/HubSpot/hubspot-api-python/compare/v8.1.1...v8.2.0) - 2023-12-19
19165

@@ -443,7 +589,7 @@ marketing.transactional.single_send_api
443589

444590
### Added
445591

446-
- new `HubSpot` class - a shortage to `hubspot.Client`
592+
- new `HubSpot` - a shortage to `hubspot.Client`
447593

448594
## [2.1.0](https://github.com/HubSpot/hubspot-api-python/compare/v2.0.0...v2.1.0) - 2020-06-23
449595

hubspot/auth/oauth/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# flake8: noqa
44

55
"""
6+
Auth Oauth
67
78
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
89

hubspot/auth/oauth/api/access_tokens_api.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# coding: utf-8
22

33
"""
4+
Auth Oauth
45
56
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
67

hubspot/auth/oauth/api/refresh_tokens_api.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# coding: utf-8
22

33
"""
4+
Auth Oauth
45
56
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
67

hubspot/auth/oauth/api/tokens_api.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# coding: utf-8
22

33
"""
4+
Auth Oauth
45
56
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
67

hubspot/auth/oauth/api_client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# coding: utf-8
22
"""
3+
Auth Oauth
34
45
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
56

hubspot/auth/oauth/configuration.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# coding: utf-8
22

33
"""
4+
Auth Oauth
45
56
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
67

hubspot/auth/oauth/exceptions.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# coding: utf-8
22

33
"""
4+
Auth Oauth
45
56
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
67

hubspot/auth/oauth/models/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
# flake8: noqa
44
"""
5+
Auth Oauth
56
67
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
78

0 commit comments

Comments
 (0)