Skip to content

folders.md

Latest commit

 

History

History
228 lines (151 loc) · 7.41 KB

folders.md

File metadata and controls

228 lines (151 loc) · 7.41 KB

FoldersManager

Get folder information

Retrieves details for a folder, including the first 100 entries in the folder.

Passing sort, direction, offset, and limit parameters in query allows you to manage the list of returned folder items.

To fetch more items within the folder, use the Get items in a folder endpoint.

This operation is performed by calling function getFolderById.

See the endpoint docs at API Reference.

await client.folders.getFolderById('0');

Arguments

  • 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"
  • optionalsInput GetFolderByIdOptionalsInput

Returns

This function returns a value of type FolderFull.

Returns a folder, including the first 100 entries in the folder. If you used query parameters like sort, direction, offset, or limit the folder items list will be affected accordingly.

To fetch more items within the folder, use the Get items in a folder) endpoint.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

Update folder

Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.

This operation is performed by calling function updateFolderById.

See the endpoint docs at API Reference.

await client.folders.updateFolderById(folderToUpdate.id, {
  requestBody: {
    name: updatedName,
    description: 'Updated description',
  } satisfies UpdateFolderByIdRequestBody,
} satisfies UpdateFolderByIdOptionalsInput);

Arguments

  • 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"
  • optionalsInput UpdateFolderByIdOptionalsInput

Returns

This function returns a value of type FolderFull.

Returns a folder object for the updated folder

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

If the user is moving folders with a large number of items in all of their descendants, the call will be run asynchronously. If the operation is not completed within 10 minutes, the user will receive a 200 OK response, and the operation will continue running.

Delete folder

Deletes a folder, either permanently or by moving it to the trash.

This operation is performed by calling function deleteFolderById.

See the endpoint docs at API Reference.

await client.folders.deleteFolderById(newFolder.id);

Arguments

  • 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"
  • optionalsInput DeleteFolderByIdOptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the folder is successfully deleted or moved to the trash.

List items in folder

Retrieves a page of items in a folder. These items can be files, folders, and web links.

To request more information about the folder itself, like its size, use the Get a folder endpoint instead.

This operation is performed by calling function getFolderItems.

See the endpoint docs at API Reference.

await client.folders.getFolderItems(folderOrigin.id);

Arguments

  • 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"
  • optionalsInput GetFolderItemsOptionalsInput

Returns

This function returns a value of type Items.

Returns a collection of files, folders, and web links contained in a folder.

Create folder

Creates a new empty folder within the specified parent folder.

This operation is performed by calling function createFolder.

See the endpoint docs at API Reference.

await client.folders.createFolder({
  name: newFolderName,
  parent: { id: '0' } satisfies CreateFolderRequestBodyParentField,
} satisfies CreateFolderRequestBody);

Arguments

  • requestBody CreateFolderRequestBody
    • Request body of createFolder method
  • optionalsInput CreateFolderOptionalsInput

Returns

This function returns a value of type FolderFull.

Returns a folder object.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.

Copy folder

Creates a copy of a folder within a destination folder.

The original folder will not be changed.

This operation is performed by calling function copyFolder.

See the endpoint docs at API Reference.

await client.folders.copyFolder(folderOrigin.id, {
  parent: { id: '0' } satisfies CopyFolderRequestBodyParentField,
  name: copiedFolderName,
} satisfies CopyFolderRequestBody);

Arguments

  • folderId string
    • The unique identifier of the folder to copy. 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 with the ID 0 can not be copied. Example: "0"
  • requestBody CopyFolderRequestBody
    • Request body of copyFolder method
  • optionalsInput CopyFolderOptionalsInput

Returns

This function returns a value of type FolderFull.

Returns a new folder object representing the copied folder.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields.