files.com 1.2.263 → 1.2.265

package/src/models/As2Partner.js

@@ -84,13 +84,20 @@ class As2Partner {
     this.attributes.default_mime_type = value
   }
 
-  // string # How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
+  // string # How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
   getMdnValidationLevel = () => this.attributes.mdn_validation_level
 
   setMdnValidationLevel = value => {
     this.attributes.mdn_validation_level = value
   }
 
+  // string # Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
+  getSignatureValidationLevel = () => this.attributes.signature_validation_level
+
+  setSignatureValidationLevel = value => {
+    this.attributes.signature_validation_level = value
+  }
+
   // boolean # If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
   getEnableDedicatedIps = () => this.attributes.enable_dedicated_ips
 
@@ -165,7 +172,8 @@ class As2Partner {
   //   enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
   //   http_auth_username - string - Username to send to server for HTTP Authentication.
   //   http_auth_password - string - Password to send to server for HTTP Authentication.
-  //   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
+  //   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
+  //   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
   //   server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
   //   default_mime_type - string - Default mime type of the file attached to the encrypted message
   //   additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -198,6 +206,10 @@ class As2Partner {
       throw new errors.InvalidParameterError(`Bad parameter: mdn_validation_level must be of type String, received ${getType(params.mdn_validation_level)}`)
     }
 
+    if (params.signature_validation_level && !isString(params.signature_validation_level)) {
+      throw new errors.InvalidParameterError(`Bad parameter: signature_validation_level must be of type String, received ${getType(params.signature_validation_level)}`)
+    }
+
     if (params.server_certificate && !isString(params.server_certificate)) {
       throw new errors.InvalidParameterError(`Bad parameter: server_certificate must be of type String, received ${getType(params.server_certificate)}`)
     }
@@ -320,7 +332,8 @@ class As2Partner {
   //   enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
   //   http_auth_username - string - Username to send to server for HTTP Authentication.
   //   http_auth_password - string - Password to send to server for HTTP Authentication.
-  //   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
+  //   mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response?  This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. `auto`: Automatically set the correct value for this setting based on next mdn received.
+  //   signature_validation_level - string - Should Files.com require signatures on incoming AS2 messages?  `normal`: require that incoming messages are signed with a valid matching signature. `none`: Unsigned incoming messages are allowed. `auto`: Automatically set the correct value for this setting based on next message received.
   //   server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? (This only applies to Outgoing AS2 message from Files.com to a Partner.)
   //   default_mime_type - string - Default mime type of the file attached to the encrypted message
   //   additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner.
@@ -357,6 +370,10 @@ class As2Partner {
       throw new errors.InvalidParameterError(`Bad parameter: mdn_validation_level must be of type String, received ${getType(params.mdn_validation_level)}`)
     }
 
+    if (params.signature_validation_level && !isString(params.signature_validation_level)) {
+      throw new errors.InvalidParameterError(`Bad parameter: signature_validation_level must be of type String, received ${getType(params.signature_validation_level)}`)
+    }
+
     if (params.server_certificate && !isString(params.server_certificate)) {
       throw new errors.InvalidParameterError(`Bad parameter: server_certificate must be of type String, received ${getType(params.server_certificate)}`)
     }

package/src/models/RemoteMountBackend.js

@@ -0,0 +1,427 @@
+/* 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 RemoteMountBackend
+ */
+class RemoteMountBackend {
+  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
+
+  // string # Path to the canary file used for health checks.
+  getCanaryFilePath = () => this.attributes.canary_file_path
+
+  setCanaryFilePath = value => {
+    this.attributes.canary_file_path = value
+  }
+
+  // boolean # True if this backend is enabled.
+  getEnabled = () => this.attributes.enabled
+
+  setEnabled = value => {
+    this.attributes.enabled = value
+  }
+
+  // int64 # Number of consecutive failures before considering the backend unhealthy.
+  getFall = () => this.attributes.fall
+
+  setFall = value => {
+    this.attributes.fall = value
+  }
+
+  // boolean # True if health checks are enabled for this backend.
+  getHealthCheckEnabled = () => this.attributes.health_check_enabled
+
+  setHealthCheckEnabled = value => {
+    this.attributes.health_check_enabled = value
+  }
+
+  // string # Type of health check to perform.
+  getHealthCheckType = () => this.attributes.health_check_type
+
+  setHealthCheckType = value => {
+    this.attributes.health_check_type = value
+  }
+
+  // int64 # Interval in seconds between health checks.
+  getInterval = () => this.attributes.interval
+
+  setInterval = value => {
+    this.attributes.interval = value
+  }
+
+  // double # Minimum free CPU percentage required for this backend to be considered healthy.
+  getMinFreeCpu = () => this.attributes.min_free_cpu
+
+  setMinFreeCpu = value => {
+    this.attributes.min_free_cpu = value
+  }
+
+  // double # Minimum free memory percentage required for this backend to be considered healthy.
+  getMinFreeMem = () => this.attributes.min_free_mem
+
+  setMinFreeMem = value => {
+    this.attributes.min_free_mem = value
+  }
+
+  // int64 # Priority of this backend.
+  getPriority = () => this.attributes.priority
+
+  setPriority = value => {
+    this.attributes.priority = value
+  }
+
+  // string # Path on the remote server to treat as the root of this mount.
+  getRemotePath = () => this.attributes.remote_path
+
+  setRemotePath = value => {
+    this.attributes.remote_path = value
+  }
+
+  // int64 # The remote server that this backend is associated with.
+  getRemoteServerId = () => this.attributes.remote_server_id
+
+  setRemoteServerId = value => {
+    this.attributes.remote_server_id = value
+  }
+
+  // int64 # The mount ID of the Remote Server Mount that this backend is associated with.
+  getRemoteServerMountId = () => this.attributes.remote_server_mount_id
+
+  setRemoteServerMountId = value => {
+    this.attributes.remote_server_mount_id = value
+  }
+
+  // int64 # Number of consecutive successes before considering the backend healthy.
+  getRise = () => this.attributes.rise
+
+  setRise = value => {
+    this.attributes.rise = value
+  }
+
+  // string # Status of this backend.
+  getStatus = () => this.attributes.status
+
+  setStatus = value => {
+    this.attributes.status = value
+  }
+
+  // boolean # True if this backend is undergoing maintenance.
+  getUndergoingMaintenance = () => this.attributes.undergoing_maintenance
+
+  setUndergoingMaintenance = value => {
+    this.attributes.undergoing_maintenance = value
+  }
+
+  // int64 # Remote Mount Backend ID.
+  getId = () => this.attributes.id
+
+  setId = value => {
+    this.attributes.id = value
+  }
+
+  // Reset backend status to healthy
+  resetStatus = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
+    }
+
+    if (!params.id) {
+      if (this.attributes.id) {
+        params.id = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    await Api.sendRequest(`/remote_mount_backends/${encodeURIComponent(params.id)}/reset_status`, 'POST', params, this.options)
+  }
+
+  // Parameters:
+  //   canary_file_path (required) - string - Path to the canary file used for health checks.
+  //   remote_server_mount_id (required) - int64 - The mount ID of the Remote Server Mount that this backend is associated with.
+  //   remote_server_id (required) - int64 - The remote server that this backend is associated with.
+  //   enabled - boolean - True if this backend is enabled.
+  //   fall - int64 - Number of consecutive failures before considering the backend unhealthy.
+  //   health_check_enabled - boolean - True if health checks are enabled for this backend.
+  //   health_check_type - string - Type of health check to perform.
+  //   interval - int64 - Interval in seconds between health checks.
+  //   min_free_cpu - double - Minimum free CPU percentage required for this backend to be considered healthy.
+  //   min_free_mem - double - Minimum free memory percentage required for this backend to be considered healthy.
+  //   priority - int64 - Priority of this backend.
+  //   remote_path - string - Path on the remote server to treat as the root of this mount.
+  //   rise - int64 - Number of consecutive successes before considering the backend healthy.
+  update = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
+    }
+
+    if (params.canary_file_path && !isString(params.canary_file_path)) {
+      throw new errors.InvalidParameterError(`Bad parameter: canary_file_path must be of type String, received ${getType(params.canary_file_path)}`)
+    }
+
+    if (params.remote_server_mount_id && !isInt(params.remote_server_mount_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: remote_server_mount_id must be of type Int, received ${getType(params.remote_server_mount_id)}`)
+    }
+
+    if (params.remote_server_id && !isInt(params.remote_server_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: remote_server_id must be of type Int, received ${getType(params.remote_server_id)}`)
+    }
+
+    if (params.fall && !isInt(params.fall)) {
+      throw new errors.InvalidParameterError(`Bad parameter: fall must be of type Int, received ${getType(params.fall)}`)
+    }
+
+    if (params.health_check_type && !isString(params.health_check_type)) {
+      throw new errors.InvalidParameterError(`Bad parameter: health_check_type must be of type String, received ${getType(params.health_check_type)}`)
+    }
+
+    if (params.interval && !isInt(params.interval)) {
+      throw new errors.InvalidParameterError(`Bad parameter: interval must be of type Int, received ${getType(params.interval)}`)
+    }
+
+    if (params.priority && !isInt(params.priority)) {
+      throw new errors.InvalidParameterError(`Bad parameter: priority must be of type Int, received ${getType(params.priority)}`)
+    }
+
+    if (params.remote_path && !isString(params.remote_path)) {
+      throw new errors.InvalidParameterError(`Bad parameter: remote_path must be of type String, received ${getType(params.remote_path)}`)
+    }
+
+    if (params.rise && !isInt(params.rise)) {
+      throw new errors.InvalidParameterError(`Bad parameter: rise must be of type Int, received ${getType(params.rise)}`)
+    }
+
+    if (!params.id) {
+      if (this.attributes.id) {
+        params.id = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    if (!params.canary_file_path) {
+      if (this.attributes.canary_file_path) {
+        params.canary_file_path = this.canary_file_path
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: canary_file_path')
+      }
+    }
+
+    if (!params.remote_server_mount_id) {
+      if (this.attributes.remote_server_mount_id) {
+        params.remote_server_mount_id = this.remote_server_mount_id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: remote_server_mount_id')
+      }
+    }
+
+    if (!params.remote_server_id) {
+      if (this.attributes.remote_server_id) {
+        params.remote_server_id = this.remote_server_id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: remote_server_id')
+      }
+    }
+
+    const response = await Api.sendRequest(`/remote_mount_backends/${encodeURIComponent(params.id)}`, 'PATCH', params, this.options)
+
+    return new RemoteMountBackend(response?.data, this.options)
+  }
+
+  delete = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
+    }
+
+    if (!params.id) {
+      if (this.attributes.id) {
+        params.id = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    await Api.sendRequest(`/remote_mount_backends/${encodeURIComponent(params.id)}`, 'DELETE', params, this.options)
+  }
+
+  destroy = (params = {}) =>
+    this.delete(params)
+
+  save = async () => {
+    if (this.attributes.id) {
+      const newObject = await this.update(this.attributes)
+      this.attributes = { ...newObject.attributes }
+      return true
+    }
+
+    const newObject = await RemoteMountBackend.create(this.attributes, this.options)
+    this.attributes = { ...newObject.attributes }
+    return true
+  }
+
+  // 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).
+  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)}`)
+    }
+
+    if (params.per_page && !isInt(params.per_page)) {
+      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
+    }
+
+    const response = await Api.sendRequest('/remote_mount_backends', 'GET', params, options)
+
+    return response?.data?.map(obj => new RemoteMountBackend(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    RemoteMountBackend.list(params, options)
+
+  // Parameters:
+  //   id (required) - int64 - Remote Mount Backend 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(`/remote_mount_backends/${encodeURIComponent(params.id)}`, 'GET', params, options)
+
+    return new RemoteMountBackend(response?.data, options)
+  }
+
+  static get = (id, params = {}, options = {}) =>
+    RemoteMountBackend.find(id, params, options)
+
+  // Parameters:
+  //   canary_file_path (required) - string - Path to the canary file used for health checks.
+  //   remote_server_mount_id (required) - int64 - The mount ID of the Remote Server Mount that this backend is associated with.
+  //   remote_server_id (required) - int64 - The remote server that this backend is associated with.
+  //   enabled - boolean - True if this backend is enabled.
+  //   fall - int64 - Number of consecutive failures before considering the backend unhealthy.
+  //   health_check_enabled - boolean - True if health checks are enabled for this backend.
+  //   health_check_type - string - Type of health check to perform.
+  //   interval - int64 - Interval in seconds between health checks.
+  //   min_free_cpu - double - Minimum free CPU percentage required for this backend to be considered healthy.
+  //   min_free_mem - double - Minimum free memory percentage required for this backend to be considered healthy.
+  //   priority - int64 - Priority of this backend.
+  //   remote_path - string - Path on the remote server to treat as the root of this mount.
+  //   rise - int64 - Number of consecutive successes before considering the backend healthy.
+  static create = async (params = {}, options = {}) => {
+    if (!params.canary_file_path) {
+      throw new errors.MissingParameterError('Parameter missing: canary_file_path')
+    }
+
+    if (!params.remote_server_mount_id) {
+      throw new errors.MissingParameterError('Parameter missing: remote_server_mount_id')
+    }
+
+    if (!params.remote_server_id) {
+      throw new errors.MissingParameterError('Parameter missing: remote_server_id')
+    }
+
+    if (params.canary_file_path && !isString(params.canary_file_path)) {
+      throw new errors.InvalidParameterError(`Bad parameter: canary_file_path must be of type String, received ${getType(params.canary_file_path)}`)
+    }
+
+    if (params.remote_server_mount_id && !isInt(params.remote_server_mount_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: remote_server_mount_id must be of type Int, received ${getType(params.remote_server_mount_id)}`)
+    }
+
+    if (params.remote_server_id && !isInt(params.remote_server_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: remote_server_id must be of type Int, received ${getType(params.remote_server_id)}`)
+    }
+
+    if (params.fall && !isInt(params.fall)) {
+      throw new errors.InvalidParameterError(`Bad parameter: fall must be of type Int, received ${getType(params.fall)}`)
+    }
+
+    if (params.health_check_type && !isString(params.health_check_type)) {
+      throw new errors.InvalidParameterError(`Bad parameter: health_check_type must be of type String, received ${getType(params.health_check_type)}`)
+    }
+
+    if (params.interval && !isInt(params.interval)) {
+      throw new errors.InvalidParameterError(`Bad parameter: interval must be of type Int, received ${getType(params.interval)}`)
+    }
+
+    if (params.priority && !isInt(params.priority)) {
+      throw new errors.InvalidParameterError(`Bad parameter: priority must be of type Int, received ${getType(params.priority)}`)
+    }
+
+    if (params.remote_path && !isString(params.remote_path)) {
+      throw new errors.InvalidParameterError(`Bad parameter: remote_path must be of type String, received ${getType(params.remote_path)}`)
+    }
+
+    if (params.rise && !isInt(params.rise)) {
+      throw new errors.InvalidParameterError(`Bad parameter: rise must be of type Int, received ${getType(params.rise)}`)
+    }
+
+    const response = await Api.sendRequest('/remote_mount_backends', 'POST', params, options)
+
+    return new RemoteMountBackend(response?.data, options)
+  }
+}
+
+export default RemoteMountBackend
+
+module.exports = RemoteMountBackend
+module.exports.default = RemoteMountBackend