docs: docs: Proper description format (box/box-openapi#530)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "f5a9cc9", "specHash": "630fc85", "version": "1.16.0" }
+{ "engineHash": "f5a9cc9", "specHash": "4beed7d", "version": "1.16.0" }

docs/ai.md

@@ -96,7 +96,7 @@ A successful response including the answer from the LLM.
 
 ## Get AI agent default configuration
 
-Get the AI agent default config
+Get the AI agent default config.
 
 This operation is performed by calling function `getAiAgentDefaultConfig`.
 

docs/avatars.md

@@ -68,9 +68,9 @@ await client.avatars.createUserAvatar(user.id, {
 
 This function returns a value of type `UserAvatar`.
 
-- `ok`: Returns the `pic_urls` object with URLs to existing
-  user avatars that were updated.\* `created`: Returns the `pic_urls` object with URLS to user avatars
-  uploaded to Box with the request.
+`ok`: Returns the `pic_urls` object with URLs to existing
+user avatars that were updated.`created`: Returns the `pic_urls` object with URLS to user avatars
+uploaded to Box with the request.
 
 ## Delete user avatar
 
@@ -99,4 +99,4 @@ await client.avatars.deleteUserAvatar(user.id);
 
 This function returns a value of type `undefined`.
 
-- `no_content`: Removes the avatar and returns an empty response.
+`no_content`: Removes the avatar and returns an empty response.

docs/collections.md

@@ -35,7 +35,7 @@ await client.collections.getCollections();
 
 This function returns a value of type `Collections`.
 
-Returns all collections for the given user
+Returns all collections for the given user.
 
 ## List collection items
 

docs/devicePinners.md

@@ -22,7 +22,7 @@ await client.devicePinners.getDevicePinnerById(devicePinnerId);
 ### Arguments
 
 - devicePinnerId `string`
-  - The ID of the device pin Example: "2324234"
+  - The ID of the device pin. Example: "2324234"
 - optionalsInput `GetDevicePinnerByIdOptionalsInput`
   -
 
@@ -50,7 +50,7 @@ await client.devicePinners.deleteDevicePinnerById(devicePinnerId);
 ### Arguments
 
 - devicePinnerId `string`
-  - The ID of the device pin Example: "2324234"
+  - The ID of the device pin. Example: "2324234"
 - optionalsInput `DeleteDevicePinnerByIdOptionalsInput`
   -
 
@@ -81,7 +81,7 @@ await client.devicePinners.getEnterpriseDevicePinners(enterpriseId);
 ### Arguments
 
 - enterpriseId `string`
-  - The ID of the enterprise Example: "3442311"
+  - The ID of the enterprise. Example: "3442311"
 - optionalsInput `GetEnterpriseDevicePinnersOptionalsInput`
   -
 

docs/docgen.md

@@ -67,7 +67,7 @@ A list of Box Doc Gen jobs.
 
 ## Get Box Doc Gen jobs by batch ID
 
-Lists Box Doc Gen jobs in a batch
+Lists Box Doc Gen jobs in a batch.
 
 This operation is performed by calling function `getDocgenBatchJobByIdV2025R0`.
 

docs/docgenTemplate.md

@@ -69,7 +69,7 @@ Returns a collection of templates.
 
 ## Delete Box Doc Gen template
 
-Unmarks file as Box Doc Gen template
+Unmarks file as Box Doc Gen template.
 
 This operation is performed by calling function `deleteDocgenTemplateByIdV2025R0`.
 

docs/fileMetadata.md

@@ -62,9 +62,9 @@ await client.fileMetadata.getFileMetadataById(
 - fileId `string`
   - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
 - scope `GetFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `string`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - optionalsInput `GetFileMetadataByIdOptionalsInput`
   -
 
@@ -111,9 +111,9 @@ await client.fileMetadata.createFileMetadataById(
 - fileId `string`
   - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
 - scope `CreateFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `string`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - requestBody `CreateFileMetadataByIdRequestBody`
   - Request body of createFileMetadataById method
 - optionalsInput `CreateFileMetadataByIdOptionalsInput`
@@ -184,9 +184,9 @@ await client.fileMetadata.updateFileMetadataById(
 - fileId `string`
   - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
 - scope `UpdateFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `string`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - requestBody `readonly UpdateFileMetadataByIdRequestBody[]`
   - Request body of updateFileMetadataById method
 - optionalsInput `UpdateFileMetadataByIdOptionalsInput`
@@ -223,9 +223,9 @@ await client.fileMetadata.deleteFileMetadataById(
 - fileId `string`
   - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
 - scope `DeleteFileMetadataByIdScope`
-  - The scope of the metadata template Example: "global"
+  - The scope of the metadata template. Example: "global"
 - templateKey `string`
-  - The name of the metadata template Example: "properties"
+  - The name of the metadata template. Example: "properties"
 - optionalsInput `DeleteFileMetadataByIdOptionalsInput`
   -
 

docs/fileVersionLegalHolds.md

@@ -24,7 +24,7 @@ await client.fileVersionLegalHolds.getFileVersionLegalHoldById(
 ### Arguments
 
 - fileVersionLegalHoldId `string`
-  - The ID of the file version legal hold Example: "2348213"
+  - The ID of the file version legal hold. Example: "2348213"
 - optionalsInput `GetFileVersionLegalHoldByIdOptionalsInput`
   -
 

docs/fileVersionRetentions.md

@@ -63,7 +63,7 @@ await client.fileVersionRetentions.getFileVersionRetentionById(
 ### Arguments
 
 - fileVersionRetentionId `string`
-  - The ID of the file version retention Example: "3424234"
+  - The ID of the file version retention. Example: "3424234"
 - optionalsInput `GetFileVersionRetentionByIdOptionalsInput`
   -