Merge pull request #363 from HubSpot/11.0.0

11.0.0
HubSpot · Nov 27, 2024 · 3bb25a3 · 3bb25a3
2 parents fbaa458 + 2c2a1a6
commit 3bb25a3
Show file tree

Hide file tree

Showing 92 changed files with 6,082 additions and 234 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/HubSpot/hubspot-api-python/compare/v10.0.0...HEAD)
+## [Unreleased](https://github.com/HubSpot/hubspot-api-python/compare/v11.0.0...HEAD)
+
+## [11.0.0](https://github.com/HubSpot/hubspot-api-python/compare/v10.0.0...v11.0.0) - 2024-11-27
+
+## 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](https://github.com/HubSpot/hubspot-api-python/compare/v9.0.0...v10.0.0) - 2024-10-10
 

diff --git a/Makefile b/Makefile
@@ -1,11 +1,11 @@
-VENV_NAME?=venv
+VENV_NAME ?= venv
 
 venv: $(VENV_NAME)/bin/activate
 
 $(VENV_NAME)/bin/activate: setup.py
-	pip3 install --upgrade pip virtualenv
-	@test -d $(VENV_NAME) || python3 -m virtualenv --clear $(VENV_NAME)
-	${VENV_NAME}/bin/python -m pip install -e .[dev]
+	@test -d $(VENV_NAME) || python3 -m venv $(VENV_NAME)
+	@${VENV_NAME}/bin/python -m pip install --upgrade pip
+	@${VENV_NAME}/bin/python -m pip install -e .[dev]
 	@touch $(VENV_NAME)/bin/activate
 
 test: venv

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ pip install --upgrade hubspot-api-client
 
 ### Requirements
 
-Make sure you have [Python 3.5+](https://docs.python.org/3/) and [pip](https://pypi.org/project/pip/) installed.
+Make sure you have [Python 3.7+](https://docs.python.org/3/) and [pip](https://pypi.org/project/pip/) installed.
 
 
 ## Quickstart
@@ -162,7 +162,66 @@ try:
 except ApiException as e:
     print("Exception when calling cards_api->create: %s\n" % e)
 ```
+## Not wrapped endpoint(s)
 
+It is possible to access the hubspot request method directly,
+it could be handy if client doesn't have implementation for some endpoint yet.
+Exposed request method benefits by having all configured client params.
+
+```python
+client.api_request({
+    "method": "PUT",
+    "path": "/some/api/not/wrapped/yet",
+    "body": {"key": "value"}
+})
+```
+
+### {Example} for `GET` request
+
+```python
+import hubspot
+from pprint import pprint
+from hubspot.crm.contacts import ApiException
+
+client = hubspot.Client.create(access_token="your_access_token")
+
+try:
+    response = client.api_request(
+        {"path": "/crm/v3/objects/contacts"}
+    )
+    pprint(response)
+except ApiException as e:
+    print(e)
+```
+
+### {Example} for `POST` request
+
+```python
+import hubspot
+from pprint import pprint
+from hubspot.crm.contacts import ApiException
+
+client = hubspot.Client.create(access_token="your_access_token")
+
+try:
+    response = client.api_request(
+        {
+            "path": "/crm/v3/objects/contacts",
+            "method": "POST",
+            "body": {
+                "properties":
+                    {
+                        "email": "[email protected]",
+                        "lastname": "some_last_name"
+                    },
+            }
+        }
+
+    )
+    pprint(response.json())
+except ApiException as e:
+    print(e)
+```
 ### Using utils
 
 #### Get OAuth url:
@@ -183,8 +242,6 @@ auth_url = get_auth_url(
 
 ```python
 import os
-
-from datetime import datetime
 from flask import request
 from hubspot.utils.signature import Signature
 
@@ -194,7 +251,7 @@ Signature.is_valid(
     request_body=request.data.decode("utf-8"),
     http_uri=request.base_url,
     signature_version=request.headers["X-HubSpot-Signature-Version"],
-    timestamp=datetime.now().timestamp()
+    timestamp=request.headers["X-HubSpot-Request-Timestamp"]
 )
 ```
 

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-10.0.0
+11.0.0
diff --git a/hubspot/client.py b/hubspot/client.py
@@ -1,5 +1,6 @@
 from urllib3.util.retry import Retry
 
+
 class Client:
     def __init__(
         self,
@@ -86,3 +87,8 @@ def settings(self):
     def webhooks(self):
         from .discovery.webhooks.discovery import Discovery as WebhooksDiscovery
         return WebhooksDiscovery(self.config)
+
+    def api_request(self, options):
+        from .utils.requests.http_request_builder import Request
+        request = Request(self.config, options)
+        return request.send()
diff --git a/hubspot/crm/associations/__init__.py b/hubspot/crm/associations/__init__.py
@@ -3,7 +3,7 @@
 # flake8: noqa
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/api/batch_api.py b/hubspot/crm/associations/api/batch_api.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/api_client.py b/hubspot/crm/associations/api_client.py
@@ -1,6 +1,6 @@
 # coding: utf-8
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/configuration.py b/hubspot/crm/associations/configuration.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/exceptions.py b/hubspot/crm/associations/exceptions.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/__init__.py b/hubspot/crm/associations/models/__init__.py
@@ -2,7 +2,7 @@
 
 # flake8: noqa
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/associated_id.py b/hubspot/crm/associations/models/associated_id.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/batch_input_public_association.py b/hubspot/crm/associations/models/batch_input_public_association.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/batch_input_public_object_id.py b/hubspot/crm/associations/models/batch_input_public_object_id.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/batch_response_public_association.py b/hubspot/crm/associations/models/batch_response_public_association.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/batch_response_public_association_multi.py b/hubspot/crm/associations/models/batch_response_public_association_multi.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/batch_response_public_association_multi_with_errors.py b/hubspot/crm/associations/models/batch_response_public_association_multi_with_errors.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/batch_response_public_association_with_errors.py b/hubspot/crm/associations/models/batch_response_public_association_with_errors.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/error.py b/hubspot/crm/associations/models/error.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/error_detail.py b/hubspot/crm/associations/models/error_detail.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/next_page.py b/hubspot/crm/associations/models/next_page.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/paging.py b/hubspot/crm/associations/models/paging.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/previous_page.py b/hubspot/crm/associations/models/previous_page.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/public_association.py b/hubspot/crm/associations/models/public_association.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/public_association_multi.py b/hubspot/crm/associations/models/public_association_multi.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/public_object_id.py b/hubspot/crm/associations/models/public_object_id.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/models/standard_error.py b/hubspot/crm/associations/models/standard_error.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/rest.py b/hubspot/crm/associations/rest.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations
+    Associations
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/schema/__init__.py b/hubspot/crm/associations/schema/__init__.py
@@ -3,7 +3,7 @@
 # flake8: noqa
 
 """
-    CRM Associations Schema
+    Associations Schema
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/schema/api/types_api.py b/hubspot/crm/associations/schema/api/types_api.py
@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    CRM Associations Schema
+    Associations Schema
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501
 

diff --git a/hubspot/crm/associations/schema/api_client.py b/hubspot/crm/associations/schema/api_client.py
@@ -1,6 +1,6 @@
 # coding: utf-8
 """
-    CRM Associations Schema
+    Associations Schema
 
     Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.  # noqa: E501