files.com 1.0.190 → 1.0.193

package/docs/models/As2IncomingMessage.md

@@ -0,0 +1,104 @@
+# As2IncomingMessage
+
+## Example As2IncomingMessage Object
+
+```
+{
+  "id": 1,
+  "as2_partner_id": 1,
+  "as2_station_id": 1,
+  "uuid": "",
+  "content_type": "",
+  "http_headers": "",
+  "activity_log": "",
+  "processing_result": "",
+  "processing_result_description": "",
+  "mic": "",
+  "mic_algo": "",
+  "as2_to": "",
+  "as2_from": "",
+  "message_id": "",
+  "subject": "",
+  "date": "",
+  "body_size": "",
+  "attachment_filename": "",
+  "ip": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "http_response_code": "",
+  "http_response_headers": "",
+  "recipient_serial": "",
+  "hex_recipient_serial": "A5:EB:C1:95:DC:D8:2B:E7",
+  "recipient_issuer": "",
+  "message_received": true,
+  "message_decrypted": true,
+  "message_signature_verified": true,
+  "message_processing_success": true,
+  "message_mdn_returned": true,
+  "encrypted_uri": "",
+  "smime_signed_uri": "",
+  "smime_uri": "",
+  "raw_uri": "",
+  "mdn_response_uri": ""
+}
+```
+
+* `id` (int64): Id of the AS2 Partner.
+* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
+* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
+* `uuid` (string): UUID assigned to this message.
+* `content_type` (string): Content Type header of the incoming message.
+* `http_headers` (object): HTTP Headers sent with this message.
+* `activity_log` (string): JSON Structure of the activity log.
+* `processing_result` (string): Result of processing.
+* `processing_result_description` (string): Result of processing description.
+* `mic` (string): AS2 Message Integrity Check
+* `mic_algo` (string): AS2 Message Integrity Check Algorithm Used
+* `as2_to` (string): AS2 TO header of message
+* `as2_from` (string): AS2 FROM header of message
+* `message_id` (string): AS2 Message Id
+* `subject` (string): AS2 Subject Header
+* `date` (string): Date Header
+* `body_size` (string): Encrypted Payload Body Size
+* `attachment_filename` (string): Filename of the file being received.
+* `ip` (string): IP Address of the Sender
+* `created_at` (date-time): Message creation date/time
+* `http_response_code` (string): HTTP Response Code sent for this message
+* `http_response_headers` (object): HTTP Headers sent for this message.
+* `recipient_serial` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial
+* `hex_recipient_serial` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.
+* `recipient_issuer` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer
+* `message_received` (boolean): Message body received?
+* `message_decrypted` (boolean): Message decrypted successfully?
+* `message_signature_verified` (boolean): Message signature verified?
+* `message_processing_success` (boolean): Message processed successfully?
+* `message_mdn_returned` (boolean): MDN returned?
+* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
+* `smime_signed_uri` (string): URL to download the file contents as smime with signature
+* `smime_uri` (string): URL to download the file contents encoded as smime
+* `raw_uri` (string): URL to download the original file contents
+* `mdn_response_uri` (string): URL to download the http response body
+
+---
+
+## List As2 Incoming Messages
+
+```
+await As2IncomingMessage.list({
+  'per_page': 1,
+  'as2_partner_id': 1,
+})
+```
+
+
+### 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).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `as2_partner_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
+* `as2_partner_id` (int64): As2 Partner ID.  If provided, will return message specific to that partner.

package/docs/models/As2OutgoingMessage.md

@@ -0,0 +1,96 @@
+# As2OutgoingMessage
+
+## Example As2OutgoingMessage Object
+
+```
+{
+  "id": 1,
+  "as2_partner_id": 1,
+  "as2_station_id": 1,
+  "uuid": "",
+  "http_headers": "",
+  "activity_log": "",
+  "processing_result": "",
+  "processing_result_description": "",
+  "mic": "",
+  "mic_sha_256": "",
+  "as2_to": "",
+  "as2_from": "",
+  "date": "",
+  "message_id": "",
+  "body_size": "",
+  "attachment_filename": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "http_response_code": "",
+  "http_response_headers": "",
+  "http_transmission_duration": 1.0,
+  "mdn_received": true,
+  "mdn_valid": true,
+  "mdn_signature_verified": true,
+  "mdn_message_id_matched": true,
+  "mdn_mic_matched": true,
+  "mdn_processing_success": true,
+  "raw_uri": "",
+  "smime_uri": "",
+  "smime_signed_uri": "",
+  "encrypted_uri": "",
+  "mdn_response_uri": ""
+}
+```
+
+* `id` (int64): Id of the AS2 Partner.
+* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
+* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
+* `uuid` (string): UUID assigned to this message.
+* `http_headers` (object): HTTP Headers sent with this message.
+* `activity_log` (string): JSON Structure of the activity log.
+* `processing_result` (string): Result of processing.
+* `processing_result_description` (string): Result of processing description.
+* `mic` (string): AS2 Message Integrity Check SHA1
+* `mic_sha_256` (string): AS2 Message Integrity Check SHA256
+* `as2_to` (string): AS2 TO
+* `as2_from` (string): AS2 FROM
+* `date` (string): Date Header
+* `message_id` (string): AS2 Message Id
+* `body_size` (string): Encrypted Payload Body Size
+* `attachment_filename` (string): Filename of the file being sent.
+* `created_at` (date-time): Message creation date/time
+* `http_response_code` (string): HTTP Response Code received for this message
+* `http_response_headers` (object): HTTP Headers received for this message.
+* `http_transmission_duration` (double): HTTP transmission duration in seceonds
+* `mdn_received` (boolean): Did the partner give a response body?
+* `mdn_valid` (boolean): Is the response in MDN format?
+* `mdn_signature_verified` (boolean): MDN signature verified?
+* `mdn_message_id_matched` (boolean): MDN message id matched?
+* `mdn_mic_matched` (boolean): MDN MIC matched?
+* `mdn_processing_success` (boolean): MDN disposition indicate a successful processing?
+* `raw_uri` (string): URL to download the original file contents
+* `smime_uri` (string): URL to download the file contents encoded as smime
+* `smime_signed_uri` (string): URL to download the file contents as smime with signature
+* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
+* `mdn_response_uri` (string): URL to download the http response body
+
+---
+
+## List As2 Outgoing Messages
+
+```
+await As2OutgoingMessage.list({
+  'per_page': 1,
+  'as2_partner_id': 1,
+})
+```
+
+
+### 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).
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `as2_partner_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
+* `as2_partner_id` (int64): As2 Partner ID.  If provided, will return message specific to that partner.

package/docs/models/As2Partner.md

@@ -0,0 +1,141 @@
+# As2Partner
+
+## Example As2Partner Object
+
+```
+{
+  "id": 1,
+  "as2_station_id": 1,
+  "name": "AS2 Partner Name",
+  "uri": "",
+  "server_certificate": "require_match",
+  "hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
+  "public_certificate_md5": "",
+  "public_certificate_subject": "",
+  "public_certificate_issuer": "",
+  "public_certificate_serial": "",
+  "public_certificate_not_before": "",
+  "public_certificate_not_after": ""
+}
+```
+
+* `id` (int64): Id of the AS2 Partner.
+* `as2_station_id` (int64): Id of the AS2 Station associated with this partner.
+* `name` (string): The partner's formal AS2 name.
+* `uri` (string): Public URI for sending AS2 message to.
+* `server_certificate` (string): Remote server certificate security setting
+* `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
+* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
+* `public_certificate_subject` (string): Subject of public certificate used for message security.
+* `public_certificate_issuer` (string): Issuer of public certificate used for message security.
+* `public_certificate_serial` (string): Serial of public certificate used for message security.
+* `public_certificate_not_before` (string): Not before value of public certificate used for message security.
+* `public_certificate_not_after` (string): Not after value of public certificate used for message security.
+* `public_certificate` (string): 
+
+---
+
+## List As2 Partners
+
+```
+await As2Partner.list({
+  'per_page': 1,
+})
+```
+
+
+### 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).
+
+---
+
+## Show As2 Partner
+
+```
+await As2Partner.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - As2 Partner ID.
+
+---
+
+## Create As2 Partner
+
+```
+await As2Partner.create({
+  'name': "name",
+  'uri': "uri",
+  'public_certificate': "public_certificate",
+  'as2_station_id': 1,
+  'server_certificate': "require_match",
+})
+```
+
+
+### Parameters
+
+* `name` (string): Required - AS2 Name
+* `uri` (string): Required - URL base for AS2 responses
+* `public_certificate` (string): Required - 
+* `as2_station_id` (int64): Required - Id of As2Station for this partner
+* `server_certificate` (string): Remote server certificate security setting
+
+---
+
+## Update As2 Partner
+
+```
+const [as2_partner] = await As2Partner.list()
+
+await as2_partner.update({
+  'name': "AS2 Partner Name",
+  'server_certificate': "require_match",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Partner ID.
+* `name` (string): AS2 Name
+* `uri` (string): URL base for AS2 responses
+* `server_certificate` (string): Remote server certificate security setting
+* `public_certificate` (string): 
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "as2_station_id": 1,
+  "name": "AS2 Partner Name",
+  "uri": "",
+  "server_certificate": "require_match",
+  "hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
+  "public_certificate_md5": "",
+  "public_certificate_subject": "",
+  "public_certificate_issuer": "",
+  "public_certificate_serial": "",
+  "public_certificate_not_before": "",
+  "public_certificate_not_after": ""
+}
+```
+
+---
+
+## Delete As2 Partner
+
+```
+const [as2_partner] = await As2Partner.list()
+
+await as2_partner.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Partner ID.
+

package/docs/models/As2Station.md

@@ -0,0 +1,142 @@
+# As2Station
+
+## Example As2Station Object
+
+```
+{
+  "id": 1,
+  "name": "AS2 Station Name",
+  "uri": "",
+  "domain": "domain.test",
+  "hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
+  "public_certificate_md5": "",
+  "private_key_md5": "",
+  "public_certificate_subject": "",
+  "public_certificate_issuer": "",
+  "public_certificate_serial": "",
+  "public_certificate_not_before": "",
+  "public_certificate_not_after": "",
+  "private_key_password_md5": ""
+}
+```
+
+* `id` (int64): Id of the AS2 Station.
+* `name` (string): The station's formal AS2 name.
+* `uri` (string): Public URI for sending AS2 message to.
+* `domain` (string): The station's AS2 domain name.
+* `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
+* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
+* `private_key_md5` (string): MD5 hash of private key used for message security.
+* `public_certificate_subject` (string): Subject of public certificate used for message security.
+* `public_certificate_issuer` (string): Issuer of public certificate used for message security.
+* `public_certificate_serial` (string): Serial of public certificate used for message security.
+* `public_certificate_not_before` (string): Not before value of public certificate used for message security.
+* `public_certificate_not_after` (string): Not after value of public certificate used for message security.
+* `private_key_password_md5` (string): MD5 hash of private key password used for message security.
+* `public_certificate` (string): 
+* `private_key` (string): 
+* `private_key_password` (string): 
+
+---
+
+## List As2 Stations
+
+```
+await As2Station.list({
+  'per_page': 1,
+})
+```
+
+
+### 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).
+
+---
+
+## Show As2 Station
+
+```
+await As2Station.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - As2 Station ID.
+
+---
+
+## Create As2 Station
+
+```
+await As2Station.create({
+  'name': "name",
+  'public_certificate': "public_certificate",
+  'private_key': "private_key",
+})
+```
+
+
+### Parameters
+
+* `name` (string): Required - AS2 Name
+* `public_certificate` (string): Required - 
+* `private_key` (string): Required - 
+* `private_key_password` (string): 
+
+---
+
+## Update As2 Station
+
+```
+const [as2_station] = await As2Station.list()
+
+await as2_station.update({
+  'name': "AS2 Station Name",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Station ID.
+* `name` (string): AS2 Name
+* `public_certificate` (string): 
+* `private_key` (string): 
+* `private_key_password` (string): 
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "name": "AS2 Station Name",
+  "uri": "",
+  "domain": "domain.test",
+  "hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
+  "public_certificate_md5": "",
+  "private_key_md5": "",
+  "public_certificate_subject": "",
+  "public_certificate_issuer": "",
+  "public_certificate_serial": "",
+  "public_certificate_not_before": "",
+  "public_certificate_not_after": "",
+  "private_key_password_md5": ""
+}
+```
+
+---
+
+## Delete As2 Station
+
+```
+const [as2_station] = await As2Station.list()
+
+await as2_station.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Station ID.
+

package/docs/models/Auto.md

@@ -0,0 +1,11 @@
+# Auto
+
+## Example Auto Object
+
+```
+{
+  "dynamic": ""
+}
+```
+
+* `dynamic` (object):