Codegen: CrmObjects

hubspot/crm/products/__init__.py

@@ -19,6 +19,7 @@
 # import apis into sdk package
 from hubspot.crm.products.api.basic_api import BasicApi
 from hubspot.crm.products.api.batch_api import BatchApi
+from hubspot.crm.products.api.gdpr_api import GDPRApi
 from hubspot.crm.products.api.public_object_api import PublicObjectApi
 from hubspot.crm.products.api.search_api import SearchApi
 
@@ -53,6 +54,7 @@
 from hubspot.crm.products.models.paging import Paging
 from hubspot.crm.products.models.previous_page import PreviousPage
 from hubspot.crm.products.models.public_associations_for_object import PublicAssociationsForObject
+from hubspot.crm.products.models.public_gdpr_delete_input import PublicGdprDeleteInput
 from hubspot.crm.products.models.public_merge_input import PublicMergeInput
 from hubspot.crm.products.models.public_object_id import PublicObjectId
 from hubspot.crm.products.models.public_object_search_request import PublicObjectSearchRequest

hubspot/crm/products/api/__init__.py

@@ -5,5 +5,6 @@
 # import apis into api package
 from hubspot.crm.products.api.basic_api import BasicApi
 from hubspot.crm.products.api.batch_api import BatchApi
+from hubspot.crm.products.api.gdpr_api import GDPRApi
 from hubspot.crm.products.api.public_object_api import PublicObjectApi
 from hubspot.crm.products.api.search_api import SearchApi

hubspot/crm/products/api/gdpr_api.py

@@ -0,0 +1,160 @@
+# coding: utf-8
+
+"""
+    Products
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: v3
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from hubspot.crm.products.api_client import ApiClient
+from hubspot.crm.products.exceptions import ApiTypeError, ApiValueError  # noqa: F401
+
+
+class GDPRApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def purge(self, public_gdpr_delete_input, **kwargs):  # noqa: E501
+        """GDPR DELETE  # noqa: E501
+
+        Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.purge(public_gdpr_delete_input, async_req=True)
+        >>> result = thread.get()
+
+        :param public_gdpr_delete_input: (required)
+        :type public_gdpr_delete_input: PublicGdprDeleteInput
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: None
+        """
+        kwargs["_return_http_data_only"] = True
+        return self.purge_with_http_info(public_gdpr_delete_input, **kwargs)  # noqa: E501
+
+    def purge_with_http_info(self, public_gdpr_delete_input, **kwargs):  # noqa: E501
+        """GDPR DELETE  # noqa: E501
+
+        Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.purge_with_http_info(public_gdpr_delete_input, async_req=True)
+        >>> result = thread.get()
+
+        :param public_gdpr_delete_input: (required)
+        :type public_gdpr_delete_input: PublicGdprDeleteInput
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :type _return_http_data_only: bool, optional
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :type _preload_content: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: None
+        """
+
+        local_var_params = locals()
+
+        all_params = ["public_gdpr_delete_input"]
+        all_params.extend(["async_req", "_return_http_data_only", "_preload_content", "_request_timeout", "_request_auth", "_content_type", "_headers"])
+
+        for key, val in six.iteritems(local_var_params["kwargs"]):
+            if key not in all_params:
+                raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method purge" % key)
+            local_var_params[key] = val
+        del local_var_params["kwargs"]
+        # verify the required parameter 'public_gdpr_delete_input' is set
+        if self.api_client.client_side_validation and local_var_params.get("public_gdpr_delete_input") is None:  # noqa: E501
+            raise ApiValueError("Missing the required parameter `public_gdpr_delete_input` when calling `purge`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = dict(local_var_params.get("_headers", {}))
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if "public_gdpr_delete_input" in local_var_params:
+            body_params = local_var_params["public_gdpr_delete_input"]
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(["*/*"])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        content_types_list = local_var_params.get("_content_type", self.api_client.select_header_content_type(["application/json"], "POST", body_params))  # noqa: E501
+        if content_types_list:
+            header_params["Content-Type"] = content_types_list
+
+        # Authentication setting
+        auth_settings = ["oauth2"]  # noqa: E501
+
+        response_types_map = {}
+
+        return self.api_client.call_api(
+            "/crm/v3/objects/products/gdpr-delete",
+            "POST",
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_types_map=response_types_map,
+            auth_settings=auth_settings,
+            async_req=local_var_params.get("async_req"),
+            _return_http_data_only=local_var_params.get("_return_http_data_only"),  # noqa: E501
+            _preload_content=local_var_params.get("_preload_content", True),
+            _request_timeout=local_var_params.get("_request_timeout"),
+            collection_formats=collection_formats,
+            _request_auth=local_var_params.get("_request_auth"),
+        )

hubspot/crm/products/models/__init__.py

@@ -34,6 +34,7 @@
 from hubspot.crm.products.models.paging import Paging
 from hubspot.crm.products.models.previous_page import PreviousPage
 from hubspot.crm.products.models.public_associations_for_object import PublicAssociationsForObject
+from hubspot.crm.products.models.public_gdpr_delete_input import PublicGdprDeleteInput
 from hubspot.crm.products.models.public_merge_input import PublicMergeInput
 from hubspot.crm.products.models.public_object_id import PublicObjectId
 from hubspot.crm.products.models.public_object_search_request import PublicObjectSearchRequest

hubspot/crm/products/models/batch_read_input_simple_public_object_id.py

@@ -35,50 +35,27 @@ class BatchReadInputSimplePublicObjectId(object):
       attribute_map (dict): The key is attribute name
                             and the value is json key in definition.
     """
-    openapi_types = {"properties": "list[str]", "properties_with_history": "list[str]", "id_property": "str", "inputs": "list[SimplePublicObjectId]"}
+    openapi_types = {"properties_with_history": "list[str]", "id_property": "str", "inputs": "list[SimplePublicObjectId]", "properties": "list[str]"}
 
-    attribute_map = {"properties": "properties", "properties_with_history": "propertiesWithHistory", "id_property": "idProperty", "inputs": "inputs"}
+    attribute_map = {"properties_with_history": "propertiesWithHistory", "id_property": "idProperty", "inputs": "inputs", "properties": "properties"}
 
-    def __init__(self, properties=None, properties_with_history=None, id_property=None, inputs=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, properties_with_history=None, id_property=None, inputs=None, properties=None, local_vars_configuration=None):  # noqa: E501
         """BatchReadInputSimplePublicObjectId - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration.get_default_copy()
         self.local_vars_configuration = local_vars_configuration
 
-        self._properties = None
         self._properties_with_history = None
         self._id_property = None
         self._inputs = None
+        self._properties = None
         self.discriminator = None
 
-        self.properties = properties
         self.properties_with_history = properties_with_history
         if id_property is not None:
             self.id_property = id_property
         self.inputs = inputs
-
-    @property
-    def properties(self):
-        """Gets the properties of this BatchReadInputSimplePublicObjectId.  # noqa: E501
-
-
-        :return: The properties of this BatchReadInputSimplePublicObjectId.  # noqa: E501
-        :rtype: list[str]
-        """
-        return self._properties
-
-    @properties.setter
-    def properties(self, properties):
-        """Sets the properties of this BatchReadInputSimplePublicObjectId.
-
-
-        :param properties: The properties of this BatchReadInputSimplePublicObjectId.  # noqa: E501
-        :type properties: list[str]
-        """
-        if self.local_vars_configuration.client_side_validation and properties is None:  # noqa: E501
-            raise ValueError("Invalid value for `properties`, must not be `None`")  # noqa: E501
-
-        self._properties = properties
+        self.properties = properties
 
     @property
     def properties_with_history(self):
@@ -147,6 +124,29 @@ def inputs(self, inputs):
 
         self._inputs = inputs
 
+    @property
+    def properties(self):
+        """Gets the properties of this BatchReadInputSimplePublicObjectId.  # noqa: E501
+
+
+        :return: The properties of this BatchReadInputSimplePublicObjectId.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._properties
+
+    @properties.setter
+    def properties(self, properties):
+        """Sets the properties of this BatchReadInputSimplePublicObjectId.
+
+
+        :param properties: The properties of this BatchReadInputSimplePublicObjectId.  # noqa: E501
+        :type properties: list[str]
+        """
+        if self.local_vars_configuration.client_side_validation and properties is None:  # noqa: E501
+            raise ValueError("Invalid value for `properties`, must not be `None`")  # noqa: E501
+
+        self._properties = properties
+
     def to_dict(self, serialize=False):
         """Returns the model properties as a dict"""
         result = {}