Codegen: Webhooks, Files

Author: alzheltkovskiy-hubspot

hubspot/files/__init__.py

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Files Files
+
+    Upload and manage files.  # noqa: E501
+
+    The version of the OpenAPI document: v3
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from hubspot.files.api.files_api import FilesApi
+from hubspot.files.api.folders_api import FoldersApi
+
+# import ApiClient
+from hubspot.files.api_client import ApiClient
+from hubspot.files.configuration import Configuration
+from hubspot.files.exceptions import OpenApiException
+from hubspot.files.exceptions import ApiTypeError
+from hubspot.files.exceptions import ApiValueError
+from hubspot.files.exceptions import ApiKeyError
+from hubspot.files.exceptions import ApiAttributeError
+from hubspot.files.exceptions import ApiException
+
+# import models into sdk package
+from hubspot.files.models.collection_response_file import CollectionResponseFile
+from hubspot.files.models.collection_response_folder import CollectionResponseFolder
+from hubspot.files.models.error import Error
+from hubspot.files.models.error_detail import ErrorDetail
+from hubspot.files.models.file import File
+from hubspot.files.models.file_action_response import FileActionResponse
+from hubspot.files.models.file_stat import FileStat
+from hubspot.files.models.file_update_input import FileUpdateInput
+from hubspot.files.models.folder import Folder
+from hubspot.files.models.folder_action_response import FolderActionResponse
+from hubspot.files.models.folder_input import FolderInput
+from hubspot.files.models.folder_update_input import FolderUpdateInput
+from hubspot.files.models.folder_update_task_locator import FolderUpdateTaskLocator
+from hubspot.files.models.import_from_url_input import ImportFromUrlInput
+from hubspot.files.models.import_from_url_task_locator import ImportFromUrlTaskLocator
+from hubspot.files.models.next_page import NextPage
+from hubspot.files.models.paging import Paging
+from hubspot.files.models.previous_page import PreviousPage
+from hubspot.files.models.signed_url import SignedUrl
+from hubspot.files.models.standard_error import StandardError

hubspot/files/api/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package
+from hubspot.files.api.files_api import FilesApi
+from hubspot.files.api.folders_api import FoldersApi

hubspot/files/files/api/files_api.py hubspot/files/api/files_api.pyhubspot/files/files/api/files_api.py renamed to hubspot/files/api/files_api.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    Files
+    Files Files
 
     Upload and manage files.  # noqa: E501
 
@@ -17,8 +17,8 @@
 # python 2 and python 3 compatibility library
 import six
 
-from hubspot.files.files.api_client import ApiClient
-from hubspot.files.files.exceptions import ApiTypeError, ApiValueError  # noqa: F401
+from hubspot.files.api_client import ApiClient
+from hubspot.files.exceptions import ApiTypeError, ApiValueError  # noqa: F401
 
 
 class FilesApi(object):
@@ -43,7 +43,7 @@ def archive(self, file_id, **kwargs):  # noqa: E501
         >>> thread = api.archive(file_id, async_req=True)
         >>> result = thread.get()
 
-        :param file_id: File ID to delete (required)
+        :param file_id: FileId to delete (required)
         :type file_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -73,7 +73,7 @@ def archive_with_http_info(self, file_id, **kwargs):  # noqa: E501
         >>> thread = api.archive_with_http_info(file_id, async_req=True)
         >>> result = thread.get()
 
-        :param file_id: File ID to delete (required)
+        :param file_id: FileId to delete (required)
         :type file_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -440,7 +440,7 @@ def do_search(self, **kwargs):  # noqa: E501
         :type name: str
         :param path: Search files by path.
         :type path: str
-        :param parent_folder_id: Search files within given folder ID.
+        :param parent_folder_id: Search files within given folderId.
         :type parent_folder_id: int
         :param size: Query by file size.
         :type size: int
@@ -516,7 +516,7 @@ def do_search_with_http_info(self, **kwargs):  # noqa: E501
         :type name: str
         :param path: Search files by path.
         :type path: str
-        :param parent_folder_id: Search files within given folder ID.
+        :param parent_folder_id: Search files within given folderId.
         :type parent_folder_id: int
         :param size: Query by file size.
         :type size: int
@@ -697,7 +697,7 @@ def get_by_id(self, file_id, **kwargs):  # noqa: E501
         >>> thread = api.get_by_id(file_id, async_req=True)
         >>> result = thread.get()
 
-        :param file_id: Id of the desired file. (required)
+        :param file_id: ID of the desired file. (required)
         :type file_id: str
         :param properties:
         :type properties: list[str]
@@ -729,7 +729,7 @@ def get_by_id_with_http_info(self, file_id, **kwargs):  # noqa: E501
         >>> thread = api.get_by_id_with_http_info(file_id, async_req=True)
         >>> result = thread.get()
 
-        :param file_id: Id of the desired file. (required)
+        :param file_id: ID of the desired file. (required)
         :type file_id: str
         :param properties:
         :type properties: list[str]
@@ -819,6 +819,136 @@ def get_by_id_with_http_info(self, file_id, **kwargs):  # noqa: E501
             _request_auth=local_var_params.get("_request_auth"),
         )
 
+    def get_metadata(self, path, **kwargs):  # noqa: E501
+        """get_metadata  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_metadata(path, async_req=True)
+        >>> result = thread.get()
+
+        :param path: (required)
+        :type path: str
+        :param properties:
+        :type properties: list[str]
+        :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: FileStat
+        """
+        kwargs["_return_http_data_only"] = True
+        return self.get_metadata_with_http_info(path, **kwargs)  # noqa: E501
+
+    def get_metadata_with_http_info(self, path, **kwargs):  # noqa: E501
+        """get_metadata  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_metadata_with_http_info(path, async_req=True)
+        >>> result = thread.get()
+
+        :param path: (required)
+        :type path: str
+        :param properties:
+        :type properties: list[str]
+        :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: tuple(FileStat, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        local_var_params = locals()
+
+        all_params = ["path", "properties"]
+        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 get_metadata" % key)
+            local_var_params[key] = val
+        del local_var_params["kwargs"]
+        # verify the required parameter 'path' is set
+        if self.api_client.client_side_validation and local_var_params.get("path") is None:  # noqa: E501
+            raise ApiValueError("Missing the required parameter `path` when calling `get_metadata`")  # noqa: E501
+
+        if self.api_client.client_side_validation and "path" in local_var_params and not re.search(r".+", local_var_params["path"]):  # noqa: E501
+            raise ApiValueError("Invalid value for parameter `path` when calling `get_metadata`, must conform to the pattern `/.+/`")  # noqa: E501
+        collection_formats = {}
+
+        path_params = {}
+        if "path" in local_var_params:
+            path_params["path"] = local_var_params["path"]  # noqa: E501
+
+        query_params = []
+        if local_var_params.get("properties") is not None:  # noqa: E501
+            query_params.append(("properties", local_var_params["properties"]))  # noqa: E501
+            collection_formats["properties"] = "multi"  # noqa: E501
+
+        header_params = dict(local_var_params.get("_headers", {}))
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(["application/json", "*/*"])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ["oauth2"]  # noqa: E501
+
+        response_types_map = {
+            200: "FileStat",
+        }
+
+        return self.api_client.call_api(
+            "/files/v3/files/stat/{path}",
+            "GET",
+            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"),
+        )
+
     def get_signed_url(self, file_id, **kwargs):  # noqa: E501
         """Get signed URL to access private file.  # noqa: E501
 
@@ -1100,7 +1230,7 @@ def replace(self, file_id, **kwargs):  # noqa: E501
         >>> thread = api.replace(file_id, async_req=True)
         >>> result = thread.get()
 
-        :param file_id: Id of the desired file. (required)
+        :param file_id: ID of the desired file. (required)
         :type file_id: str
         :param file: File data that will replace existing file in the file manager.
         :type file: file
@@ -1136,7 +1266,7 @@ def replace_with_http_info(self, file_id, **kwargs):  # noqa: E501
         >>> thread = api.replace_with_http_info(file_id, async_req=True)
         >>> result = thread.get()
 
-        :param file_id: Id of the desired file. (required)
+        :param file_id: ID of the desired file. (required)
         :type file_id: str
         :param file: File data that will replace existing file in the file manager.
         :type file: file

hubspot/files/files/api/folders_api.py hubspot/files/api/folders_api.pyhubspot/files/files/api/folders_api.py renamed to hubspot/files/api/folders_api.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-    Files
+    Files Files
 
     Upload and manage files.  # noqa: E501
 
@@ -17,8 +17,8 @@
 # python 2 and python 3 compatibility library
 import six
 
-from hubspot.files.files.api_client import ApiClient
-from hubspot.files.files.exceptions import ApiTypeError, ApiValueError  # noqa: F401
+from hubspot.files.api_client import ApiClient
+from hubspot.files.exceptions import ApiTypeError, ApiValueError  # noqa: F401
 
 
 class FoldersApi(object):
@@ -289,7 +289,7 @@ def check_update_status(self, task_id, **kwargs):  # noqa: E501
         >>> thread = api.check_update_status(task_id, async_req=True)
         >>> result = thread.get()
 
-        :param task_id: Task ID of folder update (required)
+        :param task_id: TaskId of folder update (required)
         :type task_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -319,7 +319,7 @@ def check_update_status_with_http_info(self, task_id, **kwargs):  # noqa: E501
         >>> thread = api.check_update_status_with_http_info(task_id, async_req=True)
         >>> result = thread.get()
 
-        :param task_id: Task ID of folder update (required)
+        :param task_id: TaskId of folder update (required)
         :type task_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -568,7 +568,7 @@ def do_search(self, **kwargs):  # noqa: E501
         :type name: str
         :param path: Search for folders by path.
         :type path: str
-        :param parent_folder_id: Search for folders with the given parent folder ID.
+        :param parent_folder_id: Search for folders with the given parent folderId.
         :type parent_folder_id: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
@@ -626,7 +626,7 @@ def do_search_with_http_info(self, **kwargs):  # noqa: E501
         :type name: str
         :param path: Search for folders by path.
         :type path: str
-        :param parent_folder_id: Search for folders with the given parent folder ID.
+        :param parent_folder_id: Search for folders with the given parent folderId.
         :type parent_folder_id: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional

hubspot/files/files/api_client.py hubspot/files/api_client.pyhubspot/files/files/api_client.py renamed to hubspot/files/api_client.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 """
-    Files
+    Files Files
 
     Upload and manage files.  # noqa: E501
 
@@ -24,10 +24,10 @@
 import six
 from six.moves.urllib.parse import quote
 
-from hubspot.files.files.configuration import Configuration
-import hubspot.files.files.models
-from hubspot.files.files import rest
-from hubspot.files.files.exceptions import ApiValueError, ApiException
+from hubspot.files.configuration import Configuration
+import hubspot.files.models
+from hubspot.files import rest
+from hubspot.files.exceptions import ApiValueError, ApiException
 
 
 class ApiClient(object):
@@ -301,7 +301,7 @@ def __deserialize(self, data, klass):
             if klass in self.NATIVE_TYPES_MAPPING:
                 klass = self.NATIVE_TYPES_MAPPING[klass]
             else:
-                klass = getattr(hubspot.files.files.models, klass)
+                klass = getattr(hubspot.files.models, klass)
 
         if klass in self.PRIMITIVE_TYPES:
             return self.__deserialize_primitive(data, klass)