files.com/src/models/HistoryExport.js

Files.com SDK for JavaScript

/* eslint-disable no-unused-vars */
import Api from '../Api'
import * as errors from '../Errors'
import {
  getType, isArray, isInt, isObject, isString,
} from '../utils'
/* eslint-enable no-unused-vars */

/**
 * Class HistoryExport
 */
class HistoryExport {
  attributes = {}

  options = {}

  constructor(attributes = {}, options = {}) {
    Object.entries(attributes).forEach(([key, value]) => {
      const normalizedKey = key.replace('?', '')

      this.attributes[normalizedKey] = value

      Object.defineProperty(this, normalizedKey, { value, writable: false })
    })

    this.options = { ...options }
  }

  isLoaded = () => !!this.attributes.id

  // int64 # History Export ID
  getId = () => this.attributes.id

  setId = value => {
    this.attributes.id = value
  }

  // string # Version of the history for the export.
  getHistoryVersion = () => this.attributes.history_version

  setHistoryVersion = value => {
    this.attributes.history_version = value
  }

  // date-time # Start date/time of export range.
  getStartAt = () => this.attributes.start_at

  setStartAt = value => {
    this.attributes.start_at = value
  }

  // date-time # End date/time of export range.
  getEndAt = () => this.attributes.end_at

  setEndAt = value => {
    this.attributes.end_at = value
  }

  // string # Status of export.  Will be: `building`, `ready`, or `failed`
  getStatus = () => this.attributes.status

  setStatus = value => {
    this.attributes.status = value
  }

  // string # Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
  getQueryAction = () => this.attributes.query_action

  setQueryAction = value => {
    this.attributes.query_action = value
  }

  // string # Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
  getQueryInterface = () => this.attributes.query_interface

  setQueryInterface = value => {
    this.attributes.query_interface = value
  }

  // string # Return results that are actions performed by the user indicated by this User ID
  getQueryUserId = () => this.attributes.query_user_id

  setQueryUserId = value => {
    this.attributes.query_user_id = value
  }

  // string # Return results that are file actions related to the file indicated by this File ID
  getQueryFileId = () => this.attributes.query_file_id

  setQueryFileId = value => {
    this.attributes.query_file_id = value
  }

  // string # Return results that are file actions inside the parent folder specified by this folder ID
  getQueryParentId = () => this.attributes.query_parent_id

  setQueryParentId = value => {
    this.attributes.query_parent_id = value
  }

  // string # Return results that are file actions related to paths matching this pattern.
  getQueryPath = () => this.attributes.query_path

  setQueryPath = value => {
    this.attributes.query_path = value
  }

  // string # Return results that are file actions related to files or folders inside folder paths matching this pattern.
  getQueryFolder = () => this.attributes.query_folder

  setQueryFolder = value => {
    this.attributes.query_folder = value
  }

  // string # Return results that are file moves originating from paths matching this pattern.
  getQuerySrc = () => this.attributes.query_src

  setQuerySrc = value => {
    this.attributes.query_src = value
  }

  // string # Return results that are file moves with paths matching this pattern as destination.
  getQueryDestination = () => this.attributes.query_destination

  setQueryDestination = value => {
    this.attributes.query_destination = value
  }

  // string # Filter results by this IP address.
  getQueryIp = () => this.attributes.query_ip

  setQueryIp = value => {
    this.attributes.query_ip = value
  }

  // string # Filter results by this username.
  getQueryUsername = () => this.attributes.query_username

  setQueryUsername = value => {
    this.attributes.query_username = value
  }

  // string # If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
  getQueryFailureType = () => this.attributes.query_failure_type

  setQueryFailureType = value => {
    this.attributes.query_failure_type = value
  }

  // string # If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
  getQueryTargetId = () => this.attributes.query_target_id

  setQueryTargetId = value => {
    this.attributes.query_target_id = value
  }

  // string # If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
  getQueryTargetName = () => this.attributes.query_target_name

  setQueryTargetName = value => {
    this.attributes.query_target_name = value
  }

  // string # If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
  getQueryTargetPermission = () => this.attributes.query_target_permission

  setQueryTargetPermission = value => {
    this.attributes.query_target_permission = value
  }

  // string # If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
  getQueryTargetUserId = () => this.attributes.query_target_user_id

  setQueryTargetUserId = value => {
    this.attributes.query_target_user_id = value
  }

  // string # If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
  getQueryTargetUsername = () => this.attributes.query_target_username

  setQueryTargetUsername = value => {
    this.attributes.query_target_username = value
  }

  // string # If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
  getQueryTargetPlatform = () => this.attributes.query_target_platform

  setQueryTargetPlatform = value => {
    this.attributes.query_target_platform = value
  }

  // string # If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
  getQueryTargetPermissionSet = () => this.attributes.query_target_permission_set

  setQueryTargetPermissionSet = value => {
    this.attributes.query_target_permission_set = value
  }

  // string # If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
  getResultsUrl = () => this.attributes.results_url

  setResultsUrl = value => {
    this.attributes.results_url = value
  }

  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
  getUserId = () => this.attributes.user_id

  setUserId = value => {
    this.attributes.user_id = value
  }

  save = async () => {
    if (this.attributes.id) {
      throw new errors.NotImplementedError('The HistoryExport object doesn\'t support updates.')
    } else {
      const newObject = await HistoryExport.create(this.attributes, this.options)
      this.attributes = { ...newObject.attributes }
      return true
    }
  }

  // Parameters:
  //   id (required) - int64 - History Export ID.
  static find = async (id, params = {}, options = {}) => {
    if (!isObject(params)) {
      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
    }

    params.id = id

    if (!params.id) {
      throw new errors.MissingParameterError('Parameter missing: id')
    }

    if (params.id && !isInt(params.id)) {
      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
    }

    const response = await Api.sendRequest(`/history_exports/${encodeURIComponent(params.id)}`, 'GET', params, options)

    return new HistoryExport(response?.data, options)
  }

  static get = (id, params = {}, options = {}) =>
    HistoryExport.find(id, params, options)

  // Parameters:
  //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
  //   start_at - string - Start date/time of export range.
  //   end_at - string - End date/time of export range.
  //   query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
  //   query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
  //   query_user_id - string - Return results that are actions performed by the user indicated by this User ID
  //   query_file_id - string - Return results that are file actions related to the file indicated by this File ID
  //   query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
  //   query_path - string - Return results that are file actions related to paths matching this pattern.
  //   query_folder - string - Return results that are file actions related to files or folders inside folder paths matching this pattern.
  //   query_src - string - Return results that are file moves originating from paths matching this pattern.
  //   query_destination - string - Return results that are file moves with paths matching this pattern as destination.
  //   query_ip - string - Filter results by this IP address.
  //   query_username - string - Filter results by this username.
  //   query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
  //   query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this parameter restricts results to objects that match this ID.
  //   query_target_name - string - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
  //   query_target_permission - string - If searching for Histories about Permissions, this parameter restricts results to permissions of this level.
  //   query_target_user_id - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
  //   query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
  //   query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
  //   query_target_permission_set - string - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
  static create = async (params = {}, options = {}) => {
    if (params.user_id && !isInt(params.user_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)
    }

    if (params.start_at && !isString(params.start_at)) {
      throw new errors.InvalidParameterError(`Bad parameter: start_at must be of type String, received ${getType(params.start_at)}`)
    }

    if (params.end_at && !isString(params.end_at)) {
      throw new errors.InvalidParameterError(`Bad parameter: end_at must be of type String, received ${getType(params.end_at)}`)
    }

    if (params.query_action && !isString(params.query_action)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_action must be of type String, received ${getType(params.query_action)}`)
    }

    if (params.query_interface && !isString(params.query_interface)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_interface must be of type String, received ${getType(params.query_interface)}`)
    }

    if (params.query_user_id && !isString(params.query_user_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_user_id must be of type String, received ${getType(params.query_user_id)}`)
    }

    if (params.query_file_id && !isString(params.query_file_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_file_id must be of type String, received ${getType(params.query_file_id)}`)
    }

    if (params.query_parent_id && !isString(params.query_parent_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_parent_id must be of type String, received ${getType(params.query_parent_id)}`)
    }

    if (params.query_path && !isString(params.query_path)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_path must be of type String, received ${getType(params.query_path)}`)
    }

    if (params.query_folder && !isString(params.query_folder)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_folder must be of type String, received ${getType(params.query_folder)}`)
    }

    if (params.query_src && !isString(params.query_src)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_src must be of type String, received ${getType(params.query_src)}`)
    }

    if (params.query_destination && !isString(params.query_destination)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_destination must be of type String, received ${getType(params.query_destination)}`)
    }

    if (params.query_ip && !isString(params.query_ip)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_ip must be of type String, received ${getType(params.query_ip)}`)
    }

    if (params.query_username && !isString(params.query_username)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_username must be of type String, received ${getType(params.query_username)}`)
    }

    if (params.query_failure_type && !isString(params.query_failure_type)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_failure_type must be of type String, received ${getType(params.query_failure_type)}`)
    }

    if (params.query_target_id && !isString(params.query_target_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_id must be of type String, received ${getType(params.query_target_id)}`)
    }

    if (params.query_target_name && !isString(params.query_target_name)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_name must be of type String, received ${getType(params.query_target_name)}`)
    }

    if (params.query_target_permission && !isString(params.query_target_permission)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_permission must be of type String, received ${getType(params.query_target_permission)}`)
    }

    if (params.query_target_user_id && !isString(params.query_target_user_id)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_user_id must be of type String, received ${getType(params.query_target_user_id)}`)
    }

    if (params.query_target_username && !isString(params.query_target_username)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_username must be of type String, received ${getType(params.query_target_username)}`)
    }

    if (params.query_target_platform && !isString(params.query_target_platform)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_platform must be of type String, received ${getType(params.query_target_platform)}`)
    }

    if (params.query_target_permission_set && !isString(params.query_target_permission_set)) {
      throw new errors.InvalidParameterError(`Bad parameter: query_target_permission_set must be of type String, received ${getType(params.query_target_permission_set)}`)
    }

    const response = await Api.sendRequest('/history_exports', 'POST', params, options)

    return new HistoryExport(response?.data, options)
  }
}

export default HistoryExport

module.exports = HistoryExport
module.exports.default = HistoryExport