Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "2667c0e", "specHash": "630fc85", "version": "1.16.0" }
{ "engineHash": "f5a9cc9", "specHash": "4beed7d", "version": "1.16.0" }
2 changes: 1 addition & 1 deletion docs/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
8 changes: 4 additions & 4 deletions docs/avatars.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/devicePinners.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
-

Expand Down Expand Up @@ -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`
-

Expand Down Expand Up @@ -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`
-

Expand Down
2 changes: 1 addition & 1 deletion docs/docgen.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/docgenTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
16 changes: 8 additions & 8 deletions docs/fileMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
-

Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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`
-

Expand Down
2 changes: 1 addition & 1 deletion docs/fileVersionLegalHolds.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
-

Expand Down
2 changes: 1 addition & 1 deletion docs/fileVersionRetentions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
-

Expand Down
6 changes: 3 additions & 3 deletions docs/fileVersions.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ await client.fileVersions.getFileVersionById(
- 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"
- fileVersionId `string`
- The ID of the file version Example: "1234"
- The ID of the file version. Example: "1234"
- optionalsInput `GetFileVersionByIdOptionalsInput`
-

Expand Down Expand Up @@ -98,7 +98,7 @@ await client.fileVersions.deleteFileVersionById(file.id, fileVersion.id);
- 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"
- fileVersionId `string`
- The ID of the file version Example: "1234"
- The ID of the file version. Example: "1234"
- optionalsInput `DeleteFileVersionByIdOptionalsInput`
-

Expand Down Expand Up @@ -136,7 +136,7 @@ await client.fileVersions.updateFileVersionById(file.id, fileVersion.id, {
- 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"
- fileVersionId `string`
- The ID of the file version Example: "1234"
- The ID of the file version. Example: "1234"
- optionalsInput `UpdateFileVersionByIdOptionalsInput`
-

Expand Down
4 changes: 2 additions & 2 deletions docs/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ await client.files.getFileThumbnailUrl(
- 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"
- extension `GetFileThumbnailUrlExtension`
- The file format for the thumbnail Example: "png"
- The file format for the thumbnail. Example: "png"
- optionalsInput `GetFileThumbnailUrlOptionalsInput`
-

Expand Down Expand Up @@ -224,7 +224,7 @@ await client.files.getFileThumbnailById(
- 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"
- extension `GetFileThumbnailByIdExtension`
- The file format for the thumbnail Example: "png"
- The file format for the thumbnail. Example: "png"
- optionalsInput `GetFileThumbnailByIdOptionalsInput`
-

Expand Down
16 changes: 8 additions & 8 deletions docs/folderMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ await client.folderMetadata.getFolderMetadataById(
- folderId `string`
- The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345"
- scope `GetFolderMetadataByIdScope`
- 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 `GetFolderMetadataByIdOptionalsInput`
-

Expand Down Expand Up @@ -116,9 +116,9 @@ await client.folderMetadata.createFolderMetadataById(
- folderId `string`
- The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345"
- scope `CreateFolderMetadataByIdScope`
- 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 `CreateFolderMetadataByIdRequestBody`
- Request body of createFolderMetadataById method
- optionalsInput `CreateFolderMetadataByIdOptionalsInput`
Expand Down Expand Up @@ -189,9 +189,9 @@ await client.folderMetadata.updateFolderMetadataById(
- folderId `string`
- The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345"
- scope `UpdateFolderMetadataByIdScope`
- 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 UpdateFolderMetadataByIdRequestBody[]`
- Request body of updateFolderMetadataById method
- optionalsInput `UpdateFolderMetadataByIdOptionalsInput`
Expand Down Expand Up @@ -228,9 +228,9 @@ await client.folderMetadata.deleteFolderMetadataById(
- folderId `string`
- The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folder/123` the `folder_id` is `123`. The root folder of a Box account is always represented by the ID `0`. Example: "12345"
- scope `DeleteFolderMetadataByIdScope`
- 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 `DeleteFolderMetadataByIdOptionalsInput`
-

Expand Down
2 changes: 1 addition & 1 deletion docs/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ await client.groups.getGroupById(group.id, {

This function returns a value of type `GroupFull`.

Returns the group object
Returns the group object.

## Update group

Expand Down
16 changes: 8 additions & 8 deletions docs/integrationMappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ await userClient.integrationMappings.getSlackIntegrationMapping();

This function returns a value of type `IntegrationMappings`.

Returns a collection of integration mappings
Returns a collection of integration mappings.

## Create Slack integration mapping

Expand Down Expand Up @@ -109,7 +109,7 @@ await userClient.integrationMappings.updateSlackIntegrationMappingById(
### Arguments

- integrationMappingId `string`
- An ID of an integration mapping Example: "11235432"
- An ID of an integration mapping. Example: "11235432"
- optionalsInput `UpdateSlackIntegrationMappingByIdOptionalsInput`
-

Expand Down Expand Up @@ -142,15 +142,15 @@ await userClient.integrationMappings.deleteSlackIntegrationMappingById(
### Arguments

- integrationMappingId `string`
- An ID of an integration mapping Example: "11235432"
- An ID of an integration mapping. Example: "11235432"
- optionalsInput `DeleteSlackIntegrationMappingByIdOptionalsInput`
-

### Returns

This function returns a value of type `undefined`.

Empty body in response
Empty body in response.

## List Teams integration mappings

Expand Down Expand Up @@ -182,7 +182,7 @@ await userClient.integrationMappings.getTeamsIntegrationMapping();

This function returns a value of type `IntegrationMappingsTeams`.

Returns a collection of integration mappings
Returns a collection of integration mappings.

## Create Teams integration mapping

Expand Down Expand Up @@ -251,7 +251,7 @@ await userClient.integrationMappings.updateTeamsIntegrationMappingById(
### Arguments

- integrationMappingId `string`
- An ID of an integration mapping Example: "11235432"
- An ID of an integration mapping. Example: "11235432"
- optionalsInput `UpdateTeamsIntegrationMappingByIdOptionalsInput`
-

Expand Down Expand Up @@ -283,12 +283,12 @@ await userClient.integrationMappings.deleteTeamsIntegrationMappingById(
### Arguments

- integrationMappingId `string`
- An ID of an integration mapping Example: "11235432"
- An ID of an integration mapping. Example: "11235432"
- optionalsInput `DeleteTeamsIntegrationMappingByIdOptionalsInput`
-

### Returns

This function returns a value of type `undefined`.

Empty body in response
Empty body in response.
2 changes: 1 addition & 1 deletion docs/invites.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ await client.invites.getInviteById(invitation.id);

This function returns a value of type `Invite`.

Returns an invite object
Returns an invite object.
6 changes: 3 additions & 3 deletions docs/legalHoldPolicies.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId);
### Arguments

- legalHoldPolicyId `string`
- The ID of the legal hold policy Example: "324432"
- The ID of the legal hold policy. Example: "324432"
- optionalsInput `GetLegalHoldPolicyByIdOptionalsInput`
-

Expand Down Expand Up @@ -121,7 +121,7 @@ await client.legalHoldPolicies.updateLegalHoldPolicyById(legalHoldPolicyId, {
### Arguments

- legalHoldPolicyId `string`
- The ID of the legal hold policy Example: "324432"
- The ID of the legal hold policy. Example: "324432"
- optionalsInput `UpdateLegalHoldPolicyByIdOptionalsInput`
-

Expand Down Expand Up @@ -152,7 +152,7 @@ await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicy.id);
### Arguments

- legalHoldPolicyId `string`
- The ID of the legal hold policy Example: "324432"
- The ID of the legal hold policy. Example: "324432"
- optionalsInput `DeleteLegalHoldPolicyByIdOptionalsInput`
-

Expand Down
6 changes: 3 additions & 3 deletions docs/legalHoldPolicyAssignments.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentById(
### Arguments

- legalHoldPolicyAssignmentId `string`
- The ID of the legal hold policy assignment Example: "753465"
- The ID of the legal hold policy assignment. Example: "753465"
- optionalsInput `GetLegalHoldPolicyAssignmentByIdOptionalsInput`
-

Expand Down Expand Up @@ -123,7 +123,7 @@ await client.legalHoldPolicyAssignments.deleteLegalHoldPolicyAssignmentById(
### Arguments

- legalHoldPolicyAssignmentId `string`
- The ID of the legal hold policy assignment Example: "753465"
- The ID of the legal hold policy assignment. Example: "753465"
- optionalsInput `DeleteLegalHoldPolicyAssignmentByIdOptionalsInput`
-

Expand Down Expand Up @@ -172,7 +172,7 @@ await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentFileOnHold(
### Arguments

- legalHoldPolicyAssignmentId `string`
- The ID of the legal hold policy assignment Example: "753465"
- The ID of the legal hold policy assignment. Example: "753465"
- optionalsInput `GetLegalHoldPolicyAssignmentFileOnHoldOptionalsInput`
-

Expand Down
Loading
Loading