files.com 1.0.231 → 1.0.232
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/as2_incoming_message.md +55 -0
- data/docs/as2_outgoing_message.md +49 -0
- data/docs/as2_partner.md +136 -0
- data/docs/as2_station.md +148 -0
- data/docs/history_export.md +2 -2
- data/docs/history_export_result.md +1 -1
- data/lib/files.com/errors.rb +1 -0
- data/lib/files.com/models/as2_incoming_message.rb +100 -0
- data/lib/files.com/models/as2_outgoing_message.rb +85 -0
- data/lib/files.com/models/as2_partner.rb +188 -0
- data/lib/files.com/models/as2_station.rb +217 -0
- data/lib/files.com/models/history_export.rb +2 -2
- data/lib/files.com/models/history_export_result.rb +1 -1
- data/lib/files.com.rb +4 -1
- metadata +11 -5
- data/docs/as2_key.md +0 -131
- data/lib/files.com/models/as2_key.rb +0 -176
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4e853badb0a1e39fec123b97f30f3464469400fe2bb515d278f18dbf11218b4b
|
|
4
|
+
data.tar.gz: e6d7bf73ac7299cb6f2fe321a36abc39139cad3b1eb81adc98db906f7184d4e9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 351b85e9adf6a772545a5da425ea0367fe5ca58db50cab1a439cc5e7f80e2a0d7f70369165fbb1d37bb5ea8d741989a70eb297866d5056c15db4a199404a70c4
|
|
7
|
+
data.tar.gz: 2fe0748bd322d8550e461a57a9d27e6f2496cbdfd6eab2c7fa17bfcb8b4a9c1bd960ca18a0261090b9006deef2aa17a554ecc3da377c5c65fc06cdec09e658e9
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.232
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# As2IncomingMessage
|
|
2
|
+
|
|
3
|
+
## Example As2IncomingMessage Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"as2_partner_id": 1,
|
|
9
|
+
"uuid": "",
|
|
10
|
+
"content_type": "",
|
|
11
|
+
"http_headers": "",
|
|
12
|
+
"activity_log": "",
|
|
13
|
+
"processing_result": "",
|
|
14
|
+
"as2_to": "",
|
|
15
|
+
"as2_from": "",
|
|
16
|
+
"message_id": "",
|
|
17
|
+
"subject": "",
|
|
18
|
+
"body_size": "",
|
|
19
|
+
"attachment_filename": "",
|
|
20
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
* `id` (int64): Id of the AS2 Partner.
|
|
25
|
+
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
|
|
26
|
+
* `uuid` (string): UUID assigned to this message.
|
|
27
|
+
* `content_type` (string): Content Type header of the incoming message.
|
|
28
|
+
* `http_headers` (object): HTTP Headers sent with this message.
|
|
29
|
+
* `activity_log` (string): JSON Structure of the activity log.
|
|
30
|
+
* `processing_result` (string): Result of processing. Valid values: `unable_to_find_station`, `unable_to_find_partner`, `unable_to_validate_signature`, `decrypt_fail`, `file_save_fail`, `success`
|
|
31
|
+
* `as2_to` (string): AS2 TO header of message
|
|
32
|
+
* `as2_from` (string): AS2 FROM header of message
|
|
33
|
+
* `message_id` (string): AS2 Message Id
|
|
34
|
+
* `subject` (string): AS2 Subject Header
|
|
35
|
+
* `body_size` (string): Encrypted Payload Body Size
|
|
36
|
+
* `attachment_filename` (string): Filename of the file being received.
|
|
37
|
+
* `created_at` (date-time): Message creation date/time
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## List As2 Incoming Messages
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
Files::As2IncomingMessage.list(
|
|
46
|
+
per_page: 1,
|
|
47
|
+
as2_partner_id: 1
|
|
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
|
+
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# As2OutgoingMessage
|
|
2
|
+
|
|
3
|
+
## Example As2OutgoingMessage Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"as2_partner_id": 1,
|
|
9
|
+
"uuid": "",
|
|
10
|
+
"http_headers": "",
|
|
11
|
+
"activity_log": "",
|
|
12
|
+
"processing_result": "",
|
|
13
|
+
"mic": "",
|
|
14
|
+
"message_id": "",
|
|
15
|
+
"body_size": "",
|
|
16
|
+
"attachment_filename": "",
|
|
17
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
18
|
+
}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
* `id` (int64): Id of the AS2 Partner.
|
|
22
|
+
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
|
|
23
|
+
* `uuid` (string): UUID assigned to this message.
|
|
24
|
+
* `http_headers` (object): HTTP Headers sent with this message.
|
|
25
|
+
* `activity_log` (string): JSON Structure of the activity log.
|
|
26
|
+
* `processing_result` (string): Result of processing. Valid values: `send_failed`, `send_success`
|
|
27
|
+
* `mic` (string): AS2 Message Integrity Check
|
|
28
|
+
* `message_id` (string): AS2 Message Id
|
|
29
|
+
* `body_size` (string): Encrypted Payload Body Size
|
|
30
|
+
* `attachment_filename` (string): Filename of the file being sent.
|
|
31
|
+
* `created_at` (date-time): Message creation date/time
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## List As2 Outgoing Messages
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
Files::As2OutgoingMessage.list(
|
|
40
|
+
per_page: 1,
|
|
41
|
+
as2_partner_id: 1
|
|
42
|
+
)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
* `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.
|
|
48
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
49
|
+
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
data/docs/as2_partner.md
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
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
|
+
"public_certificate_md5": ""
|
|
12
|
+
}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
* `id` (int64): Id of the AS2 Partner.
|
|
16
|
+
* `as2_station_id` (int64): Id of the AS2 Station associated with this partner.
|
|
17
|
+
* `name` (string): The partner's formal AS2 name.
|
|
18
|
+
* `uri` (string): Public URI for sending AS2 message to.
|
|
19
|
+
* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
|
|
20
|
+
* `public_certificate` (string):
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## List As2 Partners
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Files::As2Partner.list(
|
|
29
|
+
per_page: 1
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
* `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.
|
|
36
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Show As2 Partner
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
Files::As2Partner.find(id)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
* `id` (int64): Required - As2 Partner ID.
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Create As2 Partner
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
Files::As2Partner.create(
|
|
58
|
+
name: "name",
|
|
59
|
+
uri: "uri",
|
|
60
|
+
public_certificate: "public_certificate",
|
|
61
|
+
as2_station_id: 1
|
|
62
|
+
)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Parameters
|
|
66
|
+
|
|
67
|
+
* `name` (string): Required - AS2 Name
|
|
68
|
+
* `uri` (string): Required - URL base for AS2 responses
|
|
69
|
+
* `public_certificate` (string): Required -
|
|
70
|
+
* `as2_station_id` (int64): Required - Id of As2Station for this partner
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Update As2 Partner
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
Files::As2Partner.update(id,
|
|
79
|
+
name: "AS2 Partner Name"
|
|
80
|
+
)
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
* `id` (int64): Required - As2 Partner ID.
|
|
86
|
+
* `name` (string): AS2 Name
|
|
87
|
+
* `uri` (string): URL base for AS2 responses
|
|
88
|
+
* `public_certificate` (string):
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Delete As2 Partner
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
Files::As2Partner.delete(id)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
* `id` (int64): Required - As2 Partner ID.
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Update As2 Partner
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
as2_partner = Files::As2Partner.list.first
|
|
110
|
+
|
|
111
|
+
as2_partner.update(
|
|
112
|
+
name: "AS2 Partner Name"
|
|
113
|
+
)
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Parameters
|
|
117
|
+
|
|
118
|
+
* `id` (int64): Required - As2 Partner ID.
|
|
119
|
+
* `name` (string): AS2 Name
|
|
120
|
+
* `uri` (string): URL base for AS2 responses
|
|
121
|
+
* `public_certificate` (string):
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## Delete As2 Partner
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
as2_partner = Files::As2Partner.list.first
|
|
130
|
+
|
|
131
|
+
as2_partner.delete
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Parameters
|
|
135
|
+
|
|
136
|
+
* `id` (int64): Required - As2 Partner ID.
|
data/docs/as2_station.md
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
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
|
+
"public_certificate": "",
|
|
12
|
+
"public_certificate_md5": "",
|
|
13
|
+
"private_key_md5": ""
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
* `id` (int64): Id of the AS2 Station.
|
|
18
|
+
* `name` (string): The station's formal AS2 name.
|
|
19
|
+
* `uri` (string): Public URI for sending AS2 message to.
|
|
20
|
+
* `domain` (string): The station's AS2 domain name.
|
|
21
|
+
* `public_certificate` (string): Public certificate used for message security.
|
|
22
|
+
* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
|
|
23
|
+
* `private_key_md5` (string): MD5 hash of private key used for message security.
|
|
24
|
+
* `private_key` (string):
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## List As2 Stations
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
Files::As2Station.list(
|
|
33
|
+
per_page: 1
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
* `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.
|
|
40
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Show As2 Station
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
Files::As2Station.find(id)
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
* `id` (int64): Required - As2 Station ID.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Create As2 Station
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
Files::As2Station.create(
|
|
62
|
+
name: "name",
|
|
63
|
+
domain: "domain",
|
|
64
|
+
uri: "uri",
|
|
65
|
+
public_certificate: "public_certificate",
|
|
66
|
+
private_key: "private_key"
|
|
67
|
+
)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
* `name` (string): Required - AS2 Name
|
|
73
|
+
* `domain` (string): Required - AS2 Domain
|
|
74
|
+
* `uri` (string): Required - URL base for AS2 responses
|
|
75
|
+
* `public_certificate` (string): Required -
|
|
76
|
+
* `private_key` (string): Required -
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Update As2 Station
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
Files::As2Station.update(id,
|
|
85
|
+
name: "AS2 Station Name",
|
|
86
|
+
domain: "domain.test"
|
|
87
|
+
)
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
* `id` (int64): Required - As2 Station ID.
|
|
93
|
+
* `name` (string): AS2 Name
|
|
94
|
+
* `domain` (string): AS2 Domain
|
|
95
|
+
* `uri` (string): URL base for AS2 responses
|
|
96
|
+
* `public_certificate` (string):
|
|
97
|
+
* `private_key` (string):
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Delete As2 Station
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
Files::As2Station.delete(id)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
* `id` (int64): Required - As2 Station ID.
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Update As2 Station
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
as2_station = Files::As2Station.list.first
|
|
119
|
+
|
|
120
|
+
as2_station.update(
|
|
121
|
+
name: "AS2 Station Name",
|
|
122
|
+
domain: "domain.test"
|
|
123
|
+
)
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Parameters
|
|
127
|
+
|
|
128
|
+
* `id` (int64): Required - As2 Station ID.
|
|
129
|
+
* `name` (string): AS2 Name
|
|
130
|
+
* `domain` (string): AS2 Domain
|
|
131
|
+
* `uri` (string): URL base for AS2 responses
|
|
132
|
+
* `public_certificate` (string):
|
|
133
|
+
* `private_key` (string):
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## Delete As2 Station
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
as2_station = Files::As2Station.list.first
|
|
142
|
+
|
|
143
|
+
as2_station.delete
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
|
|
148
|
+
* `id` (int64): Required - As2 Station ID.
|
data/docs/history_export.md
CHANGED
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
* `end_at` (date-time): End date/time of export range.
|
|
39
39
|
* `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
|
|
40
40
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
|
41
|
-
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
|
|
41
|
+
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
|
42
42
|
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
|
43
43
|
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
|
44
44
|
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
|
@@ -110,7 +110,7 @@ Files::HistoryExport.create(
|
|
|
110
110
|
* `start_at` (string): Start date/time of export range.
|
|
111
111
|
* `end_at` (string): End date/time of export range.
|
|
112
112
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
|
113
|
-
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
|
|
113
|
+
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
|
114
114
|
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
|
115
115
|
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
|
116
116
|
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
* `username` (string): Username of the user that performed the action
|
|
44
44
|
* `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
|
45
45
|
* `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
|
|
46
|
-
* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
|
|
46
|
+
* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
|
47
47
|
* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
|
|
48
48
|
* `target_name` (string): Name of the User, Group or other object with a name related to this action
|
|
49
49
|
* `target_permission` (string): Permission level of the action
|
data/lib/files.com/errors.rb
CHANGED
|
@@ -161,6 +161,7 @@ module Files
|
|
|
161
161
|
class DestinationFolderLimitedError < ProcessingFailureError; end
|
|
162
162
|
class DestinationParentConflictError < ProcessingFailureError; end
|
|
163
163
|
class DestinationParentDoesNotExistError < ProcessingFailureError; end
|
|
164
|
+
class ExpiredPrivateKeyError < ProcessingFailureError; end
|
|
164
165
|
class ExpiredPublicKeyError < ProcessingFailureError; end
|
|
165
166
|
class ExportFailureError < ProcessingFailureError; end
|
|
166
167
|
class ExportNotReadyError < ProcessingFailureError; end
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class As2IncomingMessage
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Id of the AS2 Partner.
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# int64 - Id of the AS2 Partner associated with this message.
|
|
18
|
+
def as2_partner_id
|
|
19
|
+
@attributes[:as2_partner_id]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# string - UUID assigned to this message.
|
|
23
|
+
def uuid
|
|
24
|
+
@attributes[:uuid]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# string - Content Type header of the incoming message.
|
|
28
|
+
def content_type
|
|
29
|
+
@attributes[:content_type]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# object - HTTP Headers sent with this message.
|
|
33
|
+
def http_headers
|
|
34
|
+
@attributes[:http_headers]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# string - JSON Structure of the activity log.
|
|
38
|
+
def activity_log
|
|
39
|
+
@attributes[:activity_log]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - Result of processing. Valid values: `unable_to_find_station`, `unable_to_find_partner`, `unable_to_validate_signature`, `decrypt_fail`, `file_save_fail`, `success`
|
|
43
|
+
def processing_result
|
|
44
|
+
@attributes[:processing_result]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# string - AS2 TO header of message
|
|
48
|
+
def as2_to
|
|
49
|
+
@attributes[:as2_to]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# string - AS2 FROM header of message
|
|
53
|
+
def as2_from
|
|
54
|
+
@attributes[:as2_from]
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - AS2 Message Id
|
|
58
|
+
def message_id
|
|
59
|
+
@attributes[:message_id]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# string - AS2 Subject Header
|
|
63
|
+
def subject
|
|
64
|
+
@attributes[:subject]
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# string - Encrypted Payload Body Size
|
|
68
|
+
def body_size
|
|
69
|
+
@attributes[:body_size]
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# string - Filename of the file being received.
|
|
73
|
+
def attachment_filename
|
|
74
|
+
@attributes[:attachment_filename]
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
# date-time - Message creation date/time
|
|
78
|
+
def created_at
|
|
79
|
+
@attributes[:created_at]
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Parameters:
|
|
83
|
+
# 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.
|
|
84
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
85
|
+
# as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.
|
|
86
|
+
def self.list(params = {}, options = {})
|
|
87
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
|
88
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
|
89
|
+
raise InvalidParameterError.new("Bad parameter: as2_partner_id must be an Integer") if params.dig(:as2_partner_id) and !params.dig(:as2_partner_id).is_a?(Integer)
|
|
90
|
+
|
|
91
|
+
List.new(As2IncomingMessage, params) do
|
|
92
|
+
Api.send_request("/as2_incoming_messages", :get, params, options)
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
def self.all(params = {}, options = {})
|
|
97
|
+
list(params, options)
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class As2OutgoingMessage
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# int64 - Id of the AS2 Partner.
|
|
13
|
+
def id
|
|
14
|
+
@attributes[:id]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# int64 - Id of the AS2 Partner associated with this message.
|
|
18
|
+
def as2_partner_id
|
|
19
|
+
@attributes[:as2_partner_id]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# string - UUID assigned to this message.
|
|
23
|
+
def uuid
|
|
24
|
+
@attributes[:uuid]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# object - HTTP Headers sent with this message.
|
|
28
|
+
def http_headers
|
|
29
|
+
@attributes[:http_headers]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# string - JSON Structure of the activity log.
|
|
33
|
+
def activity_log
|
|
34
|
+
@attributes[:activity_log]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# string - Result of processing. Valid values: `send_failed`, `send_success`
|
|
38
|
+
def processing_result
|
|
39
|
+
@attributes[:processing_result]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - AS2 Message Integrity Check
|
|
43
|
+
def mic
|
|
44
|
+
@attributes[:mic]
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# string - AS2 Message Id
|
|
48
|
+
def message_id
|
|
49
|
+
@attributes[:message_id]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# string - Encrypted Payload Body Size
|
|
53
|
+
def body_size
|
|
54
|
+
@attributes[:body_size]
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Filename of the file being sent.
|
|
58
|
+
def attachment_filename
|
|
59
|
+
@attributes[:attachment_filename]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# date-time - Message creation date/time
|
|
63
|
+
def created_at
|
|
64
|
+
@attributes[:created_at]
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Parameters:
|
|
68
|
+
# 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.
|
|
69
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
70
|
+
# as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.
|
|
71
|
+
def self.list(params = {}, options = {})
|
|
72
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
|
73
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
|
74
|
+
raise InvalidParameterError.new("Bad parameter: as2_partner_id must be an Integer") if params.dig(:as2_partner_id) and !params.dig(:as2_partner_id).is_a?(Integer)
|
|
75
|
+
|
|
76
|
+
List.new(As2OutgoingMessage, params) do
|
|
77
|
+
Api.send_request("/as2_outgoing_messages", :get, params, options)
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
def self.all(params = {}, options = {})
|
|
82
|
+
list(params, options)
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|