files.com 1.0.245 → 1.0.263
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/account_line_item.md +2 -2
- data/docs/as2_incoming_message.md +49 -2
- data/docs/as2_outgoing_message.md +46 -3
- data/docs/as2_partner.md +24 -4
- data/docs/as2_station.md +22 -15
- data/docs/automation.md +8 -0
- data/docs/bundle.md +27 -3
- data/docs/bundle_download.md +1 -1
- data/docs/file.md +1 -1
- data/docs/file_comment.md +1 -1
- data/docs/folder.md +6 -2
- data/docs/form_field_set.md +1 -1
- data/docs/inbox_upload.md +1 -1
- data/docs/invoice.md +2 -2
- data/docs/message.md +1 -1
- data/docs/message_comment.md +1 -1
- data/docs/payment.md +2 -2
- data/docs/session.md +1 -33
- data/docs/site.md +11 -8
- data/docs/sso_strategy.md +28 -0
- data/docs/status.md +2 -2
- data/docs/style.md +2 -2
- data/docs/user.md +1 -1
- data/docs/webhook_test.md +1 -1
- data/lib/files.com/errors.rb +1 -0
- data/lib/files.com/models/account_line_item.rb +2 -2
- data/lib/files.com/models/as2_incoming_message.rb +115 -1
- data/lib/files.com/models/as2_outgoing_message.rb +106 -2
- data/lib/files.com/models/as2_partner.rb +69 -0
- data/lib/files.com/models/as2_station.rb +83 -19
- data/lib/files.com/models/automation.rb +12 -0
- data/lib/files.com/models/bundle.rb +38 -2
- data/lib/files.com/models/bundle_download.rb +1 -0
- data/lib/files.com/models/file.rb +1 -1
- data/lib/files.com/models/file_comment.rb +1 -1
- data/lib/files.com/models/folder.rb +11 -1
- data/lib/files.com/models/form_field_set.rb +1 -1
- data/lib/files.com/models/inbox_upload.rb +1 -0
- data/lib/files.com/models/invoice.rb +2 -2
- data/lib/files.com/models/message.rb +1 -1
- data/lib/files.com/models/message_comment.rb +1 -1
- data/lib/files.com/models/payment.rb +2 -2
- data/lib/files.com/models/session.rb +0 -144
- data/lib/files.com/models/site.rb +15 -8
- data/lib/files.com/models/sso_strategy.rb +22 -0
- data/lib/files.com/models/status.rb +2 -2
- data/lib/files.com/models/style.rb +2 -2
- data/lib/files.com/models/user.rb +1 -1
- data/lib/files.com/models/webhook_test.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 415f60c947b24e213dcab7b7f18bd802868b723e6d2399f40263079f47e5fbf7
|
4
|
+
data.tar.gz: b8420a20451e8e08dab0381acbc72180620b768638f95f0dc86f1efcad6a1c32
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0ce056ebf1594d115ae3f1eac0f53ccbc3148423ffbfaeb8bfe17216eefc5be03d6608d43d0d5e0da389e7fe9beadf3fe294423374be28d45904c2506cc7b3d0
|
7
|
+
data.tar.gz: c5e10ff72b9614ad58b6f3385f47e530230dbd209a1538061ca6ac62a31db0000f731560b5d7141588a51b5c6622c02cdb82646c5b9eb6396ad7c236a76905e9
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.263
|
data/docs/account_line_item.md
CHANGED
@@ -43,9 +43,9 @@
|
|
43
43
|
* `created_at` (date-time): Line item created at
|
44
44
|
* `currency` (string): Line item currency
|
45
45
|
* `download_uri` (string): Line item download uri
|
46
|
-
* `invoice_line_items
|
46
|
+
* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
|
47
47
|
* `method` (string): Line item payment method
|
48
|
-
* `payment_line_items
|
48
|
+
* `payment_line_items` (PaymentLineItem): Associated payment line items
|
49
49
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
50
50
|
* `payment_type` (string): Type of payment if applicable
|
51
51
|
* `site_name` (string): Site name this line item is for
|
@@ -6,35 +6,75 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"as2_partner_id": 1,
|
9
|
+
"as2_station_id": 1,
|
9
10
|
"uuid": "",
|
10
11
|
"content_type": "",
|
11
12
|
"http_headers": "",
|
12
13
|
"activity_log": "",
|
13
14
|
"processing_result": "",
|
15
|
+
"mic": "",
|
16
|
+
"mic_algo": "",
|
14
17
|
"as2_to": "",
|
15
18
|
"as2_from": "",
|
16
19
|
"message_id": "",
|
17
20
|
"subject": "",
|
21
|
+
"date": "",
|
18
22
|
"body_size": "",
|
19
23
|
"attachment_filename": "",
|
20
|
-
"
|
24
|
+
"ip": "",
|
25
|
+
"created_at": "2000-01-01T01:00:00Z",
|
26
|
+
"http_response_code": "",
|
27
|
+
"http_response_headers": "",
|
28
|
+
"recipient_serial": "",
|
29
|
+
"hex_recipient_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
30
|
+
"recipient_issuer": "",
|
31
|
+
"message_received": true,
|
32
|
+
"message_decrypted": true,
|
33
|
+
"message_signature_verified": true,
|
34
|
+
"message_processing_success": true,
|
35
|
+
"message_mdn_returned": true,
|
36
|
+
"encrypted_uri": "",
|
37
|
+
"smime_signed_uri": "",
|
38
|
+
"smime_uri": "",
|
39
|
+
"raw_uri": "",
|
40
|
+
"mdn_response_uri": ""
|
21
41
|
}
|
22
42
|
```
|
23
43
|
|
24
44
|
* `id` (int64): Id of the AS2 Partner.
|
25
45
|
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
|
46
|
+
* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
|
26
47
|
* `uuid` (string): UUID assigned to this message.
|
27
48
|
* `content_type` (string): Content Type header of the incoming message.
|
28
49
|
* `http_headers` (object): HTTP Headers sent with this message.
|
29
50
|
* `activity_log` (string): JSON Structure of the activity log.
|
30
|
-
* `processing_result` (string): Result of processing.
|
51
|
+
* `processing_result` (string): Result of processing.
|
52
|
+
* `mic` (string): AS2 Message Integrity Check
|
53
|
+
* `mic_algo` (string): AS2 Message Integrity Check Algorithm Used
|
31
54
|
* `as2_to` (string): AS2 TO header of message
|
32
55
|
* `as2_from` (string): AS2 FROM header of message
|
33
56
|
* `message_id` (string): AS2 Message Id
|
34
57
|
* `subject` (string): AS2 Subject Header
|
58
|
+
* `date` (string): Date Header
|
35
59
|
* `body_size` (string): Encrypted Payload Body Size
|
36
60
|
* `attachment_filename` (string): Filename of the file being received.
|
61
|
+
* `ip` (string): IP Address of the Sender
|
37
62
|
* `created_at` (date-time): Message creation date/time
|
63
|
+
* `http_response_code` (string): HTTP Response Code sent for this message
|
64
|
+
* `http_response_headers` (object): HTTP Headers sent for this message.
|
65
|
+
* `recipient_serial` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial
|
66
|
+
* `hex_recipient_serial` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.
|
67
|
+
* `recipient_issuer` (string): Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer
|
68
|
+
* `message_received` (boolean): Message body received?
|
69
|
+
* `message_decrypted` (boolean): Message decrypted successfully?
|
70
|
+
* `message_signature_verified` (boolean): Message signature verified?
|
71
|
+
* `message_processing_success` (boolean): Message processed successfully?
|
72
|
+
* `message_mdn_returned` (boolean): MDN returned?
|
73
|
+
* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
|
74
|
+
* `smime_signed_uri` (string): URL to download the file contents as smime with signature
|
75
|
+
* `smime_uri` (string): URL to download the file contents encoded as smime
|
76
|
+
* `raw_uri` (string): URL to download the original file contents
|
77
|
+
* `mdn_response_uri` (string): URL to download the http response body
|
38
78
|
|
39
79
|
|
40
80
|
---
|
@@ -52,4 +92,11 @@ Files::As2IncomingMessage.list(
|
|
52
92
|
|
53
93
|
* `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
94
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
95
|
+
* `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`.
|
96
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
97
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
98
|
+
* `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`.
|
99
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
100
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
101
|
+
* `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`.
|
55
102
|
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
@@ -6,29 +6,65 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"as2_partner_id": 1,
|
9
|
+
"as2_station_id": 1,
|
9
10
|
"uuid": "",
|
10
11
|
"http_headers": "",
|
11
12
|
"activity_log": "",
|
12
13
|
"processing_result": "",
|
13
14
|
"mic": "",
|
15
|
+
"mic_sha_256": "",
|
16
|
+
"as2_to": "",
|
17
|
+
"as2_from": "",
|
18
|
+
"date": "",
|
14
19
|
"message_id": "",
|
15
20
|
"body_size": "",
|
16
21
|
"attachment_filename": "",
|
17
|
-
"created_at": "2000-01-01T01:00:00Z"
|
22
|
+
"created_at": "2000-01-01T01:00:00Z",
|
23
|
+
"http_response_code": "",
|
24
|
+
"http_response_headers": "",
|
25
|
+
"mdn_received": true,
|
26
|
+
"mdn_valid": true,
|
27
|
+
"mdn_signature_verified": true,
|
28
|
+
"mdn_message_id_matched": true,
|
29
|
+
"mdn_mic_matched": true,
|
30
|
+
"mdn_processing_success": true,
|
31
|
+
"raw_uri": "",
|
32
|
+
"smime_uri": "",
|
33
|
+
"smime_signed_uri": "",
|
34
|
+
"encrypted_uri": "",
|
35
|
+
"mdn_response_uri": ""
|
18
36
|
}
|
19
37
|
```
|
20
38
|
|
21
39
|
* `id` (int64): Id of the AS2 Partner.
|
22
40
|
* `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
|
41
|
+
* `as2_station_id` (int64): Id of the AS2 Station associated with this message.
|
23
42
|
* `uuid` (string): UUID assigned to this message.
|
24
43
|
* `http_headers` (object): HTTP Headers sent with this message.
|
25
44
|
* `activity_log` (string): JSON Structure of the activity log.
|
26
|
-
* `processing_result` (string): Result of processing.
|
27
|
-
* `mic` (string): AS2 Message Integrity Check
|
45
|
+
* `processing_result` (string): Result of processing.
|
46
|
+
* `mic` (string): AS2 Message Integrity Check SHA1
|
47
|
+
* `mic_sha_256` (string): AS2 Message Integrity Check SHA256
|
48
|
+
* `as2_to` (string): AS2 TO
|
49
|
+
* `as2_from` (string): AS2 FROM
|
50
|
+
* `date` (string): Date Header
|
28
51
|
* `message_id` (string): AS2 Message Id
|
29
52
|
* `body_size` (string): Encrypted Payload Body Size
|
30
53
|
* `attachment_filename` (string): Filename of the file being sent.
|
31
54
|
* `created_at` (date-time): Message creation date/time
|
55
|
+
* `http_response_code` (string): HTTP Response Code received for this message
|
56
|
+
* `http_response_headers` (object): HTTP Headers received for this message.
|
57
|
+
* `mdn_received` (boolean): Did the partner give a response body?
|
58
|
+
* `mdn_valid` (boolean): Is the response in MDN format?
|
59
|
+
* `mdn_signature_verified` (boolean): MDN signature verified?
|
60
|
+
* `mdn_message_id_matched` (boolean): MDN message id matched?
|
61
|
+
* `mdn_mic_matched` (boolean): MDN MIC matched?
|
62
|
+
* `mdn_processing_success` (boolean): MDN disposition indicate a successful processing?
|
63
|
+
* `raw_uri` (string): URL to download the original file contents
|
64
|
+
* `smime_uri` (string): URL to download the file contents encoded as smime
|
65
|
+
* `smime_signed_uri` (string): URL to download the file contents as smime with signature
|
66
|
+
* `encrypted_uri` (string): URL to download the encrypted signed smime that is to sent as AS2 body
|
67
|
+
* `mdn_response_uri` (string): URL to download the http response body
|
32
68
|
|
33
69
|
|
34
70
|
---
|
@@ -46,4 +82,11 @@ Files::As2OutgoingMessage.list(
|
|
46
82
|
|
47
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.
|
48
84
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
|
+
* `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`.
|
86
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
87
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
88
|
+
* `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`.
|
89
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
90
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
91
|
+
* `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`.
|
49
92
|
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
data/docs/as2_partner.md
CHANGED
@@ -8,7 +8,14 @@
|
|
8
8
|
"as2_station_id": 1,
|
9
9
|
"name": "AS2 Partner Name",
|
10
10
|
"uri": "",
|
11
|
-
"
|
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": ""
|
12
19
|
}
|
13
20
|
```
|
14
21
|
|
@@ -16,7 +23,14 @@
|
|
16
23
|
* `as2_station_id` (int64): Id of the AS2 Station associated with this partner.
|
17
24
|
* `name` (string): The partner's formal AS2 name.
|
18
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.
|
19
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.
|
20
34
|
* `public_certificate` (string):
|
21
35
|
|
22
36
|
|
@@ -58,7 +72,8 @@ Files::As2Partner.create(
|
|
58
72
|
name: "name",
|
59
73
|
uri: "uri",
|
60
74
|
public_certificate: "public_certificate",
|
61
|
-
as2_station_id: 1
|
75
|
+
as2_station_id: 1,
|
76
|
+
server_certificate: "require_match"
|
62
77
|
)
|
63
78
|
```
|
64
79
|
|
@@ -68,6 +83,7 @@ Files::As2Partner.create(
|
|
68
83
|
* `uri` (string): Required - URL base for AS2 responses
|
69
84
|
* `public_certificate` (string): Required -
|
70
85
|
* `as2_station_id` (int64): Required - Id of As2Station for this partner
|
86
|
+
* `server_certificate` (string): Remote server certificate security setting
|
71
87
|
|
72
88
|
|
73
89
|
---
|
@@ -76,7 +92,8 @@ Files::As2Partner.create(
|
|
76
92
|
|
77
93
|
```
|
78
94
|
Files::As2Partner.update(id,
|
79
|
-
name: "AS2 Partner Name"
|
95
|
+
name: "AS2 Partner Name",
|
96
|
+
server_certificate: "require_match"
|
80
97
|
)
|
81
98
|
```
|
82
99
|
|
@@ -85,6 +102,7 @@ Files::As2Partner.update(id,
|
|
85
102
|
* `id` (int64): Required - As2 Partner ID.
|
86
103
|
* `name` (string): AS2 Name
|
87
104
|
* `uri` (string): URL base for AS2 responses
|
105
|
+
* `server_certificate` (string): Remote server certificate security setting
|
88
106
|
* `public_certificate` (string):
|
89
107
|
|
90
108
|
|
@@ -109,7 +127,8 @@ Files::As2Partner.delete(id)
|
|
109
127
|
as2_partner = Files::As2Partner.list.first
|
110
128
|
|
111
129
|
as2_partner.update(
|
112
|
-
name: "AS2 Partner Name"
|
130
|
+
name: "AS2 Partner Name",
|
131
|
+
server_certificate: "require_match"
|
113
132
|
)
|
114
133
|
```
|
115
134
|
|
@@ -118,6 +137,7 @@ as2_partner.update(
|
|
118
137
|
* `id` (int64): Required - As2 Partner ID.
|
119
138
|
* `name` (string): AS2 Name
|
120
139
|
* `uri` (string): URL base for AS2 responses
|
140
|
+
* `server_certificate` (string): Remote server certificate security setting
|
121
141
|
* `public_certificate` (string):
|
122
142
|
|
123
143
|
|
data/docs/as2_station.md
CHANGED
@@ -8,9 +8,15 @@
|
|
8
8
|
"name": "AS2 Station Name",
|
9
9
|
"uri": "",
|
10
10
|
"domain": "domain.test",
|
11
|
-
"
|
11
|
+
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
12
12
|
"public_certificate_md5": "",
|
13
|
-
"private_key_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": ""
|
14
20
|
}
|
15
21
|
```
|
16
22
|
|
@@ -18,10 +24,18 @@
|
|
18
24
|
* `name` (string): The station's formal AS2 name.
|
19
25
|
* `uri` (string): Public URI for sending AS2 message to.
|
20
26
|
* `domain` (string): The station's AS2 domain name.
|
21
|
-
* `
|
27
|
+
* `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
|
22
28
|
* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
|
23
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):
|
24
37
|
* `private_key` (string):
|
38
|
+
* `private_key_password` (string):
|
25
39
|
|
26
40
|
|
27
41
|
---
|
@@ -60,8 +74,6 @@ Files::As2Station.find(id)
|
|
60
74
|
```
|
61
75
|
Files::As2Station.create(
|
62
76
|
name: "name",
|
63
|
-
domain: "domain",
|
64
|
-
uri: "uri",
|
65
77
|
public_certificate: "public_certificate",
|
66
78
|
private_key: "private_key"
|
67
79
|
)
|
@@ -70,10 +82,9 @@ Files::As2Station.create(
|
|
70
82
|
### Parameters
|
71
83
|
|
72
84
|
* `name` (string): Required - AS2 Name
|
73
|
-
* `domain` (string): Required - AS2 Domain
|
74
|
-
* `uri` (string): Required - URL base for AS2 responses
|
75
85
|
* `public_certificate` (string): Required -
|
76
86
|
* `private_key` (string): Required -
|
87
|
+
* `private_key_password` (string):
|
77
88
|
|
78
89
|
|
79
90
|
---
|
@@ -82,8 +93,7 @@ Files::As2Station.create(
|
|
82
93
|
|
83
94
|
```
|
84
95
|
Files::As2Station.update(id,
|
85
|
-
name: "AS2 Station Name"
|
86
|
-
domain: "domain.test"
|
96
|
+
name: "AS2 Station Name"
|
87
97
|
)
|
88
98
|
```
|
89
99
|
|
@@ -91,10 +101,9 @@ Files::As2Station.update(id,
|
|
91
101
|
|
92
102
|
* `id` (int64): Required - As2 Station ID.
|
93
103
|
* `name` (string): AS2 Name
|
94
|
-
* `domain` (string): AS2 Domain
|
95
|
-
* `uri` (string): URL base for AS2 responses
|
96
104
|
* `public_certificate` (string):
|
97
105
|
* `private_key` (string):
|
106
|
+
* `private_key_password` (string):
|
98
107
|
|
99
108
|
|
100
109
|
---
|
@@ -118,8 +127,7 @@ Files::As2Station.delete(id)
|
|
118
127
|
as2_station = Files::As2Station.list.first
|
119
128
|
|
120
129
|
as2_station.update(
|
121
|
-
name: "AS2 Station Name"
|
122
|
-
domain: "domain.test"
|
130
|
+
name: "AS2 Station Name"
|
123
131
|
)
|
124
132
|
```
|
125
133
|
|
@@ -127,10 +135,9 @@ as2_station.update(
|
|
127
135
|
|
128
136
|
* `id` (int64): Required - As2 Station ID.
|
129
137
|
* `name` (string): AS2 Name
|
130
|
-
* `domain` (string): AS2 Domain
|
131
|
-
* `uri` (string): URL base for AS2 responses
|
132
138
|
* `public_certificate` (string):
|
133
139
|
* `private_key` (string):
|
140
|
+
* `private_key_password` (string):
|
134
141
|
|
135
142
|
|
136
143
|
---
|
data/docs/automation.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"automation": "create_folder",
|
9
|
+
"disabled": true,
|
9
10
|
"trigger": "realtime",
|
10
11
|
"interval": "week",
|
11
12
|
"name": "",
|
@@ -46,6 +47,7 @@
|
|
46
47
|
|
47
48
|
* `id` (int64): Automation ID
|
48
49
|
* `automation` (string): Automation type
|
50
|
+
* `disabled` (boolean): If true, this automation will not run.
|
49
51
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
50
52
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
51
53
|
* `name` (string): Name for this automation.
|
@@ -116,6 +118,7 @@ Files::Automation.create(
|
|
116
118
|
user_ids: [1,2],
|
117
119
|
group_ids: [1,2],
|
118
120
|
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
121
|
+
disabled: true,
|
119
122
|
trigger: "realtime",
|
120
123
|
trigger_actions: "[ \"create\" ]",
|
121
124
|
value: "{\"limit\": \"1\"}"
|
@@ -136,6 +139,7 @@ Files::Automation.create(
|
|
136
139
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
137
140
|
* `schedule` (object): Custom schedule for running this automation.
|
138
141
|
* `description` (string): Description for the this Automation.
|
142
|
+
* `disabled` (boolean): If true, this automation will not run.
|
139
143
|
* `name` (string): Name for this automation.
|
140
144
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
141
145
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
@@ -155,6 +159,7 @@ Files::Automation.update(id,
|
|
155
159
|
user_ids: [1,2],
|
156
160
|
group_ids: [1,2],
|
157
161
|
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
162
|
+
disabled: true,
|
158
163
|
trigger: "realtime",
|
159
164
|
trigger_actions: "[ \"create\" ]",
|
160
165
|
value: "{\"limit\": \"1\"}"
|
@@ -176,6 +181,7 @@ Files::Automation.update(id,
|
|
176
181
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
177
182
|
* `schedule` (object): Custom schedule for running this automation.
|
178
183
|
* `description` (string): Description for the this Automation.
|
184
|
+
* `disabled` (boolean): If true, this automation will not run.
|
179
185
|
* `name` (string): Name for this automation.
|
180
186
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
181
187
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
@@ -210,6 +216,7 @@ automation.update(
|
|
210
216
|
user_ids: [1,2],
|
211
217
|
group_ids: [1,2],
|
212
218
|
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
219
|
+
disabled: true,
|
213
220
|
trigger: "realtime",
|
214
221
|
trigger_actions: "[ \"create\" ]",
|
215
222
|
value: "{\"limit\": \"1\"}"
|
@@ -231,6 +238,7 @@ automation.update(
|
|
231
238
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
232
239
|
* `schedule` (object): Custom schedule for running this automation.
|
233
240
|
* `description` (string): Description for the this Automation.
|
241
|
+
* `disabled` (boolean): If true, this automation will not run.
|
234
242
|
* `name` (string): Name for this automation.
|
235
243
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
236
244
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
data/docs/bundle.md
CHANGED
@@ -39,6 +39,9 @@
|
|
39
39
|
"skip_email": true,
|
40
40
|
"skip_company": true
|
41
41
|
},
|
42
|
+
"skip_name": true,
|
43
|
+
"skip_email": true,
|
44
|
+
"skip_company": true,
|
42
45
|
"id": 1,
|
43
46
|
"created_at": "2000-01-01T01:00:00Z",
|
44
47
|
"expires_at": "2000-01-01T01:00:00Z",
|
@@ -68,7 +71,10 @@
|
|
68
71
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
69
72
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
70
73
|
* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
|
71
|
-
* `form_field_set
|
74
|
+
* `form_field_set` (FormFieldSet): Custom Form to use
|
75
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
76
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
77
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
72
78
|
* `id` (int64): Bundle ID
|
73
79
|
* `created_at` (date-time): Bundle created at date/time
|
74
80
|
* `expires_at` (date-time): Bundle expiration date/time
|
@@ -78,7 +84,7 @@
|
|
78
84
|
* `username` (string): Bundle creator username
|
79
85
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
80
86
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
81
|
-
* `watermark_attachment
|
87
|
+
* `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
82
88
|
* `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
83
89
|
* `has_inbox` (boolean): Does this bundle have an associated inbox?
|
84
90
|
* `paths` (array): A list of paths in this bundle
|
@@ -145,7 +151,10 @@ Files::Bundle.create(
|
|
145
151
|
require_registration: true,
|
146
152
|
clickwrap_id: 1,
|
147
153
|
inbox_id: 1,
|
148
|
-
require_share_recipient: true
|
154
|
+
require_share_recipient: true,
|
155
|
+
skip_email: true,
|
156
|
+
skip_name: true,
|
157
|
+
skip_company: true
|
149
158
|
)
|
150
159
|
```
|
151
160
|
|
@@ -165,6 +174,9 @@ Files::Bundle.create(
|
|
165
174
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
166
175
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
167
176
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
177
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
178
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
179
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
168
180
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
169
181
|
|
170
182
|
|
@@ -207,6 +219,9 @@ Files::Bundle.update(id,
|
|
207
219
|
preview_only: true,
|
208
220
|
require_registration: true,
|
209
221
|
require_share_recipient: true,
|
222
|
+
skip_email: true,
|
223
|
+
skip_name: true,
|
224
|
+
skip_company: true,
|
210
225
|
watermark_attachment_delete: true
|
211
226
|
)
|
212
227
|
```
|
@@ -227,6 +242,9 @@ Files::Bundle.update(id,
|
|
227
242
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
228
243
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
229
244
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
245
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
246
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
247
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
230
248
|
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
231
249
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
232
250
|
|
@@ -287,6 +305,9 @@ bundle.update(
|
|
287
305
|
preview_only: true,
|
288
306
|
require_registration: true,
|
289
307
|
require_share_recipient: true,
|
308
|
+
skip_email: true,
|
309
|
+
skip_name: true,
|
310
|
+
skip_company: true,
|
290
311
|
watermark_attachment_delete: true
|
291
312
|
)
|
292
313
|
```
|
@@ -307,6 +328,9 @@ bundle.update(
|
|
307
328
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
308
329
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
309
330
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
331
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
332
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
333
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
310
334
|
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
311
335
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
312
336
|
|
data/docs/bundle_download.md
CHANGED
@@ -11,7 +11,7 @@
|
|
11
11
|
}
|
12
12
|
```
|
13
13
|
|
14
|
-
* `bundle_registration
|
14
|
+
* `bundle_registration` (BundleRegistration):
|
15
15
|
* `download_method` (string): Download method (file or full_zip)
|
16
16
|
* `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
17
17
|
* `created_at` (date-time): Download date/time
|
data/docs/file.md
CHANGED
@@ -47,7 +47,7 @@ may places where a Ruby File object can be used.
|
|
47
47
|
* `download_uri` (string): Link to download file. Provided only in response to a download request.
|
48
48
|
* `priority_color` (string): Bookmark/priority color of file/folder
|
49
49
|
* `preview_id` (int64): File preview ID
|
50
|
-
* `preview
|
50
|
+
* `preview` (Preview): File preview
|
51
51
|
* `action` (string): The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
52
52
|
* `length` (int64): Length of file.
|
53
53
|
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
data/docs/file_comment.md
CHANGED
data/docs/folder.md
CHANGED
@@ -49,7 +49,8 @@ Files::Dir is an alias of Files::Folder
|
|
49
49
|
* `download_uri` (string): Link to download file. Provided only in response to a download request.
|
50
50
|
* `priority_color` (string): Bookmark/priority color of file/folder
|
51
51
|
* `preview_id` (int64): File preview ID
|
52
|
-
* `preview
|
52
|
+
* `preview` (Preview): File preview
|
53
|
+
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
53
54
|
|
54
55
|
|
55
56
|
---
|
@@ -83,9 +84,12 @@ Files::Folder.list_for(path,
|
|
83
84
|
## Create folder
|
84
85
|
|
85
86
|
```
|
86
|
-
Files::Folder.create(path
|
87
|
+
Files::Folder.create(path,
|
88
|
+
mkdir_parents: true
|
89
|
+
)
|
87
90
|
```
|
88
91
|
|
89
92
|
### Parameters
|
90
93
|
|
91
94
|
* `path` (string): Required - Path to operate on.
|
95
|
+
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
data/docs/form_field_set.md
CHANGED
@@ -35,7 +35,7 @@
|
|
35
35
|
* `id` (int64): Form field set id
|
36
36
|
* `title` (string): Title to be displayed
|
37
37
|
* `form_layout` (int64): Layout of the form
|
38
|
-
* `form_fields
|
38
|
+
* `form_fields` (FormField): Associated form fields
|
39
39
|
* `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
|
40
40
|
* `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
|
41
41
|
* `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
|
data/docs/inbox_upload.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
}
|
11
11
|
```
|
12
12
|
|
13
|
-
* `inbox_registration
|
13
|
+
* `inbox_registration` (InboxRegistration):
|
14
14
|
* `path` (string): Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
15
15
|
* `created_at` (date-time): Upload date/time
|
16
16
|
|
data/docs/invoice.md
CHANGED
@@ -43,9 +43,9 @@
|
|
43
43
|
* `created_at` (date-time): Line item created at
|
44
44
|
* `currency` (string): Line item currency
|
45
45
|
* `download_uri` (string): Line item download uri
|
46
|
-
* `invoice_line_items
|
46
|
+
* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
|
47
47
|
* `method` (string): Line item payment method
|
48
|
-
* `payment_line_items
|
48
|
+
* `payment_line_items` (PaymentLineItem): Associated payment line items
|
49
49
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
50
50
|
* `payment_type` (string): Type of payment if applicable
|
51
51
|
* `site_name` (string): Site name this line item is for
|
data/docs/message.md
CHANGED
@@ -21,7 +21,7 @@
|
|
21
21
|
* `id` (int64): Message ID
|
22
22
|
* `subject` (string): Message subject.
|
23
23
|
* `body` (string): Message body.
|
24
|
-
* `comments
|
24
|
+
* `comments` (MessageComment): Comments.
|
25
25
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
26
26
|
* `project_id` (int64): Project to which the message should be attached.
|
27
27
|
|
data/docs/message_comment.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
|
16
16
|
* `id` (int64): Message Comment ID
|
17
17
|
* `body` (string): Comment body.
|
18
|
-
* `reactions
|
18
|
+
* `reactions` (MessageCommentReaction): Reactions to this comment.
|
19
19
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
20
20
|
|
21
21
|
|
data/docs/payment.md
CHANGED
@@ -43,9 +43,9 @@
|
|
43
43
|
* `created_at` (date-time): Line item created at
|
44
44
|
* `currency` (string): Line item currency
|
45
45
|
* `download_uri` (string): Line item download uri
|
46
|
-
* `invoice_line_items
|
46
|
+
* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
|
47
47
|
* `method` (string): Line item payment method
|
48
|
-
* `payment_line_items
|
48
|
+
* `payment_line_items` (PaymentLineItem): Associated payment line items
|
49
49
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
50
50
|
* `payment_type` (string): Type of payment if applicable
|
51
51
|
* `site_name` (string): Site name this line item is for
|