files.com 1.2.16 → 1.2.18

package/README.md

@@ -2,6 +2,7 @@
 
 The Files.com JavaScript SDK provides convenient access to the Files.com API from applications written in JavaScript.
 
+
 ## Installation
 
 To install the package:
@@ -12,8 +13,10 @@ or
 
     npm install files.com
 
+
 ## Usage
 
+
 ### Import and initialize
 
 ```js
@@ -23,6 +26,7 @@ import Files from "files.com/lib/Files.js";
 Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");
 ```
 
+
 #### `require()` vs. `import`
 
 The examples provided in the documentation here use the newer ES6 `import` syntax. To
@@ -37,9 +41,11 @@ const User = require("files.com/lib/models/User.js").default;
 const { LogLevel } = require("files.com/lib/Logger.js").default;
 ```
 
+
 ### Authentication
 
-There are multiple ways to authenticate to the API.
+There are multiple ways to authenticate to the Files.com SDK for Javascript.
+
 
 #### Global API Key
 
@@ -47,6 +53,7 @@ You can set an API key globally like this:
 
     Files.setApiKey('my-api-key')
 
+
 #### Per-Request API Key
 
 Or, you can pass an API key per-request, in the options object at the end of every method like this:
@@ -54,6 +61,7 @@ Or, you can pass an API key per-request, in the options object at the end of eve
     import User from 'files.com/lib/models/User.js'
     const user = new User(params, { apiKey: 'my-api-key' })
 
+
 #### User Session
 
 Or, you can open a user session by calling `Session.create()`
@@ -70,10 +78,12 @@ Or, you can pass the session ID per-request, in the options array at the end of
     import User from 'files.com/lib/models/User.js'
     const user = new User(params, { sessionId: session.id })
 
+
 ### Setting Global Options
 
 You can set the following global properties using static methods on the `Files` class:
 
+
 #### Log Level
 
     import { LogLevel } from 'files.com/lib/Logger.js'
@@ -88,6 +98,7 @@ You can set the following global properties using static methods on the `Files`
       LogLevel.DEBUG
     */
 
+
 #### Debugging
 
     Files.configureDebugging({
@@ -98,6 +109,7 @@ You can set the following global properties using static methods on the `Files`
       debugResponseHeaders: false,
     })
 
+
 #### Network
 
     Files.configureNetwork({
@@ -117,13 +129,16 @@ You can set the following global properties using static methods on the `Files`
       autoPaginate: true,
     })
 
+
 ### File Operations
 
+
 #### List root folder
 
     import Folder from 'files.com/lib/models/Folder.js'
     const dirFiles = await Folder.listFor('/')
 
+
 #### Uploading a file
 
     import File from 'files.com/lib/models/File.js'
@@ -137,6 +152,7 @@ You can set the following global properties using static methods on the `Files`
       await File.uploadFile(destinationFileName, sourceFilePath)
     }
 
+
 #### Downloading a file
 
 ##### Get a downloadable file object by path
@@ -146,6 +162,7 @@ You can set the following global properties using static methods on the `Files`
     const foundFile = await File.find(remoteFilePath)
     const downloadableFile = await foundFile.download()
 
+
 ##### Download a file (not available in browser)
 
     import { isBrowser } from 'files.com/lib/utils.js'
@@ -161,6 +178,7 @@ You can set the following global properties using static methods on the `Files`
       const textContent = await downloadableFile.downloadToString()
     }
 
+
 #### Comparing Case insensitive files and paths
 
 For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
@@ -171,13 +189,14 @@ For related documentation see [Case Sensitivity Documentation](https://www.files
       // the paths are the same
     }
 
+
 ### Additional Object Documentation
 
 Additional docs are available at <https://developers.files.com>
 
+
 ## Getting Support
 
 The Files.com team is happy to help with any SDK Integration challenges you may face.
 
 Just email <support@files.com> and we'll get the process started.
-

package/_VERSION

@@ -1 +1 @@
-1.2.16
+1.2.18

package/docs/models/Site.md

@@ -137,6 +137,7 @@
   "phone": "555-555-5555",
   "pin_all_remote_servers_to_site_region": true,
   "prevent_root_permissions_for_non_site_admins": true,
+  "protocol_access_groups_only": true,
   "require_2fa": true,
   "require_2fa_stop_time": "2000-01-01T01:00:00Z",
   "require_2fa_user_type": "`site_admins`",
@@ -377,6 +378,7 @@
 * `phone` (string): Site phone number
 * `pin_all_remote_servers_to_site_region` (boolean): If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
 * `prevent_root_permissions_for_non_site_admins` (boolean): If true, we will prevent non-administrators from receiving any permissions directly on the root folder.  This is commonly used to prevent the accidental application of permissions.
+* `protocol_access_groups_only` (boolean): If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
 * `require_2fa` (boolean): Require two-factor authentication for all users?
 * `require_2fa_stop_time` (date-time): If set, requirement for two-factor authentication has been scheduled to end on this date-time.
 * `require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
@@ -673,7 +675,7 @@ await Site.update({
 * `sftp_enabled` (boolean): Is SFTP enabled?
 * `sftp_host_key_type` (string): Sftp Host Key Type
 * `active_sftp_host_key_id` (int64): Id of the currently selected custom SFTP Host Key
-* `protocol_access_groups_only` (boolean): If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
+* `protocol_access_groups_only` (boolean): If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
 * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
 * `group_admins_can_set_user_password` (boolean): Allow group admins set password authentication method
 * `bundle_recipient_blacklist_free_email_domains` (boolean): Disallow free email domains for Bundle/Inbox recipients?

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.16';
+var version = '1.2.18';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Site.js

@@ -465,6 +465,10 @@ var Site = /*#__PURE__*/(0, _createClass2.default)(function Site() {
   (0, _defineProperty2.default)(this, "getPreventRootPermissionsForNonSiteAdmins", function () {
     return _this.attributes.prevent_root_permissions_for_non_site_admins;
   });
+  // boolean # If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
+  (0, _defineProperty2.default)(this, "getProtocolAccessGroupsOnly", function () {
+    return _this.attributes.protocol_access_groups_only;
+  });
   // boolean # Require two-factor authentication for all users?
   (0, _defineProperty2.default)(this, "getRequire2fa", function () {
     return _this.attributes.require_2fa;
@@ -780,7 +784,7 @@ _Site = Site;
 //   sftp_enabled - boolean - Is SFTP enabled?
 //   sftp_host_key_type - string - Sftp Host Key Type
 //   active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key
-//   protocol_access_groups_only - boolean - If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
+//   protocol_access_groups_only - boolean - If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
 //   bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
 //   group_admins_can_set_user_password - boolean - Allow group admins set password authentication method
 //   bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.16",
+  "version": "1.2.18",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.16'
+const version = '1.2.18'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Site.js

@@ -352,6 +352,9 @@ class Site {
   // boolean # If true, we will prevent non-administrators from receiving any permissions directly on the root folder.  This is commonly used to prevent the accidental application of permissions.
   getPreventRootPermissionsForNonSiteAdmins = () => this.attributes.prevent_root_permissions_for_non_site_admins
 
+  // boolean # If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
+  getProtocolAccessGroupsOnly = () => this.attributes.protocol_access_groups_only
+
   // boolean # Require two-factor authentication for all users?
   getRequire2fa = () => this.attributes.require_2fa
 
@@ -582,7 +585,7 @@ class Site {
   //   sftp_enabled - boolean - Is SFTP enabled?
   //   sftp_host_key_type - string - Sftp Host Key Type
   //   active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key
-  //   protocol_access_groups_only - boolean - If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
+  //   protocol_access_groups_only - boolean - If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
   //   bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
   //   group_admins_can_set_user_password - boolean - Allow group admins set password authentication method
   //   bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients?