files.com 1.2.15 → 1.2.17

package/_VERSION

@@ -1 +1 @@
-1.2.15
+1.2.17

package/docs/models/AutomationRun.md

@@ -8,7 +8,11 @@
   "automation_id": 1,
   "completed_at": "2000-01-01T01:00:00Z",
   "created_at": "2000-01-01T01:00:00Z",
+  "runtime": "2000-01-01T01:00:00Z",
   "status": "success",
+  "run_stage": "planning",
+  "successful_operations": 1,
+  "failed_operations": 1,
   "status_messages_url": "https://www.example.com/log_file.txt"
 }
 ```
@@ -17,7 +21,11 @@
 * `automation_id` (int64): ID of the associated Automation.
 * `completed_at` (date-time): Automation run completion/failure date/time.
 * `created_at` (date-time): Automation run start date/time.
+* `runtime` (date-time): Automation run runtime.
 * `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
+* `run_stage` (string): The stage currently being executed in the execution environment.  One of `queued_for_planning`, `planning`, `queued_for_execution`, `executing`, or `finished`.
+* `successful_operations` (int64): Count of successful operations.
+* `failed_operations` (int64): Count of failed operations.
 * `status_messages_url` (string): Link to status messages log file.
 
 ---

package/docs/models/Notification.md

@@ -38,21 +38,21 @@
 
 * `id` (int64): Notification ID
 * `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
-* `group_id` (int64): Notification group id
-* `group_name` (string): Group name if applicable
-* `triggering_group_ids` (array): Only notify on actions made by a member of one of the specified groups
-* `triggering_user_ids` (array): Only notify on actions made one of the specified users
+* `group_id` (int64): ID of Group to receive notifications
+* `group_name` (string): Group name, if a Group ID is set
+* `triggering_group_ids` (array): If set, will only notify on actions made by a member of one of the specified groups
+* `triggering_user_ids` (array): If set, will onlynotify on actions made one of the specified users
 * `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
-* `notify_user_actions` (boolean): Trigger notification on notification user actions?
-* `notify_on_copy` (boolean): Triggers notification when copying files to this path
-* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
-* `notify_on_download` (boolean): Triggers notification when downloading files from this path
-* `notify_on_move` (boolean): Triggers notification when moving files to this path
-* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
-* `recursive` (boolean): Enable notifications for each subfolder in this path
+* `notify_user_actions` (boolean): If true, will send notifications about a user's own activity to that user.  If false, only activity performed by other users (or anonymous users) will be sent in notifications.
+* `notify_on_copy` (boolean): Trigger on files copied to this path?
+* `notify_on_delete` (boolean): Trigger on files deleted in this path?
+* `notify_on_download` (boolean): Trigger on files downloaded in this path?
+* `notify_on_move` (boolean): Trigger on files moved to this path?
+* `notify_on_upload` (boolean): Trigger on files created/uploaded/updated/changed in this path?
+* `recursive` (boolean): Apply notification recursively?  This will enable notifications for each subfolder.
 * `send_interval` (string): The time interval that notifications are aggregated to
-* `message` (string): Custom message to include in notification emails.
-* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to match for action path
+* `message` (string): Custom message to include in notification emails
+* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to scope trigger
 * `unsubscribed` (boolean): Is the user unsubscribed from this notification?
 * `unsubscribed_reason` (string): The reason that the user unsubscribed
 * `user_id` (int64): Notification user ID
@@ -128,17 +128,17 @@ await Notification.create({
 
 * `user_id` (int64): The id of the user to notify. Provide `user_id`, `username` or `group_id`.
 * `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
-* `notify_on_download` (boolean): Triggers notification when downloading files from this path
-* `notify_on_move` (boolean): Triggers notification when moving files to this path
-* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
+* `notify_on_delete` (boolean): Trigger on files deleted in this path?
+* `notify_on_download` (boolean): Trigger on files downloaded in this path?
+* `notify_on_move` (boolean): Trigger on files moved to this path?
+* `notify_on_upload` (boolean): Trigger on files created/uploaded/updated/changed in this path?
 * `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
 * `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
 * `send_interval` (string): The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
-* `message` (string): Custom message to include in notification emails.
-* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to match for action path
-* `triggering_group_ids` (array(int64)): Only notify on actions made by a member of one of the specified groups
-* `triggering_user_ids` (array(int64)): Only notify on actions made one of the specified users
+* `message` (string): Custom message to include in notification emails
+* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
+* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
+* `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
 * `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
 * `group_id` (int64): The ID of the group to notify.  Provide `user_id`, `username` or `group_id`.
 * `path` (string): Path
@@ -172,17 +172,17 @@ await notification.update({
 
 * `id` (int64): Required - Notification ID.
 * `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
-* `notify_on_download` (boolean): Triggers notification when downloading files from this path
-* `notify_on_move` (boolean): Triggers notification when moving files to this path
-* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
+* `notify_on_delete` (boolean): Trigger on files deleted in this path?
+* `notify_on_download` (boolean): Trigger on files downloaded in this path?
+* `notify_on_move` (boolean): Trigger on files moved to this path?
+* `notify_on_upload` (boolean): Trigger on files created/uploaded/updated/changed in this path?
 * `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
 * `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
 * `send_interval` (string): The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
-* `message` (string): Custom message to include in notification emails.
-* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to match for action path
-* `triggering_group_ids` (array(int64)): Only notify on actions made by a member of one of the specified groups
-* `triggering_user_ids` (array(int64)): Only notify on actions made one of the specified users
+* `message` (string): Custom message to include in notification emails
+* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
+* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
+* `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
 * `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
 
 ### Example Response

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.15';
+var version = '1.2.17';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/AutomationRun.js

@@ -49,10 +49,26 @@ var AutomationRun = /*#__PURE__*/(0, _createClass2.default)(function AutomationR
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
+  // date-time # Automation run runtime.
+  (0, _defineProperty2.default)(this, "getRuntime", function () {
+    return _this.attributes.runtime;
+  });
   // string # The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
+  // string # The stage currently being executed in the execution environment.  One of `queued_for_planning`, `planning`, `queued_for_execution`, `executing`, or `finished`.
+  (0, _defineProperty2.default)(this, "getRunStage", function () {
+    return _this.attributes.run_stage;
+  });
+  // int64 # Count of successful operations.
+  (0, _defineProperty2.default)(this, "getSuccessfulOperations", function () {
+    return _this.attributes.successful_operations;
+  });
+  // int64 # Count of failed operations.
+  (0, _defineProperty2.default)(this, "getFailedOperations", function () {
+    return _this.attributes.failed_operations;
+  });
   // string # Link to status messages log file.
   (0, _defineProperty2.default)(this, "getStatusMessagesUrl", function () {
     return _this.attributes.status_messages_url;

package/lib/models/Notification.js

@@ -47,28 +47,28 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
   (0, _defineProperty2.default)(this, "setPath", function (value) {
     _this.attributes.path = value;
   });
-  // int64 # Notification group id
+  // int64 # ID of Group to receive notifications
   (0, _defineProperty2.default)(this, "getGroupId", function () {
     return _this.attributes.group_id;
   });
   (0, _defineProperty2.default)(this, "setGroupId", function (value) {
     _this.attributes.group_id = value;
   });
-  // string # Group name if applicable
+  // string # Group name, if a Group ID is set
   (0, _defineProperty2.default)(this, "getGroupName", function () {
     return _this.attributes.group_name;
   });
   (0, _defineProperty2.default)(this, "setGroupName", function (value) {
     _this.attributes.group_name = value;
   });
-  // array # Only notify on actions made by a member of one of the specified groups
+  // array # If set, will only notify on actions made by a member of one of the specified groups
   (0, _defineProperty2.default)(this, "getTriggeringGroupIds", function () {
     return _this.attributes.triggering_group_ids;
   });
   (0, _defineProperty2.default)(this, "setTriggeringGroupIds", function (value) {
     _this.attributes.triggering_group_ids = value;
   });
-  // array # Only notify on actions made one of the specified users
+  // array # If set, will onlynotify on actions made one of the specified users
   (0, _defineProperty2.default)(this, "getTriggeringUserIds", function () {
     return _this.attributes.triggering_user_ids;
   });
@@ -82,49 +82,49 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
   (0, _defineProperty2.default)(this, "setTriggerByShareRecipients", function (value) {
     _this.attributes.trigger_by_share_recipients = value;
   });
-  // boolean # Trigger notification on notification user actions?
+  // boolean # If true, will send notifications about a user's own activity to that user.  If false, only activity performed by other users (or anonymous users) will be sent in notifications.
   (0, _defineProperty2.default)(this, "getNotifyUserActions", function () {
     return _this.attributes.notify_user_actions;
   });
   (0, _defineProperty2.default)(this, "setNotifyUserActions", function (value) {
     _this.attributes.notify_user_actions = value;
   });
-  // boolean # Triggers notification when copying files to this path
+  // boolean # Trigger on files copied to this path?
   (0, _defineProperty2.default)(this, "getNotifyOnCopy", function () {
     return _this.attributes.notify_on_copy;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnCopy", function (value) {
     _this.attributes.notify_on_copy = value;
   });
-  // boolean # Triggers notification when deleting files from this path
+  // boolean # Trigger on files deleted in this path?
   (0, _defineProperty2.default)(this, "getNotifyOnDelete", function () {
     return _this.attributes.notify_on_delete;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnDelete", function (value) {
     _this.attributes.notify_on_delete = value;
   });
-  // boolean # Triggers notification when downloading files from this path
+  // boolean # Trigger on files downloaded in this path?
   (0, _defineProperty2.default)(this, "getNotifyOnDownload", function () {
     return _this.attributes.notify_on_download;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnDownload", function (value) {
     _this.attributes.notify_on_download = value;
   });
-  // boolean # Triggers notification when moving files to this path
+  // boolean # Trigger on files moved to this path?
   (0, _defineProperty2.default)(this, "getNotifyOnMove", function () {
     return _this.attributes.notify_on_move;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnMove", function (value) {
     _this.attributes.notify_on_move = value;
   });
-  // boolean # Triggers notification when uploading new files to this path
+  // boolean # Trigger on files created/uploaded/updated/changed in this path?
   (0, _defineProperty2.default)(this, "getNotifyOnUpload", function () {
     return _this.attributes.notify_on_upload;
   });
   (0, _defineProperty2.default)(this, "setNotifyOnUpload", function (value) {
     _this.attributes.notify_on_upload = value;
   });
-  // boolean # Enable notifications for each subfolder in this path
+  // boolean # Apply notification recursively?  This will enable notifications for each subfolder.
   (0, _defineProperty2.default)(this, "getRecursive", function () {
     return _this.attributes.recursive;
   });
@@ -138,14 +138,14 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
   (0, _defineProperty2.default)(this, "setSendInterval", function (value) {
     _this.attributes.send_interval = value;
   });
-  // string # Custom message to include in notification emails.
+  // string # Custom message to include in notification emails
   (0, _defineProperty2.default)(this, "getMessage", function () {
     return _this.attributes.message;
   });
   (0, _defineProperty2.default)(this, "setMessage", function (value) {
     _this.attributes.message = value;
   });
-  // array # Array of filenames (possibly with wildcards) to match for action path
+  // array # Array of filenames (possibly with wildcards) to scope trigger
   (0, _defineProperty2.default)(this, "getTriggeringFilenames", function () {
     return _this.attributes.triggering_filenames;
   });
@@ -189,17 +189,17 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
   });
   // Parameters:
   //   notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-  //   notify_on_delete - boolean - Triggers notification when deleting files from this path
-  //   notify_on_download - boolean - Triggers notification when downloading files from this path
-  //   notify_on_move - boolean - Triggers notification when moving files to this path
-  //   notify_on_upload - boolean - Triggers notification when uploading new files to this path
+  //   notify_on_delete - boolean - Trigger on files deleted in this path?
+  //   notify_on_download - boolean - Trigger on files downloaded in this path?
+  //   notify_on_move - boolean - Trigger on files moved to this path?
+  //   notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
   //   notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
   //   recursive - boolean - If `true`, enable notifications for each subfolder in this path
   //   send_interval - string - The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
-  //   message - string - Custom message to include in notification emails.
-  //   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
-  //   triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
-  //   triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
+  //   message - string - Custom message to include in notification emails
+  //   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
+  //   triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
+  //   triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
   //   trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
@@ -501,17 +501,17 @@ _Notification = Notification;
 // Parameters:
 //   user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
 //   notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-//   notify_on_delete - boolean - Triggers notification when deleting files from this path
-//   notify_on_download - boolean - Triggers notification when downloading files from this path
-//   notify_on_move - boolean - Triggers notification when moving files to this path
-//   notify_on_upload - boolean - Triggers notification when uploading new files to this path
+//   notify_on_delete - boolean - Trigger on files deleted in this path?
+//   notify_on_download - boolean - Trigger on files downloaded in this path?
+//   notify_on_move - boolean - Trigger on files moved to this path?
+//   notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
 //   notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
 //   recursive - boolean - If `true`, enable notifications for each subfolder in this path
 //   send_interval - string - The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
-//   message - string - Custom message to include in notification emails.
-//   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
-//   triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
-//   triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
+//   message - string - Custom message to include in notification emails
+//   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
+//   triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
+//   triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
 //   trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
 //   group_id - int64 - The ID of the group to notify.  Provide `user_id`, `username` or `group_id`.
 //   path - string - Path

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.15",
+  "version": "1.2.17",
   "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.15'
+const version = '1.2.17'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/AutomationRun.js

@@ -40,9 +40,21 @@ class AutomationRun {
   // date-time # Automation run start date/time.
   getCreatedAt = () => this.attributes.created_at
 
+  // date-time # Automation run runtime.
+  getRuntime = () => this.attributes.runtime
+
   // string # The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
   getStatus = () => this.attributes.status
 
+  // string # The stage currently being executed in the execution environment.  One of `queued_for_planning`, `planning`, `queued_for_execution`, `executing`, or `finished`.
+  getRunStage = () => this.attributes.run_stage
+
+  // int64 # Count of successful operations.
+  getSuccessfulOperations = () => this.attributes.successful_operations
+
+  // int64 # Count of failed operations.
+  getFailedOperations = () => this.attributes.failed_operations
+
   // string # Link to status messages log file.
   getStatusMessagesUrl = () => this.attributes.status_messages_url
 

package/src/models/Notification.js

@@ -42,28 +42,28 @@ class Notification {
     this.attributes.path = value
   }
 
-  // int64 # Notification group id
+  // int64 # ID of Group to receive notifications
   getGroupId = () => this.attributes.group_id
 
   setGroupId = value => {
     this.attributes.group_id = value
   }
 
-  // string # Group name if applicable
+  // string # Group name, if a Group ID is set
   getGroupName = () => this.attributes.group_name
 
   setGroupName = value => {
     this.attributes.group_name = value
   }
 
-  // array # Only notify on actions made by a member of one of the specified groups
+  // array # If set, will only notify on actions made by a member of one of the specified groups
   getTriggeringGroupIds = () => this.attributes.triggering_group_ids
 
   setTriggeringGroupIds = value => {
     this.attributes.triggering_group_ids = value
   }
 
-  // array # Only notify on actions made one of the specified users
+  // array # If set, will onlynotify on actions made one of the specified users
   getTriggeringUserIds = () => this.attributes.triggering_user_ids
 
   setTriggeringUserIds = value => {
@@ -77,49 +77,49 @@ class Notification {
     this.attributes.trigger_by_share_recipients = value
   }
 
-  // boolean # Trigger notification on notification user actions?
+  // boolean # If true, will send notifications about a user's own activity to that user.  If false, only activity performed by other users (or anonymous users) will be sent in notifications.
   getNotifyUserActions = () => this.attributes.notify_user_actions
 
   setNotifyUserActions = value => {
     this.attributes.notify_user_actions = value
   }
 
-  // boolean # Triggers notification when copying files to this path
+  // boolean # Trigger on files copied to this path?
   getNotifyOnCopy = () => this.attributes.notify_on_copy
 
   setNotifyOnCopy = value => {
     this.attributes.notify_on_copy = value
   }
 
-  // boolean # Triggers notification when deleting files from this path
+  // boolean # Trigger on files deleted in this path?
   getNotifyOnDelete = () => this.attributes.notify_on_delete
 
   setNotifyOnDelete = value => {
     this.attributes.notify_on_delete = value
   }
 
-  // boolean # Triggers notification when downloading files from this path
+  // boolean # Trigger on files downloaded in this path?
   getNotifyOnDownload = () => this.attributes.notify_on_download
 
   setNotifyOnDownload = value => {
     this.attributes.notify_on_download = value
   }
 
-  // boolean # Triggers notification when moving files to this path
+  // boolean # Trigger on files moved to this path?
   getNotifyOnMove = () => this.attributes.notify_on_move
 
   setNotifyOnMove = value => {
     this.attributes.notify_on_move = value
   }
 
-  // boolean # Triggers notification when uploading new files to this path
+  // boolean # Trigger on files created/uploaded/updated/changed in this path?
   getNotifyOnUpload = () => this.attributes.notify_on_upload
 
   setNotifyOnUpload = value => {
     this.attributes.notify_on_upload = value
   }
 
-  // boolean # Enable notifications for each subfolder in this path
+  // boolean # Apply notification recursively?  This will enable notifications for each subfolder.
   getRecursive = () => this.attributes.recursive
 
   setRecursive = value => {
@@ -133,14 +133,14 @@ class Notification {
     this.attributes.send_interval = value
   }
 
-  // string # Custom message to include in notification emails.
+  // string # Custom message to include in notification emails
   getMessage = () => this.attributes.message
 
   setMessage = value => {
     this.attributes.message = value
   }
 
-  // array # Array of filenames (possibly with wildcards) to match for action path
+  // array # Array of filenames (possibly with wildcards) to scope trigger
   getTriggeringFilenames = () => this.attributes.triggering_filenames
 
   setTriggeringFilenames = value => {
@@ -184,17 +184,17 @@ class Notification {
 
   // Parameters:
   //   notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-  //   notify_on_delete - boolean - Triggers notification when deleting files from this path
-  //   notify_on_download - boolean - Triggers notification when downloading files from this path
-  //   notify_on_move - boolean - Triggers notification when moving files to this path
-  //   notify_on_upload - boolean - Triggers notification when uploading new files to this path
+  //   notify_on_delete - boolean - Trigger on files deleted in this path?
+  //   notify_on_download - boolean - Trigger on files downloaded in this path?
+  //   notify_on_move - boolean - Trigger on files moved to this path?
+  //   notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
   //   notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
   //   recursive - boolean - If `true`, enable notifications for each subfolder in this path
   //   send_interval - string - The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
-  //   message - string - Custom message to include in notification emails.
-  //   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
-  //   triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
-  //   triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
+  //   message - string - Custom message to include in notification emails
+  //   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
+  //   triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
+  //   triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
   //   trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
   update = async (params = {}) => {
     if (!this.attributes.id) {
@@ -350,17 +350,17 @@ class Notification {
   // Parameters:
   //   user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
   //   notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-  //   notify_on_delete - boolean - Triggers notification when deleting files from this path
-  //   notify_on_download - boolean - Triggers notification when downloading files from this path
-  //   notify_on_move - boolean - Triggers notification when moving files to this path
-  //   notify_on_upload - boolean - Triggers notification when uploading new files to this path
+  //   notify_on_delete - boolean - Trigger on files deleted in this path?
+  //   notify_on_download - boolean - Trigger on files downloaded in this path?
+  //   notify_on_move - boolean - Trigger on files moved to this path?
+  //   notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
   //   notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
   //   recursive - boolean - If `true`, enable notifications for each subfolder in this path
   //   send_interval - string - The time interval that notifications are aggregated by.  Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
-  //   message - string - Custom message to include in notification emails.
-  //   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
-  //   triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
-  //   triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
+  //   message - string - Custom message to include in notification emails
+  //   triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
+  //   triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
+  //   triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
   //   trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
   //   group_id - int64 - The ID of the group to notify.  Provide `user_id`, `username` or `group_id`.
   //   path - string - Path

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?