files.com 1.1.764 → 1.1.766

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49dfceda26d15e50434c26fa7e029f98da9110f5f450cdcf670ce1795f23fa48
-  data.tar.gz: 3adfc8a8080fabb093a89be14deef3610df554c28f8ed9982929e4d1266205c1
+  metadata.gz: 0bb1d5b48b96119ec91525d8f055be9455d19406b796869d5e9db694bc10e34d
+  data.tar.gz: 3b963488ee21b159a12a9bd256e343d0e86987f4ac8701de9e3eccc1fdc86876
 SHA512:
-  metadata.gz: 2dc7126351c5336b53ec3056b75021635abb2bd8a1dbc1d736f0378e480264550199cc2891afc0be7df35f3532705f34746902b44b06eb5f62317401db9fccc6
-  data.tar.gz: 940a14a60dc168554f787c6d3ec085125681c259d73ad25ae8706a2ac40017949c7e7d2e53572af9003c383e6c5a1980d6e488b07a8c7443bac947ecf093f7e3
+  metadata.gz: ebe6a92f79a33732e665c36dec9269f648bb77be622659921ae9594fb703eebc457e628b058daa103ba693a15df62410b8c0e87f9b4f1f0eda714cda06937a15
+  data.tar.gz: 279cacd8d1dbadfb490ecbbecfd8a1069b019633469e731c1fac550aa42791f601c2f173868681b8d78fc71ed5d9f1dded664bc45c3cd27ac524e9e9e647e4e7

data/README.md

@@ -396,13 +396,40 @@ Trailing whitespace is significant for comparison. `report.txt` and `report.txt
 
 ## Workspaces
 
-A Workspace is a lightweight way to organize related resources inside a single Files.com Site.
+A Workspace groups files, users, groups, Partners, integrations, and workflows within a Files.com Site. An integration can provision a Workspace for a department or project and delegate its operation to a team without making that team Site Administrators. Every Site has a Default Workspace, with ID `0`; additional Workspaces have their own IDs and root folders.
 
-Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear "workspace context" and admins can delegate management for a subset of resources without requiring full site-level isolation.
+Account membership, request context, and permission grants serve different purposes. Creating an account in a Workspace determines where it belongs. Selecting a Workspace determines which resources a request operates on. A permission grant determines what the caller can do there. Selecting a Workspace never grants access to it.
 
-Every Site has an implicit Default workspace (ID `0`). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.
+### Accounts and Administrative Access
+
+A user's or group's `workspace_id` identifies the Workspace the account belongs to. Accounts belonging to a Custom Workspace stay within it. Default Workspace users and groups can receive permissions in one or more Custom Workspaces while keeping their existing accounts in Workspace `0`.
+
+| Account | Workspace Administrator assignment | Scope |
+| --- | --- | --- |
+| User belonging to a Custom Workspace | Set the user's `workspace_admin` to `true`. | That user's own Custom Workspace. |
+| Default Workspace user | Create an `admin` Permission for the user on a Custom Workspace's root folder. | Each Custom Workspace with a root grant. |
+| Default Workspace group | Create an `admin` Permission for the group on a Custom Workspace's root folder. | Every member inherits administration of each Workspace with a root grant. |
+
+`workspace_admin` is not a summary of a user's effective administrative access. A Default Workspace user can administer a Custom Workspace through a direct or group root grant while their `workspace_admin` remains `false`. Groups have no `workspace_admin` field. See [Users](/ruby/resources/user-accounts/users) and [Groups](/ruby/resources/user-accounts/groups) for account fields.
+
+An `admin` grant on the **Custom Workspace root** provides full Workspace Administrator authority over its files, users, groups, Partners, workflows, and integrations. An `admin` grant on a subfolder provides Folder Admin authority over that folder and its descendants; it does not provide Workspace administration. Other permission levels provide their corresponding folder access without Workspace administration. [Permissions](/ruby/resources/user-accounts/permissions) defines the levels.
+
+Site Administrators manage cross-Workspace assignments to Default Workspace accounts. Workspace Administrators manage accounts and permissions within their own scope. Site Administrators retain access to every Workspace; adding a Workspace grant does not narrow Site Administrator authority. The [product documentation](https://www.files.com/docs/workspaces/workspace-administrators) explains the administrator's operational scope and site-wide controls.
+
+### Request Context and API Keys
+
+You can include the `X-Files-Workspace-Id` REST header to select a Workspace for a request. SDK request options and CLI configuration send that same selection. When a Workspace is selected, Workspace-scoped resources are listed, created, and changed within that context, and ordinary paths are relative to its root.
+
+A resource's `workspace_id` request field describes the resource's Workspace membership. It is separate from the SDK's Workspace request option or REST header. Creating a Workspace-scoped resource in a Custom Workspace defaults its `workspace_id` to the selected Workspace; a mismatching membership value is rejected with `not-authorized/insufficient-permission-for-params`.
+
+Selecting another Workspace with an API key requires a **Full Access key created in the Default Workspace**. A user key follows that user's current access, including group permissions. A site-wide Full Access key created in the Default Workspace has Site Administrator authority in every Workspace. A Files Only key stays in its creation Workspace, even if its user has cross-Workspace access. Any key created in a Custom Workspace stays within that Workspace. Selecting another context with these confined keys is rejected with `bad-request/invalid-workspace-id-header`.
+
+An account belonging to a Custom Workspace is scoped there when it authenticates normally. For a Default Workspace user, explicitly select the intended Workspace for an integration rather than relying on an interactive login preference. [API Keys](/ruby/resources/developers/api-keys) and [Authentication](/ruby/overview/authentication) cover credentials.
 
 The Files.com Ruby SDK supports workspace scoping by using the `Files.workspace_id` configuration attribute. Scope a single request by passing `workspace_id` in the request options.
+
+The adjacent scoping example uses a credential authorized for the selected Workspace. A group member uses their own Full Access user key from the Default Workspace; the Site Administrator credential used to assign the grant is not needed for their day-to-day work.
+
 ```ruby title="Example Request"
 require "files.com"
 
@@ -411,6 +438,50 @@ Files.workspace_id = 123
 Files::Folder.list_for("", {}, workspace_id: 456)
 ```
 
+### Delegating a Workspace to an Existing Group
+
+An operations team already represented by a Default Workspace group can administer a Custom Workspace through one root Permission. The group and its members stay in the Default Workspace, so the same team can receive different access in other Workspaces.
+
+First retrieve the target [Workspace](/ruby/resources/settings/workspaces) and [Group](/ruby/resources/user-accounts/groups) IDs as a Site Administrator in Workspace `0`. The examples use Workspace `123`, group `456`, and member user `789`; replace them with your own IDs. Confirm that the group belongs to Workspace `0` and that the intended user is a member.
+
+Create the Permission using a Default Workspace Full Access site-wide key or a Full Access user key belonging to a Site Administrator. Keep the request context at `0` and use the qualified root path `_/Workspaces/123`. Set `group_id` to the group's ID, `permission` to `admin`, and `recursive` to `true`. Save the returned Permission `id` for later removal. For an individual Default Workspace user, use `user_id` instead of `group_id`.
+
+For a Default Workspace group, a Site Administrator can also select Workspace `123` and use an empty `path` to grant access to its root. The qualified path in Workspace `0` works for both Default Workspace users and groups and keeps the account scope and target Workspace explicit. Appending a subfolder to the path would grant Folder Admin access instead of Workspace Administrator authority.
+
+After the grant, run the request-context example above with the member's own credential and Workspace `123` selected. That member can work with the Workspace's files and perform Workspace Administrator operations, such as managing its users, Partners, and integrations. A Site Administrator's successful request does not establish that the member has the intended access.
+
+```ruby title="Grant group administration"
+require 'files.com'
+
+Files.workspace_id = 0
+grant = Files::Permission.create({
+  path: "_/Workspaces/123",
+  group_id: 456,
+  permission: "admin",
+  recursive: true
+}, workspace_id: 0)
+puts grant.id
+```
+
+### Permission Inspection and Removal
+
+List the member's Permissions with `user_id` and `include_groups=true` to include grants inherited through group membership. Listing only direct user grants can miss the Permission that provides Workspace administration. In Workspace `0`, the Custom Workspace root appears as `_/Workspaces/123`; in Workspace `123`, paths are relative to that root. Inspect the root path and `permission=admin`, rather than treating the user's `workspace_admin` field as their effective administrative access.
+
+Permission lists show individual grants, rather than a single flag for effective administrative access. Membership in several groups combines their access. A Permission using `group_ids` instead of `group_id` requires membership in all the specified groups; it is not a shorthand for assigning the same grant to several independent groups.
+
+Removing a member ends access received through that group. Deleting the root Permission ends the group's Workspace Administrator grant for every member. These changes leave independent direct and other group grants in place, so review all applicable grants when withdrawing access. Default Workspace user API keys follow those permission changes without being recreated.
+
+Group membership maintained through SCIM follows the same rule. A Group Admin allowed to add members can give those users the group's existing Workspace Administrator access. Choose who manages the group with that authority in mind.
+
+Delete the Permission by its returned `id` as the Site Administrator in Workspace `0`. The removal examples use Permission ID `9001`; replace it with the ID returned by your create request. Permissions are created and deleted, rather than updated in place. If narrower folder access is still needed, assign it explicitly; deleting a broad grant does not restore narrower grants it previously replaced.
+
+```ruby title="Inspect member grants and remove the group grant"
+Files::Permission.list({user_id: "789", include_groups: true}, workspace_id: 0).each do |item|
+  puts [item.path, item.permission, item.group_id].inspect
+end
+Files::Permission.delete(9001, {}, workspace_id: 0)
+```
+
 ## Foreign Language Support
 
 The Files.com Ruby SDK supports localized responses by using the `Files.language` configuration attribute.
@@ -683,6 +754,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`TooManyRequestsError`|  `RateLimitedError` |
 |`TooManySharesError`|  `RateLimitedError` |
 |`AutomationsUnavailableError`|  `ServiceUnavailableError` |
+|`LockOperationBusyError`|  `ServiceUnavailableError` |
 |`MigrationInProgressError`|  `ServiceUnavailableError` |
 |`SearchUnavailableError`|  `ServiceUnavailableError` |
 |`SiteDisabledError`|  `ServiceUnavailableError` |

data/_VERSION

@@ -1 +1 @@
-1.1.764
+1.1.766

data/docs/api_key.md

@@ -36,14 +36,14 @@
 * `aws_secret_key` (string): AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
 * `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
 * `name` (string): Internal name for the API Key.  For your use.
-* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
+* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
 * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
 * `site_id` (int64): Site ID
 * `site_name` (string): Site Name
 * `url` (string): URL for API host.
 * `user_id` (int64): User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
 * `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
-* `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+* `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
 
 
 ---
@@ -115,8 +115,8 @@ Files::ApiKey.create(
 * `expires_at` (string): API Key expiration date
 * `name` (string): Required - Internal name for the API Key.  For your use.
 * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
-* `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
-* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
+* `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
 * `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
 
 
@@ -136,7 +136,7 @@ Files::ApiKey.update_current(
 
 * `expires_at` (string): API Key expiration date
 * `name` (string): Internal name for the API Key.  For your use.
-* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
+* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
 
 
 ---

data/docs/form_field_set.md

@@ -38,7 +38,7 @@
 * `id` (int64): Form field set id
 * `title` (string): Title to be displayed
 * `form_layout` (array(int64)): Layout of the form
-* `form_fields` (array(object)): Associated form fields
+* `form_fields` (array(object)): Associated form field definitions; authenticated form field set responses include historical definitions, while form_layout identifies current fields
 * `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
 * `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
 * `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company

data/docs/history_export.md

@@ -4,6 +4,7 @@
 
 ```
 {
+  "workspace_id": 1,
   "id": 1,
   "history_version": "20201213.2",
   "start_at": "2000-01-01T01:00:00Z",
@@ -32,6 +33,7 @@
 }
 ```
 
+* `workspace_id` (int64): Workspace of the export. 0 represents the default workspace. A null value means a site-wide export.
 * `id` (int64): History Export ID
 * `history_version` (string): Version of the history for the export.
 * `start_at` (date-time): Start date/time of export range.

data/docs/lock.md

@@ -23,7 +23,7 @@
 * `timeout` (int64): Lock timeout in seconds
 * `depth` (string): 
 * `recursive` (boolean): Does lock apply to subfolders?
-* `owner` (string): Owner of the lock.  This can be any arbitrary string.
+* `owner` (string): Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
 * `scope` (string): 
 * `exclusive` (boolean): Is lock exclusive?
 * `token` (string): Lock token.  Use to release lock.
@@ -31,6 +31,7 @@
 * `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
 * `user_id` (int64): Lock creator user ID
 * `username` (string): Lock creator username
+* `expected_token` (string): Require this existing, unexpired token before refreshing or replacing a lock. Set token to the same value to refresh, or a different value to replace.
 
 
 ---
@@ -57,9 +58,11 @@ Files::Lock.list_for(path,
 
 ```
 Files::Lock.create(path, 
+  token: "17c54824e9931a4688ca032d03f6663c", 
   allow_access_by_any_user: false, 
   exclusive: false, 
   recursive: true, 
+  owner: "user", 
   timeout: 1
 )
 ```
@@ -67,9 +70,12 @@ Files::Lock.create(path,
 ### Parameters
 
 * `path` (string): Required - Path
+* `token` (string): Lock token. With expected_token, use the same value to refresh or a different value to replace the existing token.
+* `expected_token` (string): Require this existing, unexpired token before refreshing or replacing a lock. Set token to the same value to refresh, or a different value to replace.
 * `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
 * `exclusive` (boolean): Is lock exclusive?
 * `recursive` (boolean): Does lock apply to subfolders?
+* `owner` (string): Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
 * `timeout` (int64): Lock timeout in seconds
 
 

data/docs/partner.md

@@ -79,7 +79,7 @@ Files::Partner.list
 
 * `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).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
 * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
 
 

data/docs/permission.md

@@ -25,17 +25,17 @@
 ```
 
 * `id` (int64): Permission ID
-* `path` (string): Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `path` (string): Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `user_id` (int64): User ID
 * `username` (string): Username (if applicable)
 * `group_id` (int64): Group ID
 * `group_name` (string): Group name (if applicable)
-* `group_ids` (array(int64)): Group IDs when this permission requires multiple groups
+* `group_ids` (array(int64)): Group IDs when this Permission requires membership in every listed group.
 * `group_names` (array(string)): Group names when this permission requires multiple groups
 * `partner_id` (int64): Partner ID (if applicable)
 * `partner_name` (string): Partner name (if applicable)
 * `permission` (string): Permission type.  See the table referenced in the documentation for an explanation of each permission.
-* `recursive` (boolean): Recursive: does this permission apply to subfolders?
+* `recursive` (boolean): Whether this Permission applies to subfolders. Must be true for `admin` Permissions.
 * `site_id` (int64): Site ID
 
 
@@ -90,9 +90,9 @@ Files::Permission.create(
 
 * `path` (string): Required - Folder path
 * `group_id` (int64): Group ID. Provide `group_name` or `group_id`
-* `group_ids` (string): Group IDs when the permission requires multiple groups. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): Group IDs when the Permission requires membership in every listed group. If sent as a string, it should be comma-delimited.
 * `permission` (string): Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
-* `recursive` (boolean): Apply to subfolders recursively?
+* `recursive` (boolean): Apply to subfolders recursively? Must be true for `admin` Permissions.
 * `partner_id` (int64): Partner ID if this Permission belongs to a partner.
 * `user_id` (int64): User ID.  Provide `username` or `user_id`
 * `username` (string): User username.  Provide `username` or `user_id`

data/docs/remote_server.md

@@ -92,13 +92,13 @@
 * `id` (int64): Remote Server ID
 * `disabled` (boolean): If true, this Remote Server is disabled. Updating it clears this flag, except for retired Agent v1 records, which remain disabled.
 * `authentication_method` (string): Type of authentication method to use
-* `hostname` (string): Hostname or IP address
+* `hostname` (string): Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `remote_home_path` (string): Initial home folder on remote server
 * `upload_staging_path` (string): Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
 * `allow_relative_paths` (boolean): Allow relative paths in SFTP. If true, paths will not be forced to be absolute, allowing operations relative to the user's home directory.
 * `name` (string): Internal name for your reference
 * `description` (string): Internal description for your reference
-* `port` (int64): Port for remote server.
+* `port` (int64): Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `buffer_uploads` (string): If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections.  It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
 * `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
 * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
@@ -149,9 +149,9 @@
 * `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
 * `custom_domain_id` (int64): Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
 * `outbound_ip_addresses` (array(string)): Current eligible public IP addresses for the selected Custom Domain. Any address in this list may originate a connection. Empty when no domain is selected or its configuration is unavailable. Only included in responses for a single Remote Server.
-* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
-* `files_agent_root` (string): Agent local root path
-* `files_agent_version` (string): Files Agent version
+* `files_agent_permission_set` (string): Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+* `files_agent_root` (string): Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+* `files_agent_version` (string): Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
 * `files_agent_up_to_date` (boolean): If true, the Files Agent is up to date.
 * `files_agent_latest_version` (string): Latest available Files Agent version
 * `files_agent_supports_push_updates` (boolean): Files Agent supports receiving push updates
@@ -370,9 +370,9 @@ Files::RemoteServer.create(
 * `filebase_access_key` (string): Filebase: Access Key.
 * `filebase_bucket` (string): Filebase: Bucket name
 * `files_api_key` (string): Files.com direct link: API key used once to pair the remote server.
-* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
-* `files_agent_root` (string): Agent local root path
-* `files_agent_version` (string): Files Agent version
+* `files_agent_permission_set` (string): Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+* `files_agent_root` (string): Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+* `files_agent_version` (string): Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
 * `outbound_agent_id` (int64): Route traffic to outbound on a files-agent
 * `custom_domain_id` (int64): Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
 * `google_cloud_storage_authentication_method` (string): Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
@@ -380,7 +380,7 @@ Files::RemoteServer.create(
 * `google_cloud_storage_oauth_scope` (string): Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
 * `google_cloud_storage_project_id` (string): Google Cloud Storage: Project ID
 * `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
-* `hostname` (string): Hostname or IP address
+* `hostname` (string): Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `linode_access_key` (string): Linode: Access Key
 * `linode_bucket` (string): Linode: Bucket name
 * `linode_region` (string): Linode: region
@@ -388,7 +388,7 @@ Files::RemoteServer.create(
 * `name` (string): Internal name for your reference
 * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
 * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-* `port` (int64): Port for remote server.
+* `port` (int64): Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `upload_staging_path` (string): Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
 * `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
 * `s3_assume_role_arn` (string): AWS IAM Role ARN for AssumeRole authentication.
@@ -543,9 +543,9 @@ Files::RemoteServer.update(id,
 * `filebase_access_key` (string): Filebase: Access Key.
 * `filebase_bucket` (string): Filebase: Bucket name
 * `files_api_key` (string): Files.com direct link: API key used once to pair the remote server.
-* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
-* `files_agent_root` (string): Agent local root path
-* `files_agent_version` (string): Files Agent version
+* `files_agent_permission_set` (string): Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+* `files_agent_root` (string): Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+* `files_agent_version` (string): Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
 * `outbound_agent_id` (int64): Route traffic to outbound on a files-agent
 * `custom_domain_id` (int64): Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
 * `google_cloud_storage_authentication_method` (string): Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
@@ -553,7 +553,7 @@ Files::RemoteServer.update(id,
 * `google_cloud_storage_oauth_scope` (string): Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
 * `google_cloud_storage_project_id` (string): Google Cloud Storage: Project ID
 * `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
-* `hostname` (string): Hostname or IP address
+* `hostname` (string): Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `linode_access_key` (string): Linode: Access Key
 * `linode_bucket` (string): Linode: Bucket name
 * `linode_region` (string): Linode: region
@@ -561,7 +561,7 @@ Files::RemoteServer.update(id,
 * `name` (string): Internal name for your reference
 * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
 * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-* `port` (int64): Port for remote server.
+* `port` (int64): Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `upload_staging_path` (string): Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
 * `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
 * `s3_assume_role_arn` (string): AWS IAM Role ARN for AssumeRole authentication.
@@ -747,9 +747,9 @@ remote_server.update(
 * `filebase_access_key` (string): Filebase: Access Key.
 * `filebase_bucket` (string): Filebase: Bucket name
 * `files_api_key` (string): Files.com direct link: API key used once to pair the remote server.
-* `files_agent_permission_set` (string): Local permissions for files agent. read_only, write_only, or read_write
-* `files_agent_root` (string): Agent local root path
-* `files_agent_version` (string): Files Agent version
+* `files_agent_permission_set` (string): Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+* `files_agent_root` (string): Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+* `files_agent_version` (string): Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
 * `outbound_agent_id` (int64): Route traffic to outbound on a files-agent
 * `custom_domain_id` (int64): Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
 * `google_cloud_storage_authentication_method` (string): Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
@@ -757,7 +757,7 @@ remote_server.update(
 * `google_cloud_storage_oauth_scope` (string): Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
 * `google_cloud_storage_project_id` (string): Google Cloud Storage: Project ID
 * `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible Access Key.
-* `hostname` (string): Hostname or IP address
+* `hostname` (string): Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `linode_access_key` (string): Linode: Access Key
 * `linode_bucket` (string): Linode: Bucket name
 * `linode_region` (string): Linode: region
@@ -765,7 +765,7 @@ remote_server.update(
 * `name` (string): Internal name for your reference
 * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
 * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-* `port` (int64): Port for remote server.
+* `port` (int64): Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
 * `upload_staging_path` (string): Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
 * `remote_server_credential_id` (int64): ID of Remote Server Credential, if applicable.
 * `s3_assume_role_arn` (string): AWS IAM Role ARN for AssumeRole authentication.

data/docs/site.md

@@ -103,6 +103,7 @@
   "domain_letsencrypt_chain": "example",
   "email": "john.doe@files.com",
   "fedramp": true,
+  "files_com_remote_server_enabled": true,
   "ftp_enabled": true,
   "reply_to_email": "jane.doe@files.com",
   "non_sso_groups_allowed": true,
@@ -452,6 +453,7 @@
 * `domain_letsencrypt_chain` (string): Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
 * `email` (email): Main email for this site
 * `fedramp` (boolean): Are FedRAMP security restrictions enabled for this site?
+* `files_com_remote_server_enabled` (boolean): Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.
 * `ftp_enabled` (boolean): Is FTP enabled?
 * `reply_to_email` (email): Reply-to email for this site
 * `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
@@ -702,6 +704,7 @@ Files::Site.update(
   user_requests_enabled: false, 
   user_requests_notify_admins: false, 
   dav_enabled: false, 
+  files_com_remote_server_enabled: false, 
   ftp_enabled: false, 
   s3_compatible_endpoint_enabled: false, 
   sftp_enabled: false, 
@@ -889,6 +892,7 @@ Files::Site.update(
 * `user_requests_enabled` (boolean): Enable User Requests feature
 * `user_requests_notify_admins` (boolean): Send email to site admins when a user request is received?
 * `dav_enabled` (boolean): Is WebDAV enabled?
+* `files_com_remote_server_enabled` (boolean): Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.
 * `ftp_enabled` (boolean): Is FTP enabled?
 * `s3_compatible_endpoint_enabled` (boolean): Is the S3-compatible endpoint enabled for all users and workspaces on this site? Defaults to true. When false, user and group S3 permissions do not allow access.
 * `sftp_enabled` (boolean): Is SFTP enabled?

data/docs/user.md

@@ -170,9 +170,9 @@
 * `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
 * `sftp_permission` (boolean): Can the user access with SFTP?
 * `site_admin` (boolean): Is the user an administrator for this site?
-* `workspace_admin` (boolean): Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+* `workspace_admin` (boolean): Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
 * `site_id` (int64): Site ID
-* `workspace_id` (int64): Workspace ID
+* `workspace_id` (int64): ID of the Workspace the user belongs to. 0 is the Default Workspace.
 * `default_workspace_id` (int64): Workspace ID the user should land in by default when more than one Workspace is available.
 * `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
 * `ssl_required` (string): SSL required setting
@@ -379,9 +379,9 @@ Files::User.create(
 * `time_zone` (string): User time zone
 * `user_root` (string): If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is site_root or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partner_root layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
 * `user_home` (string): Home folder for FTP/SFTP. For users with the partner_root filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
-* `workspace_admin` (boolean): Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+* `workspace_admin` (boolean): Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
 * `username` (string): Required - User's username
-* `workspace_id` (int64): Workspace ID
+* `workspace_id` (int64): ID of the Workspace the user belongs to. 0 is the Default Workspace.
 
 
 ---
@@ -565,7 +565,7 @@ Files::User.update(id,
 * `time_zone` (string): User time zone
 * `user_root` (string): If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is site_root or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partner_root layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
 * `user_home` (string): Home folder for FTP/SFTP. For users with the partner_root filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
-* `workspace_admin` (boolean): Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+* `workspace_admin` (boolean): Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
 * `username` (string): User's username
 * `workspace_id` (int64): Workspace ID. Only Site Administrators can change this field. Values supplied by Workspace Administrators, Group Administrators, or other non-Site Administrators using `/user` are ignored.
 * `clear_2fa` (boolean): If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
@@ -777,7 +777,7 @@ user.update(
 * `time_zone` (string): User time zone
 * `user_root` (string): If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is site_root or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partner_root layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
 * `user_home` (string): Home folder for FTP/SFTP. For users with the partner_root filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
-* `workspace_admin` (boolean): Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+* `workspace_admin` (boolean): Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
 * `username` (string): User's username
 * `workspace_id` (int64): Workspace ID. Only Site Administrators can change this field. Values supplied by Workspace Administrators, Group Administrators, or other non-Site Administrators using `/user` are ignored.
 * `clear_2fa` (boolean): If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.

data/docs/user_sftp_client_use.md

@@ -34,3 +34,4 @@ Files::UserSftpClientUse.list(
 * `user_id` (int64): User ID. If provided, will return uses for this 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).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.

data/lib/files.com/errors.rb

@@ -256,6 +256,7 @@ module Files
 
   class ServiceUnavailableError < APIError; end
   class AutomationsUnavailableError < ServiceUnavailableError; end
+  class LockOperationBusyError < ServiceUnavailableError; end
   class MigrationInProgressError < ServiceUnavailableError; end
   class SearchUnavailableError < ServiceUnavailableError; end
   class SiteDisabledError < ServiceUnavailableError; end

data/lib/files.com/models/api_key.rb

@@ -104,7 +104,7 @@ module Files
       @attributes[:name] = value
     end
 
-    # string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
+    # string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
     def permission_set
       @attributes[:permission_set]
     end
@@ -167,7 +167,7 @@ module Files
       @attributes[:workspace_id] = value
     end
 
-    # string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+    # string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
     def path
       @attributes[:path]
     end
@@ -276,8 +276,8 @@ module Files
     #   expires_at - string - API Key expiration date
     #   name (required) - string - Internal name for the API Key.  For your use.
     #   aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
-    #   path - string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
-    #   permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
+    #   path - string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. For `GET /file_migrations/{id}`, a key with a path can read only migrations it started. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to file operations and their supporting lookups. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+    #   permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
     #   workspace_id - int64 - Workspace ID for this API Key. `0` means the default workspace.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -296,7 +296,7 @@ module Files
     # Parameters:
     #   expires_at - string - API Key expiration date
     #   name - string - Internal name for the API Key.  For your use.
-    #   permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
+    #   permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. On the migration lookup, any key with a `path` can read only migrations it started. Without a `path`, user-owned keys retain user-scoped access; site-wide Workspace-bound keys can read only migrations whose source and destination are both in their Workspace. Every `files_only` key is Workspace-bound, including Workspace `0`, as is a full-access key in a named Workspace. A full-access site-wide key in the default Workspace retains Site-wide migration access. Migrations outside the caller's visibility return `not-found`. Keys with `files_only` cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
     def self.update_current(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)

data/lib/files.com/models/form_field_set.rb

@@ -36,7 +36,7 @@ module Files
       @attributes[:form_layout] = value
     end
 
-    # array(object) - Associated form fields
+    # array(object) - Associated form field definitions; authenticated form field set responses include historical definitions, while form_layout identifies current fields
     def form_fields
       @attributes[:form_fields]
     end

data/lib/files.com/models/history_export.rb

@@ -9,6 +9,15 @@ module Files
       @options = options || {}
     end
 
+    # int64 - Workspace of the export. 0 represents the default workspace. A null value means a site-wide export.
+    def workspace_id
+      @attributes[:workspace_id]
+    end
+
+    def workspace_id=(value)
+      @attributes[:workspace_id] = value
+    end
+
     # int64 - History Export ID
     def id
       @attributes[:id]

data/lib/files.com/models/lock.rb

@@ -45,7 +45,7 @@ module Files
       @attributes[:recursive] = value
     end
 
-    # string - Owner of the lock.  This can be any arbitrary string.
+    # string - Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
     def owner
       @attributes[:owner]
     end
@@ -117,6 +117,15 @@ module Files
       @attributes[:username] = value
     end
 
+    # string - Require this existing, unexpired token before refreshing or replacing a lock. Set token to the same value to refresh, or a different value to replace.
+    def expected_token
+      @attributes[:expected_token]
+    end
+
+    def expected_token=(value)
+      @attributes[:expected_token] = value
+    end
+
     # Parameters:
     #   token (required) - string - Lock token
     def delete(params = {})
@@ -162,14 +171,20 @@ module Files
 
     # Parameters:
     #   path (required) - string - Path
+    #   token - string - Lock token. With expected_token, use the same value to refresh or a different value to replace the existing token.
+    #   expected_token - string - Require this existing, unexpired token before refreshing or replacing a lock. Set token to the same value to refresh, or a different value to replace.
     #   allow_access_by_any_user - boolean - Can lock be modified by users other than its creator?
     #   exclusive - boolean - Is lock exclusive?
     #   recursive - boolean - Does lock apply to subfolders?
+    #   owner - string - Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
     #   timeout - int64 - Lock timeout in seconds
     def self.create(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: token must be an String") if params[:token] and !params[:token].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expected_token must be an String") if params[:expected_token] and !params[:expected_token].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: owner must be an String") if params[:owner] and !params[:owner].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: timeout must be an Integer") if params[:timeout] and !params[:timeout].is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params[:path]
 

data/lib/files.com/models/partner.rb

@@ -264,7 +264,7 @@ module Files
     # Parameters:
     #   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).
-    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)

data/lib/files.com/models/permission.rb

@@ -18,7 +18,7 @@ module Files
       @attributes[:id] = value
     end
 
-    # string - Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    # string - Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
     def path
       @attributes[:path]
     end
@@ -63,7 +63,7 @@ module Files
       @attributes[:group_name] = value
     end
 
-    # array(int64) - Group IDs when this permission requires multiple groups
+    # array(int64) - Group IDs when this Permission requires membership in every listed group.
     def group_ids
       @attributes[:group_ids]
     end
@@ -108,7 +108,7 @@ module Files
       @attributes[:permission] = value
     end
 
-    # boolean - Recursive: does this permission apply to subfolders?
+    # boolean - Whether this Permission applies to subfolders. Must be true for `admin` Permissions.
     def recursive
       @attributes[:recursive]
     end
@@ -186,9 +186,9 @@ module Files
     # Parameters:
     #   path (required) - string - Folder path
     #   group_id - int64 - Group ID. Provide `group_name` or `group_id`
-    #   group_ids - string - Group IDs when the permission requires multiple groups. If sent as a string, it should be comma-delimited.
+    #   group_ids - string - Group IDs when the Permission requires membership in every listed group. If sent as a string, it should be comma-delimited.
     #   permission - string - Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
-    #   recursive - boolean - Apply to subfolders recursively?
+    #   recursive - boolean - Apply to subfolders recursively? Must be true for `admin` Permissions.
     #   partner_id - int64 - Partner ID if this Permission belongs to a partner.
     #   user_id - int64 - User ID.  Provide `username` or `user_id`
     #   username - string - User username.  Provide `username` or `user_id`

data/lib/files.com/models/remote_server.rb

@@ -36,7 +36,7 @@ module Files
       @attributes[:authentication_method] = value
     end
 
-    # string - Hostname or IP address
+    # string - Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     def hostname
       @attributes[:hostname]
     end
@@ -90,7 +90,7 @@ module Files
       @attributes[:description] = value
     end
 
-    # int64 - Port for remote server.
+    # int64 - Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     def port
       @attributes[:port]
     end
@@ -549,7 +549,7 @@ module Files
       @attributes[:outbound_ip_addresses] = value
     end
 
-    # string - Local permissions for files agent. read_only, write_only, or read_write
+    # string - Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
     def files_agent_permission_set
       @attributes[:files_agent_permission_set]
     end
@@ -558,7 +558,7 @@ module Files
       @attributes[:files_agent_permission_set] = value
     end
 
-    # string - Agent local root path
+    # string - Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
     def files_agent_root
       @attributes[:files_agent_root]
     end
@@ -567,7 +567,7 @@ module Files
       @attributes[:files_agent_root] = value
     end
 
-    # string - Files Agent version
+    # string - Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
     def files_agent_version
       @attributes[:files_agent_version]
     end
@@ -992,9 +992,9 @@ module Files
     #   filebase_access_key - string - Filebase: Access Key.
     #   filebase_bucket - string - Filebase: Bucket name
     #   files_api_key - string - Files.com direct link: API key used once to pair the remote server.
-    #   files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
-    #   files_agent_root - string - Agent local root path
-    #   files_agent_version - string - Files Agent version
+    #   files_agent_permission_set - string - Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+    #   files_agent_root - string - Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+    #   files_agent_version - string - Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
     #   outbound_agent_id - int64 - Route traffic to outbound on a files-agent
     #   custom_domain_id - int64 - Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
     #   google_cloud_storage_authentication_method - string - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
@@ -1002,7 +1002,7 @@ module Files
     #   google_cloud_storage_oauth_scope - string - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
     #   google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
     #   google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
-    #   hostname - string - Hostname or IP address
+    #   hostname - string - Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     #   linode_access_key - string - Linode: Access Key
     #   linode_bucket - string - Linode: Bucket name
     #   linode_region - string - Linode: region
@@ -1010,7 +1010,7 @@ module Files
     #   name - string - Internal name for your reference
     #   one_drive_account_type - string - OneDrive: Either personal or business_other account types
     #   pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-    #   port - int64 - Port for remote server.
+    #   port - int64 - Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     #   upload_staging_path - string - Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
     #   remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
     #   s3_assume_role_arn - string - AWS IAM Role ARN for AssumeRole authentication.
@@ -1252,9 +1252,9 @@ module Files
     #   filebase_access_key - string - Filebase: Access Key.
     #   filebase_bucket - string - Filebase: Bucket name
     #   files_api_key - string - Files.com direct link: API key used once to pair the remote server.
-    #   files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
-    #   files_agent_root - string - Agent local root path
-    #   files_agent_version - string - Files Agent version
+    #   files_agent_permission_set - string - Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+    #   files_agent_root - string - Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+    #   files_agent_version - string - Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
     #   outbound_agent_id - int64 - Route traffic to outbound on a files-agent
     #   custom_domain_id - int64 - Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
     #   google_cloud_storage_authentication_method - string - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
@@ -1262,7 +1262,7 @@ module Files
     #   google_cloud_storage_oauth_scope - string - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
     #   google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
     #   google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
-    #   hostname - string - Hostname or IP address
+    #   hostname - string - Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     #   linode_access_key - string - Linode: Access Key
     #   linode_bucket - string - Linode: Bucket name
     #   linode_region - string - Linode: region
@@ -1270,7 +1270,7 @@ module Files
     #   name - string - Internal name for your reference
     #   one_drive_account_type - string - OneDrive: Either personal or business_other account types
     #   pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-    #   port - int64 - Port for remote server.
+    #   port - int64 - Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     #   upload_staging_path - string - Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
     #   remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
     #   s3_assume_role_arn - string - AWS IAM Role ARN for AssumeRole authentication.
@@ -1432,9 +1432,9 @@ module Files
     #   filebase_access_key - string - Filebase: Access Key.
     #   filebase_bucket - string - Filebase: Bucket name
     #   files_api_key - string - Files.com direct link: API key used once to pair the remote server.
-    #   files_agent_permission_set - string - Local permissions for files agent. read_only, write_only, or read_write
-    #   files_agent_root - string - Agent local root path
-    #   files_agent_version - string - Files Agent version
+    #   files_agent_permission_set - string - Agent file permissions: `read_only`, `write_only`, or `read_write`. Files.com writes this value as `permission_set` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the permissions in its local configuration file, controlled by the host's system administrator, and reports them at registration, replacing the stored value.
+    #   files_agent_root - string - Agent local root path. Files.com writes this value as `root` in the configuration file generated for this Remote Server. Setting it on Create or Update changes the generated file, not a running Agent. The Agent enforces the root in its local configuration file, controlled by the host's system administrator, and reports it at registration, replacing the stored value.
+    #   files_agent_version - string - Files.com Agent version reported by the Agent at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not update the running Agent.
     #   outbound_agent_id - int64 - Route traffic to outbound on a files-agent
     #   custom_domain_id - int64 - Custom Domain ID whose dedicated IP addresses are selected when this Remote Server uses dedicated IPs. Must be available to this Remote Server's workspace. Requires enable_dedicated_ips and cannot be combined with an outbound Agent. Set to null to use the site's default dedicated IPs.
     #   google_cloud_storage_authentication_method - string - Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
@@ -1442,7 +1442,7 @@ module Files
     #   google_cloud_storage_oauth_scope - string - Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
     #   google_cloud_storage_project_id - string - Google Cloud Storage: Project ID
     #   google_cloud_storage_s3_compatible_access_key - string - Google Cloud Storage: S3-compatible Access Key.
-    #   hostname - string - Hostname or IP address
+    #   hostname - string - Hostname or IP address. For Agent Remote Servers, the Agent reports the hostname it connects from at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     #   linode_access_key - string - Linode: Access Key
     #   linode_bucket - string - Linode: Bucket name
     #   linode_region - string - Linode: region
@@ -1450,7 +1450,7 @@ module Files
     #   name - string - Internal name for your reference
     #   one_drive_account_type - string - OneDrive: Either personal or business_other account types
     #   pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site.  This setting can also be overridden by a site-wide setting which will force it to true.
-    #   port - int64 - Port for remote server.
+    #   port - int64 - Port for remote server. For Agent Remote Servers, the Agent reports its downstream proxy port at each registration, replacing the stored value. This field is not included in the generated Agent configuration file. Setting it on Create or Update does not change the running Agent.
     #   upload_staging_path - string - Upload staging path.  Applies to SFTP only.  If a path is provided here, files will first be uploaded to this path on the remote folder and the moved into the final correct path via an SFTP move command.  This is required by some remote MFT systems to emulate atomic uploads, which are otherwise not supoprted by SFTP.
     #   remote_server_credential_id - int64 - ID of Remote Server Credential, if applicable.
     #   s3_assume_role_arn - string - AWS IAM Role ARN for AssumeRole authentication.

data/lib/files.com/models/site.rb

@@ -391,6 +391,11 @@ module Files
       @attributes[:fedramp]
     end
 
+    # boolean - Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.
+    def files_com_remote_server_enabled
+      @attributes[:files_com_remote_server_enabled]
+    end
+
     # boolean - Is FTP enabled?
     def ftp_enabled
       @attributes[:ftp_enabled]
@@ -1118,6 +1123,7 @@ module Files
     #   user_requests_enabled - boolean - Enable User Requests feature
     #   user_requests_notify_admins - boolean - Send email to site admins when a user request is received?
     #   dav_enabled - boolean - Is WebDAV enabled?
+    #   files_com_remote_server_enabled - boolean - Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.
     #   ftp_enabled - boolean - Is FTP enabled?
     #   s3_compatible_endpoint_enabled - boolean - Is the S3-compatible endpoint enabled for all users and workspaces on this site? Defaults to true. When false, user and group S3 permissions do not allow access.
     #   sftp_enabled - boolean - Is SFTP enabled?

data/lib/files.com/models/user.rb

@@ -653,7 +653,7 @@ module Files
       @attributes[:site_admin] = value
     end
 
-    # boolean - Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+    # boolean - Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
     def workspace_admin
       @attributes[:workspace_admin]
     end
@@ -671,7 +671,7 @@ module Files
       @attributes[:site_id] = value
     end
 
-    # int64 - Workspace ID
+    # int64 - ID of the Workspace the user belongs to. 0 is the Default Workspace.
     def workspace_id
       @attributes[:workspace_id]
     end
@@ -1014,7 +1014,7 @@ module Files
     #   time_zone - string - User time zone
     #   user_root - string - If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is site_root or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partner_root layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
     #   user_home - string - Home folder for FTP/SFTP. For users with the partner_root filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
-    #   workspace_admin - boolean - Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+    #   workspace_admin - boolean - Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
     #   username - string - User's username
     #   workspace_id - int64 - Workspace ID. Only Site Administrators can change this field. Values supplied by Workspace Administrators, Group Administrators, or other non-Site Administrators using `/user` are ignored.
     #   clear_2fa - boolean - If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
@@ -1214,9 +1214,9 @@ module Files
     #   time_zone - string - User time zone
     #   user_root - string - If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is site_root or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partner_root layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
     #   user_home - string - Home folder for FTP/SFTP. For users with the partner_root filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
-    #   workspace_admin - boolean - Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+    #   workspace_admin - boolean - Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
     #   username (required) - string - User's username
-    #   workspace_id - int64 - Workspace ID
+    #   workspace_id - int64 - ID of the Workspace the user belongs to. 0 is the Default Workspace.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: change_password must be an String") if params[:change_password] and !params[:change_password].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: change_password_confirmation must be an String") if params[:change_password_confirmation] and !params[:change_password_confirmation].is_a?(String)
@@ -1362,7 +1362,7 @@ module Files
     #   time_zone - string - User time zone
     #   user_root - string - If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is site_root or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partner_root layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
     #   user_home - string - Home folder for FTP/SFTP. For users with the partner_root filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
-    #   workspace_admin - boolean - Is the user a Workspace administrator?  Applicable only to the workspace ID related to this user, if one is set.
+    #   workspace_admin - boolean - Whether the user is an administrator of their own Custom Workspace. Does not reflect administration granted through Permissions.
     #   username - string - User's username
     #   workspace_id - int64 - Workspace ID. Only Site Administrators can change this field. Values supplied by Workspace Administrators, Group Administrators, or other non-Site Administrators using `/user` are ignored.
     #   clear_2fa - boolean - If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.

data/lib/files.com/models/user_sftp_client_use.rb

@@ -38,10 +38,12 @@ module Files
     #   user_id - int64 - User ID. If provided, will return uses for this 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).
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
 
       List.new(UserSftpClientUse, params) do
         Api.send_request("/user_sftp_client_uses", :get, params, options)

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.764"
+  VERSION = "1.1.766"
 end

data/spec/language_spec.rb

@@ -1,14 +1,28 @@
 require "spec_helper"
 
-RSpec.describe 'Language setting', :with_test_folder do
-  it 'sets the language' do
-    # Set language and verify
-    Files.language = 'es'
-    expect(Files.language).to eq('es')
-    begin
-      Files::File.find(test_folder.join("read.txt").to_s, {}, options)
-    rescue StandardError => e
-      expect(e.message).to include('No se ha encontrado')
-    end
+RSpec.describe "Language setting" do
+  around do |example|
+    old_language = Files.language
+    Files.language = nil
+    example.run
+  ensure
+    Files.language = old_language
+  end
+
+  let(:client) { Files::ApiClient.new }
+
+  it "sends the configured language as the Accept-Language header" do
+    Files.language = "es"
+
+    headers = client.send(:request_headers, "api-key", nil, :get, nil)
+
+    expect(Files.language).to eq("es")
+    expect(headers["Accept-Language"]).to eq("es")
+  end
+
+  it "omits the Accept-Language header when unset" do
+    headers = client.send(:request_headers, "api-key", nil, :get, nil)
+
+    expect(headers).not_to have_key("Accept-Language")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.764
+  version: 1.1.766
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-10-02 00:00:00.000000000 Z
+date: 2026-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable