feat: Support nullable fields in TypeScript (box/box-codegen#612) (#425)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "37e1577", "specHash": "c2c76f3", "version": "1.7.0" }
+{ "engineHash": "f6ccea9", "specHash": "6d5f53e", "version": "1.7.0" }

.github/workflows/spell-check-lint.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
 jobs:
-  spellcheck-request-title:
+  spellcheck-request:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout current repository
@@ -19,3 +19,5 @@ jobs:
           path: spellchecker
       - name: Execute spellchecker
         uses: ./spellchecker
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/collections.md

@@ -62,7 +62,7 @@ await client.collections.getCollectionItems(favouriteCollection.id!);
 
 ### Returns
 
-This function returns a value of type `Items`.
+This function returns a value of type `ItemsOffsetPaginated`.
 
 Returns an array of items in the collection.
 

docs/fileVersions.md

@@ -54,6 +54,16 @@ See the endpoint docs at
 await client.fileVersions.getFileVersionById(
   file.id,
   fileVersions.entries![0].id,
+  {
+    queryParams: {
+      fields: [
+        'trashed_at' as string,
+        'trashed_by' as string,
+        'restored_at' as string,
+        'restored_by' as string,
+      ],
+    } satisfies GetFileVersionByIdQueryParams,
+  } satisfies GetFileVersionByIdOptionalsInput,
 );
 ```
 
@@ -121,7 +131,15 @@ This operation is performed by calling function `updateFileVersionById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/put-files-id-versions-id/).
 
-_Currently we don't have an example for calling `updateFileVersionById` in integration tests_
+<!-- sample put_files_id_versions_id -->
+
+```ts
+await client.fileVersions.updateFileVersionById(file.id, fileVersion.id, {
+  requestBody: {
+    trashedAt: createNull(),
+  } satisfies UpdateFileVersionByIdRequestBody,
+} satisfies UpdateFileVersionByIdOptionalsInput);
+```
 
 ### Arguments
 

docs/listCollaborations.md

@@ -101,7 +101,7 @@ await client.listCollaborations.getCollaborations({
 
 ### Returns
 
-This function returns a value of type `Collaborations`.
+This function returns a value of type `CollaborationsOffsetPaginated`.
 
 Returns a collection of pending collaboration objects.
 
@@ -136,7 +136,7 @@ await client.listCollaborations.getGroupCollaborations(group.id);
 
 ### Returns
 
-This function returns a value of type `Collaborations`.
+This function returns a value of type `CollaborationsOffsetPaginated`.
 
 Returns a collection of collaboration objects. If there are no
 collaborations, an empty collection will be returned.

docs/users.md

@@ -172,7 +172,9 @@ See the endpoint docs at
 
 ```ts
 await client.users.updateUserById(user.id, {
-  requestBody: { name: updatedUserName } satisfies UpdateUserByIdRequestBody,
+  requestBody: {
+    notificationEmail: createNull(),
+  } satisfies UpdateUserByIdRequestBody,
 } satisfies UpdateUserByIdOptionalsInput);
 ```