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

box-sdk-build · web-flow · commit 824791817bd4 · 2025-10-03T11:55:39.000+02:00
diff --git a/.codegen.json b/.codegen.json
@@ -1 +1 @@
-{ "engineHash": "9334953", "specHash": "62fdfd1", "version": "10.0.0" }
+{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" }
diff --git a/Box.Sdk.Gen.Net/Managers/UserCollaborations/IUserCollaborationsManager.cs b/Box.Sdk.Gen.Net/Managers/UserCollaborations/IUserCollaborationsManager.cs
@@ -29,7 +29,7 @@ public interface IUserCollaborationsManager {
         /// <summary>
     /// 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.
     /// </summary>
     /// <param name="collaborationId">
     /// The ID of the collaboration.
@@ -44,7 +44,7 @@ public interface IUserCollaborationsManager {
     /// <param name="cancellationToken">
     /// Token used for request cancellation.
     /// </param>
-    public System.Threading.Tasks.Task<Collaboration?> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody requestBody, UpdateCollaborationByIdHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
+    public System.Threading.Tasks.Task<Collaboration?> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody? requestBody = default, UpdateCollaborationByIdHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) => throw new System.NotImplementedException("This method needs to be implemented by the derived class before calling it.");
 
         /// <summary>
     /// Deletes a single collaboration.
diff --git a/Box.Sdk.Gen.Net/Managers/UserCollaborations/UpdateCollaborationByIdRequestBody.cs b/Box.Sdk.Gen.Net/Managers/UserCollaborations/UpdateCollaborationByIdRequestBody.cs
@@ -13,7 +13,7 @@ public class UpdateCollaborationByIdRequestBody : ISerializable {
         /// </summary>
         [JsonPropertyName("role")]
         [JsonConverter(typeof(StringEnumConverter<UpdateCollaborationByIdRequestBodyRoleField>))]
-        public StringEnum<UpdateCollaborationByIdRequestBodyRoleField> Role { get; }
+        public StringEnum<UpdateCollaborationByIdRequestBodyRoleField>? Role { get; init; }
 
         /// <summary>
         /// Set the status of a `pending` collaboration invitation,
@@ -59,13 +59,8 @@ public class UpdateCollaborationByIdRequestBody : ISerializable {
         [JsonPropertyName("can_view_path")]
         public bool? CanViewPath { get; init; }
 
-        public UpdateCollaborationByIdRequestBody(UpdateCollaborationByIdRequestBodyRoleField role) {
-            Role = role;
-        }
-        
-        [JsonConstructorAttribute]
-        internal UpdateCollaborationByIdRequestBody(StringEnum<UpdateCollaborationByIdRequestBodyRoleField> role) {
-            Role = role;
+        public UpdateCollaborationByIdRequestBody() {
+            
         }
         internal string? RawJson { get; set; } = default;
 
diff --git a/Box.Sdk.Gen.Net/Managers/UserCollaborations/UserCollaborationsManager.cs b/Box.Sdk.Gen.Net/Managers/UserCollaborations/UserCollaborationsManager.cs
@@ -43,7 +43,7 @@ public async System.Threading.Tasks.Task<Collaboration> GetCollaborationByIdAsyn
         /// <summary>
         /// 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.
         /// </summary>
         /// <param name="collaborationId">
         /// The ID of the collaboration.
@@ -58,7 +58,8 @@ public async System.Threading.Tasks.Task<Collaboration> GetCollaborationByIdAsyn
         /// <param name="cancellationToken">
         /// Token used for request cancellation.
         /// </param>
-        public async System.Threading.Tasks.Task<Collaboration?> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody requestBody, UpdateCollaborationByIdHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+        public async System.Threading.Tasks.Task<Collaboration?> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody? requestBody = default, UpdateCollaborationByIdHeaders? headers = default, System.Threading.CancellationToken? cancellationToken = null) {
+            requestBody = requestBody ?? new UpdateCollaborationByIdRequestBody();
             headers = headers ?? new UpdateCollaborationByIdHeaders();
             Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string?>() {  }, headers.ExtraHeaders));
             FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/collaborations/", StringUtils.ToStringRepresentation(collaborationId)), method: "PUT", contentType: "application/json", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Data = SimpleJsonSerializer.Serialize(requestBody), Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
diff --git a/Box.Sdk.Gen.NetFramework.Tests.Integration/Test/UserCollaborations/UserCollaborationsManagerTests.cs b/Box.Sdk.Gen.NetFramework.Tests.Integration/Test/UserCollaborations/UserCollaborationsManagerTests.cs
@@ -27,7 +27,7 @@ public async System.Threading.Tasks.Task TestUserCollaborations() {
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(collaborationFromApi.Status)) == "accepted");
             Assert.IsTrue(StringUtils.ToStringRepresentation(collaborationFromApi.Type?.Value) == "collaboration");
             Assert.IsTrue(collaborationFromApi.InviteEmail == null);
-            Collaboration updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.Viewer));
+            Collaboration updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody() { Role = UpdateCollaborationByIdRequestBodyRoleField.Viewer });
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(NullableUtils.Unwrap(updatedCollaboration).Role)) == "viewer");
             await client.UserCollaborations.DeleteCollaborationByIdAsync(collaborationId: collaborationId);
             await Assert.That.IsExceptionAsync(async() => await client.UserCollaborations.GetCollaborationByIdAsync(collaborationId: collaborationId));
@@ -43,7 +43,7 @@ public async System.Threading.Tasks.Task TestConvertingUserCollaborationToOwners
             FolderFull folder = await new CommonsManager().CreateNewFolderAsync();
             Collaboration collaboration = await client.UserCollaborations.CreateCollaborationAsync(requestBody: new CreateCollaborationRequestBody(item: new CreateCollaborationRequestBodyItemField() { Type = CreateCollaborationRequestBodyItemTypeField.Folder, Id = folder.Id }, accessibleBy: new CreateCollaborationRequestBodyAccessibleByField(type: CreateCollaborationRequestBodyAccessibleByTypeField.User) { Id = user.Id }, role: CreateCollaborationRequestBodyRoleField.Editor));
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(collaboration.Role)) == "editor");
-            Collaboration ownerCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaboration.Id, requestBody: new UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.Owner));
+            Collaboration ownerCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaboration.Id, requestBody: new UpdateCollaborationByIdRequestBody() { Role = UpdateCollaborationByIdRequestBodyRoleField.Owner });
             Assert.IsTrue(ownerCollaboration == null);
             Collaborations folderCollaborations = await client.ListCollaborations.GetFolderCollaborationsAsync(folderId: folder.Id);
             Collaboration folderCollaboration = NullableUtils.Unwrap(folderCollaborations.Entries)[0];
@@ -67,7 +67,7 @@ public async System.Threading.Tasks.Task TestExternalUserCollaborations() {
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(collaborationFromApi.Status)) == "pending");
             Assert.IsTrue(StringUtils.ToStringRepresentation(collaborationFromApi.Type?.Value) == "collaboration");
             Assert.IsTrue(collaborationFromApi.InviteEmail == userLogin);
-            Collaboration updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.Viewer));
+            Collaboration updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody() { Role = UpdateCollaborationByIdRequestBodyRoleField.Viewer });
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(NullableUtils.Unwrap(updatedCollaboration).Role)) == "viewer");
             await client.UserCollaborations.DeleteCollaborationByIdAsync(collaborationId: collaborationId);
             await Assert.That.IsExceptionAsync(async() => await client.UserCollaborations.GetCollaborationByIdAsync(collaborationId: collaborationId));
diff --git a/Box.Sdk.Gen.NetFramework/Managers/UserCollaborations/UpdateCollaborationByIdRequestBody.cs b/Box.Sdk.Gen.NetFramework/Managers/UserCollaborations/UpdateCollaborationByIdRequestBody.cs
@@ -59,13 +59,8 @@ public class UpdateCollaborationByIdRequestBody : ISerializable {
         [JsonPropertyName("can_view_path")]
         public bool? CanViewPath { get; set; }
 
-        public UpdateCollaborationByIdRequestBody(UpdateCollaborationByIdRequestBodyRoleField role) {
-            Role = role;
-        }
-        
-        [JsonConstructorAttribute]
-        internal UpdateCollaborationByIdRequestBody(StringEnum<UpdateCollaborationByIdRequestBodyRoleField> role) {
-            Role = role;
+        public UpdateCollaborationByIdRequestBody() {
+            
         }
         internal string RawJson { get; set; } = default;
 
diff --git a/Box.Sdk.Gen.NetFramework/Managers/UserCollaborations/UserCollaborationsManager.cs b/Box.Sdk.Gen.NetFramework/Managers/UserCollaborations/UserCollaborationsManager.cs
@@ -43,7 +43,7 @@ public async System.Threading.Tasks.Task<Collaboration> GetCollaborationByIdAsyn
         /// <summary>
         /// 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.
         /// </summary>
         /// <param name="collaborationId">
         /// The ID of the collaboration.
@@ -58,7 +58,8 @@ public async System.Threading.Tasks.Task<Collaboration> GetCollaborationByIdAsyn
         /// <param name="cancellationToken">
         /// Token used for request cancellation.
         /// </param>
-        public async System.Threading.Tasks.Task<Collaboration> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody requestBody, UpdateCollaborationByIdHeaders headers = default, System.Threading.CancellationToken cancellationToken = default) {
+        public async System.Threading.Tasks.Task<Collaboration> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody requestBody = default, UpdateCollaborationByIdHeaders headers = default, System.Threading.CancellationToken cancellationToken = default) {
+            requestBody = requestBody ?? new UpdateCollaborationByIdRequestBody();
             headers = headers ?? new UpdateCollaborationByIdHeaders();
             Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string>() {  }, headers.ExtraHeaders));
             FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/collaborations/", StringUtils.ToStringRepresentation(collaborationId)), method: "PUT", contentType: "application/json", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Data = SimpleJsonSerializer.Serialize(requestBody), Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
diff --git a/Box.Sdk.Gen.NetStandard/Managers/UserCollaborations/UpdateCollaborationByIdRequestBody.cs b/Box.Sdk.Gen.NetStandard/Managers/UserCollaborations/UpdateCollaborationByIdRequestBody.cs
@@ -59,13 +59,8 @@ public class UpdateCollaborationByIdRequestBody : ISerializable {
         [JsonPropertyName("can_view_path")]
         public bool? CanViewPath { get; set; }
 
-        public UpdateCollaborationByIdRequestBody(UpdateCollaborationByIdRequestBodyRoleField role) {
-            Role = role;
-        }
-        
-        [JsonConstructorAttribute]
-        internal UpdateCollaborationByIdRequestBody(StringEnum<UpdateCollaborationByIdRequestBodyRoleField> role) {
-            Role = role;
+        public UpdateCollaborationByIdRequestBody() {
+            
         }
         internal string RawJson { get; set; } = default;
 
diff --git a/Box.Sdk.Gen.NetStandard/Managers/UserCollaborations/UserCollaborationsManager.cs b/Box.Sdk.Gen.NetStandard/Managers/UserCollaborations/UserCollaborationsManager.cs
@@ -43,7 +43,7 @@ public async System.Threading.Tasks.Task<Collaboration> GetCollaborationByIdAsyn
         /// <summary>
         /// 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.
         /// </summary>
         /// <param name="collaborationId">
         /// The ID of the collaboration.
@@ -58,7 +58,8 @@ public async System.Threading.Tasks.Task<Collaboration> GetCollaborationByIdAsyn
         /// <param name="cancellationToken">
         /// Token used for request cancellation.
         /// </param>
-        public async System.Threading.Tasks.Task<Collaboration> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody requestBody, UpdateCollaborationByIdHeaders headers = default, System.Threading.CancellationToken cancellationToken = default) {
+        public async System.Threading.Tasks.Task<Collaboration> UpdateCollaborationByIdAsync(string collaborationId, UpdateCollaborationByIdRequestBody requestBody = default, UpdateCollaborationByIdHeaders headers = default, System.Threading.CancellationToken cancellationToken = default) {
+            requestBody = requestBody ?? new UpdateCollaborationByIdRequestBody();
             headers = headers ?? new UpdateCollaborationByIdHeaders();
             Dictionary<string, string> headersMap = Utils.PrepareParams(map: DictionaryUtils.MergeDictionaries(new Dictionary<string, string>() {  }, headers.ExtraHeaders));
             FetchResponse response = await this.NetworkSession.NetworkClient.FetchAsync(options: new FetchOptions(url: string.Concat(this.NetworkSession.BaseUrls.BaseUrl, "/2.0/collaborations/", StringUtils.ToStringRepresentation(collaborationId)), method: "PUT", contentType: "application/json", responseFormat: Box.Sdk.Gen.ResponseFormat.Json) { Headers = headersMap, Data = SimpleJsonSerializer.Serialize(requestBody), Auth = this.Auth, NetworkSession = this.NetworkSession, CancellationToken = cancellationToken }).ConfigureAwait(false);
diff --git a/Box.Sdk.Gen.Tests.Integration.Net/Test/UserCollaborations/UserCollaborationsManagerTests.cs b/Box.Sdk.Gen.Tests.Integration.Net/Test/UserCollaborations/UserCollaborationsManagerTests.cs
@@ -27,7 +27,7 @@ public async System.Threading.Tasks.Task TestUserCollaborations() {
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(collaborationFromApi.Status)) == "accepted");
             Assert.IsTrue(StringUtils.ToStringRepresentation(collaborationFromApi.Type?.Value) == "collaboration");
             Assert.IsTrue(collaborationFromApi.InviteEmail == null);
-            Collaboration? updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.Viewer));
+            Collaboration? updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody() { Role = UpdateCollaborationByIdRequestBodyRoleField.Viewer });
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(NullableUtils.Unwrap(updatedCollaboration).Role)) == "viewer");
             await client.UserCollaborations.DeleteCollaborationByIdAsync(collaborationId: collaborationId);
             await Assert.That.IsExceptionAsync(async() => await client.UserCollaborations.GetCollaborationByIdAsync(collaborationId: collaborationId));
@@ -43,7 +43,7 @@ public async System.Threading.Tasks.Task TestConvertingUserCollaborationToOwners
             FolderFull folder = await new CommonsManager().CreateNewFolderAsync();
             Collaboration collaboration = await client.UserCollaborations.CreateCollaborationAsync(requestBody: new CreateCollaborationRequestBody(item: new CreateCollaborationRequestBodyItemField() { Type = CreateCollaborationRequestBodyItemTypeField.Folder, Id = folder.Id }, accessibleBy: new CreateCollaborationRequestBodyAccessibleByField(type: CreateCollaborationRequestBodyAccessibleByTypeField.User) { Id = user.Id }, role: CreateCollaborationRequestBodyRoleField.Editor));
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(collaboration.Role)) == "editor");
-            Collaboration? ownerCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaboration.Id, requestBody: new UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.Owner));
+            Collaboration? ownerCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaboration.Id, requestBody: new UpdateCollaborationByIdRequestBody() { Role = UpdateCollaborationByIdRequestBodyRoleField.Owner });
             Assert.IsTrue(ownerCollaboration == null);
             Collaborations folderCollaborations = await client.ListCollaborations.GetFolderCollaborationsAsync(folderId: folder.Id);
             Collaboration folderCollaboration = NullableUtils.Unwrap(folderCollaborations.Entries)[0];
@@ -67,7 +67,7 @@ public async System.Threading.Tasks.Task TestExternalUserCollaborations() {
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(collaborationFromApi.Status)) == "pending");
             Assert.IsTrue(StringUtils.ToStringRepresentation(collaborationFromApi.Type?.Value) == "collaboration");
             Assert.IsTrue(collaborationFromApi.InviteEmail == userLogin);
-            Collaboration? updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody(role: UpdateCollaborationByIdRequestBodyRoleField.Viewer));
+            Collaboration? updatedCollaboration = await client.UserCollaborations.UpdateCollaborationByIdAsync(collaborationId: collaborationId, requestBody: new UpdateCollaborationByIdRequestBody() { Role = UpdateCollaborationByIdRequestBodyRoleField.Viewer });
             Assert.IsTrue(StringUtils.ToStringRepresentation(NullableUtils.Unwrap(NullableUtils.Unwrap(updatedCollaboration).Role)) == "viewer");
             await client.UserCollaborations.DeleteCollaborationByIdAsync(collaborationId: collaborationId);
             await Assert.That.IsExceptionAsync(async() => await client.UserCollaborations.GetCollaborationByIdAsync(collaborationId: collaborationId));
diff --git a/Box.Sdk.Gen.Tests.Integration.NetStandard/Test/UserCollaborations/UserCollaborationsManagerTests.cs b/Box.Sdk.Gen.Tests.Integration.NetStandard/Test/UserCollaborations/UserCollaborationsManagerTests.cs
diff --git a/docs/UserCollaborations.md b/docs/UserCollaborations.md

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{ "engineHash": "9334953", "specHash": "62fdfd1", "version": "10.0.0" }`
	`1`	`+{ "engineHash": "9334953", "specHash": "c7acada", "version": "10.0.0" }`