files.com 1.1.669 → 1.1.671

data/docs/file.md

@@ -7,7 +7,9 @@ may places where a Ruby File object can be used.
 
 ```
 {
+  "id": 1,
   "path": "path/file.txt",
+  "path_absolute": "path/file.txt",
   "created_by_id": 1,
   "created_by_api_key_id": 1,
   "created_by_as2_incoming_message_id": 1,
@@ -40,6 +42,14 @@ may places where a Ruby File object can be used.
   "permissions": "rwd",
   "subfolders_locked?": true,
   "is_locked": true,
+  "remote_server_id": 1,
+  "headers": {
+    "key": "example value"
+  },
+  "socks_ips": [
+    "example"
+  ],
+  "internal_download_uri": "example",
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
@@ -53,7 +63,9 @@ may places where a Ruby File object can be used.
 }
 ```
 
+* `id` (int64): File/Folder ID.  Used only for ExaVault compatibility API.  Do not use for other purposes, as this value will not always be set.
 * `path` (string): File/Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `path_absolute` (string): File/Folder absolute path for Bundle Trusted Relay use
 * `created_by_id` (int64): User ID of the User who created the file/folder
 * `created_by_api_key_id` (int64): ID of the API key that created the file/folder
 * `created_by_as2_incoming_message_id` (int64): ID of the AS2 Incoming Message that created the file/folder
@@ -84,20 +96,33 @@ may places where a Ruby File object can be used.
 * `permissions` (string): A short string representing the current user's permissions.  Can be `r` (Read),`w` (Write),`d` (Delete), `l` (List) or any combination
 * `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
 * `is_locked` (boolean): Is this folder locked and unable to be modified?
+* `remote_server_id` (int64): Used for internal bandwidth tracking
+* `headers` (object): Used for internal url management
+* `socks_ips` (array(string)): Used for internal url management
+* `internal_download_uri` (string): For use with internal services and should also be with headers and socks_ips
 * `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
+* `copy_destination` (string): 
+* `move_destination` (string): 
 * `action` (string): The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
+* `action_attributes` (object): Attributes to pass through for recording the Action.  Used for overriding action types (i.e. representing copy/move)
+* `file` (object): 
+* `crc32b` (string): 
 * `length` (int64): Length of file.
 * `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `overwrite` (boolean): Overwrite existing file(s) in the destination?
 * `part` (int64): Part if uploading a part.
 * `parts` (int64): How many parts to fetch?
+* `prefer_spdy` (boolean): 
 * `ref` (string): 
 * `restart` (int64): File byte offset to restart from.
 * `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
 * `structure` (string): If copying folder, copy just the structure?
 * `with_rename` (boolean): Allow file rename instead of overwrite?
+* `inbox_registration_code` (string): 
+* `bundle_registration_code` (string): 
 * `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
 
 
@@ -107,8 +132,10 @@ may places where a Ruby File object can be used.
 
 ```
 Files::File.download(path, 
+  prefer_spdy: false, 
   with_previews: false, 
-  with_priority_color: false
+  with_priority_color: false, 
+  full_document_preview: false
 )
 ```
 
@@ -116,9 +143,12 @@ Files::File.download(path,
 
 * `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.
+* `bundle_registration_code` (string): 
+* `prefer_spdy` (boolean): 
 * `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?
+* `full_document_preview` (boolean): If true, always return a proxied download uri
 
 
 ---
@@ -127,12 +157,18 @@ Files::File.download(path,
 
 ```
 Files::File.create(path, 
+  crc32: "70976923", 
   length: 1, 
+  md5: "17c54824e9931a4688ca032d03f6663c", 
   mkdir_parents: false, 
+  overwrite: false, 
   part: 1, 
   parts: 1, 
+  prefer_spdy: false, 
   provided_mtime: "2000-01-01T01:00:00Z", 
   restart: 1, 
+  sha1: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3", 
+  sha256: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", 
   size: 1, 
   copy_behaviors: false, 
   with_rename: false, 
@@ -143,20 +179,33 @@ Files::File.create(path,
 ### Parameters
 
 * `path` (string): Required - Path to operate on.
+* `copy_destination` (string): 
+* `move_destination` (string): 
 * `action` (string): The action to perform.  Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
+* `action_attributes` (object): Attributes to pass through for recording the Action.  Used for overriding action types (i.e. representing copy/move)
+* `file` (object): 
+* `crc32` (string): 
+* `crc32b` (string): 
 * `etags[etag]` (array(string)): etag identifier.
 * `etags[part]` (array(int64)): Part number.
 * `length` (int64): Length of file.
+* `md5` (string): 
 * `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `overwrite` (boolean): Overwrite existing file(s) in the destination?
 * `part` (int64): Part if uploading a part.
 * `parts` (int64): How many parts to fetch?
+* `prefer_spdy` (boolean): 
 * `provided_mtime` (string): User provided modification time.
 * `ref` (string): 
 * `restart` (int64): File byte offset to restart from.
+* `sha1` (string): 
+* `sha256` (string): 
 * `size` (int64): Size of file.
 * `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
 * `structure` (string): If copying folder, copy just the structure?
 * `with_rename` (boolean): Allow file rename instead of overwrite?
+* `inbox_registration_code` (string): 
+* `bundle_registration_code` (string): 
 * `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
 
 
@@ -194,6 +243,26 @@ Files::File.delete(path,
 
 * `path` (string): Required - Path to operate on.
 * `recursive` (boolean): If true, will recursively delete folders.  Otherwise, will error on non-empty folders.
+* `bundle_registration_code` (string): 
+
+
+---
+
+## Find File/Folder by ID
+
+```
+Files::File.find_id(id, 
+  with_previews: false, 
+  with_priority_color: false
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - File/Folder ID
+* `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?
 
 
 ---
@@ -213,6 +282,7 @@ Files::File.find(path,
 * `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?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -248,6 +318,7 @@ Files::File.copy(path,
 * `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
 * `structure` (boolean): Copy structure only?
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -266,6 +337,7 @@ Files::File.move(path,
 * `path` (string): Required - Path to operate on.
 * `destination` (string): Required - Move destination path.
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -392,6 +464,7 @@ Files::File.begin_upload(path,
   mkdir_parents: false, 
   part: 1, 
   parts: 1, 
+  prefer_spdy: false, 
   ref: "upload-1", 
   restart: 1, 
   size: 1, 
@@ -406,10 +479,13 @@ Files::File.begin_upload(path,
 * `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?
+* `prefer_spdy` (boolean): 
 * `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?
+* `action` (string): 
+* `bundle_registration_code` (string): 
 * `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
 
 
@@ -421,8 +497,10 @@ Files::File.begin_upload(path,
 file = Files::File.find(path)
 
 file.download(
+  prefer_spdy: false,
   with_previews: false,
-  with_priority_color: false
+  with_priority_color: false,
+  full_document_preview: false
 )
 ```
 
@@ -430,9 +508,12 @@ file.download(
 
 * `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.
+* `bundle_registration_code` (string): 
+* `prefer_spdy` (boolean): 
 * `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?
+* `full_document_preview` (boolean): If true, always return a proxied download uri
 
 
 ---
@@ -473,6 +554,7 @@ file.delete(
 
 * `path` (string): Required - Path to operate on.
 * `recursive` (boolean): If true, will recursively delete folders.  Otherwise, will error on non-empty folders.
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -512,6 +594,7 @@ file.copy(
 * `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
 * `structure` (boolean): Copy structure only?
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -532,6 +615,7 @@ file.move(
 * `path` (string): Required - Path to operate on.
 * `destination` (string): Required - Move destination path.
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -649,6 +733,7 @@ file.begin_upload(
   mkdir_parents: false,
   part: 1,
   parts: 1,
+  prefer_spdy: false,
   ref: "upload-1",
   restart: 1,
   size: 1,
@@ -663,8 +748,11 @@ file.begin_upload(
 * `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?
+* `prefer_spdy` (boolean): 
 * `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?
+* `action` (string): 
+* `bundle_registration_code` (string): 
 * `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.

data/docs/file_migration.md

@@ -29,6 +29,23 @@
 * `log_url` (string): Link to download the log file for this migration.
 
 
+---
+
+## List in-progress file migrations. Returns the 10 most recently active migrations, after narrowing the list to remove overlapping operations
+
+```
+Files::FileMigration.list(
+  user_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+* `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
+
+
 ---
 
 ## Show File Migration
@@ -40,3 +57,18 @@ Files::FileMigration.find(id)
 ### Parameters
 
 * `id` (int64): Required - File Migration ID.
+
+
+---
+
+## List in-progress file migrations. Returns the 10 most recently active migrations, after narrowing the list to remove overlapping operations
+
+```
+Files::FileMigration.create_export(
+  user_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.

data/docs/file_migration_log.md

@@ -12,7 +12,8 @@
   "operation": "example",
   "path": "example",
   "status": "example",
-  "created_at": "2000-01-01T01:00:00Z"
+  "created_at": "2000-01-01T01:00:00Z",
+  "log_type": "example"
 }
 ```
 
@@ -25,6 +26,7 @@
 * `path` (string): File path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `status` (string): Status
 * `created_at` (date-time): Start Time of Action
+* `log_type` (string): Log Type
 
 
 ---
@@ -44,3 +46,20 @@ Files::FileMigrationLog.list
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
 * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
 * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
+
+
+---
+
+## Create an export CSV of File Migration Log resources
+
+```
+Files::FileMigrationLog.create_export
+```
+
+### Parameters
+
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `file_migration_id`, `operation`, `status`, `type` or `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.

data/docs/file_upload_part.md

@@ -25,7 +25,8 @@
   "partsize": 1,
   "path": "",
   "ref": "upload-1",
-  "upload_uri": "example"
+  "upload_uri": "example",
+  "internal_upload_uri": "example"
 }
 ```
 
@@ -45,3 +46,4 @@
 * `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
+* `internal_upload_uri` (string): For use with internal services URI to upload this part to

data/docs/folder.md

@@ -9,7 +9,9 @@ Files::Dir is an alias of Files::Folder
 
 ```
 {
+  "id": 1,
   "path": "path/file.txt",
+  "path_absolute": "path/file.txt",
   "created_by_id": 1,
   "created_by_api_key_id": 1,
   "created_by_as2_incoming_message_id": 1,
@@ -42,6 +44,14 @@ Files::Dir is an alias of Files::Folder
   "permissions": "rwd",
   "subfolders_locked?": true,
   "is_locked": true,
+  "remote_server_id": 1,
+  "headers": {
+    "key": "example value"
+  },
+  "socks_ips": [
+    "example"
+  ],
+  "internal_download_uri": "example",
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
@@ -55,7 +65,9 @@ Files::Dir is an alias of Files::Folder
 }
 ```
 
+* `id` (int64): File/Folder ID.  Used only for ExaVault compatibility API.  Do not use for other purposes, as this value will not always be set.
 * `path` (string): File/Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `path_absolute` (string): File/Folder absolute path for Bundle Trusted Relay use
 * `created_by_id` (int64): User ID of the User who created the file/folder
 * `created_by_api_key_id` (int64): ID of the API key that created the file/folder
 * `created_by_as2_incoming_message_id` (int64): ID of the AS2 Incoming Message that created the file/folder
@@ -86,11 +98,16 @@ Files::Dir is an alias of Files::Folder
 * `permissions` (string): A short string representing the current user's permissions.  Can be `r` (Read),`w` (Write),`d` (Delete), `l` (List) or any combination
 * `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
 * `is_locked` (boolean): Is this folder locked and unable to be modified?
+* `remote_server_id` (int64): Used for internal bandwidth tracking
+* `headers` (object): Used for internal url management
+* `socks_ips` (array(string)): Used for internal url management
+* `internal_download_uri` (string): For use with internal services and should also be with headers and socks_ips
 * `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
 * `mkdir_parents` (boolean): Create parent directories if they do not exist?
+* `bundle_registration_code` (string): 
 
 
 ---
@@ -113,6 +130,8 @@ Files::Folder.list_for(path,
 * `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 or the X-Files-Cursor-Prev header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
 * `path` (string): Required - Path to operate on.
+* `action` (string): Action to take.  Can be `count`, `size`, `permissions`, or blank.
+* `bundle_registration_code` (string): 
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
 * `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
@@ -140,3 +159,4 @@ Files::Folder.create(path,
 * `path` (string): Required - Path to operate on.
 * `mkdir_parents` (boolean): Create parent directories if they do not exist?
 * `provided_mtime` (string): User provided modification time.
+* `bundle_registration_code` (string): 

data/docs/form_field_set.md

@@ -104,6 +104,21 @@ Files::FormFieldSet.create(
 * `form_fields` (array(object)): 
 
 
+---
+
+## Create an export CSV of Form Field Set resources
+
+```
+Files::FormFieldSet.create_export(
+  user_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+
 ---
 
 ## Update Form Field Set

data/docs/front_end_server.md

@@ -0,0 +1,111 @@
+# FrontEndServer
+
+## Example FrontEndServer Object
+
+```
+{
+  "ip": "example",
+  "external_ip": "example",
+  "assigned": true,
+  "site": {
+    "name": "example",
+    "certificate": "example",
+    "private_key": "example",
+    "key": "example",
+    "intermediates": "example",
+    "id": 1,
+    "domain_hsts_header": true,
+    "ftps_enabled": true,
+    "https_enabled": true,
+    "sftp_insecure_ciphers": true,
+    "tls_disabled": true,
+    "subdomain": "example",
+    "domains": [
+      "example"
+    ]
+  },
+  "ftp_enabled": true,
+  "sftp_enabled": true,
+  "sftp_host_key_type": "example",
+  "sftp_host_key_private_key": "example",
+  "site_id": 1,
+  "motd_text": "example",
+  "motd_use_for_ftp": true,
+  "motd_use_for_sftp": true,
+  "custom_domains": [
+    {
+      "id": 1,
+      "domain": "example",
+      "destination": "example",
+      "ssl_certificate_id": 1,
+      "certificate": "example",
+      "private_key": "example",
+      "intermediates": "example"
+    }
+  ],
+  "pair_type": "example"
+}
+```
+
+* `ip` (string): Private IP of the server.
+* `external_ip` (string): Public IP of the server.
+* `assigned` (boolean): Flag to signal to other systems to use this config
+* `site` (SslCertificate): SSL certificate information for the site associated with this IP, if available.
+* `ftp_enabled` (boolean): 
+* `sftp_enabled` (boolean): 
+* `sftp_host_key_type` (string): Which SFTP host key to use.
+* `sftp_host_key_private_key` (string): SFTP Host Key private key if using a custom key.
+* `site_id` (int64): Site Id
+* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
+* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
+* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
+* `custom_domains` (array(object)): Active Custom Domains for the site associated with this IP, with their attached SSL certificate content.
+* `pair_type` (string): Pair type for General Use Public IPs
+* `name` (string): Server's short name.
+* `hostname` (string): Server's full hostname.
+* `zone` (string): Availability zone where this server lives.
+* `ips` (array(string)): An array of public and private ip address pairs.
+* `primary_ip` (string): Primary Internal IP.
+* `primary_ip_public` (string): Primary Public IP.
+* `soo_ip` (string): Security Opt Out Internal IP.
+* `soo_ip_public` (string): Security Opt Out Public IP.
+* `exavault_ip` (string): Exavault Internal IP.
+* `exavault_ip_public` (string): Exavault Public IP.
+* `exavault_soo_ip` (string): Exavault Security Opt Out Internal IP.
+* `exavault_soo_ip_public` (string): Exavault Security Opt Out Public IP.
+* `smartfile_ip` (string): Smartfile Internal IP.
+* `smartfile_ip_public` (string): Smartfile Public IP.
+* `smartfile_soo_ip` (string): Smartfile Security Opt Out Internal IP.
+* `smartfile_soo_ip_public` (string): Smartfile Security Opt Out Public IP.
+
+
+---
+
+## Create or update a front end server and perform a checkin for the given IPs
+
+```
+Files::FrontEndServer.create(
+  name: "name"
+)
+```
+
+### Parameters
+
+* `name` (string): Required - Server's short name.
+* `hostname` (string): Server's full hostname.
+* `zone` (string): Availability zone where this server lives.
+* `ips` (array(string)): An array of public and private ip address pairs.
+* `ips[private_ip]` (array(string)): Private IP address associated with the server.
+* `ips[public_ip]` (array(string)): Public IP address associated with the server.
+* `primary_ip` (string): Primary Internal IP.
+* `primary_ip_public` (string): Primary Public IP.
+* `soo_ip` (string): Security Opt Out Internal IP.
+* `soo_ip_public` (string): Security Opt Out Public IP.
+* `exavault_ip` (string): Exavault Internal IP.
+* `exavault_ip_public` (string): Exavault Public IP.
+* `exavault_soo_ip` (string): Exavault Security Opt Out Internal IP.
+* `exavault_soo_ip_public` (string): Exavault Security Opt Out Public IP.
+* `smartfile_ip` (string): Smartfile Internal IP.
+* `smartfile_ip_public` (string): Smartfile Public IP.
+* `smartfile_soo_ip` (string): Smartfile Security Opt Out Internal IP.
+* `smartfile_soo_ip_public` (string): Smartfile Security Opt Out Public IP.

data/docs/frontend_metric.md

@@ -0,0 +1,34 @@
+# FrontendMetric
+
+## Example FrontendMetric Object
+
+```
+{
+  "metric_type": "increment",
+  "subkey": "abc123",
+  "ms": 100
+}
+```
+
+* `metric_type` (string): Statsd metric type
+* `subkey` (string): Where in statsd to store the metric. The final key in statsd will be `files-react.[environment].[subkey]`
+* `ms` (int64): For timing metrics, the number of milliseconds. Required if `metric_type` is `timing`.
+
+
+---
+
+## Submit Frontend Metric data
+
+```
+Files::FrontendMetric.create(
+  metric_type: "metric_type", 
+  subkey: "abc123", 
+  ms: 100
+)
+```
+
+### Parameters
+
+* `metric_type` (string): Required - Statsd metric type.  Use `timing` to submit the amount of time something took, or `increment` to increment a counter
+* `subkey` (string): Required - Where in statsd to store the metric. The final key in statsd will be `files-react.[environment].[subkey]`
+* `ms` (int64): For timing metrics, the number of milliseconds. Required if `metric_type` is `timing`.