Source: schemas/file-mini.generated.ts

  1. import * as schemas from '.';
  2. /**
  3.  * File (Mini)
  4.  *
  5.  * A mini representation of a file, used when
  6.  * nested under another resource.
  7.  */
  8. export interface FileMini extends schemas.FileBase {
  9. 	/**
  10. 	 * A numeric identifier that represents the most recent user event
  11. 	 * that has been applied to this item.
  12. 	 *
  13. 	 * This can be used in combination with the `GET /events`-endpoint
  14. 	 * to filter out user events that would have occurred before this
  15. 	 * identifier was read.
  16. 	 *
  17. 	 * An example would be where a Box Drive-like application
  18. 	 * would fetch an item via the API, and then listen to incoming
  19. 	 * user events for changes to the item. The application would
  20. 	 * ignore any user events where the `sequence_id` in the event
  21. 	 * is smaller than or equal to the `sequence_id` in the originally
  22. 	 * fetched resource.
  23. 	 * Example: 3
  24. 	 */
  25. 	sequence_id?: string;
  26. 	/**
  27. 	 * The name of the file
  28. 	 * Example: Contract.pdf
  29. 	 */
  30. 	name?: string;
  31. 	/**
  32. 	 * The SHA1 hash of the file. This can be used to compare the contents
  33. 	 * of a file on Box with a local file.
  34. 	 * Example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37
  35. 	 */
  36. 	sha1?: string;
  37. 	/**
  38. 	 * The information about the current version of the file.
  39. 	 */
  40. 	file_version?: schemas.FileVersionMini;
  41. }