files.com 1.0.190 → 1.0.193

package/docs/models/ExternalEvent.md

@@ -0,0 +1,84 @@
+# ExternalEvent
+
+## Example ExternalEvent Object
+
+```
+{
+  "id": 1,
+  "event_type": "",
+  "status": "",
+  "body": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "body_url": "",
+  "folder_behavior_id": 1,
+  "successful_files": 1,
+  "errored_files": 1,
+  "bytes_synced": 1,
+  "remote_server_type": ""
+}
+```
+
+* `id` (int64): Event ID
+* `event_type` (string): Type of event being recorded.
+* `status` (string): Status of event.
+* `body` (string): Event body
+* `created_at` (date-time): External event create date/time
+* `body_url` (string): Link to log file.
+* `folder_behavior_id` (int64): Folder Behavior ID
+* `successful_files` (int64): For sync events, the number of files handled successfully.
+* `errored_files` (int64): For sync events, the number of files that encountered errors.
+* `bytes_synced` (int64): For sync events, the total number of bytes synced.
+* `remote_server_type` (string): Associated Remote Server type, if any
+
+---
+
+## List External Events
+
+```
+await ExternalEvent.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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 `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
+
+---
+
+## Show External Event
+
+```
+await ExternalEvent.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - External Event ID.
+
+---
+
+## Create External Event
+
+```
+await ExternalEvent.create({
+  'status': "status",
+  'body': "body",
+})
+```
+
+
+### Parameters
+
+* `status` (string): Required - Status of event.
+* `body` (string): Required - Event body

package/docs/models/File.md

@@ -0,0 +1,339 @@
+# File
+
+## Example File Object
+
+```
+{
+  "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": "rwd",
+  "subfolders_locked?": true,
+  "download_uri": "https://mysite.files.com/...",
+  "priority_color": "red",
+  "preview_id": 1,
+  "preview": {
+    "id": 1,
+    "status": "complete",
+    "download_uri": "https://mysite.files.com/...",
+    "type": "image",
+    "size": "large"
+  }
+}
+```
+
+* `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`,`d`, `l` 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` (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?
+
+---
+
+## Upload file
+
+```
+await 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?
+
+---
+
+## Find file/folder by path
+
+```
+await File.find(path, {
+  'with_previews': true,
+  'with_priority_color': true,
+})
+```
+
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `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?
+
+---
+
+## Download file
+
+```
+const file = new File()
+file.path = myFilePath
+
+await 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?
+
+### Example Response
+
+```json
+{
+  "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": "rwd",
+  "subfolders_locked?": true,
+  "download_uri": "https://mysite.files.com/...",
+  "priority_color": "red",
+  "preview_id": 1,
+  "preview": {
+    "id": 1,
+    "status": "complete",
+    "download_uri": "https://mysite.files.com/...",
+    "type": "image",
+    "size": "large"
+  }
+}
+```
+
+---
+
+## Update file/folder metadata
+
+```
+const file = new File()
+file.path = myFilePath
+
+await 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.
+
+### Example Response
+
+```json
+{
+  "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": "rwd",
+  "subfolders_locked?": true,
+  "download_uri": "https://mysite.files.com/...",
+  "priority_color": "red",
+  "preview_id": 1,
+  "preview": {
+    "id": 1,
+    "status": "complete",
+    "download_uri": "https://mysite.files.com/...",
+    "type": "image",
+    "size": "large"
+  }
+}
+```
+
+---
+
+## Delete file/folder
+
+```
+const file = new File()
+file.path = myFilePath
+
+await 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.
+
+
+---
+
+## Copy file/folder
+
+```
+const file = new File()
+file.path = myFilePath
+
+await file.copy({
+  'destination': "destination",
+  'structure': true,
+})
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Copy destination path.
+* `structure` (boolean): Copy structure only?
+
+### Example Response
+
+```json
+{
+  "status": "pending",
+  "file_migration_id": "123"
+}
+```
+
+---
+
+## Move file/folder
+
+```
+const file = new File()
+file.path = myFilePath
+
+await file.move({
+  'destination': "destination",
+})
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Move destination path.
+
+### Example Response
+
+```json
+{
+  "status": "pending",
+  "file_migration_id": "123"
+}
+```
+
+---
+
+## Begin file upload
+
+```
+const file = new File()
+file.path = myFilePath
+
+await file.begin_upload({
+  'mkdir_parents': true,
+  'part': 1,
+  'parts': 1,
+  'ref': "upload-1",
+  'restart': 1,
+  'size': 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.
+* `size` (int64): Total bytes of file being uploaded (include bytes being retained if appending/restarting).
+* `with_rename` (boolean): Allow file rename instead of overwrite?
+
+### Example Response
+
+```json
+[
+  {
+    "send": "",
+    "action": "multipart",
+    "ask_about_overwrites": true,
+    "available_parts": 1,
+    "expires": "",
+    "headers": "",
+    "http_method": "PUT",
+    "next_partsize": 1,
+    "parallel_parts": true,
+    "parameters": "{}",
+    "part_number": 1,
+    "partsize": 1,
+    "path": "",
+    "ref": "upload-1",
+    "upload_uri": ""
+  }
+]
+```

package/docs/models/FileAction.md

@@ -0,0 +1,13 @@
+# FileAction
+
+## Example FileAction Object
+
+```
+{
+  "status": "pending",
+  "file_migration_id": "123"
+}
+```
+
+* `status` (string): Status of file operation.
+* `file_migration_id` (int64): If status is pending, this is the id of the FileMigration to check for status updates.

package/docs/models/FileComment.md

@@ -0,0 +1,98 @@
+# FileComment
+
+## Example FileComment Object
+
+```
+{
+  "id": 1,
+  "body": "What a great file!",
+  "reactions": {
+    "id": 1,
+    "emoji": "👍"
+  }
+}
+```
+
+* `id` (int64): File Comment ID
+* `body` (string): Comment body.
+* `reactions` (FileCommentReaction): Reactions to this comment.
+* `path` (string): File path.
+
+---
+
+## List File Comments by path
+
+```
+await FileComment.listFor(path, {
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `path` (string): Required - Path to operate on.
+
+---
+
+## Create File Comment
+
+```
+await FileComment.create({
+  'body': "body",
+  'path': "path",
+})
+```
+
+
+### Parameters
+
+* `body` (string): Required - Comment body.
+* `path` (string): Required - File path.
+
+---
+
+## Update File Comment
+
+```
+const [file_comment] = await FileComment.list()
+
+await file_comment.update({
+  'body': "body",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment ID.
+* `body` (string): Required - Comment body.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "body": "What a great file!",
+  "reactions": {
+    "id": 1,
+    "emoji": "👍"
+  }
+}
+```
+
+---
+
+## Delete File Comment
+
+```
+const [file_comment] = await FileComment.list()
+
+await file_comment.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment ID.
+

package/docs/models/FileCommentReaction.md

@@ -0,0 +1,50 @@
+# 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
+
+```
+await 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
+
+```
+const file_comment_reaction = new FileCommentReaction()
+file_comment_reaction.path = myFilePath
+
+await file_comment_reaction.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - File Comment Reaction ID.
+

package/docs/models/FileMigration.md

@@ -0,0 +1,40 @@
+# FileMigration
+
+## Example FileMigration Object
+
+```
+{
+  "id": 1,
+  "path": "MyFolder",
+  "dest_path": "MyFolder",
+  "files_moved": 1,
+  "files_total": 1,
+  "operation": "move",
+  "region": "USA",
+  "status": "complete",
+  "log_url": "https://www.example.com/log_file"
+}
+```
+
+* `id` (int64): File migration ID
+* `path` (string): Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `dest_path` (string): Destination path
+* `files_moved` (int64): Number of files processed
+* `files_total` (int64): Total number of files to process
+* `operation` (string): The type of operation
+* `region` (string): Region
+* `status` (string): Status
+* `log_url` (string): Link to download the log file for this migration.
+
+---
+
+## Show File Migration
+
+```
+await FileMigration.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - File Migration ID.

package/docs/models/FileUploadPart.md

@@ -0,0 +1,39 @@
+# FileUploadPart
+
+## Example FileUploadPart Object
+
+```
+{
+  "send": "",
+  "action": "multipart",
+  "ask_about_overwrites": true,
+  "available_parts": 1,
+  "expires": "",
+  "headers": "",
+  "http_method": "PUT",
+  "next_partsize": 1,
+  "parallel_parts": true,
+  "parameters": "{}",
+  "part_number": 1,
+  "partsize": 1,
+  "path": "",
+  "ref": "upload-1",
+  "upload_uri": ""
+}
+```
+
+* `send` (object): Content-Type and File to send
+* `action` (string): Type of upload
+* `ask_about_overwrites` (boolean): If `true`, this file exists and you may wish to ask the user for overwrite confirmation
+* `available_parts` (int64): Number of parts in the upload
+* `expires` (string): Date/time of when this Upload part expires and the URL cannot be used any more
+* `headers` (object): Additional upload headers to provide as part of the upload
+* `http_method` (string): HTTP Method to use for uploading the part, usually `PUT`
+* `next_partsize` (int64): Size in bytes for this part
+* `parallel_parts` (boolean): If `true`, multiple parts may be uploaded in parallel.  If `false`, be sure to only upload one part at a time, in order.
+* `parameters` (object): Additional HTTP parameters to send with the upload
+* `part_number` (int64): Number of this upload part
+* `partsize` (int64): Size in bytes for the next upload part
+* `path` (string): New file 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