fix: Make role parameter of update collaboration optional (box/box-openapi#557) (#1093)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "9334953", "specHash": "62fdfd1", "version": "10.0.0" }
+{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" }

box_sdk_gen/managers/user_collaborations.py

@@ -195,8 +195,8 @@ def get_collaboration_by_id(
     def update_collaboration_by_id(
         self,
         collaboration_id: str,
-        role: UpdateCollaborationByIdRole,
         *,
+        role: Optional[UpdateCollaborationByIdRole] = None,
         status: Optional[UpdateCollaborationByIdStatus] = None,
         expires_at: Optional[DateTime] = None,
         can_view_path: Optional[bool] = None,
@@ -208,13 +208,13 @@ def update_collaboration_by_id(
                 Can be used to change the owner of an item, or to
 
 
-                accept collaboration invites.
+                accept collaboration invites. In case of accepting collaboration invite, role is not required.
 
                 :param collaboration_id: The ID of the collaboration.
         Example: "1234"
                 :type collaboration_id: str
-                :param role: The level of access granted.
-                :type role: UpdateCollaborationByIdRole
+                :param role: The level of access granted., defaults to None
+                :type role: Optional[UpdateCollaborationByIdRole], optional
                 :param status: Set the status of a `pending` collaboration invitation,
         effectively accepting, or rejecting the invite., defaults to None
                 :type status: Optional[UpdateCollaborationByIdStatus], optional

docs/user_collaborations.md

@@ -39,7 +39,7 @@ Returns a collaboration object.
 
 Updates a collaboration.
 Can be used to change the owner of an item, or to
-accept collaboration invites.
+accept collaboration invites. In case of accepting collaboration invite, role is not required.
 
 This operation is performed by calling function `update_collaboration_by_id`.
 
@@ -50,15 +50,15 @@ See the endpoint docs at
 
 ```python
 client.user_collaborations.update_collaboration_by_id(
-    collaboration_id, UpdateCollaborationByIdRole.VIEWER
+    collaboration_id, role=UpdateCollaborationByIdRole.VIEWER
 )
 ```
 
 ### Arguments
 
 - collaboration_id `str`
   - The ID of the collaboration. Example: "1234"
-- role `UpdateCollaborationByIdRole`
+- role `Optional[UpdateCollaborationByIdRole]`
   - The level of access granted.
 - status `Optional[UpdateCollaborationByIdStatus]`
   - Set the status of a `pending` collaboration invitation, effectively accepting, or rejecting the invite.

test/user_collaborations.py

@@ -64,7 +64,7 @@ def testUserCollaborations():
     assert collaboration_from_api.invite_email == None
     updated_collaboration: Optional[Collaboration] = (
         client.user_collaborations.update_collaboration_by_id(
-            collaboration_id, UpdateCollaborationByIdRole.VIEWER
+            collaboration_id, role=UpdateCollaborationByIdRole.VIEWER
         )
     )
     assert to_string(updated_collaboration.role) == 'viewer'
@@ -94,7 +94,7 @@ def testConvertingUserCollaborationToOwnership():
     assert to_string(collaboration.role) == 'editor'
     owner_collaboration: Optional[Collaboration] = (
         client.user_collaborations.update_collaboration_by_id(
-            collaboration.id, UpdateCollaborationByIdRole.OWNER
+            collaboration.id, role=UpdateCollaborationByIdRole.OWNER
         )
     )
     assert owner_collaboration == None
@@ -133,7 +133,7 @@ def testExternalUserCollaborations():
     assert collaboration_from_api.invite_email == user_login
     updated_collaboration: Optional[Collaboration] = (
         client.user_collaborations.update_collaboration_by_id(
-            collaboration_id, UpdateCollaborationByIdRole.VIEWER
+            collaboration_id, role=UpdateCollaborationByIdRole.VIEWER
         )
     )
     assert to_string(updated_collaboration.role) == 'viewer'