files.com 1.0.92

data/docs/ip_address.md

@@ -0,0 +1,55 @@
+# IpAddress
+
+## Example IpAddress Object
+
+```
+{
+  "id": "Site",
+  "associated_with": "Site",
+  "group_id": 1,
+  "ip_addresses": [
+
+  ]
+}
+```
+
+* `id` (string): Unique label for list; used by Zapier and other integrations.
+* `associated_with` (string): The object that this public IP address list is associated with.
+* `group_id` (int64): Group ID
+* `ip_addresses` (array): A list of IP addresses.
+
+
+---
+
+## List IP Addresses associated with the current site
+
+```
+Files::IpAddress.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.
+
+
+---
+
+## List all possible public IP addresses
+
+```
+Files::IpAddress.get_reserved(
+  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.

data/docs/lock.md

@@ -0,0 +1,98 @@
+# Lock
+
+## Example Lock Object
+
+```
+{
+  "path": "locked_file",
+  "timeout": 43200,
+  "depth": "infinity",
+  "owner": "user",
+  "scope": "shared",
+  "token": "17c54824e9931a4688ca032d03f6663c",
+  "type": "write",
+  "user_id": 1,
+  "username": "username"
+}
+```
+
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `timeout` (int64): Lock timeout
+* `depth` (string): Lock depth (0 or infinity)
+* `owner` (string): Owner of lock.  This can be any arbitrary string.
+* `scope` (string): Lock scope(shared or exclusive)
+* `token` (string): Lock token.  Use to release lock.
+* `type` (string): Lock type
+* `user_id` (int64): Lock creator user ID
+* `username` (string): Lock creator username
+
+
+---
+
+## List Locks by path
+
+```
+Files::Lock.list_for(path, 
+  page: 1, 
+  per_page: 1, 
+  include_children: 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): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+* `path` (string): Required - Path to operate on.
+* `include_children` (boolean): Include locks from children objects?
+
+
+---
+
+## Create Lock
+
+```
+Files::Lock.create(path, 
+  timeout: 1
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path
+* `timeout` (int64): Lock timeout length
+
+
+---
+
+## Delete Lock
+
+```
+Files::Lock.delete(path, 
+  token: "token"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path
+* `token` (string): Required - Lock token
+
+
+---
+
+## Delete Lock
+
+```
+lock = Files::Lock.list_for(path).first
+
+lock.delete(
+  token: "token"
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path
+* `token` (string): Required - Lock token

data/docs/message.md

@@ -0,0 +1,147 @@
+# Message
+
+## Example Message Object
+
+```
+{
+  "id": 1,
+  "subject": "Files.com Account Upgrade",
+  "body": "We should upgrade our Files.com account!",
+  "comments": [
+
+  ]
+}
+```
+
+* `id` (int64): Message ID
+* `subject` (string): Message subject.
+* `body` (string): Message body.
+* `comments` (array): Comments.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `project_id` (int64): Project to which the message should be attached.
+
+
+---
+
+## List Messages
+
+```
+Files::Message.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  project_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's 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.
+* `project_id` (int64): Required - Project for which to return messages.
+
+
+---
+
+## Show Message
+
+```
+Files::Message.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message ID.
+
+
+---
+
+## Create Message
+
+```
+Files::Message.create(
+  user_id: 1, 
+  project_id: 1, 
+  subject: "Files.com Account Upgrade", 
+  body: "We should upgrade our Files.com account!"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `project_id` (int64): Required - Project to which the message should be attached.
+* `subject` (string): Required - Message subject.
+* `body` (string): Required - Message body.
+
+
+---
+
+## Update Message
+
+```
+Files::Message.update(id, 
+  project_id: 1, 
+  subject: "Files.com Account Upgrade", 
+  body: "We should upgrade our Files.com account!"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message ID.
+* `project_id` (int64): Required - Project to which the message should be attached.
+* `subject` (string): Required - Message subject.
+* `body` (string): Required - Message body.
+
+
+---
+
+## Delete Message
+
+```
+Files::Message.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message ID.
+
+
+---
+
+## Update Message
+
+```
+message = Files::Message.list_for(path).first
+
+message.update(
+  project_id: 1,
+  subject: "Files.com Account Upgrade",
+  body: "We should upgrade our Files.com account!"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message ID.
+* `project_id` (int64): Required - Project to which the message should be attached.
+* `subject` (string): Required - Message subject.
+* `body` (string): Required - Message body.
+
+
+---
+
+## Delete Message
+
+```
+message = Files::Message.list_for(path).first
+
+message.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Message ID.

data/docs/message_comment.md

@@ -0,0 +1,132 @@
+# MessageComment
+
+## Example MessageComment Object
+
+```
+{
+  "id": 1,
+  "body": "What a great idea, thank you!",
+  "reactions": [
+
+  ]
+}
+```
+
+* `id` (int64): Message Comment ID
+* `body` (string): Comment body.
+* `reactions` (array): Reactions to this comment.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+
+---
+
+## List Message Comments
+
+```
+Files::MessageComment.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  message_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's 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.
+* `message_id` (int64): Required - Message comment to return comments for.
+
+
+---
+
+## Show Message Comment
+
+```
+Files::MessageComment.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment ID.
+
+
+---
+
+## Create Message Comment
+
+```
+Files::MessageComment.create(
+  user_id: 1, 
+  body: "body"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `body` (string): Required - Comment body.
+
+
+---
+
+## Update Message Comment
+
+```
+Files::MessageComment.update(id, 
+  body: "body"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment ID.
+* `body` (string): Required - Comment body.
+
+
+---
+
+## Delete Message Comment
+
+```
+Files::MessageComment.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment ID.
+
+
+---
+
+## Update Message Comment
+
+```
+message_comment = Files::MessageComment.list_for(path).first
+
+message_comment.update(
+  body: "body"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment ID.
+* `body` (string): Required - Comment body.
+
+
+---
+
+## Delete Message Comment
+
+```
+message_comment = Files::MessageComment.list_for(path).first
+
+message_comment.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment ID.

data/docs/message_comment_reaction.md

@@ -0,0 +1,94 @@
+# MessageCommentReaction
+
+## Example MessageCommentReaction 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.
+
+
+---
+
+## List Message Comment Reactions
+
+```
+Files::MessageCommentReaction.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  message_comment_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's 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.
+* `message_comment_id` (int64): Required - Message comment to return reactions for.
+
+
+---
+
+## Show Message Comment Reaction
+
+```
+Files::MessageCommentReaction.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment Reaction ID.
+
+
+---
+
+## Create Message Comment Reaction
+
+```
+Files::MessageCommentReaction.create(
+  user_id: 1, 
+  emoji: "emoji"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `emoji` (string): Required - Emoji to react with.
+
+
+---
+
+## Delete Message Comment Reaction
+
+```
+Files::MessageCommentReaction.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment Reaction ID.
+
+
+---
+
+## Delete Message Comment Reaction
+
+```
+message_comment_reaction = Files::MessageCommentReaction.list_for(path).first
+
+message_comment_reaction.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Message Comment Reaction ID.