Skip to content

Latest commit

 

History

History
195 lines (131 loc) · 5.97 KB

fileVersions.md

File metadata and controls

195 lines (131 loc) · 5.97 KB

FileVersionsManager

List all file versions

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the GET /file/:id API.

This operation is performed by calling function getFileVersions.

See the endpoint docs at API Reference.

await client.fileVersions.getFileVersions(file.id);

Arguments

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

  • optionalsInput GetFileVersionsOptionalsInput

Returns

This function returns a value of type FileVersions.

Returns an array of past versions for this file.

Get file version

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

This operation is performed by calling function getFileVersionById.

See the endpoint docs at API Reference.

await client.fileVersions.getFileVersionById(
  file.id,
  fileVersions.entries![0].id,
);

Arguments

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

  • optionalsInput GetFileVersionByIdOptionalsInput

Returns

This function returns a value of type FileVersionFull.

Returns a specific version of a file.

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

Remove file version

Move a file version to the trash.

Versions are only tracked for Box users with premium accounts.

This operation is performed by calling function deleteFileVersionById.

See the endpoint docs at API Reference.

await client.fileVersions.deleteFileVersionById(file.id, fileVersion.id);

Arguments

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

  • optionalsInput DeleteFileVersionByIdOptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the file has been successfully deleted.

Restore file version

Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

This operation is performed by calling function updateFileVersionById.

See the endpoint docs at API Reference.

await client.fileVersions.updateFileVersionById(file.id, fileVersion.id, {
  requestBody: {
    trashedAt: createNull(),
  } satisfies UpdateFileVersionByIdRequestBody,
} satisfies UpdateFileVersionByIdOptionalsInput);

Arguments

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

  • optionalsInput UpdateFileVersionByIdOptionalsInput

Returns

This function returns a value of type FileVersionFull.

Returns a restored file version object.

Promote file version

Promote a specific version of a file.

If previous versions exist, this method can be used to promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original.

Other properties such as comments do not get updated to their former values.

Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.

This operation is performed by calling function promoteFileVersion.

See the endpoint docs at API Reference.

await client.fileVersions.promoteFileVersion(file.id, {
  requestBody: {
    id: fileVersions.entries![0].id,
    type: 'file_version' as PromoteFileVersionRequestBodyTypeField,
  } satisfies PromoteFileVersionRequestBody,
} satisfies PromoteFileVersionOptionalsInput);

Arguments

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

  • optionalsInput PromoteFileVersionOptionalsInput

Returns

This function returns a value of type FileVersionFull.

Returns a newly created file version object.