files.com 1.0.92

data/docs/file_comment_reaction.md

@@ -0,0 +1,62 @@
+# FileCommentReaction
+
+## Example FileCommentReaction Object
+
+```
+{
+  "id": 1,
+  "emoji": "👍"
+}
+```
+
+* `id` (int64): Reaction ID
+* `emoji` (string): Emoji used in the reaction.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `file_comment_id` (int64): ID of file comment to attach reaction to.
+
+
+---
+
+## Create File Comment Reaction
+
+```
+Files::FileCommentReaction.create(
+  user_id: 1, 
+  file_comment_id: 1, 
+  emoji: "emoji"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `file_comment_id` (int64): Required - ID of file comment to attach reaction to.
+* `emoji` (string): Required - Emoji to react with.
+
+
+---
+
+## Delete File Comment Reaction
+
+```
+Files::FileCommentReaction.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment Reaction ID.
+
+
+---
+
+## Delete File Comment Reaction
+
+```
+file_comment_reaction = Files::FileCommentReaction.list_for(path).first
+
+file_comment_reaction.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment Reaction ID.

data/docs/file_part_upload.md

@@ -0,0 +1,37 @@
+# FilePartUpload
+
+## Example FilePartUpload Object
+
+```
+{
+  "send": "",
+  "action": "upload/direct",
+  "ask_about_overwrites": true,
+  "available_parts": "",
+  "expires": "",
+  "headers": "",
+  "http_method": "POST",
+  "next_partsize": "",
+  "parameters": "",
+  "part_number": "",
+  "partsize": "",
+  "path": "path",
+  "ref": "upload-1",
+  "upload_uri": ""
+}
+```
+
+* `send` (object): Content-Type and File to send
+* `action` (string): Type of upload
+* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation
+* `available_parts` (string): Currently unused
+* `expires` (string): Currently unused
+* `headers` (object): Additional upload headers
+* `http_method` (string): Upload method, usually POST
+* `next_partsize` (string): Currently unused
+* `parameters` (string): Additional upload parameters
+* `part_number` (string): Currently unused
+* `partsize` (string): Currently unused
+* `path` (string): Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `ref` (string): Reference name for this upload part
+* `upload_uri` (string): URI to upload this part to

data/docs/file_utils.md

@@ -0,0 +1,4 @@
+# FileUtils
+
+The Files::FileUtils object emulates a Ruby FileUtils object and can be used in
+may places where a Ruby FileUtils object can be used.

data/docs/folder.md

@@ -0,0 +1,90 @@
+# Folder
+
+The Files::Folder object emulates a Ruby Dir object and can be used in
+may places where a Ruby Dir object can be used.
+
+Files::Dir is an alias of Files::Folder
+
+## Example Folder 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
+
+
+---
+
+## List Folders by path
+
+```
+Files::Folder.list_for(path, 
+  page: 1, 
+  per_page: 1, 
+  search_all: true, 
+  with_previews: true, 
+  with_priority_color: true
+)
+```
+
+### 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): Action to take.  Can be `count`, `count_nrs` (non recursive), `size`, `permissions`, or blank.
+* `path` (string): Required - Path to operate on.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor header.
+* `filter` (string): If specified, will to filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+* `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+* `search` (string): If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
+* `search_all` (boolean): Search entire site?
+* `with_previews` (boolean): Include file previews?
+* `with_priority_color` (boolean): Include file priority color information?
+
+
+---
+
+## Create folder
+
+```
+Files::Folder.create(path)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.

data/docs/group.md

@@ -0,0 +1,153 @@
+# Group
+
+## Example Group Object
+
+```
+{
+  "id": 1,
+  "name": "owners",
+  "admin_ids": [
+
+  ],
+  "notes": "",
+  "user_ids": [
+
+  ],
+  "usernames": [
+
+  ]
+}
+```
+
+* `id` (int64): Group ID
+* `name` (string): Group name
+* `admin_ids` (array): List of user IDs who are group administrators (separated by commas)
+* `notes` (string): Notes about this group
+* `user_ids` (array): List of user IDs who belong to this group (separated by commas)
+* `usernames` (array): List of usernames who belong to this group (separated by commas)
+
+
+---
+
+## List Groups
+
+```
+Files::Group.list(
+  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.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `active`, `deleted_at`, `site_id` or `name`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `name`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name`.
+* `ids` (string): Comma-separated list of group ids to include in results.
+
+
+---
+
+## Show Group
+
+```
+Files::Group.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+
+
+---
+
+## Create Group
+
+```
+Files::Group.create(
+  name: "owners"
+)
+```
+
+### Parameters
+
+* `name` (string): Group name.
+* `notes` (string): Group notes.
+* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
+* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+
+
+---
+
+## Update Group
+
+```
+Files::Group.update(id, 
+  name: "owners"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+* `name` (string): Group name.
+* `notes` (string): Group notes.
+* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
+* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+
+
+---
+
+## Delete Group
+
+```
+Files::Group.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+
+
+---
+
+## Update Group
+
+```
+group = Files::Group.list_for(path).first
+
+group.update(
+  name: "owners"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.
+* `name` (string): Group name.
+* `notes` (string): Group notes.
+* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
+* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+
+
+---
+
+## Delete Group
+
+```
+group = Files::Group.list_for(path).first
+
+group.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Group ID.

data/docs/group_user.md

@@ -0,0 +1,124 @@
+# GroupUser
+
+## Example GroupUser Object
+
+```
+{
+  "group_name": "My Group",
+  "group_id": 1,
+  "user_id": 1,
+  "admin": true,
+  "usernames": [
+
+  ]
+}
+```
+
+* `group_name` (string): Group name
+* `group_id` (int64): Group ID
+* `user_id` (int64): User ID
+* `admin` (boolean): Is this user an administrator of this group?
+* `usernames` (array): A list of usernames for users in this group
+* `id` (int64): Group User ID.
+
+
+---
+
+## List Group Users
+
+```
+Files::GroupUser.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  group_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  If provided, will return group_users of this user.
+* `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.
+* `group_id` (int64): Group ID.  If provided, will return group_users of this group.
+
+
+---
+
+## Update Group User
+
+```
+Files::GroupUser.update(id, 
+  group_id: 1, 
+  user_id: 1, 
+  admin: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group User ID.
+* `group_id` (int64): Required - Group ID to add user to.
+* `user_id` (int64): Required - User ID to add to group.
+* `admin` (boolean): Is the user a group administrator?
+
+
+---
+
+## Delete Group User
+
+```
+Files::GroupUser.delete(id, 
+  group_id: 1, 
+  user_id: 1
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group User ID.
+* `group_id` (int64): Required - Group ID from which to remove user.
+* `user_id` (int64): Required - User ID to remove from group.
+
+
+---
+
+## Update Group User
+
+```
+group_user = Files::GroupUser.list_for(path).first
+
+group_user.update(
+  group_id: 1,
+  user_id: 1,
+  admin: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group User ID.
+* `group_id` (int64): Required - Group ID to add user to.
+* `user_id` (int64): Required - User ID to add to group.
+* `admin` (boolean): Is the user a group administrator?
+
+
+---
+
+## Delete Group User
+
+```
+group_user = Files::GroupUser.list_for(path).first
+
+group_user.delete(
+  group_id: 1,
+  user_id: 1
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Group User ID.
+* `group_id` (int64): Required - Group ID from which to remove user.
+* `user_id` (int64): Required - User ID to remove from group.