files.com 1.0.245 → 1.0.263
Sign up to get free protection for your applications and to get access to all the features.
- 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
data/docs/session.md
CHANGED
@@ -6,47 +6,15 @@
|
|
6
6
|
{
|
7
7
|
"id": "60525f92e859c4c3d74cb02fd176b1525901b525",
|
8
8
|
"language": "en",
|
9
|
-
"login_token": "@tok-randomcode",
|
10
|
-
"login_token_domain": "https://mysite.files.com",
|
11
|
-
"max_dir_listing_size": 1,
|
12
|
-
"multiple_regions": true,
|
13
9
|
"read_only": true,
|
14
|
-
"
|
15
|
-
"sftp_insecure_ciphers": true,
|
16
|
-
"site_id": 1,
|
17
|
-
"ssl_required": true,
|
18
|
-
"tls_disabled": true,
|
19
|
-
"two_factor_setup_needed": true,
|
20
|
-
"allowed_2fa_method_sms": true,
|
21
|
-
"allowed_2fa_method_totp": true,
|
22
|
-
"allowed_2fa_method_u2f": true,
|
23
|
-
"allowed_2fa_method_webauthn": true,
|
24
|
-
"allowed_2fa_method_yubi": true,
|
25
|
-
"use_provided_modified_at": true,
|
26
|
-
"windows_mode_ftp": true
|
10
|
+
"sftp_insecure_ciphers": true
|
27
11
|
}
|
28
12
|
```
|
29
13
|
|
30
14
|
* `id` (string): Session ID
|
31
15
|
* `language` (string): Session language
|
32
|
-
* `login_token` (string): Login token. If set, this token will allow your user to log in via browser at the domain in `login_token_domain`.
|
33
|
-
* `login_token_domain` (string): Domain to use with `login_token`.
|
34
|
-
* `max_dir_listing_size` (int64): Maximum number of files to retrieve per folder for a directory listing. This is based on the user's plan.
|
35
|
-
* `multiple_regions` (boolean): Can access multiple regions?
|
36
16
|
* `read_only` (boolean): Is this session read only?
|
37
|
-
* `root_path` (string): Initial root path to start the user's session in.
|
38
17
|
* `sftp_insecure_ciphers` (boolean): Are insecure SFTP ciphers allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure SSH ciphers for this user.)
|
39
|
-
* `site_id` (int64): Site ID
|
40
|
-
* `ssl_required` (boolean): Is SSL required for this user? (If so, ensure all your communications with this user use SSL.)
|
41
|
-
* `tls_disabled` (boolean): Are insecure TLS versions allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure TLS versions for this user.)
|
42
|
-
* `two_factor_setup_needed` (boolean): If true, this user needs to add a Two Factor Authentication method before performing any further actions.
|
43
|
-
* `allowed_2fa_method_sms` (boolean): Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
|
44
|
-
* `allowed_2fa_method_totp` (boolean): Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
|
45
|
-
* `allowed_2fa_method_u2f` (boolean): Sent only if 2FA setup is needed. Is U2F two factor authentication allowed?
|
46
|
-
* `allowed_2fa_method_webauthn` (boolean): Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
|
47
|
-
* `allowed_2fa_method_yubi` (boolean): Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
|
48
|
-
* `use_provided_modified_at` (boolean): Allow the user to provide file/folder modified at dates? If false, the server will always use the current date/time.
|
49
|
-
* `windows_mode_ftp` (boolean): Does this user want to use Windows line-ending emulation? (CR vs CRLF)
|
50
18
|
* `username` (string): Username to sign in as
|
51
19
|
* `password` (string): Password for sign in
|
52
20
|
* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
|
data/docs/site.md
CHANGED
@@ -217,6 +217,7 @@
|
|
217
217
|
"user_requests_enabled": true,
|
218
218
|
"welcome_custom_text": "Welcome to my site!",
|
219
219
|
"welcome_email_cc": "",
|
220
|
+
"welcome_email_subject": "",
|
220
221
|
"welcome_email_enabled": true,
|
221
222
|
"welcome_screen": "user_controlled",
|
222
223
|
"windows_mode_ftp": true,
|
@@ -238,7 +239,7 @@
|
|
238
239
|
* `bundle_expiration` (int64): Site-wide Bundle expiration in days
|
239
240
|
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
240
241
|
* `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
|
241
|
-
* `bundle_watermark_attachment
|
242
|
+
* `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
242
243
|
* `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
243
244
|
* `color2_left` (string): Page link and button color
|
244
245
|
* `color2_link` (string): Top bar link color
|
@@ -270,10 +271,10 @@
|
|
270
271
|
* `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
|
271
272
|
* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
|
272
273
|
* `hipaa` (boolean): Is there a signed HIPAA BAA between Files.com and this site?
|
273
|
-
* `icon128
|
274
|
-
* `icon16
|
275
|
-
* `icon32
|
276
|
-
* `icon48
|
274
|
+
* `icon128` (Image): Branded icon 128x128
|
275
|
+
* `icon16` (Image): Branded icon 16x16
|
276
|
+
* `icon32` (Image): Branded icon 32x32
|
277
|
+
* `icon48` (Image): Branded icon 48x48
|
277
278
|
* `immutable_files_set_at` (date-time): Can files be modified?
|
278
279
|
* `include_password_in_welcome_email` (boolean): Include password in emails to new users?
|
279
280
|
* `language` (string): Site default language
|
@@ -294,7 +295,7 @@
|
|
294
295
|
* `ldap_username` (string): Username for signing in to LDAP server.
|
295
296
|
* `ldap_username_field` (string): LDAP username field
|
296
297
|
* `login_help_text` (string): Login help text
|
297
|
-
* `logo
|
298
|
+
* `logo` (Image): Branded logo
|
298
299
|
* `max_prior_passwords` (int64): Number of prior passwords to disallow
|
299
300
|
* `next_billing_amount` (double): Next billing amount
|
300
301
|
* `next_billing_date` (string): Next billing date
|
@@ -316,7 +317,7 @@
|
|
316
317
|
* `require_2fa` (boolean): Require two-factor authentication for all users?
|
317
318
|
* `require_2fa_stop_time` (date-time): If set, requirement for two-factor authentication has been scheduled to end on this date-time.
|
318
319
|
* `require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?
|
319
|
-
* `session
|
320
|
+
* `session` (Session): Current session
|
320
321
|
* `session_pinned_by_ip` (boolean): Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
|
321
322
|
* `sftp_enabled` (boolean): Is SFTP enabled?
|
322
323
|
* `sftp_insecure_ciphers` (boolean): Are Insecure Ciphers allowed for SFTP? Note: Settting TLS Disabled -> True will always allow insecure ciphers for SFTP as well. Enabling this is insecure.
|
@@ -339,7 +340,7 @@
|
|
339
340
|
* `trial_until` (date-time): When does this Site trial expire?
|
340
341
|
* `updated_at` (date-time): Last time this Site was updated
|
341
342
|
* `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?
|
342
|
-
* `user
|
343
|
+
* `user` (User): User of current session
|
343
344
|
* `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
|
344
345
|
* `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
|
345
346
|
* `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
|
@@ -347,6 +348,7 @@
|
|
347
348
|
* `user_requests_enabled` (boolean): Enable User Requests feature
|
348
349
|
* `welcome_custom_text` (string): Custom text send in user welcome email
|
349
350
|
* `welcome_email_cc` (email): Include this email in welcome emails if enabled
|
351
|
+
* `welcome_email_subject` (string): Include this email subject in welcome emails if enabled
|
350
352
|
* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
|
351
353
|
* `welcome_screen` (string): Does the welcome screen appear?
|
352
354
|
* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
|
@@ -495,6 +497,7 @@ Files::Site.update(
|
|
495
497
|
* `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
496
498
|
* `show_request_access_link` (boolean): Show request access link for users without access? Currently unused.
|
497
499
|
* `welcome_email_cc` (string): Include this email in welcome emails if enabled
|
500
|
+
* `welcome_email_subject` (string): Include this email subject in welcome emails if enabled
|
498
501
|
* `welcome_custom_text` (string): Custom text send in user welcome email
|
499
502
|
* `language` (string): Site default language
|
500
503
|
* `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
|
data/docs/sso_strategy.md
CHANGED
@@ -122,3 +122,31 @@ Files::SsoStrategy.find(id)
|
|
122
122
|
### Parameters
|
123
123
|
|
124
124
|
* `id` (int64): Required - Sso Strategy ID.
|
125
|
+
|
126
|
+
|
127
|
+
---
|
128
|
+
|
129
|
+
## Synchronize provisioning data with the SSO remote server
|
130
|
+
|
131
|
+
```
|
132
|
+
Files::SsoStrategy.sync(id)
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
* `id` (int64): Required - Sso Strategy ID.
|
138
|
+
|
139
|
+
|
140
|
+
---
|
141
|
+
|
142
|
+
## Synchronize provisioning data with the SSO remote server
|
143
|
+
|
144
|
+
```
|
145
|
+
sso_strategy = Files::SsoStrategy.list.first
|
146
|
+
|
147
|
+
sso_strategy.sync
|
148
|
+
```
|
149
|
+
|
150
|
+
### Parameters
|
151
|
+
|
152
|
+
* `id` (int64): Required - Sso Strategy ID.
|
data/docs/status.md
CHANGED
@@ -24,7 +24,7 @@
|
|
24
24
|
* `code` (int64): Status HTTP code
|
25
25
|
* `message` (string): Error message
|
26
26
|
* `status` (string): Status message
|
27
|
-
* `data
|
28
|
-
* `errors
|
27
|
+
* `data` (Auto): Additional data
|
28
|
+
* `errors` (Errors): A list of api errors
|
29
29
|
* `clickwrap_id` (int64): Required Clickwrap id
|
30
30
|
* `clickwrap_body` (string): Required Clickwrap body
|
data/docs/style.md
CHANGED
@@ -13,8 +13,8 @@
|
|
13
13
|
|
14
14
|
* `id` (int64): Style ID
|
15
15
|
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
16
|
-
* `logo
|
17
|
-
* `thumbnail
|
16
|
+
* `logo` (Image): Logo
|
17
|
+
* `thumbnail` (Image): Logo thumbnail
|
18
18
|
* `file` (file): Logo for custom branding.
|
19
19
|
|
20
20
|
|
data/docs/user.md
CHANGED
@@ -131,7 +131,7 @@ Files::User.list(
|
|
131
131
|
|
132
132
|
* `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.
|
133
133
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
134
|
-
* `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 `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
|
134
|
+
* `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 `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
|
135
135
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
136
136
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
137
137
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
data/docs/webhook_test.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
* `code` (int64): Status HTTP code
|
16
16
|
* `message` (string): Error message
|
17
17
|
* `status` (string): Status message
|
18
|
-
* `data
|
18
|
+
* `data` (Auto): Additional data
|
19
19
|
* `success` (boolean): The success status of the webhook test
|
20
20
|
* `url` (string): URL for testing the webhook.
|
21
21
|
* `method` (string): HTTP method(GET or POST).
|
data/lib/files.com/errors.rb
CHANGED
@@ -182,6 +182,7 @@ module Files
|
|
182
182
|
class ModelSaveErrorError < ProcessingFailureError; end
|
183
183
|
class MultipartUploadsRequiredForRemotesError < ProcessingFailureError; end
|
184
184
|
class MultipleProcessingErrorsError < ProcessingFailureError; end
|
185
|
+
class PathTooLongError < ProcessingFailureError; end
|
185
186
|
class RecipientAlreadySharedError < ProcessingFailureError; end
|
186
187
|
class RemoteServerErrorError < ProcessingFailureError; end
|
187
188
|
class ResourceLockedError < ProcessingFailureError; end
|
@@ -39,7 +39,7 @@ module Files
|
|
39
39
|
@attributes[:download_uri]
|
40
40
|
end
|
41
41
|
|
42
|
-
# Associated invoice line items
|
42
|
+
# InvoiceLineItem - Associated invoice line items
|
43
43
|
def invoice_line_items
|
44
44
|
@attributes[:invoice_line_items]
|
45
45
|
end
|
@@ -49,7 +49,7 @@ module Files
|
|
49
49
|
@attributes[:method]
|
50
50
|
end
|
51
51
|
|
52
|
-
# Associated payment line items
|
52
|
+
# PaymentLineItem - Associated payment line items
|
53
53
|
def payment_line_items
|
54
54
|
@attributes[:payment_line_items]
|
55
55
|
end
|
@@ -19,6 +19,11 @@ module Files
|
|
19
19
|
@attributes[:as2_partner_id]
|
20
20
|
end
|
21
21
|
|
22
|
+
# int64 - Id of the AS2 Station associated with this message.
|
23
|
+
def as2_station_id
|
24
|
+
@attributes[:as2_station_id]
|
25
|
+
end
|
26
|
+
|
22
27
|
# string - UUID assigned to this message.
|
23
28
|
def uuid
|
24
29
|
@attributes[:uuid]
|
@@ -39,11 +44,21 @@ module Files
|
|
39
44
|
@attributes[:activity_log]
|
40
45
|
end
|
41
46
|
|
42
|
-
# string - Result of processing.
|
47
|
+
# string - Result of processing.
|
43
48
|
def processing_result
|
44
49
|
@attributes[:processing_result]
|
45
50
|
end
|
46
51
|
|
52
|
+
# string - AS2 Message Integrity Check
|
53
|
+
def mic
|
54
|
+
@attributes[:mic]
|
55
|
+
end
|
56
|
+
|
57
|
+
# string - AS2 Message Integrity Check Algorithm Used
|
58
|
+
def mic_algo
|
59
|
+
@attributes[:mic_algo]
|
60
|
+
end
|
61
|
+
|
47
62
|
# string - AS2 TO header of message
|
48
63
|
def as2_to
|
49
64
|
@attributes[:as2_to]
|
@@ -64,6 +79,11 @@ module Files
|
|
64
79
|
@attributes[:subject]
|
65
80
|
end
|
66
81
|
|
82
|
+
# string - Date Header
|
83
|
+
def date
|
84
|
+
@attributes[:date]
|
85
|
+
end
|
86
|
+
|
67
87
|
# string - Encrypted Payload Body Size
|
68
88
|
def body_size
|
69
89
|
@attributes[:body_size]
|
@@ -74,18 +94,112 @@ module Files
|
|
74
94
|
@attributes[:attachment_filename]
|
75
95
|
end
|
76
96
|
|
97
|
+
# string - IP Address of the Sender
|
98
|
+
def ip
|
99
|
+
@attributes[:ip]
|
100
|
+
end
|
101
|
+
|
77
102
|
# date-time - Message creation date/time
|
78
103
|
def created_at
|
79
104
|
@attributes[:created_at]
|
80
105
|
end
|
81
106
|
|
107
|
+
# string - HTTP Response Code sent for this message
|
108
|
+
def http_response_code
|
109
|
+
@attributes[:http_response_code]
|
110
|
+
end
|
111
|
+
|
112
|
+
# object - HTTP Headers sent for this message.
|
113
|
+
def http_response_headers
|
114
|
+
@attributes[:http_response_headers]
|
115
|
+
end
|
116
|
+
|
117
|
+
# string - Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial
|
118
|
+
def recipient_serial
|
119
|
+
@attributes[:recipient_serial]
|
120
|
+
end
|
121
|
+
|
122
|
+
# string - Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.
|
123
|
+
def hex_recipient_serial
|
124
|
+
@attributes[:hex_recipient_serial]
|
125
|
+
end
|
126
|
+
|
127
|
+
# string - Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer
|
128
|
+
def recipient_issuer
|
129
|
+
@attributes[:recipient_issuer]
|
130
|
+
end
|
131
|
+
|
132
|
+
# boolean - Message body received?
|
133
|
+
def message_received
|
134
|
+
@attributes[:message_received]
|
135
|
+
end
|
136
|
+
|
137
|
+
# boolean - Message decrypted successfully?
|
138
|
+
def message_decrypted
|
139
|
+
@attributes[:message_decrypted]
|
140
|
+
end
|
141
|
+
|
142
|
+
# boolean - Message signature verified?
|
143
|
+
def message_signature_verified
|
144
|
+
@attributes[:message_signature_verified]
|
145
|
+
end
|
146
|
+
|
147
|
+
# boolean - Message processed successfully?
|
148
|
+
def message_processing_success
|
149
|
+
@attributes[:message_processing_success]
|
150
|
+
end
|
151
|
+
|
152
|
+
# boolean - MDN returned?
|
153
|
+
def message_mdn_returned
|
154
|
+
@attributes[:message_mdn_returned]
|
155
|
+
end
|
156
|
+
|
157
|
+
# string - URL to download the encrypted signed smime that is to sent as AS2 body
|
158
|
+
def encrypted_uri
|
159
|
+
@attributes[:encrypted_uri]
|
160
|
+
end
|
161
|
+
|
162
|
+
# string - URL to download the file contents as smime with signature
|
163
|
+
def smime_signed_uri
|
164
|
+
@attributes[:smime_signed_uri]
|
165
|
+
end
|
166
|
+
|
167
|
+
# string - URL to download the file contents encoded as smime
|
168
|
+
def smime_uri
|
169
|
+
@attributes[:smime_uri]
|
170
|
+
end
|
171
|
+
|
172
|
+
# string - URL to download the original file contents
|
173
|
+
def raw_uri
|
174
|
+
@attributes[:raw_uri]
|
175
|
+
end
|
176
|
+
|
177
|
+
# string - URL to download the http response body
|
178
|
+
def mdn_response_uri
|
179
|
+
@attributes[:mdn_response_uri]
|
180
|
+
end
|
181
|
+
|
82
182
|
# Parameters:
|
83
183
|
# 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
184
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
185
|
+
# 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`.
|
186
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
187
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
188
|
+
# 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`.
|
189
|
+
# filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
190
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
191
|
+
# 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`.
|
85
192
|
# as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.
|
86
193
|
def self.list(params = {}, options = {})
|
87
194
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
88
195
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
196
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
|
197
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
|
198
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
|
199
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
|
200
|
+
raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
|
201
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
|
202
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
|
89
203
|
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
204
|
|
91
205
|
List.new(As2IncomingMessage, params) do
|
@@ -19,6 +19,11 @@ module Files
|
|
19
19
|
@attributes[:as2_partner_id]
|
20
20
|
end
|
21
21
|
|
22
|
+
# int64 - Id of the AS2 Station associated with this message.
|
23
|
+
def as2_station_id
|
24
|
+
@attributes[:as2_station_id]
|
25
|
+
end
|
26
|
+
|
22
27
|
# string - UUID assigned to this message.
|
23
28
|
def uuid
|
24
29
|
@attributes[:uuid]
|
@@ -34,16 +39,36 @@ module Files
|
|
34
39
|
@attributes[:activity_log]
|
35
40
|
end
|
36
41
|
|
37
|
-
# string - Result of processing.
|
42
|
+
# string - Result of processing.
|
38
43
|
def processing_result
|
39
44
|
@attributes[:processing_result]
|
40
45
|
end
|
41
46
|
|
42
|
-
# string - AS2 Message Integrity Check
|
47
|
+
# string - AS2 Message Integrity Check SHA1
|
43
48
|
def mic
|
44
49
|
@attributes[:mic]
|
45
50
|
end
|
46
51
|
|
52
|
+
# string - AS2 Message Integrity Check SHA256
|
53
|
+
def mic_sha_256
|
54
|
+
@attributes[:mic_sha_256]
|
55
|
+
end
|
56
|
+
|
57
|
+
# string - AS2 TO
|
58
|
+
def as2_to
|
59
|
+
@attributes[:as2_to]
|
60
|
+
end
|
61
|
+
|
62
|
+
# string - AS2 FROM
|
63
|
+
def as2_from
|
64
|
+
@attributes[:as2_from]
|
65
|
+
end
|
66
|
+
|
67
|
+
# string - Date Header
|
68
|
+
def date
|
69
|
+
@attributes[:date]
|
70
|
+
end
|
71
|
+
|
47
72
|
# string - AS2 Message Id
|
48
73
|
def message_id
|
49
74
|
@attributes[:message_id]
|
@@ -64,13 +89,92 @@ module Files
|
|
64
89
|
@attributes[:created_at]
|
65
90
|
end
|
66
91
|
|
92
|
+
# string - HTTP Response Code received for this message
|
93
|
+
def http_response_code
|
94
|
+
@attributes[:http_response_code]
|
95
|
+
end
|
96
|
+
|
97
|
+
# object - HTTP Headers received for this message.
|
98
|
+
def http_response_headers
|
99
|
+
@attributes[:http_response_headers]
|
100
|
+
end
|
101
|
+
|
102
|
+
# boolean - Did the partner give a response body?
|
103
|
+
def mdn_received
|
104
|
+
@attributes[:mdn_received]
|
105
|
+
end
|
106
|
+
|
107
|
+
# boolean - Is the response in MDN format?
|
108
|
+
def mdn_valid
|
109
|
+
@attributes[:mdn_valid]
|
110
|
+
end
|
111
|
+
|
112
|
+
# boolean - MDN signature verified?
|
113
|
+
def mdn_signature_verified
|
114
|
+
@attributes[:mdn_signature_verified]
|
115
|
+
end
|
116
|
+
|
117
|
+
# boolean - MDN message id matched?
|
118
|
+
def mdn_message_id_matched
|
119
|
+
@attributes[:mdn_message_id_matched]
|
120
|
+
end
|
121
|
+
|
122
|
+
# boolean - MDN MIC matched?
|
123
|
+
def mdn_mic_matched
|
124
|
+
@attributes[:mdn_mic_matched]
|
125
|
+
end
|
126
|
+
|
127
|
+
# boolean - MDN disposition indicate a successful processing?
|
128
|
+
def mdn_processing_success
|
129
|
+
@attributes[:mdn_processing_success]
|
130
|
+
end
|
131
|
+
|
132
|
+
# string - URL to download the original file contents
|
133
|
+
def raw_uri
|
134
|
+
@attributes[:raw_uri]
|
135
|
+
end
|
136
|
+
|
137
|
+
# string - URL to download the file contents encoded as smime
|
138
|
+
def smime_uri
|
139
|
+
@attributes[:smime_uri]
|
140
|
+
end
|
141
|
+
|
142
|
+
# string - URL to download the file contents as smime with signature
|
143
|
+
def smime_signed_uri
|
144
|
+
@attributes[:smime_signed_uri]
|
145
|
+
end
|
146
|
+
|
147
|
+
# string - URL to download the encrypted signed smime that is to sent as AS2 body
|
148
|
+
def encrypted_uri
|
149
|
+
@attributes[:encrypted_uri]
|
150
|
+
end
|
151
|
+
|
152
|
+
# string - URL to download the http response body
|
153
|
+
def mdn_response_uri
|
154
|
+
@attributes[:mdn_response_uri]
|
155
|
+
end
|
156
|
+
|
67
157
|
# Parameters:
|
68
158
|
# 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
159
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
160
|
+
# 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`.
|
161
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
162
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
163
|
+
# 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`.
|
164
|
+
# filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
165
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
166
|
+
# 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`.
|
70
167
|
# as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.
|
71
168
|
def self.list(params = {}, options = {})
|
72
169
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
73
170
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
171
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
|
172
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
|
173
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
|
174
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
|
175
|
+
raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
|
176
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
|
177
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
|
74
178
|
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
179
|
|
76
180
|
List.new(As2OutgoingMessage, params) do
|
@@ -45,6 +45,24 @@ module Files
|
|
45
45
|
@attributes[:uri] = value
|
46
46
|
end
|
47
47
|
|
48
|
+
# string - Remote server certificate security setting
|
49
|
+
def server_certificate
|
50
|
+
@attributes[:server_certificate]
|
51
|
+
end
|
52
|
+
|
53
|
+
def server_certificate=(value)
|
54
|
+
@attributes[:server_certificate] = value
|
55
|
+
end
|
56
|
+
|
57
|
+
# string - Serial of public certificate used for message security in hex format.
|
58
|
+
def hex_public_certificate_serial
|
59
|
+
@attributes[:hex_public_certificate_serial]
|
60
|
+
end
|
61
|
+
|
62
|
+
def hex_public_certificate_serial=(value)
|
63
|
+
@attributes[:hex_public_certificate_serial] = value
|
64
|
+
end
|
65
|
+
|
48
66
|
# string - MD5 hash of public certificate used for message security.
|
49
67
|
def public_certificate_md5
|
50
68
|
@attributes[:public_certificate_md5]
|
@@ -54,6 +72,51 @@ module Files
|
|
54
72
|
@attributes[:public_certificate_md5] = value
|
55
73
|
end
|
56
74
|
|
75
|
+
# string - Subject of public certificate used for message security.
|
76
|
+
def public_certificate_subject
|
77
|
+
@attributes[:public_certificate_subject]
|
78
|
+
end
|
79
|
+
|
80
|
+
def public_certificate_subject=(value)
|
81
|
+
@attributes[:public_certificate_subject] = value
|
82
|
+
end
|
83
|
+
|
84
|
+
# string - Issuer of public certificate used for message security.
|
85
|
+
def public_certificate_issuer
|
86
|
+
@attributes[:public_certificate_issuer]
|
87
|
+
end
|
88
|
+
|
89
|
+
def public_certificate_issuer=(value)
|
90
|
+
@attributes[:public_certificate_issuer] = value
|
91
|
+
end
|
92
|
+
|
93
|
+
# string - Serial of public certificate used for message security.
|
94
|
+
def public_certificate_serial
|
95
|
+
@attributes[:public_certificate_serial]
|
96
|
+
end
|
97
|
+
|
98
|
+
def public_certificate_serial=(value)
|
99
|
+
@attributes[:public_certificate_serial] = value
|
100
|
+
end
|
101
|
+
|
102
|
+
# string - Not before value of public certificate used for message security.
|
103
|
+
def public_certificate_not_before
|
104
|
+
@attributes[:public_certificate_not_before]
|
105
|
+
end
|
106
|
+
|
107
|
+
def public_certificate_not_before=(value)
|
108
|
+
@attributes[:public_certificate_not_before] = value
|
109
|
+
end
|
110
|
+
|
111
|
+
# string - Not after value of public certificate used for message security.
|
112
|
+
def public_certificate_not_after
|
113
|
+
@attributes[:public_certificate_not_after]
|
114
|
+
end
|
115
|
+
|
116
|
+
def public_certificate_not_after=(value)
|
117
|
+
@attributes[:public_certificate_not_after] = value
|
118
|
+
end
|
119
|
+
|
57
120
|
# string
|
58
121
|
def public_certificate
|
59
122
|
@attributes[:public_certificate]
|
@@ -66,6 +129,7 @@ module Files
|
|
66
129
|
# Parameters:
|
67
130
|
# name - string - AS2 Name
|
68
131
|
# uri - string - URL base for AS2 responses
|
132
|
+
# server_certificate - string - Remote server certificate security setting
|
69
133
|
# public_certificate - string
|
70
134
|
def update(params = {})
|
71
135
|
params ||= {}
|
@@ -74,6 +138,7 @@ module Files
|
|
74
138
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
75
139
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
76
140
|
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
|
141
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
77
142
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
|
78
143
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
79
144
|
|
@@ -140,11 +205,13 @@ module Files
|
|
140
205
|
# uri (required) - string - URL base for AS2 responses
|
141
206
|
# public_certificate (required) - string
|
142
207
|
# as2_station_id (required) - int64 - Id of As2Station for this partner
|
208
|
+
# server_certificate - string - Remote server certificate security setting
|
143
209
|
def self.create(params = {}, options = {})
|
144
210
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
145
211
|
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
|
146
212
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
|
147
213
|
raise InvalidParameterError.new("Bad parameter: as2_station_id must be an Integer") if params.dig(:as2_station_id) and !params.dig(:as2_station_id).is_a?(Integer)
|
214
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
148
215
|
raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
|
149
216
|
raise MissingParameterError.new("Parameter missing: uri") unless params.dig(:uri)
|
150
217
|
raise MissingParameterError.new("Parameter missing: public_certificate") unless params.dig(:public_certificate)
|
@@ -157,6 +224,7 @@ module Files
|
|
157
224
|
# Parameters:
|
158
225
|
# name - string - AS2 Name
|
159
226
|
# uri - string - URL base for AS2 responses
|
227
|
+
# server_certificate - string - Remote server certificate security setting
|
160
228
|
# public_certificate - string
|
161
229
|
def self.update(id, params = {}, options = {})
|
162
230
|
params ||= {}
|
@@ -164,6 +232,7 @@ module Files
|
|
164
232
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
165
233
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
166
234
|
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
|
235
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
167
236
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
|
168
237
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
169
238
|
|