fix: Changed some functions signarure to fix liskov substitution violations

BREAKING CHANGE: Changed function signatures:
  - `get_url()` in `base_endpoint.py`
  - `copy()` in 'base_item.py' 'file.py'
  - `create_shared_link()` in 'base_item.py', 'item.py'
  - `get_shared_link()` in 'base_item.py', 'item.py'
  - `remove_shared_link()` in 'base_item.py', 'item.py'
  - `get()` in `base_object.py`, 'item.py'
  - `update_info()` in `base_object.py`, `collaboration.py`, 'item.py', `metadata_template.py`
  - `delete()` in `base_object.py`, `folder.py`, 'item.py', `user.py`
Closes: SDK-1904

Author: lukaszsocha2

boxsdk/object/base_endpoint.py

@@ -34,17 +34,14 @@ def translator(self) -> 'Translator':
         """
         return self._session.translator
 
-    def get_url(self, endpoint: str, *args: Any) -> str:
+    def get_url(self, *args: Any) -> str:
         """
         Return the URL used to access the endpoint.
 
-        :param endpoint:
-            The name of the endpoint.
         :param args:
-            Additional parts of the endpoint URL.
+            Parts of the endpoint URL.
         """
-        # pylint:disable=no-self-use
-        return self._session.get_url(endpoint, *args)
+        return self._session.get_url(*args)
 
     def clone(self, session: 'Session' = None) -> 'BaseEndpoint':
         """

boxsdk/object/base_item.py

@@ -1,6 +1,6 @@
 import json
 
-from typing import TYPE_CHECKING, Any, Union
+from typing import TYPE_CHECKING, Any, Union, Optional
 
 from .base_object import BaseObject
 from ..exception import BoxValueError
@@ -15,7 +15,7 @@
 class BaseItem(BaseObject):
 
     @api_call
-    def copy(self, parent_folder: 'Folder', name: str = None) -> 'BaseItem':
+    def copy(self, parent_folder: 'Folder', name: str = None, **_kwargs) -> 'BaseItem':
         """Copy the item to the given folder.
 
         :param parent_folder:
@@ -68,23 +68,50 @@ def rename(self, name: str) -> 'BaseItem':
         return self.update_info(data)
 
     @api_call
-    def create_shared_link(self, **kwargs: Any) -> Any:
+    def create_shared_link(
+            self,
+            access: Optional[str] = None,
+            unshared_at: Optional[str] = SDK_VALUE_NOT_SET,
+            password: Optional[str] = None,
+            vanity_name: Optional[str] = None,
+            **kwargs: Any) -> Any:
         """
         Create a shared link for the item with the given access permissions.
 
+        :param access:
+            Determines who can access the shared link. May be open, company, or collaborators. If no access is
+            specified, the default access will be used.
+        :param unshared_at:
+            The date on which this link should be disabled. May only be set if the current user is not a free user
+            and has permission to set expiration dates.  Takes an RFC3339-formatted string, e.g.
+            '2018-10-31T23:59:59-07:00' for 11:59:59 PM on October 31, 2018 in the America/Los_Angeles timezone.
+            The time portion can be omitted, which defaults to midnight (00:00:00) on that date.
+        :param password:
+            The password required to view this link. If no password is specified then no password will be set.
+            Please notice that this is a premium feature, which might not be available to your app.
+        :param vanity_name:
+            Defines a custom vanity name to use in the shared link URL, eg. https://app.box.com/v/my-custom-vanity-name.
+            If this parameter is None, the standard shared link URL will be used.
         :param kwargs:
             Keyword arguments passed from overriding method used to build request properties.
         :return:
             The updated object with shared link.
             Returns a new object of the same type, without modifying the original object passed as self.
         """
+
         shared_link = {}
 
-        if kwargs.get('access') is not None:
-            shared_link['access'] = kwargs.get('access')
+        if access is not None:
+            shared_link['access'] = access
+
+        if unshared_at is not SDK_VALUE_NOT_SET:
+            shared_link['unshared_at'] = unshared_at
+
+        if password is not None:
+            shared_link['password'] = password
 
-        if kwargs.get('unshared_at') is not SDK_VALUE_NOT_SET:
-            shared_link['unshared_at'] = kwargs.get('unshared_at')
+        if vanity_name is not None:
+            shared_link['vanity_name'] = vanity_name
 
         if kwargs.get('allow_download') is not None or kwargs.get('allow_preview') is not None:
             shared_link['permissions'] = {}
@@ -93,29 +120,45 @@ def create_shared_link(self, **kwargs: Any) -> Any:
             if kwargs.get('allow_preview') is not None:
                 shared_link['permissions']['can_preview'] = kwargs.get('allow_preview')
 
-        if kwargs.get('password') is not None:
-            shared_link['password'] = kwargs.get('password')
-
-        if kwargs.get('vanity_name') is not None:
-            shared_link['vanity_name'] = kwargs.get('vanity_name')
-
         data = {'shared_link': shared_link}
         update_info_kwargs = {'etag': kwargs.get('etag')} if kwargs.get('etag') is not None else {}
 
         return self.update_info(data, **update_info_kwargs)
 
     @api_call
-    def get_shared_link(self, **kwargs: Any) -> str:
+    def get_shared_link(
+            self,
+            access: Optional[str] = None,
+            unshared_at: Optional[str] = SDK_VALUE_NOT_SET,
+            password: Optional[str] = None,
+            vanity_name: Optional[str] = None,
+            **kwargs: Any) -> str:
         """
         Get a shared link for the item with the given access permissions.
         This url leads to a Box.com shared link page, where the item can be previewed, downloaded, etc.
 
+        :param access:
+            Determines who can access the shared link. May be open, company, or collaborators. If no access is
+            specified, the default access will be used.
+        :param unshared_at:
+            The date on which this link should be disabled. May only be set if the current user is not a free user
+            and has permission to set expiration dates.  Takes an RFC3339-formatted string, e.g.
+            '2018-10-31T23:59:59-07:00' for 11:59:59 PM on October 31, 2018 in the America/Los_Angeles timezone.
+            The time portion can be omitted, which defaults to midnight (00:00:00) on that date.
+        :param password:
+            The password required to view this link. If no password is specified then no password will be set.
+            Please notice that this is a premium feature, which might not be available to your app.
+        :param vanity_name:
+            Defines a custom vanity name to use in the shared link URL, eg. https://app.box.com/v/my-custom-vanity-name.
+            If this parameter is None, the standard shared link URL will be used.
         :param kwargs:
             Keyword arguments passed from overriding method used to create a new shared link.
         :returns:
             The URL of the shared link.
         """
-        item = self.create_shared_link(**kwargs)
+        item = self.create_shared_link(
+            access=access, unshared_at=unshared_at, password=password, vanity_name=vanity_name, **kwargs
+        )
         return item.shared_link['url']  # pylint:disable=no-member
 
     @api_call

boxsdk/object/base_object.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 import json
-from typing import TYPE_CHECKING, Any, Iterable, Optional
+from typing import TYPE_CHECKING, Any, Iterable, Optional, Union, List
 
 from .base_endpoint import BaseEndpoint
 from .base_api_json_object import BaseAPIJSONObject
@@ -40,7 +40,6 @@ def get_url(self, *args: Any) -> str:
         Base class override.
         Return the given object's URL, appending any optional parts as specified by args.
         """
-        # pylint:disable=arguments-differ
         return super().get_url(f'{self._item_type}s', self._object_id, *args)
 
     def get_type_url(self) -> str:
@@ -57,7 +56,7 @@ def object_id(self) -> str:
         return self._object_id
 
     @api_call
-    def get(self, fields: Iterable[str] = None, headers: dict = None) -> Any:
+    def get(self, fields: Iterable[str] = None, headers: dict = None, **_kwargs) -> Any:
         """
         Get information about the object, specified by fields. If fields is None, return the default fields.
 
@@ -79,7 +78,7 @@ def get(self, fields: Iterable[str] = None, headers: dict = None) -> Any:
     @api_call
     def update_info(
             self,
-            data: dict,
+            data: Union[dict, List[dict]],
             params: Optional[dict] = None,
             headers: Optional[dict] = None,
             **kwargs: Any
@@ -109,19 +108,18 @@ def update_info(
             Construct the new object with all the default attributes that are
             returned from the endpoint.
         """
-        # pylint:disable=no-else-return
         url = self.get_url()
         box_response = self._session.put(url, data=json.dumps(data), params=params, headers=headers, **kwargs)
         if 'expect_json_response' in kwargs and not kwargs['expect_json_response']:
             return box_response.ok
-        else:
-            return self.translator.translate(
-                session=self._session,
-                response_object=box_response.json(),
-            )
+
+        return self.translator.translate(
+            session=self._session,
+            response_object=box_response.json(),
+        )
 
     @api_call
-    def delete(self, params: Optional[dict] = None, headers: Optional[dict] = None) -> bool:
+    def delete(self, params: Optional[dict] = None, headers: Optional[dict] = None, **_kwargs) -> bool:
         """ Delete the object.
 
         :param params:
@@ -134,8 +132,7 @@ def delete(self, params: Optional[dict] = None, headers: Optional[dict] = None)
             :class:`BoxAPIException` in case of unexpected errors.
         """
         url = self.get_url()
-        # ??? There's a question about why params forces a default to {}, while headers doesn't. Looking for
-        # confirmation that the below is correct.
+
         box_response = self._session.delete(url, expect_json_response=False, params=params or {}, headers=headers)
         return box_response.ok
 

boxsdk/object/collaboration.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-from typing import Optional
+from typing import Optional, Any
 
 from boxsdk.object.base_object import BaseObject
 from boxsdk.util.text_enum import TextEnum
@@ -34,11 +34,27 @@ class Collaboration(BaseObject):
     @api_call
     def update_info(
             self,
+            data: Optional[dict] = None,
+            params: Optional[dict] = None,
+            headers: Optional[dict] = None,
+            *,
             role: Optional[CollaborationRole] = None,
-            status: Optional[CollaborationStatus] = None
+            status: Optional[CollaborationStatus] = None,
+            **kwargs: Any
     ) -> 'BaseObject':
-        """Edit an existing collaboration on Box
+        """
 
+        :param data:
+            (optional) The updated information about this object.
+            Must be JSON serializable.
+            Update the object attributes in data.keys(). The semantics of the
+            values depends on the the type and attributes of the object being
+            updated. For details on particular semantics, refer to the Box
+            developer API documentation <https://developer.box.com/>.
+        :param params:
+            (optional) Query string parameters for the request.
+        :param headers:
+            (optional) Extra HTTP headers for the request.
         :param role:
             The new role for this collaboration or None to leave unchanged
         :param status:
@@ -49,16 +65,17 @@ def update_info(
         :raises:
             :class:`BoxAPIException` if current user doesn't have permissions to edit the collaboration.
         """
-        # pylint:disable=arguments-differ
-        data = {}
+        # pylint: disable=arguments-differ
+        data_to_update = data if data else {}
         if role:
-            data['role'] = role
+            data_to_update['role'] = role
         if status:
-            data['status'] = status
+            data_to_update['status'] = status
+
         if role == CollaborationRole.OWNER:
-            return super().update_info(data=data, expect_json_response=False)
+            return super().update_info(data=data_to_update, params=params, headers=headers, expect_json_response=False, **kwargs)
 
-        return super().update_info(data=data)
+        return super().update_info(data=data_to_update, params=params, headers=headers, **kwargs)
 
     @api_call
     def accept(self) -> 'BaseObject':

boxsdk/object/events.py

@@ -60,7 +60,6 @@ class Events(BaseEndpoint):
 
     def get_url(self, *args: Any) -> str:
         """Base class override."""
-        # pylint:disable=arguments-differ
         return super().get_url('events', *args)
 
     @api_call

boxsdk/object/file.py

@@ -681,8 +681,14 @@ def get_thumbnail_representation(self, dimensions: str, extension: str = 'png')
         return b''
 
     @api_call
-    def copy(self, parent_folder: 'Folder', name: Optional[str] = None, file_version: 'FileVersion' = None) -> 'File':
-        # pylint: disable=arguments-differ
+    def copy(
+            self,
+            parent_folder: 'Folder',
+            name: Optional[str] = None,
+            *,
+            file_version: 'FileVersion' = None,
+            **_kwargs
+    ) -> 'File':
         """Copy the item to the given folder.
 
         :param parent_folder:
@@ -694,6 +700,7 @@ def copy(self, parent_folder: 'Folder', name: Optional[str] = None, file_version
         :returns:
             The copy of the file
         """
+        # pylint: disable=arguments-differ
         url = self.get_url('copy')
         data = {
             'parent': {'id': parent_folder.object_id}

boxsdk/object/folder.py

@@ -503,9 +503,20 @@ def create_web_link(
         )
 
     @api_call
-    def delete(self, recursive: bool = True, etag: Optional[str] = None) -> bool:
+    def delete(
+            self,
+            params: Optional[dict] = None,
+            headers: Optional[dict] = None,
+            *,
+            recursive: bool = True,
+            etag: Optional[str] = None,
+            **kwargs
+    ) -> bool:
         """Base class override. Delete the folder.
-
+        :param params:
+            Additional parameters to send with the request.
+        :param headers:
+            Additional headers to send with the request.
         :param recursive:
             Whether or not the folder should be deleted if it isn't empty.
         :param etag:
@@ -514,8 +525,11 @@ def delete(self, recursive: bool = True, etag: Optional[str] = None) -> bool:
             Whether or not the update was successful.
         :raises: :class:`BoxAPIException` if the specified etag doesn't match the latest version of the folder.
         """
-        # pylint:disable=arguments-differ,arguments-renamed
-        return super().delete({'recursive': recursive}, etag)
+        # pylint: disable=arguments-differ
+        params_to_send = params if params else {}
+        params_to_send.update({'recursive': recursive})
+
+        return super().delete(params=params_to_send, headers=headers, etag=etag, **kwargs)
 
     @api_call
     def get_metadata_cascade_policies(