files.com 1.0.149 → 1.0.153

package/src/models/As2IncomingMessage.js

@@ -0,0 +1,94 @@
+import Api from '../Api'
+import Logger from '../Logger'
+import { getType, isArray, isBrowser, isInt, isObject, isString } from '../utils'
+
+/**
+ * Class As2IncomingMessage
+ */
+class As2IncomingMessage {
+  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 # Id of the AS2 Partner.
+  getId = () => this.attributes.id
+
+  // int64 # Id of the AS2 Partner associated with this message.
+  getAs2PartnerId = () => this.attributes.as2_partner_id
+
+  // string # UUID assigned to this message.
+  getUuid = () => this.attributes.uuid
+
+  // string # Content Type header of the incoming message.
+  getContentType = () => this.attributes.content_type
+
+  // object # HTTP Headers sent with this message.
+  getHttpHeaders = () => this.attributes.http_headers
+
+  // string # JSON Structure of the activity log.
+  getActivityLog = () => this.attributes.activity_log
+
+  // string # Result of processing. Valid values: `unable_to_find_station`, `unable_to_find_partner`, `unable_to_validate_signature`, `decrypt_fail`, `file_save_fail`, `success`
+  getProcessingResult = () => this.attributes.processing_result
+
+  // string # AS2 TO header of message
+  getAs2To = () => this.attributes.as2_to
+
+  // string # AS2 FROM header of message
+  getAs2From = () => this.attributes.as2_from
+
+  // string # AS2 Message Id
+  getMessageId = () => this.attributes.message_id
+
+  // string # AS2 Subject Header
+  getSubject = () => this.attributes.subject
+
+  // string # Encrypted Payload Body Size
+  getBodySize = () => this.attributes.body_size
+
+  // string # Filename of the file being received.
+  getAttachmentFilename = () => this.attributes.attachment_filename
+
+  // date-time # Message creation date/time
+  getCreatedAt = () => this.attributes.created_at
+
+
+  // Parameters:
+  //   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+  //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   as2_partner_id - int64 - As2 Partner ID.  If provided, will return message specific to that partner.
+  static list = async (params = {}, options = {}) => {
+    if (params['cursor'] && !isString(params['cursor'])) {
+      throw new Error(`Bad parameter: cursor must be of type String, received ${getType(cursor)}`)
+    }
+
+    if (params['per_page'] && !isInt(params['per_page'])) {
+      throw new Error(`Bad parameter: per_page must be of type Int, received ${getType(per_page)}`)
+    }
+
+    if (params['as2_partner_id'] && !isInt(params['as2_partner_id'])) {
+      throw new Error(`Bad parameter: as2_partner_id must be of type Int, received ${getType(as2_partner_id)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_incoming_messages`, 'GET', params, options)
+
+    return response?.data?.map(obj => new As2IncomingMessage(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    As2IncomingMessage.list(params, options)
+}
+
+export default As2IncomingMessage

package/src/models/As2OutgoingMessage.js

@@ -0,0 +1,85 @@
+import Api from '../Api'
+import Logger from '../Logger'
+import { getType, isArray, isBrowser, isInt, isObject, isString } from '../utils'
+
+/**
+ * Class As2OutgoingMessage
+ */
+class As2OutgoingMessage {
+  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 # Id of the AS2 Partner.
+  getId = () => this.attributes.id
+
+  // int64 # Id of the AS2 Partner associated with this message.
+  getAs2PartnerId = () => this.attributes.as2_partner_id
+
+  // string # UUID assigned to this message.
+  getUuid = () => this.attributes.uuid
+
+  // object # HTTP Headers sent with this message.
+  getHttpHeaders = () => this.attributes.http_headers
+
+  // string # JSON Structure of the activity log.
+  getActivityLog = () => this.attributes.activity_log
+
+  // string # Result of processing. Valid values: `send_failed`, `send_success`
+  getProcessingResult = () => this.attributes.processing_result
+
+  // string # AS2 Message Integrity Check
+  getMic = () => this.attributes.mic
+
+  // string # AS2 Message Id
+  getMessageId = () => this.attributes.message_id
+
+  // string # Encrypted Payload Body Size
+  getBodySize = () => this.attributes.body_size
+
+  // string # Filename of the file being sent.
+  getAttachmentFilename = () => this.attributes.attachment_filename
+
+  // date-time # Message creation date/time
+  getCreatedAt = () => this.attributes.created_at
+
+
+  // Parameters:
+  //   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+  //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+  //   as2_partner_id - int64 - As2 Partner ID.  If provided, will return message specific to that partner.
+  static list = async (params = {}, options = {}) => {
+    if (params['cursor'] && !isString(params['cursor'])) {
+      throw new Error(`Bad parameter: cursor must be of type String, received ${getType(cursor)}`)
+    }
+
+    if (params['per_page'] && !isInt(params['per_page'])) {
+      throw new Error(`Bad parameter: per_page must be of type Int, received ${getType(per_page)}`)
+    }
+
+    if (params['as2_partner_id'] && !isInt(params['as2_partner_id'])) {
+      throw new Error(`Bad parameter: as2_partner_id must be of type Int, received ${getType(as2_partner_id)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_outgoing_messages`, 'GET', params, options)
+
+    return response?.data?.map(obj => new As2OutgoingMessage(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    As2OutgoingMessage.list(params, options)
+}
+
+export default As2OutgoingMessage

package/src/models/As2Partner.js

@@ -0,0 +1,233 @@
+import Api from '../Api'
+import Logger from '../Logger'
+import { getType, isArray, isBrowser, isInt, isObject, isString } from '../utils'
+
+/**
+ * Class As2Partner
+ */
+class As2Partner {
+  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 # Id of the AS2 Partner.
+  getId = () => this.attributes.id
+
+  setId = value => {
+    this.attributes.id = value
+  }
+
+  // int64 # Id of the AS2 Station associated with this partner.
+  getAs2StationId = () => this.attributes.as2_station_id
+
+  setAs2StationId = value => {
+    this.attributes.as2_station_id = value
+  }
+
+  // string # The partner's formal AS2 name.
+  getName = () => this.attributes.name
+
+  setName = value => {
+    this.attributes.name = value
+  }
+
+  // string # Public URI for sending AS2 message to.
+  getUri = () => this.attributes.uri
+
+  setUri = value => {
+    this.attributes.uri = value
+  }
+
+  // string # MD5 hash of public certificate used for message security.
+  getPublicCertificateMd5 = () => this.attributes.public_certificate_md5
+
+  setPublicCertificateMd5 = value => {
+    this.attributes.public_certificate_md5 = value
+  }
+
+  // string
+  getPublicCertificate = () => this.attributes.public_certificate
+
+  setPublicCertificate = value => {
+    this.attributes.public_certificate = value
+  }
+
+
+  // Parameters:
+  //   name - string - AS2 Name
+  //   uri - string - URL base for AS2 responses
+  //   public_certificate - string
+  update = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new Error('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+    if (params['name'] && !isString(params['name'])) {
+      throw new Error(`Bad parameter: name must be of type String, received ${getType(name)}`)
+    }
+    if (params['uri'] && !isString(params['uri'])) {
+      throw new Error(`Bad parameter: uri must be of type String, received ${getType(uri)}`)
+    }
+    if (params['public_certificate'] && !isString(params['public_certificate'])) {
+      throw new Error(`Bad parameter: public_certificate must be of type String, received ${getType(public_certificate)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new Error('Parameter missing: id')
+      }
+    }
+
+    return Api.sendRequest(`/as2_partners/${params['id']}`, 'PATCH', params, this.options)
+  }
+
+  delete = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new Error('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new Error('Parameter missing: id')
+      }
+    }
+
+    return Api.sendRequest(`/as2_partners/${params['id']}`, 'DELETE', params, this.options)
+  }
+
+  destroy = (params = {}) =>
+    this.delete(params)
+
+  save = () => {
+      if (this.attributes['id']) {
+        return this.update(this.attributes)
+      } else {
+        const newObject = As2Partner.create(this.attributes, this.options)
+        this.attributes = { ...newObject.attributes }
+        return true
+      }
+  }
+
+  // Parameters:
+  //   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+  //   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 Error(`Bad parameter: cursor must be of type String, received ${getType(cursor)}`)
+    }
+
+    if (params['per_page'] && !isInt(params['per_page'])) {
+      throw new Error(`Bad parameter: per_page must be of type Int, received ${getType(per_page)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_partners`, 'GET', params, options)
+
+    return response?.data?.map(obj => new As2Partner(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    As2Partner.list(params, options)
+
+  // Parameters:
+  //   id (required) - int64 - As2 Partner ID.
+  static find = async (id, params = {}, options = {}) => {
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params['id'] = id
+
+    if (!params['id']) {
+      throw new Error('Parameter missing: id')
+    }
+
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_partners/${params['id']}`, 'GET', params, options)
+
+    return new As2Partner(response?.data, options)
+  }
+
+  static get = (id, params = {}, options = {}) =>
+    As2Partner.find(id, params, options)
+
+  // Parameters:
+  //   name (required) - string - AS2 Name
+  //   uri (required) - string - URL base for AS2 responses
+  //   public_certificate (required) - string
+  //   as2_station_id (required) - int64 - Id of As2Station for this partner
+  static create = async (params = {}, options = {}) => {
+    if (!params['name']) {
+      throw new Error('Parameter missing: name')
+    }
+
+    if (!params['uri']) {
+      throw new Error('Parameter missing: uri')
+    }
+
+    if (!params['public_certificate']) {
+      throw new Error('Parameter missing: public_certificate')
+    }
+
+    if (!params['as2_station_id']) {
+      throw new Error('Parameter missing: as2_station_id')
+    }
+
+    if (params['name'] && !isString(params['name'])) {
+      throw new Error(`Bad parameter: name must be of type String, received ${getType(name)}`)
+    }
+
+    if (params['uri'] && !isString(params['uri'])) {
+      throw new Error(`Bad parameter: uri must be of type String, received ${getType(uri)}`)
+    }
+
+    if (params['public_certificate'] && !isString(params['public_certificate'])) {
+      throw new Error(`Bad parameter: public_certificate must be of type String, received ${getType(public_certificate)}`)
+    }
+
+    if (params['as2_station_id'] && !isInt(params['as2_station_id'])) {
+      throw new Error(`Bad parameter: as2_station_id must be of type Int, received ${getType(as2_station_id)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_partners`, 'POST', params, options)
+
+    return new As2Partner(response?.data, options)
+  }
+}
+
+export default As2Partner

package/src/models/As2Station.js

@@ -0,0 +1,264 @@
+import Api from '../Api'
+import Logger from '../Logger'
+import { getType, isArray, isBrowser, isInt, isObject, isString } from '../utils'
+
+/**
+ * Class As2Station
+ */
+class As2Station {
+  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 # Id of the AS2 Station.
+  getId = () => this.attributes.id
+
+  setId = value => {
+    this.attributes.id = value
+  }
+
+  // string # The station's formal AS2 name.
+  getName = () => this.attributes.name
+
+  setName = value => {
+    this.attributes.name = value
+  }
+
+  // string # Public URI for sending AS2 message to.
+  getUri = () => this.attributes.uri
+
+  setUri = value => {
+    this.attributes.uri = value
+  }
+
+  // string # The station's AS2 domain name.
+  getDomain = () => this.attributes.domain
+
+  setDomain = value => {
+    this.attributes.domain = value
+  }
+
+  // string # Public certificate used for message security.
+  getPublicCertificate = () => this.attributes.public_certificate
+
+  setPublicCertificate = value => {
+    this.attributes.public_certificate = value
+  }
+
+  // string # MD5 hash of public certificate used for message security.
+  getPublicCertificateMd5 = () => this.attributes.public_certificate_md5
+
+  setPublicCertificateMd5 = value => {
+    this.attributes.public_certificate_md5 = value
+  }
+
+  // string # MD5 hash of private key used for message security.
+  getPrivateKeyMd5 = () => this.attributes.private_key_md5
+
+  setPrivateKeyMd5 = value => {
+    this.attributes.private_key_md5 = value
+  }
+
+  // string
+  getPrivateKey = () => this.attributes.private_key
+
+  setPrivateKey = value => {
+    this.attributes.private_key = value
+  }
+
+
+  // Parameters:
+  //   name - string - AS2 Name
+  //   domain - string - AS2 Domain
+  //   uri - string - URL base for AS2 responses
+  //   public_certificate - string
+  //   private_key - string
+  update = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new Error('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+    if (params['name'] && !isString(params['name'])) {
+      throw new Error(`Bad parameter: name must be of type String, received ${getType(name)}`)
+    }
+    if (params['domain'] && !isString(params['domain'])) {
+      throw new Error(`Bad parameter: domain must be of type String, received ${getType(domain)}`)
+    }
+    if (params['uri'] && !isString(params['uri'])) {
+      throw new Error(`Bad parameter: uri must be of type String, received ${getType(uri)}`)
+    }
+    if (params['public_certificate'] && !isString(params['public_certificate'])) {
+      throw new Error(`Bad parameter: public_certificate must be of type String, received ${getType(public_certificate)}`)
+    }
+    if (params['private_key'] && !isString(params['private_key'])) {
+      throw new Error(`Bad parameter: private_key must be of type String, received ${getType(private_key)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new Error('Parameter missing: id')
+      }
+    }
+
+    return Api.sendRequest(`/as2_stations/${params['id']}`, 'PATCH', params, this.options)
+  }
+
+  delete = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new Error('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new Error('Parameter missing: id')
+      }
+    }
+
+    return Api.sendRequest(`/as2_stations/${params['id']}`, 'DELETE', params, this.options)
+  }
+
+  destroy = (params = {}) =>
+    this.delete(params)
+
+  save = () => {
+      if (this.attributes['id']) {
+        return this.update(this.attributes)
+      } else {
+        const newObject = As2Station.create(this.attributes, this.options)
+        this.attributes = { ...newObject.attributes }
+        return true
+      }
+  }
+
+  // Parameters:
+  //   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+  //   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 Error(`Bad parameter: cursor must be of type String, received ${getType(cursor)}`)
+    }
+
+    if (params['per_page'] && !isInt(params['per_page'])) {
+      throw new Error(`Bad parameter: per_page must be of type Int, received ${getType(per_page)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_stations`, 'GET', params, options)
+
+    return response?.data?.map(obj => new As2Station(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    As2Station.list(params, options)
+
+  // Parameters:
+  //   id (required) - int64 - As2 Station ID.
+  static find = async (id, params = {}, options = {}) => {
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params['id'] = id
+
+    if (!params['id']) {
+      throw new Error('Parameter missing: id')
+    }
+
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_stations/${params['id']}`, 'GET', params, options)
+
+    return new As2Station(response?.data, options)
+  }
+
+  static get = (id, params = {}, options = {}) =>
+    As2Station.find(id, params, options)
+
+  // Parameters:
+  //   name (required) - string - AS2 Name
+  //   domain (required) - string - AS2 Domain
+  //   uri (required) - string - URL base for AS2 responses
+  //   public_certificate (required) - string
+  //   private_key (required) - string
+  static create = async (params = {}, options = {}) => {
+    if (!params['name']) {
+      throw new Error('Parameter missing: name')
+    }
+
+    if (!params['domain']) {
+      throw new Error('Parameter missing: domain')
+    }
+
+    if (!params['uri']) {
+      throw new Error('Parameter missing: uri')
+    }
+
+    if (!params['public_certificate']) {
+      throw new Error('Parameter missing: public_certificate')
+    }
+
+    if (!params['private_key']) {
+      throw new Error('Parameter missing: private_key')
+    }
+
+    if (params['name'] && !isString(params['name'])) {
+      throw new Error(`Bad parameter: name must be of type String, received ${getType(name)}`)
+    }
+
+    if (params['domain'] && !isString(params['domain'])) {
+      throw new Error(`Bad parameter: domain must be of type String, received ${getType(domain)}`)
+    }
+
+    if (params['uri'] && !isString(params['uri'])) {
+      throw new Error(`Bad parameter: uri must be of type String, received ${getType(uri)}`)
+    }
+
+    if (params['public_certificate'] && !isString(params['public_certificate'])) {
+      throw new Error(`Bad parameter: public_certificate must be of type String, received ${getType(public_certificate)}`)
+    }
+
+    if (params['private_key'] && !isString(params['private_key'])) {
+      throw new Error(`Bad parameter: private_key must be of type String, received ${getType(private_key)}`)
+    }
+
+    const response = await Api.sendRequest(`/as2_stations`, 'POST', params, options)
+
+    return new As2Station(response?.data, options)
+  }
+}
+
+export default As2Station