files.com 1.2.321 → 1.2.323

package/src/models/SyncRun.js

@@ -31,26 +31,11 @@ class SyncRun {
   // int64 # SyncRun ID
   getId = () => this.attributes.id
 
-  // int64 # ID of the Sync this run belongs to
-  getSyncId = () => this.attributes.sync_id
-
-  // int64 # Site ID
-  getSiteId = () => this.attributes.site_id
-
-  // string # Status of the sync run (success, failure, partial_failure, in_progress, skipped)
-  getStatus = () => this.attributes.status
-
-  // string # Source remote server type, if any
-  getSrcRemoteServerType = () => this.attributes.src_remote_server_type
-
-  // string # Destination remote server type, if any
-  getDestRemoteServerType = () => this.attributes.dest_remote_server_type
-
   // string # Log or summary body for this run
   getBody = () => this.attributes.body
 
-  // array(string) # Array of errors encountered during the run
-  getEventErrors = () => this.attributes.event_errors
+  // int64 # Total bytes synced in this run
+  getBytesSynced = () => this.attributes.bytes_synced
 
   // int64 # Number of files compared
   getComparedFiles = () => this.attributes.compared_files
@@ -58,32 +43,50 @@ class SyncRun {
   // int64 # Number of folders compared
   getComparedFolders = () => this.attributes.compared_folders
 
+  // date-time # When this run was completed
+  getCompletedAt = () => this.attributes.completed_at
+
+  // date-time # When this run was created
+  getCreatedAt = () => this.attributes.created_at
+
+  // string # Destination remote server type, if any
+  getDestRemoteServerType = () => this.attributes.dest_remote_server_type
+
+  // boolean # Whether this run was a dry run (no actual changes made)
+  getDryRun = () => this.attributes.dry_run
+
   // int64 # Number of files that errored
   getErroredFiles = () => this.attributes.errored_files
 
-  // int64 # Number of files successfully synced
-  getSuccessfulFiles = () => this.attributes.successful_files
+  // int64 # Estimated bytes count for this run
+  getEstimatedBytesCount = () => this.attributes.estimated_bytes_count
 
-  // double # Total runtime in seconds
-  getRuntime = () => this.attributes.runtime
+  // array(string) # Array of errors encountered during the run
+  getEventErrors = () => this.attributes.event_errors
 
   // string # Link to external log file.
   getLogUrl = () => this.attributes.log_url
 
-  // date-time # When this run was completed
-  getCompletedAt = () => this.attributes.completed_at
+  // double # Total runtime in seconds
+  getRuntime = () => this.attributes.runtime
 
-  // boolean # Whether this run was a dry run (no actual changes made)
-  getDryRun = () => this.attributes.dry_run
+  // int64 # Site ID
+  getSiteId = () => this.attributes.site_id
 
-  // int64 # Total bytes synced in this run
-  getBytesSynced = () => this.attributes.bytes_synced
+  // string # Source remote server type, if any
+  getSrcRemoteServerType = () => this.attributes.src_remote_server_type
 
-  // int64 # Estimated bytes count for this run
-  getEstimatedBytesCount = () => this.attributes.estimated_bytes_count
+  // string # Status of the sync run (success, failure, partial_failure, in_progress, skipped)
+  getStatus = () => this.attributes.status
 
-  // date-time # When this run was created
-  getCreatedAt = () => this.attributes.created_at
+  // int64 # Number of files successfully synced
+  getSuccessfulFiles = () => this.attributes.successful_files
+
+  // int64 # ID of the Sync this run belongs to
+  getSyncId = () => this.attributes.sync_id
+
+  // string # Name of the Sync this run belongs to
+  getSyncName = () => this.attributes.sync_name
 
   // date-time # When this run was last updated
   getUpdatedAt = () => this.attributes.updated_at

package/src/models/User.js

@@ -458,6 +458,13 @@ class User {
     this.attributes.externally_managed = value
   }
 
+  // string # Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
+  getTags = () => this.attributes.tags
+
+  setTags = value => {
+    this.attributes.tags = value
+  }
+
   // string # User time zone
   getTimeZone = () => this.attributes.time_zone
 
@@ -709,6 +716,7 @@ class User {
   //   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
   //   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
   //   require_2fa - string - 2FA required setting
+  //   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
   //   time_zone - string - User time zone
   //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
   //   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
@@ -828,6 +836,10 @@ class User {
       throw new errors.InvalidParameterError(`Bad parameter: require_2fa must be of type String, received ${getType(params.require_2fa)}`)
     }
 
+    if (params.tags && !isString(params.tags)) {
+      throw new errors.InvalidParameterError(`Bad parameter: tags must be of type String, received ${getType(params.tags)}`)
+    }
+
     if (params.time_zone && !isString(params.time_zone)) {
       throw new errors.InvalidParameterError(`Bad parameter: time_zone must be of type String, received ${getType(params.time_zone)}`)
     }
@@ -907,7 +919,7 @@ class 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: 10,000, 1,000 or less is recommended).
   //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
-  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin` or `disabled`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
+  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
   //   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
   //   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
   //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
@@ -1013,6 +1025,7 @@ class User {
   //   sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
   //   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
   //   require_2fa - string - 2FA required setting
+  //   tags - string - Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
   //   time_zone - string - User time zone
   //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
   //   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
@@ -1122,6 +1135,10 @@ class User {
       throw new errors.InvalidParameterError(`Bad parameter: require_2fa must be of type String, received ${getType(params.require_2fa)}`)
     }
 
+    if (params.tags && !isString(params.tags)) {
+      throw new errors.InvalidParameterError(`Bad parameter: tags must be of type String, received ${getType(params.tags)}`)
+    }
+
     if (params.time_zone && !isString(params.time_zone)) {
       throw new errors.InvalidParameterError(`Bad parameter: time_zone must be of type String, received ${getType(params.time_zone)}`)
     }

package/src/models/UserLifecycleRule.js

@@ -35,7 +35,7 @@ class UserLifecycleRule {
     this.attributes.id = value
   }
 
-  // string # User authentication method for the rule
+  // string # User authentication method for which the rule will apply.
   getAuthenticationMethod = () => this.attributes.authentication_method
 
   setAuthenticationMethod = value => {
@@ -49,6 +49,13 @@ class UserLifecycleRule {
     this.attributes.group_ids = value
   }
 
+  // string # Action to take on inactive users (disable or delete)
+  getAction = () => this.attributes.action
+
+  setAction = value => {
+    this.attributes.action = value
+  }
+
   // int64 # Number of days of inactivity before the rule applies
   getInactivityDays = () => this.attributes.inactivity_days
 
@@ -56,34 +63,20 @@ class UserLifecycleRule {
     this.attributes.inactivity_days = value
   }
 
-  // boolean # Include folder admins in the rule
+  // boolean # If true, the rule will apply to folder admins.
   getIncludeFolderAdmins = () => this.attributes.include_folder_admins
 
   setIncludeFolderAdmins = value => {
     this.attributes.include_folder_admins = value
   }
 
-  // boolean # Include site admins in the rule
+  // boolean # If true, the rule will apply to site admins.
   getIncludeSiteAdmins = () => this.attributes.include_site_admins
 
   setIncludeSiteAdmins = value => {
     this.attributes.include_site_admins = value
   }
 
-  // string # Action to take on inactive users (disable or delete)
-  getAction = () => this.attributes.action
-
-  setAction = value => {
-    this.attributes.action = value
-  }
-
-  // string # State of the users to apply the rule to (inactive or disabled)
-  getUserState = () => this.attributes.user_state
-
-  setUserState = value => {
-    this.attributes.user_state = value
-  }
-
   // string # User Lifecycle Rule name
   getName = () => this.attributes.name
 
@@ -91,6 +84,13 @@ class UserLifecycleRule {
     this.attributes.name = value
   }
 
+  // string # If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
+  getPartnerTag = () => this.attributes.partner_tag
+
+  setPartnerTag = value => {
+    this.attributes.partner_tag = value
+  }
+
   // int64 # Site ID
   getSiteId = () => this.attributes.site_id
 
@@ -98,15 +98,31 @@ class UserLifecycleRule {
     this.attributes.site_id = value
   }
 
+  // string # State of the users to apply the rule to (inactive or disabled)
+  getUserState = () => this.attributes.user_state
+
+  setUserState = value => {
+    this.attributes.user_state = value
+  }
+
+  // string # If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
+  getUserTag = () => this.attributes.user_tag
+
+  setUserTag = value => {
+    this.attributes.user_tag = value
+  }
+
   // Parameters:
   //   action - string - Action to take on inactive users (disable or delete)
-  //   authentication_method - string - User authentication method for the rule
+  //   authentication_method - string - User authentication method for which the rule will apply.
   //   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
   //   inactivity_days - int64 - Number of days of inactivity before the rule applies
-  //   include_site_admins - boolean - Include site admins in the rule
-  //   include_folder_admins - boolean - Include folder admins in the rule
-  //   user_state - string - State of the users to apply the rule to (inactive or disabled)
+  //   include_site_admins - boolean - If true, the rule will apply to site admins.
+  //   include_folder_admins - boolean - If true, the rule will apply to folder admins.
   //   name - string - User Lifecycle Rule name
+  //   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
+  //   user_state - string - State of the users to apply the rule to (inactive or disabled)
+  //   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
   update = async (params = {}) => {
     if (!this.attributes.id) {
       throw new errors.EmptyPropertyError('Current object has no id')
@@ -137,12 +153,20 @@ class UserLifecycleRule {
       throw new errors.InvalidParameterError(`Bad parameter: inactivity_days must be of type Int, received ${getType(params.inactivity_days)}`)
     }
 
+    if (params.name && !isString(params.name)) {
+      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
+    }
+
+    if (params.partner_tag && !isString(params.partner_tag)) {
+      throw new errors.InvalidParameterError(`Bad parameter: partner_tag must be of type String, received ${getType(params.partner_tag)}`)
+    }
+
     if (params.user_state && !isString(params.user_state)) {
       throw new errors.InvalidParameterError(`Bad parameter: user_state must be of type String, received ${getType(params.user_state)}`)
     }
 
-    if (params.name && !isString(params.name)) {
-      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
+    if (params.user_tag && !isString(params.user_tag)) {
+      throw new errors.InvalidParameterError(`Bad parameter: user_tag must be of type String, received ${getType(params.user_tag)}`)
     }
 
     if (!params.id) {
@@ -201,6 +225,7 @@ class UserLifecycleRule {
   // 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: 10,000, 1,000 or less is recommended).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
   static list = async (params = {}, options = {}) => {
     if (params.cursor && !isString(params.cursor)) {
       throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
@@ -245,13 +270,15 @@ class UserLifecycleRule {
 
   // Parameters:
   //   action - string - Action to take on inactive users (disable or delete)
-  //   authentication_method - string - User authentication method for the rule
+  //   authentication_method - string - User authentication method for which the rule will apply.
   //   group_ids - array(int64) - Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
   //   inactivity_days - int64 - Number of days of inactivity before the rule applies
-  //   include_site_admins - boolean - Include site admins in the rule
-  //   include_folder_admins - boolean - Include folder admins in the rule
-  //   user_state - string - State of the users to apply the rule to (inactive or disabled)
+  //   include_site_admins - boolean - If true, the rule will apply to site admins.
+  //   include_folder_admins - boolean - If true, the rule will apply to folder admins.
   //   name - string - User Lifecycle Rule name
+  //   partner_tag - string - If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
+  //   user_state - string - State of the users to apply the rule to (inactive or disabled)
+  //   user_tag - string - If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
   static create = async (params = {}, options = {}) => {
     if (params.action && !isString(params.action)) {
       throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
@@ -269,12 +296,20 @@ class UserLifecycleRule {
       throw new errors.InvalidParameterError(`Bad parameter: inactivity_days must be of type Int, received ${getType(params.inactivity_days)}`)
     }
 
+    if (params.name && !isString(params.name)) {
+      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
+    }
+
+    if (params.partner_tag && !isString(params.partner_tag)) {
+      throw new errors.InvalidParameterError(`Bad parameter: partner_tag must be of type String, received ${getType(params.partner_tag)}`)
+    }
+
     if (params.user_state && !isString(params.user_state)) {
       throw new errors.InvalidParameterError(`Bad parameter: user_state must be of type String, received ${getType(params.user_state)}`)
     }
 
-    if (params.name && !isString(params.name)) {
-      throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
+    if (params.user_tag && !isString(params.user_tag)) {
+      throw new errors.InvalidParameterError(`Bad parameter: user_tag must be of type String, received ${getType(params.user_tag)}`)
     }
 
     const response = await Api.sendRequest('/user_lifecycle_rules', 'POST', params, options)