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

Author: box-sdk-build

.codegen.json

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

docs/userCollaborations.md

@@ -36,7 +36,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 `updateCollaborationById`.
 
@@ -47,16 +47,16 @@ See the endpoint docs at
 
 ```ts
 await client.userCollaborations.updateCollaborationById(collaborationId, {
-  role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
-} satisfies UpdateCollaborationByIdRequestBody);
+  requestBody: {
+    role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
+  } satisfies UpdateCollaborationByIdRequestBody,
+} satisfies UpdateCollaborationByIdOptionalsInput);
 ```
 
 ### Arguments
 
 - collaborationId `string`
   - The ID of the collaboration. Example: "1234"
-- requestBody `UpdateCollaborationByIdRequestBody`
-  - Request body of updateCollaborationById method
 - optionalsInput `UpdateCollaborationByIdOptionalsInput`
 
 ### Returns

src/managers/userCollaborations.ts

@@ -60,18 +60,26 @@ export interface GetCollaborationByIdOptionalsInput {
   readonly cancellationToken?: undefined | CancellationToken;
 }
 export class UpdateCollaborationByIdOptionals {
+  readonly requestBody: UpdateCollaborationByIdRequestBody =
+    {} satisfies UpdateCollaborationByIdRequestBody;
   readonly headers: UpdateCollaborationByIdHeaders =
     new UpdateCollaborationByIdHeaders({});
   readonly cancellationToken?: CancellationToken = void 0;
   constructor(
     fields: Omit<
       UpdateCollaborationByIdOptionals,
-      'headers' | 'cancellationToken'
+      'requestBody' | 'headers' | 'cancellationToken'
     > &
       Partial<
-        Pick<UpdateCollaborationByIdOptionals, 'headers' | 'cancellationToken'>
+        Pick<
+          UpdateCollaborationByIdOptionals,
+          'requestBody' | 'headers' | 'cancellationToken'
+        >
       >,
   ) {
+    if (fields.requestBody !== undefined) {
+      this.requestBody = fields.requestBody;
+    }
     if (fields.headers !== undefined) {
       this.headers = fields.headers;
     }
@@ -81,6 +89,7 @@ export class UpdateCollaborationByIdOptionals {
   }
 }
 export interface UpdateCollaborationByIdOptionalsInput {
+  readonly requestBody?: UpdateCollaborationByIdRequestBody;
   readonly headers?: UpdateCollaborationByIdHeaders;
   readonly cancellationToken?: undefined | CancellationToken;
 }
@@ -199,7 +208,7 @@ export type UpdateCollaborationByIdRequestBodyStatusField =
 export interface UpdateCollaborationByIdRequestBody {
   /**
    * The level of access granted. */
-  readonly role: UpdateCollaborationByIdRequestBodyRoleField;
+  readonly role?: UpdateCollaborationByIdRequestBodyRoleField;
   /**
    * Set the status of a `pending` collaboration invitation,
    * effectively accepting, or rejecting the invite. */
@@ -486,23 +495,23 @@ export class UserCollaborationsManager {
   /**
      * 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.
      * @param {string} collaborationId The ID of the collaboration.
     Example: "1234"
-     * @param {UpdateCollaborationByIdRequestBody} requestBody Request body of updateCollaborationById method
      * @param {UpdateCollaborationByIdOptionalsInput} optionalsInput
      * @returns {Promise<undefined | Collaboration>}
      */
   async updateCollaborationById(
     collaborationId: string,
-    requestBody: UpdateCollaborationByIdRequestBody,
     optionalsInput: UpdateCollaborationByIdOptionalsInput = {},
   ): Promise<undefined | Collaboration> {
     const optionals: UpdateCollaborationByIdOptionals =
       new UpdateCollaborationByIdOptionals({
+        requestBody: optionalsInput.requestBody,
         headers: optionalsInput.headers,
         cancellationToken: optionalsInput.cancellationToken,
       });
+    const requestBody: any = optionals.requestBody;
     const headers: any = optionals.headers;
     const cancellationToken: any = optionals.cancellationToken;
     const headersMap: {
@@ -711,7 +720,10 @@ export function serializeUpdateCollaborationByIdRequestBody(
   val: UpdateCollaborationByIdRequestBody,
 ): SerializedData {
   return {
-    ['role']: serializeUpdateCollaborationByIdRequestBodyRoleField(val.role),
+    ['role']:
+      val.role == void 0
+        ? val.role
+        : serializeUpdateCollaborationByIdRequestBodyRoleField(val.role),
     ['status']:
       val.status == void 0
         ? val.status
@@ -731,14 +743,10 @@ export function deserializeUpdateCollaborationByIdRequestBody(
       message: 'Expecting a map for "UpdateCollaborationByIdRequestBody"',
     });
   }
-  if (val.role == void 0) {
-    throw new BoxSdkError({
-      message:
-        'Expecting "role" of type "UpdateCollaborationByIdRequestBody" to be defined',
-    });
-  }
-  const role: UpdateCollaborationByIdRequestBodyRoleField =
-    deserializeUpdateCollaborationByIdRequestBodyRoleField(val.role);
+  const role: undefined | UpdateCollaborationByIdRequestBodyRoleField =
+    val.role == void 0
+      ? void 0
+      : deserializeUpdateCollaborationByIdRequestBodyRoleField(val.role);
   const status: undefined | UpdateCollaborationByIdRequestBodyStatusField =
     val.status == void 0
       ? void 0

src/test/userCollaborations.test.ts

@@ -24,6 +24,8 @@ import { serializeUpdateCollaborationByIdRequestBodyRoleField } from '@/managers
 import { deserializeUpdateCollaborationByIdRequestBodyRoleField } from '@/managers/userCollaborations';
 import { serializeCollaborations } from '@/schemas/collaborations';
 import { deserializeCollaborations } from '@/schemas/collaborations';
+import { UpdateCollaborationByIdOptionalsInput } from '@/managers/userCollaborations';
+import { UpdateCollaborationByIdOptionals } from '@/managers/userCollaborations';
 import { BoxClient } from '@/client';
 import { UserFull } from '@/schemas/userFull';
 import { CreateUserRequestBody } from '@/managers/users';
@@ -92,8 +94,10 @@ test('testUserCollaborations', async function testUserCollaborations(): Promise<
   }
   const updatedCollaboration: undefined | Collaboration =
     await client.userCollaborations.updateCollaborationById(collaborationId, {
-      role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
-    } satisfies UpdateCollaborationByIdRequestBody);
+      requestBody: {
+        role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
+      } satisfies UpdateCollaborationByIdRequestBody,
+    } satisfies UpdateCollaborationByIdOptionalsInput);
   if (!((toString(updatedCollaboration!.role!) as string) == 'viewer')) {
     throw new Error('Assertion failed');
   }
@@ -130,8 +134,10 @@ test('testConvertingUserCollaborationToOwnership', async function testConverting
   }
   const ownerCollaboration: undefined | Collaboration =
     await client.userCollaborations.updateCollaborationById(collaboration.id, {
-      role: 'owner' as UpdateCollaborationByIdRequestBodyRoleField,
-    } satisfies UpdateCollaborationByIdRequestBody);
+      requestBody: {
+        role: 'owner' as UpdateCollaborationByIdRequestBodyRoleField,
+      } satisfies UpdateCollaborationByIdRequestBody,
+    } satisfies UpdateCollaborationByIdOptionalsInput);
   if (!(ownerCollaboration == void 0)) {
     throw new Error('Assertion failed');
   }
@@ -182,8 +188,10 @@ test('testExternalUserCollaborations', async function testExternalUserCollaborat
   }
   const updatedCollaboration: undefined | Collaboration =
     await client.userCollaborations.updateCollaborationById(collaborationId, {
-      role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
-    } satisfies UpdateCollaborationByIdRequestBody);
+      requestBody: {
+        role: 'viewer' as UpdateCollaborationByIdRequestBodyRoleField,
+      } satisfies UpdateCollaborationByIdRequestBody,
+    } satisfies UpdateCollaborationByIdOptionalsInput);
   if (!((toString(updatedCollaboration!.role!) as string) == 'viewer')) {
     throw new Error('Assertion failed');
   }