files.com 1.0.92

data/docs/errors.md

@@ -0,0 +1,17 @@
+# Errors
+
+## Example Errors Object
+
+```
+{
+  "fields": [
+
+  ],
+  "messages": [
+
+  ]
+}
+```
+
+* `fields` (array): A list of fields where errors occur
+* `messages` (array): A list of error messages

data/docs/file.md

@@ -0,0 +1,204 @@
+# File
+
+The Files::File object emulates a Ruby File object and can be used in
+may places where a Ruby File object can be used.
+
+## Example File Object
+
+```
+{
+  "id": 1,
+  "path": "path/file.txt",
+  "display_name": "file.txt",
+  "type": "file",
+  "size": 1024,
+  "mtime": "2000-01-01T01:00:00Z",
+  "provided_mtime": "2000-01-01T01:00:00Z",
+  "crc32": "70976923",
+  "md5": "17c54824e9931a4688ca032d03f6663c",
+  "mime_type": "application/octet-stream",
+  "region": "us-east-1",
+  "permissions": "rpw",
+  "subfolders_locked?": true,
+  "download_uri": "https://mysite.files.com/...",
+  "priority_color": "red",
+  "preview_id": 1,
+  "preview": ""
+}
+```
+
+* `id` (int64): File/Folder ID
+* `path` (string): File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `display_name` (string): File/Folder display name
+* `type` (string): Type: `directory` or `file`.
+* `size` (int64): File/Folder size
+* `mtime` (date-time): File last modified date/time, according to the server.  This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
+* `provided_mtime` (date-time): File last modified date/time, according to the client who set it.  Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times.  This allows Desktop<->Cloud syncing to preserve modified at times.
+* `crc32` (string): File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
+* `md5` (string): File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
+* `mime_type` (string): MIME Type.  This is determined by the filename extension and is not stored separately internally.
+* `region` (string): Region location
+* `permissions` (string): A short string representing the current user's permissions.  Can be `r`,`w`,`p`, or any combination
+* `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
+* `download_uri` (string): Link to download file. Provided only in response to a download request.
+* `priority_color` (string): Bookmark/priority color of file/folder
+* `preview_id` (int64): File preview ID
+* `preview`: File preview
+* `action` (string): The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
+* `length` (int64): Length of file.
+* `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `part` (int64): Part if uploading a part.
+* `parts` (int64): How many parts to fetch?
+* `ref` (string): 
+* `restart` (int64): File byte offset to restart from.
+* `structure` (string): If copying folder, copy just the structure?
+* `with_rename` (boolean): Allow file rename instead of overwrite?
+
+
+---
+
+## Download file
+
+```
+Files::File.download(path, 
+  with_previews: true, 
+  with_priority_color: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `action` (string): Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
+* `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+* `with_previews` (boolean): Include file preview information?
+* `with_priority_color` (boolean): Include file priority color information?
+
+
+---
+
+## Upload file
+
+```
+Files::File.create(path, 
+  length: 1, 
+  mkdir_parents: true, 
+  part: 1, 
+  parts: 1, 
+  provided_mtime: "2000-01-01T01:00:00Z", 
+  restart: 1, 
+  size: 1, 
+  with_rename: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `action` (string): The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
+* `etags[etag]` (array(string)): etag identifier.
+* `etags[part]` (array(int64)): Part number.
+* `length` (int64): Length of file.
+* `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `part` (int64): Part if uploading a part.
+* `parts` (int64): How many parts to fetch?
+* `provided_mtime` (string): User provided modification time.
+* `ref` (string): 
+* `restart` (int64): File byte offset to restart from.
+* `size` (int64): Size of file.
+* `structure` (string): If copying folder, copy just the structure?
+* `with_rename` (boolean): Allow file rename instead of overwrite?
+
+
+---
+
+## Update file/folder metadata
+
+```
+Files::File.update(path, 
+  provided_mtime: "2000-01-01T01:00:00Z", 
+  priority_color: "red"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `provided_mtime` (string): Modified time of file.
+* `priority_color` (string): Priority/Bookmark color of file.
+
+
+---
+
+## Delete file/folder
+
+```
+Files::File.delete(path, 
+  recursive: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `recursive` (boolean): If true, will recursively delete folers.  Otherwise, will error on non-empty folders.  For legacy reasons, this parameter may also be provided as the HTTP header `Depth: Infinity`
+
+
+---
+
+## Download file
+
+```
+file = Files::File.list_for(path).first
+
+file.download(
+  with_previews: true,
+  with_priority_color: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `action` (string): Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
+* `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+* `with_previews` (boolean): Include file preview information?
+* `with_priority_color` (boolean): Include file priority color information?
+
+
+---
+
+## Update file/folder metadata
+
+```
+file = Files::File.list_for(path).first
+
+file.update(
+  provided_mtime: "2000-01-01T01:00:00Z",
+  priority_color: "red"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `provided_mtime` (string): Modified time of file.
+* `priority_color` (string): Priority/Bookmark color of file.
+
+
+---
+
+## Delete file/folder
+
+```
+file = Files::File.list_for(path).first
+
+file.delete(
+  recursive: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `recursive` (boolean): If true, will recursively delete folers.  Otherwise, will error on non-empty folders.  For legacy reasons, this parameter may also be provided as the HTTP header `Depth: Infinity`

data/docs/file_action.md

@@ -0,0 +1,126 @@
+
+
+---
+
+## Copy file/folder
+
+```
+Files::FileAction.copy(path, 
+  destination: "destination", 
+  structure: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Copy destination path.
+* `structure` (boolean): Copy structure only?
+
+
+---
+
+## Move file/folder
+
+```
+Files::FileAction.move(path, 
+  destination: "destination"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Move destination path.
+
+
+---
+
+## Begin file upload
+
+```
+Files::FileAction.begin_upload(path, 
+  mkdir_parents: true, 
+  part: 1, 
+  parts: 1, 
+  ref: "upload-1", 
+  restart: 1, 
+  with_rename: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `part` (int64): Part if uploading a part.
+* `parts` (int64): How many parts to fetch?
+* `ref` (string): 
+* `restart` (int64): File byte offset to restart from.
+* `with_rename` (boolean): Allow file rename instead of overwrite?
+
+
+---
+
+## Copy file/folder
+
+```
+file_action = Files::FileAction.list_for(path).first
+
+file_action.copy(
+  destination: "destination",
+  structure: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Copy destination path.
+* `structure` (boolean): Copy structure only?
+
+
+---
+
+## Move file/folder
+
+```
+file_action = Files::FileAction.list_for(path).first
+
+file_action.move(
+  destination: "destination"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Move destination path.
+
+
+---
+
+## Begin file upload
+
+```
+file_action = Files::FileAction.list_for(path).first
+
+file_action.begin_upload(
+  mkdir_parents: true,
+  part: 1,
+  parts: 1,
+  ref: "upload-1",
+  restart: 1,
+  with_rename: true
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `part` (int64): Part if uploading a part.
+* `parts` (int64): How many parts to fetch?
+* `ref` (string): 
+* `restart` (int64): File byte offset to restart from.
+* `with_rename` (boolean): Allow file rename instead of overwrite?

data/docs/file_comment.md

@@ -0,0 +1,116 @@
+# FileComment
+
+## Example FileComment Object
+
+```
+{
+  "id": 1,
+  "body": "What a great file!",
+  "reactions": [
+
+  ]
+}
+```
+
+* `id` (int64): File Comment ID
+* `body` (string): Comment body.
+* `reactions` (array): Reactions to this comment.
+* `path` (string): File path.
+
+
+---
+
+## List File Comments by path
+
+```
+Files::FileComment.list_for(path, 
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+* `path` (string): Required - Path to operate on.
+
+
+---
+
+## Create File Comment
+
+```
+Files::FileComment.create(
+  body: "body", 
+  path: "path"
+)
+```
+
+### Parameters
+
+* `body` (string): Required - Comment body.
+* `path` (string): Required - File path.
+
+
+---
+
+## Update File Comment
+
+```
+Files::FileComment.update(id, 
+  body: "body"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment ID.
+* `body` (string): Required - Comment body.
+
+
+---
+
+## Delete File Comment
+
+```
+Files::FileComment.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment ID.
+
+
+---
+
+## Update File Comment
+
+```
+file_comment = Files::FileComment.list_for(path).first
+
+file_comment.update(
+  body: "body"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment ID.
+* `body` (string): Required - Comment body.
+
+
+---
+
+## Delete File Comment
+
+```
+file_comment = Files::FileComment.list_for(path).first
+
+file_comment.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment ID.