Increase.Files.File (Increase v1.0.0)

Copy Markdown View Source

Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF). If you need to download a File, create a File Link.

Fields

  • id - The File's identifier.
  • created_at - The time the File was created.
  • description - A description of the File.
  • direction - Whether the File was generated by Increase or by you and sent to Increase.
  • filename - The filename that was provided upon upload or generated by Increase.
  • idempotency_key - The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  • mime_type - The MIME type of the file.
  • purpose - What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
  • type - A constant representing the object's type. For this resource it will always be file.

Summary

Types

t()

Types

t()

@type t() :: %Increase.Files.File{
  created_at: DateTime.t(),
  description: String.t() | nil,
  direction: String.t(),
  filename: String.t() | nil,
  id: String.t(),
  idempotency_key: String.t() | nil,
  mime_type: String.t(),
  purpose: String.t(),
  type: String.t()
}