files.com 1.0.188 → 1.0.191
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/Errors.md +186 -0
- package/docs/models/AccountLineItem.md +53 -0
- package/docs/models/Action.md +37 -0
- package/docs/models/ActionNotificationExport.md +82 -0
- package/docs/models/ActionNotificationExportResult.md +49 -0
- package/docs/models/ActionWebhookFailure.md +16 -0
- package/docs/models/ApiKey.md +183 -0
- package/docs/models/App.md +66 -0
- package/docs/models/As2IncomingMessage.md +104 -0
- package/docs/models/As2OutgoingMessage.md +96 -0
- package/docs/models/As2Partner.md +141 -0
- package/docs/models/As2Station.md +142 -0
- package/docs/models/Auto.md +11 -0
- package/docs/models/Automation.md +257 -0
- package/docs/models/AutomationRun.md +61 -0
- package/docs/models/BandwidthSnapshot.md +50 -0
- package/docs/models/Behavior.md +195 -0
- package/docs/models/Bundle.md +330 -0
- package/docs/models/BundleDownload.md +44 -0
- package/docs/models/BundleRecipient.md +76 -0
- package/docs/models/BundleRegistration.md +53 -0
- package/docs/models/Clickwrap.md +120 -0
- package/docs/models/DnsRecord.md +33 -0
- package/docs/models/Errors.md +17 -0
- package/docs/models/ExternalEvent.md +84 -0
- package/docs/models/File.md +339 -0
- package/docs/models/FileAction.md +13 -0
- package/docs/models/FileComment.md +98 -0
- package/docs/models/FileCommentReaction.md +50 -0
- package/docs/models/FileMigration.md +40 -0
- package/docs/models/FileUploadPart.md +39 -0
- package/docs/models/Folder.md +90 -0
- package/docs/models/FormField.md +29 -0
- package/docs/models/FormFieldSet.md +170 -0
- package/docs/models/Group.md +140 -0
- package/docs/models/GroupUser.md +116 -0
- package/docs/models/History.md +151 -0
- package/docs/models/HistoryExport.md +130 -0
- package/docs/models/HistoryExportResult.md +75 -0
- package/docs/models/Image.md +13 -0
- package/docs/models/InboxRecipient.md +76 -0
- package/docs/models/InboxRegistration.md +47 -0
- package/docs/models/InboxUpload.md +42 -0
- package/docs/models/Invoice.md +82 -0
- package/docs/models/InvoiceLineItem.md +27 -0
- package/docs/models/IpAddress.md +51 -0
- package/docs/models/Lock.md +92 -0
- package/docs/models/Message.md +134 -0
- package/docs/models/MessageComment.md +114 -0
- package/docs/models/MessageCommentReaction.md +79 -0
- package/docs/models/MessageReaction.md +79 -0
- package/docs/models/Notification.md +241 -0
- package/docs/models/Payment.md +82 -0
- package/docs/models/PaymentLineItem.md +19 -0
- package/docs/models/Permission.md +94 -0
- package/docs/models/Preview.md +19 -0
- package/docs/models/Priority.md +30 -0
- package/docs/models/Project.md +98 -0
- package/docs/models/PublicIpAddress.md +17 -0
- package/docs/models/PublicKey.md +112 -0
- package/docs/models/RemoteBandwidthSnapshot.md +42 -0
- package/docs/models/RemoteServer.md +385 -0
- package/docs/models/Request.md +97 -0
- package/docs/models/Session.md +50 -0
- package/docs/models/SettingsChange.md +44 -0
- package/docs/models/Site.md +607 -0
- package/docs/models/SsoStrategy.md +139 -0
- package/docs/models/Status.md +30 -0
- package/docs/models/Style.md +76 -0
- package/docs/models/UsageDailySnapshot.md +56 -0
- package/docs/models/UsageSnapshot.md +63 -0
- package/docs/models/User.md +465 -0
- package/docs/models/UserCipherUse.md +39 -0
- package/docs/models/UserRequest.md +80 -0
- package/docs/models/WebhookTest.md +59 -0
- package/lib/Api.js +12 -11
- package/lib/Errors.js +3126 -0
- package/lib/models/AccountLineItem.js +8 -0
- package/lib/models/Action.js +8 -0
- package/lib/models/ActionNotificationExport.js +21 -13
- package/lib/models/ActionNotificationExportResult.js +13 -5
- package/lib/models/ActionWebhookFailure.js +12 -4
- package/lib/models/ApiKey.js +33 -25
- package/lib/models/App.js +10 -2
- package/lib/models/As2IncomingMessage.js +11 -3
- package/lib/models/As2OutgoingMessage.js +11 -3
- package/lib/models/As2Partner.js +34 -26
- package/lib/models/As2Station.js +32 -24
- package/lib/models/Auto.js +8 -0
- package/lib/models/Automation.js +54 -60
- package/lib/models/AutomationRun.js +16 -8
- package/lib/models/BandwidthSnapshot.js +10 -2
- package/lib/models/Behavior.js +46 -38
- package/lib/models/Bundle.js +51 -43
- package/lib/models/BundleDownload.js +12 -4
- package/lib/models/BundleRecipient.js +22 -14
- package/lib/models/BundleRegistration.js +12 -4
- package/lib/models/Clickwrap.js +31 -23
- package/lib/models/DnsRecord.js +10 -2
- package/lib/models/Errors.js +8 -0
- package/lib/models/ExternalEvent.js +18 -10
- package/lib/models/File.js +68 -60
- package/lib/models/FileAction.js +8 -0
- package/lib/models/FileComment.js +27 -19
- package/lib/models/FileCommentReaction.js +18 -10
- package/lib/models/FileMigration.js +11 -3
- package/lib/models/FileUploadPart.js +8 -0
- package/lib/models/Folder.js +19 -11
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -19
- package/lib/models/Group.js +30 -22
- package/lib/models/GroupUser.js +32 -24
- package/lib/models/History.js +42 -34
- package/lib/models/HistoryExport.js +34 -26
- package/lib/models/HistoryExportResult.js +13 -5
- package/lib/models/Image.js +8 -0
- package/lib/models/InboxRecipient.js +22 -14
- package/lib/models/InboxRegistration.js +11 -3
- package/lib/models/InboxUpload.js +12 -4
- package/lib/models/Invoice.js +13 -5
- package/lib/models/InvoiceLineItem.js +8 -0
- package/lib/models/IpAddress.js +12 -4
- package/lib/models/Lock.js +24 -16
- package/lib/models/Message.js +37 -29
- package/lib/models/MessageComment.js +29 -21
- package/lib/models/MessageCommentReaction.js +24 -16
- package/lib/models/MessageReaction.js +24 -16
- package/lib/models/Notification.js +38 -30
- package/lib/models/Payment.js +13 -5
- package/lib/models/PaymentLineItem.js +8 -0
- package/lib/models/Permission.js +23 -15
- package/lib/models/Preview.js +8 -0
- package/lib/models/Priority.js +13 -5
- package/lib/models/Project.js +25 -17
- package/lib/models/PublicIpAddress.js +8 -0
- package/lib/models/PublicKey.js +29 -21
- package/lib/models/RemoteBandwidthSnapshot.js +10 -2
- package/lib/models/RemoteServer.js +226 -196
- package/lib/models/Request.js +27 -19
- package/lib/models/Session.js +13 -5
- package/lib/models/SettingsChange.js +10 -2
- package/lib/models/Site.js +65 -57
- package/lib/models/SsoStrategy.js +17 -9
- package/lib/models/Status.js +8 -0
- package/lib/models/Style.js +20 -12
- package/lib/models/UsageDailySnapshot.js +10 -2
- package/lib/models/UsageSnapshot.js +10 -2
- package/lib/models/User.js +85 -77
- package/lib/models/UserCipherUse.js +11 -3
- package/lib/models/UserRequest.js +24 -16
- package/lib/models/WebhookTest.js +16 -8
- package/package.json +1 -1
- package/src/Api.js +4 -8
- package/src/Errors.js +222 -0
- package/src/models/AccountLineItem.js +1 -0
- package/src/models/Action.js +1 -0
- package/src/models/ActionNotificationExport.js +14 -13
- package/src/models/ActionNotificationExportResult.js +6 -5
- package/src/models/ActionWebhookFailure.js +5 -4
- package/src/models/ApiKey.js +26 -25
- package/src/models/App.js +3 -2
- package/src/models/As2IncomingMessage.js +4 -3
- package/src/models/As2OutgoingMessage.js +4 -3
- package/src/models/As2Partner.js +27 -26
- package/src/models/As2Station.js +25 -24
- package/src/models/Auto.js +1 -0
- package/src/models/Automation.js +51 -62
- package/src/models/AutomationRun.js +9 -8
- package/src/models/BandwidthSnapshot.js +3 -2
- package/src/models/Behavior.js +39 -38
- package/src/models/Bundle.js +44 -43
- package/src/models/BundleDownload.js +5 -4
- package/src/models/BundleRecipient.js +15 -14
- package/src/models/BundleRegistration.js +5 -4
- package/src/models/Clickwrap.js +24 -23
- package/src/models/DnsRecord.js +3 -2
- package/src/models/Errors.js +1 -0
- package/src/models/ExternalEvent.js +11 -10
- package/src/models/File.js +61 -60
- package/src/models/FileAction.js +1 -0
- package/src/models/FileComment.js +20 -19
- package/src/models/FileCommentReaction.js +11 -10
- package/src/models/FileMigration.js +4 -3
- package/src/models/FileUploadPart.js +1 -0
- package/src/models/Folder.js +12 -11
- package/src/models/FormField.js +1 -0
- package/src/models/FormFieldSet.js +20 -19
- package/src/models/Group.js +23 -22
- package/src/models/GroupUser.js +25 -24
- package/src/models/History.js +35 -34
- package/src/models/HistoryExport.js +27 -26
- package/src/models/HistoryExportResult.js +6 -5
- package/src/models/Image.js +1 -0
- package/src/models/InboxRecipient.js +15 -14
- package/src/models/InboxRegistration.js +4 -3
- package/src/models/InboxUpload.js +5 -4
- package/src/models/Invoice.js +6 -5
- package/src/models/InvoiceLineItem.js +1 -0
- package/src/models/IpAddress.js +5 -4
- package/src/models/Lock.js +17 -16
- package/src/models/Message.js +30 -29
- package/src/models/MessageComment.js +22 -21
- package/src/models/MessageCommentReaction.js +17 -16
- package/src/models/MessageReaction.js +17 -16
- package/src/models/Notification.js +31 -30
- package/src/models/Payment.js +6 -5
- package/src/models/PaymentLineItem.js +1 -0
- package/src/models/Permission.js +16 -15
- package/src/models/Preview.js +3 -2
- package/src/models/Priority.js +6 -5
- package/src/models/Project.js +18 -17
- package/src/models/PublicIpAddress.js +1 -0
- package/src/models/PublicKey.js +22 -21
- package/src/models/RemoteBandwidthSnapshot.js +3 -2
- package/src/models/RemoteServer.js +120 -103
- package/src/models/Request.js +20 -19
- package/src/models/Session.js +6 -5
- package/src/models/SettingsChange.js +3 -2
- package/src/models/Site.js +58 -57
- package/src/models/SsoStrategy.js +10 -9
- package/src/models/Status.js +1 -0
- package/src/models/Style.js +13 -12
- package/src/models/UsageDailySnapshot.js +3 -2
- package/src/models/UsageSnapshot.js +3 -2
- package/src/models/User.js +78 -77
- package/src/models/UserCipherUse.js +4 -3
- package/src/models/UserRequest.js +17 -16
- package/src/models/WebhookTest.js +9 -8
- package/test/src/index.js +46 -0
@@ -0,0 +1,104 @@
|
|
1
|
+
# As2IncomingMessage
|
2
|
+
|
3
|
+
## Example As2IncomingMessage Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"as2_partner_id": 1,
|
9
|
+
"as2_station_id": 1,
|
10
|
+
"uuid": "",
|
11
|
+
"content_type": "",
|
12
|
+
"http_headers": "",
|
13
|
+
"activity_log": "",
|
14
|
+
"processing_result": "",
|
15
|
+
"processing_result_description": "",
|
16
|
+
"mic": "",
|
17
|
+
"mic_algo": "",
|
18
|
+
"as2_to": "",
|
19
|
+
"as2_from": "",
|
20
|
+
"message_id": "",
|
21
|
+
"subject": "",
|
22
|
+
"date": "",
|
23
|
+
"body_size": "",
|
24
|
+
"attachment_filename": "",
|
25
|
+
"ip": "",
|
26
|
+
"created_at": "2000-01-01T01:00:00Z",
|
27
|
+
"http_response_code": "",
|
28
|
+
"http_response_headers": "",
|
29
|
+
"recipient_serial": "",
|
30
|
+
"hex_recipient_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
31
|
+
"recipient_issuer": "",
|
32
|
+
"message_received": true,
|
33
|
+
"message_decrypted": true,
|
34
|
+
"message_signature_verified": true,
|
35
|
+
"message_processing_success": true,
|
36
|
+
"message_mdn_returned": true,
|
37
|
+
"encrypted_uri": "",
|
38
|
+
"smime_signed_uri": "",
|
39
|
+
"smime_uri": "",
|
40
|
+
"raw_uri": "",
|
41
|
+
"mdn_response_uri": ""
|
42
|
+
}
|
43
|
+
```
|
44
|
+
|
45
|
+
* `id` (int64): Id of the AS2 Partner.
|
46
|
+
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
|
47
|
+
* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
|
48
|
+
* `uuid` (string): UUID assigned to this message.
|
49
|
+
* `content_type` (string): Content Type header of the incoming message.
|
50
|
+
* `http_headers` (object): HTTP Headers sent with this message.
|
51
|
+
* `activity_log` (string): JSON Structure of the activity log.
|
52
|
+
* `processing_result` (string): Result of processing.
|
53
|
+
* `processing_result_description` (string): Result of processing description.
|
54
|
+
* `mic` (string): AS2 Message Integrity Check
|
55
|
+
* `mic_algo` (string): AS2 Message Integrity Check Algorithm Used
|
56
|
+
* `as2_to` (string): AS2 TO header of message
|
57
|
+
* `as2_from` (string): AS2 FROM header of message
|
58
|
+
* `message_id` (string): AS2 Message Id
|
59
|
+
* `subject` (string): AS2 Subject Header
|
60
|
+
* `date` (string): Date Header
|
61
|
+
* `body_size` (string): Encrypted Payload Body Size
|
62
|
+
* `attachment_filename` (string): Filename of the file being received.
|
63
|
+
* `ip` (string): IP Address of the Sender
|
64
|
+
* `created_at` (date-time): Message creation date/time
|
65
|
+
* `http_response_code` (string): HTTP Response Code sent for this message
|
66
|
+
* `http_response_headers` (object): HTTP Headers sent for this message.
|
67
|
+
* `recipient_serial` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial
|
68
|
+
* `hex_recipient_serial` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.
|
69
|
+
* `recipient_issuer` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer
|
70
|
+
* `message_received` (boolean): Message body received?
|
71
|
+
* `message_decrypted` (boolean): Message decrypted successfully?
|
72
|
+
* `message_signature_verified` (boolean): Message signature verified?
|
73
|
+
* `message_processing_success` (boolean): Message processed successfully?
|
74
|
+
* `message_mdn_returned` (boolean): MDN returned?
|
75
|
+
* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
|
76
|
+
* `smime_signed_uri` (string): URL to download the file contents as smime with signature
|
77
|
+
* `smime_uri` (string): URL to download the file contents encoded as smime
|
78
|
+
* `raw_uri` (string): URL to download the original file contents
|
79
|
+
* `mdn_response_uri` (string): URL to download the http response body
|
80
|
+
|
81
|
+
---
|
82
|
+
|
83
|
+
## List As2 Incoming Messages
|
84
|
+
|
85
|
+
```
|
86
|
+
await As2IncomingMessage.list({
|
87
|
+
'per_page': 1,
|
88
|
+
'as2_partner_id': 1,
|
89
|
+
})
|
90
|
+
```
|
91
|
+
|
92
|
+
|
93
|
+
### Parameters
|
94
|
+
|
95
|
+
* `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.
|
96
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
97
|
+
* `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`.
|
98
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
99
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
100
|
+
* `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`.
|
101
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
102
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
103
|
+
* `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`.
|
104
|
+
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
@@ -0,0 +1,96 @@
|
|
1
|
+
# As2OutgoingMessage
|
2
|
+
|
3
|
+
## Example As2OutgoingMessage Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"as2_partner_id": 1,
|
9
|
+
"as2_station_id": 1,
|
10
|
+
"uuid": "",
|
11
|
+
"http_headers": "",
|
12
|
+
"activity_log": "",
|
13
|
+
"processing_result": "",
|
14
|
+
"processing_result_description": "",
|
15
|
+
"mic": "",
|
16
|
+
"mic_sha_256": "",
|
17
|
+
"as2_to": "",
|
18
|
+
"as2_from": "",
|
19
|
+
"date": "",
|
20
|
+
"message_id": "",
|
21
|
+
"body_size": "",
|
22
|
+
"attachment_filename": "",
|
23
|
+
"created_at": "2000-01-01T01:00:00Z",
|
24
|
+
"http_response_code": "",
|
25
|
+
"http_response_headers": "",
|
26
|
+
"http_transmission_duration": 1.0,
|
27
|
+
"mdn_received": true,
|
28
|
+
"mdn_valid": true,
|
29
|
+
"mdn_signature_verified": true,
|
30
|
+
"mdn_message_id_matched": true,
|
31
|
+
"mdn_mic_matched": true,
|
32
|
+
"mdn_processing_success": true,
|
33
|
+
"raw_uri": "",
|
34
|
+
"smime_uri": "",
|
35
|
+
"smime_signed_uri": "",
|
36
|
+
"encrypted_uri": "",
|
37
|
+
"mdn_response_uri": ""
|
38
|
+
}
|
39
|
+
```
|
40
|
+
|
41
|
+
* `id` (int64): Id of the AS2 Partner.
|
42
|
+
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
|
43
|
+
* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
|
44
|
+
* `uuid` (string): UUID assigned to this message.
|
45
|
+
* `http_headers` (object): HTTP Headers sent with this message.
|
46
|
+
* `activity_log` (string): JSON Structure of the activity log.
|
47
|
+
* `processing_result` (string): Result of processing.
|
48
|
+
* `processing_result_description` (string): Result of processing description.
|
49
|
+
* `mic` (string): AS2 Message Integrity Check SHA1
|
50
|
+
* `mic_sha_256` (string): AS2 Message Integrity Check SHA256
|
51
|
+
* `as2_to` (string): AS2 TO
|
52
|
+
* `as2_from` (string): AS2 FROM
|
53
|
+
* `date` (string): Date Header
|
54
|
+
* `message_id` (string): AS2 Message Id
|
55
|
+
* `body_size` (string): Encrypted Payload Body Size
|
56
|
+
* `attachment_filename` (string): Filename of the file being sent.
|
57
|
+
* `created_at` (date-time): Message creation date/time
|
58
|
+
* `http_response_code` (string): HTTP Response Code received for this message
|
59
|
+
* `http_response_headers` (object): HTTP Headers received for this message.
|
60
|
+
* `http_transmission_duration` (double): HTTP transmission duration in seceonds
|
61
|
+
* `mdn_received` (boolean): Did the partner give a response body?
|
62
|
+
* `mdn_valid` (boolean): Is the response in MDN format?
|
63
|
+
* `mdn_signature_verified` (boolean): MDN signature verified?
|
64
|
+
* `mdn_message_id_matched` (boolean): MDN message id matched?
|
65
|
+
* `mdn_mic_matched` (boolean): MDN MIC matched?
|
66
|
+
* `mdn_processing_success` (boolean): MDN disposition indicate a successful processing?
|
67
|
+
* `raw_uri` (string): URL to download the original file contents
|
68
|
+
* `smime_uri` (string): URL to download the file contents encoded as smime
|
69
|
+
* `smime_signed_uri` (string): URL to download the file contents as smime with signature
|
70
|
+
* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
|
71
|
+
* `mdn_response_uri` (string): URL to download the http response body
|
72
|
+
|
73
|
+
---
|
74
|
+
|
75
|
+
## List As2 Outgoing Messages
|
76
|
+
|
77
|
+
```
|
78
|
+
await As2OutgoingMessage.list({
|
79
|
+
'per_page': 1,
|
80
|
+
'as2_partner_id': 1,
|
81
|
+
})
|
82
|
+
```
|
83
|
+
|
84
|
+
|
85
|
+
### Parameters
|
86
|
+
|
87
|
+
* `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.
|
88
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
89
|
+
* `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`.
|
90
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
91
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
92
|
+
* `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`.
|
93
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
94
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
95
|
+
* `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`.
|
96
|
+
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
@@ -0,0 +1,141 @@
|
|
1
|
+
# As2Partner
|
2
|
+
|
3
|
+
## Example As2Partner Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"as2_station_id": 1,
|
9
|
+
"name": "AS2 Partner Name",
|
10
|
+
"uri": "",
|
11
|
+
"server_certificate": "require_match",
|
12
|
+
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
13
|
+
"public_certificate_md5": "",
|
14
|
+
"public_certificate_subject": "",
|
15
|
+
"public_certificate_issuer": "",
|
16
|
+
"public_certificate_serial": "",
|
17
|
+
"public_certificate_not_before": "",
|
18
|
+
"public_certificate_not_after": ""
|
19
|
+
}
|
20
|
+
```
|
21
|
+
|
22
|
+
* `id` (int64): Id of the AS2 Partner.
|
23
|
+
* `as2_station_id` (int64): Id of the AS2 Station associated with this partner.
|
24
|
+
* `name` (string): The partner's formal AS2 name.
|
25
|
+
* `uri` (string): Public URI for sending AS2 message to.
|
26
|
+
* `server_certificate` (string): Remote server certificate security setting
|
27
|
+
* `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
|
28
|
+
* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
|
29
|
+
* `public_certificate_subject` (string): Subject of public certificate used for message security.
|
30
|
+
* `public_certificate_issuer` (string): Issuer of public certificate used for message security.
|
31
|
+
* `public_certificate_serial` (string): Serial of public certificate used for message security.
|
32
|
+
* `public_certificate_not_before` (string): Not before value of public certificate used for message security.
|
33
|
+
* `public_certificate_not_after` (string): Not after value of public certificate used for message security.
|
34
|
+
* `public_certificate` (string):
|
35
|
+
|
36
|
+
---
|
37
|
+
|
38
|
+
## List As2 Partners
|
39
|
+
|
40
|
+
```
|
41
|
+
await As2Partner.list({
|
42
|
+
'per_page': 1,
|
43
|
+
})
|
44
|
+
```
|
45
|
+
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
* `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.
|
50
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
51
|
+
|
52
|
+
---
|
53
|
+
|
54
|
+
## Show As2 Partner
|
55
|
+
|
56
|
+
```
|
57
|
+
await As2Partner.find(id)
|
58
|
+
```
|
59
|
+
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
* `id` (int64): Required - As2 Partner ID.
|
64
|
+
|
65
|
+
---
|
66
|
+
|
67
|
+
## Create As2 Partner
|
68
|
+
|
69
|
+
```
|
70
|
+
await As2Partner.create({
|
71
|
+
'name': "name",
|
72
|
+
'uri': "uri",
|
73
|
+
'public_certificate': "public_certificate",
|
74
|
+
'as2_station_id': 1,
|
75
|
+
'server_certificate': "require_match",
|
76
|
+
})
|
77
|
+
```
|
78
|
+
|
79
|
+
|
80
|
+
### Parameters
|
81
|
+
|
82
|
+
* `name` (string): Required - AS2 Name
|
83
|
+
* `uri` (string): Required - URL base for AS2 responses
|
84
|
+
* `public_certificate` (string): Required -
|
85
|
+
* `as2_station_id` (int64): Required - Id of As2Station for this partner
|
86
|
+
* `server_certificate` (string): Remote server certificate security setting
|
87
|
+
|
88
|
+
---
|
89
|
+
|
90
|
+
## Update As2 Partner
|
91
|
+
|
92
|
+
```
|
93
|
+
const [as2_partner] = await As2Partner.list()
|
94
|
+
|
95
|
+
await as2_partner.update({
|
96
|
+
'name': "AS2 Partner Name",
|
97
|
+
'server_certificate': "require_match",
|
98
|
+
})
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
* `id` (int64): Required - As2 Partner ID.
|
104
|
+
* `name` (string): AS2 Name
|
105
|
+
* `uri` (string): URL base for AS2 responses
|
106
|
+
* `server_certificate` (string): Remote server certificate security setting
|
107
|
+
* `public_certificate` (string):
|
108
|
+
|
109
|
+
### Example Response
|
110
|
+
|
111
|
+
```json
|
112
|
+
{
|
113
|
+
"id": 1,
|
114
|
+
"as2_station_id": 1,
|
115
|
+
"name": "AS2 Partner Name",
|
116
|
+
"uri": "",
|
117
|
+
"server_certificate": "require_match",
|
118
|
+
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
119
|
+
"public_certificate_md5": "",
|
120
|
+
"public_certificate_subject": "",
|
121
|
+
"public_certificate_issuer": "",
|
122
|
+
"public_certificate_serial": "",
|
123
|
+
"public_certificate_not_before": "",
|
124
|
+
"public_certificate_not_after": ""
|
125
|
+
}
|
126
|
+
```
|
127
|
+
|
128
|
+
---
|
129
|
+
|
130
|
+
## Delete As2 Partner
|
131
|
+
|
132
|
+
```
|
133
|
+
const [as2_partner] = await As2Partner.list()
|
134
|
+
|
135
|
+
await as2_partner.delete()
|
136
|
+
```
|
137
|
+
|
138
|
+
### Parameters
|
139
|
+
|
140
|
+
* `id` (int64): Required - As2 Partner ID.
|
141
|
+
|
@@ -0,0 +1,142 @@
|
|
1
|
+
# As2Station
|
2
|
+
|
3
|
+
## Example As2Station Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"name": "AS2 Station Name",
|
9
|
+
"uri": "",
|
10
|
+
"domain": "domain.test",
|
11
|
+
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
12
|
+
"public_certificate_md5": "",
|
13
|
+
"private_key_md5": "",
|
14
|
+
"public_certificate_subject": "",
|
15
|
+
"public_certificate_issuer": "",
|
16
|
+
"public_certificate_serial": "",
|
17
|
+
"public_certificate_not_before": "",
|
18
|
+
"public_certificate_not_after": "",
|
19
|
+
"private_key_password_md5": ""
|
20
|
+
}
|
21
|
+
```
|
22
|
+
|
23
|
+
* `id` (int64): Id of the AS2 Station.
|
24
|
+
* `name` (string): The station's formal AS2 name.
|
25
|
+
* `uri` (string): Public URI for sending AS2 message to.
|
26
|
+
* `domain` (string): The station's AS2 domain name.
|
27
|
+
* `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
|
28
|
+
* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
|
29
|
+
* `private_key_md5` (string): MD5 hash of private key used for message security.
|
30
|
+
* `public_certificate_subject` (string): Subject of public certificate used for message security.
|
31
|
+
* `public_certificate_issuer` (string): Issuer of public certificate used for message security.
|
32
|
+
* `public_certificate_serial` (string): Serial of public certificate used for message security.
|
33
|
+
* `public_certificate_not_before` (string): Not before value of public certificate used for message security.
|
34
|
+
* `public_certificate_not_after` (string): Not after value of public certificate used for message security.
|
35
|
+
* `private_key_password_md5` (string): MD5 hash of private key password used for message security.
|
36
|
+
* `public_certificate` (string):
|
37
|
+
* `private_key` (string):
|
38
|
+
* `private_key_password` (string):
|
39
|
+
|
40
|
+
---
|
41
|
+
|
42
|
+
## List As2 Stations
|
43
|
+
|
44
|
+
```
|
45
|
+
await As2Station.list({
|
46
|
+
'per_page': 1,
|
47
|
+
})
|
48
|
+
```
|
49
|
+
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
* `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.
|
54
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
55
|
+
|
56
|
+
---
|
57
|
+
|
58
|
+
## Show As2 Station
|
59
|
+
|
60
|
+
```
|
61
|
+
await As2Station.find(id)
|
62
|
+
```
|
63
|
+
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
* `id` (int64): Required - As2 Station ID.
|
68
|
+
|
69
|
+
---
|
70
|
+
|
71
|
+
## Create As2 Station
|
72
|
+
|
73
|
+
```
|
74
|
+
await As2Station.create({
|
75
|
+
'name': "name",
|
76
|
+
'public_certificate': "public_certificate",
|
77
|
+
'private_key': "private_key",
|
78
|
+
})
|
79
|
+
```
|
80
|
+
|
81
|
+
|
82
|
+
### Parameters
|
83
|
+
|
84
|
+
* `name` (string): Required - AS2 Name
|
85
|
+
* `public_certificate` (string): Required -
|
86
|
+
* `private_key` (string): Required -
|
87
|
+
* `private_key_password` (string):
|
88
|
+
|
89
|
+
---
|
90
|
+
|
91
|
+
## Update As2 Station
|
92
|
+
|
93
|
+
```
|
94
|
+
const [as2_station] = await As2Station.list()
|
95
|
+
|
96
|
+
await as2_station.update({
|
97
|
+
'name': "AS2 Station Name",
|
98
|
+
})
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
* `id` (int64): Required - As2 Station ID.
|
104
|
+
* `name` (string): AS2 Name
|
105
|
+
* `public_certificate` (string):
|
106
|
+
* `private_key` (string):
|
107
|
+
* `private_key_password` (string):
|
108
|
+
|
109
|
+
### Example Response
|
110
|
+
|
111
|
+
```json
|
112
|
+
{
|
113
|
+
"id": 1,
|
114
|
+
"name": "AS2 Station Name",
|
115
|
+
"uri": "",
|
116
|
+
"domain": "domain.test",
|
117
|
+
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
118
|
+
"public_certificate_md5": "",
|
119
|
+
"private_key_md5": "",
|
120
|
+
"public_certificate_subject": "",
|
121
|
+
"public_certificate_issuer": "",
|
122
|
+
"public_certificate_serial": "",
|
123
|
+
"public_certificate_not_before": "",
|
124
|
+
"public_certificate_not_after": "",
|
125
|
+
"private_key_password_md5": ""
|
126
|
+
}
|
127
|
+
```
|
128
|
+
|
129
|
+
---
|
130
|
+
|
131
|
+
## Delete As2 Station
|
132
|
+
|
133
|
+
```
|
134
|
+
const [as2_station] = await As2Station.list()
|
135
|
+
|
136
|
+
await as2_station.delete()
|
137
|
+
```
|
138
|
+
|
139
|
+
### Parameters
|
140
|
+
|
141
|
+
* `id` (int64): Required - As2 Station ID.
|
142
|
+
|