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
@@ -45,13 +45,13 @@ module Files
|
|
45
45
|
@attributes[:domain] = value
|
46
46
|
end
|
47
47
|
|
48
|
-
# string -
|
49
|
-
def
|
50
|
-
@attributes[:
|
48
|
+
# string - Serial of public certificate used for message security in hex format.
|
49
|
+
def hex_public_certificate_serial
|
50
|
+
@attributes[:hex_public_certificate_serial]
|
51
51
|
end
|
52
52
|
|
53
|
-
def
|
54
|
-
@attributes[:
|
53
|
+
def hex_public_certificate_serial=(value)
|
54
|
+
@attributes[:hex_public_certificate_serial] = value
|
55
55
|
end
|
56
56
|
|
57
57
|
# string - MD5 hash of public certificate used for message security.
|
@@ -72,6 +72,69 @@ module Files
|
|
72
72
|
@attributes[:private_key_md5] = value
|
73
73
|
end
|
74
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
|
+
|
120
|
+
# string - MD5 hash of private key password used for message security.
|
121
|
+
def private_key_password_md5
|
122
|
+
@attributes[:private_key_password_md5]
|
123
|
+
end
|
124
|
+
|
125
|
+
def private_key_password_md5=(value)
|
126
|
+
@attributes[:private_key_password_md5] = value
|
127
|
+
end
|
128
|
+
|
129
|
+
# string
|
130
|
+
def public_certificate
|
131
|
+
@attributes[:public_certificate]
|
132
|
+
end
|
133
|
+
|
134
|
+
def public_certificate=(value)
|
135
|
+
@attributes[:public_certificate] = value
|
136
|
+
end
|
137
|
+
|
75
138
|
# string
|
76
139
|
def private_key
|
77
140
|
@attributes[:private_key]
|
@@ -81,22 +144,29 @@ module Files
|
|
81
144
|
@attributes[:private_key] = value
|
82
145
|
end
|
83
146
|
|
147
|
+
# string
|
148
|
+
def private_key_password
|
149
|
+
@attributes[:private_key_password]
|
150
|
+
end
|
151
|
+
|
152
|
+
def private_key_password=(value)
|
153
|
+
@attributes[:private_key_password] = value
|
154
|
+
end
|
155
|
+
|
84
156
|
# Parameters:
|
85
157
|
# name - string - AS2 Name
|
86
|
-
# domain - string - AS2 Domain
|
87
|
-
# uri - string - URL base for AS2 responses
|
88
158
|
# public_certificate - string
|
89
159
|
# private_key - string
|
160
|
+
# private_key_password - string
|
90
161
|
def update(params = {})
|
91
162
|
params ||= {}
|
92
163
|
params[:id] = @attributes[:id]
|
93
164
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
94
165
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
95
166
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
96
|
-
raise InvalidParameterError.new("Bad parameter: domain must be an String") if params.dig(:domain) and !params.dig(:domain).is_a?(String)
|
97
|
-
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
|
98
167
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
|
99
168
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
|
169
|
+
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params.dig(:private_key_password) and !params.dig(:private_key_password).is_a?(String)
|
100
170
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
101
171
|
|
102
172
|
Api.send_request("/as2_stations/#{@attributes[:id]}", :patch, params, @options)
|
@@ -159,19 +229,15 @@ module Files
|
|
159
229
|
|
160
230
|
# Parameters:
|
161
231
|
# name (required) - string - AS2 Name
|
162
|
-
# domain (required) - string - AS2 Domain
|
163
|
-
# uri (required) - string - URL base for AS2 responses
|
164
232
|
# public_certificate (required) - string
|
165
233
|
# private_key (required) - string
|
234
|
+
# private_key_password - string
|
166
235
|
def self.create(params = {}, options = {})
|
167
236
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
168
|
-
raise InvalidParameterError.new("Bad parameter: domain must be an String") if params.dig(:domain) and !params.dig(:domain).is_a?(String)
|
169
|
-
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
|
170
237
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
|
171
238
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
|
239
|
+
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params.dig(:private_key_password) and !params.dig(:private_key_password).is_a?(String)
|
172
240
|
raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
|
173
|
-
raise MissingParameterError.new("Parameter missing: domain") unless params.dig(:domain)
|
174
|
-
raise MissingParameterError.new("Parameter missing: uri") unless params.dig(:uri)
|
175
241
|
raise MissingParameterError.new("Parameter missing: public_certificate") unless params.dig(:public_certificate)
|
176
242
|
raise MissingParameterError.new("Parameter missing: private_key") unless params.dig(:private_key)
|
177
243
|
|
@@ -181,19 +247,17 @@ module Files
|
|
181
247
|
|
182
248
|
# Parameters:
|
183
249
|
# name - string - AS2 Name
|
184
|
-
# domain - string - AS2 Domain
|
185
|
-
# uri - string - URL base for AS2 responses
|
186
250
|
# public_certificate - string
|
187
251
|
# private_key - string
|
252
|
+
# private_key_password - string
|
188
253
|
def self.update(id, params = {}, options = {})
|
189
254
|
params ||= {}
|
190
255
|
params[:id] = id
|
191
256
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
192
257
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
193
|
-
raise InvalidParameterError.new("Bad parameter: domain must be an String") if params.dig(:domain) and !params.dig(:domain).is_a?(String)
|
194
|
-
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params.dig(:uri) and !params.dig(:uri).is_a?(String)
|
195
258
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params.dig(:public_certificate) and !params.dig(:public_certificate).is_a?(String)
|
196
259
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
|
260
|
+
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params.dig(:private_key_password) and !params.dig(:private_key_password).is_a?(String)
|
197
261
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
198
262
|
|
199
263
|
response, options = Api.send_request("/as2_stations/#{params[:id]}", :patch, params, options)
|
@@ -27,6 +27,15 @@ module Files
|
|
27
27
|
@attributes[:automation] = value
|
28
28
|
end
|
29
29
|
|
30
|
+
# boolean - If true, this automation will not run.
|
31
|
+
def disabled
|
32
|
+
@attributes[:disabled]
|
33
|
+
end
|
34
|
+
|
35
|
+
def disabled=(value)
|
36
|
+
@attributes[:disabled] = value
|
37
|
+
end
|
38
|
+
|
30
39
|
# string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
31
40
|
def trigger
|
32
41
|
@attributes[:trigger]
|
@@ -193,6 +202,7 @@ module Files
|
|
193
202
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
194
203
|
# schedule - object - Custom schedule for running this automation.
|
195
204
|
# description - string - Description for the this Automation.
|
205
|
+
# disabled - boolean - If true, this automation will not run.
|
196
206
|
# name - string - Name for this automation.
|
197
207
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
198
208
|
# 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
|
@@ -306,6 +316,7 @@ module Files
|
|
306
316
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
307
317
|
# schedule - object - Custom schedule for running this automation.
|
308
318
|
# description - string - Description for the this Automation.
|
319
|
+
# disabled - boolean - If true, this automation will not run.
|
309
320
|
# name - string - Name for this automation.
|
310
321
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
311
322
|
# 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
|
@@ -346,6 +357,7 @@ module Files
|
|
346
357
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
347
358
|
# schedule - object - Custom schedule for running this automation.
|
348
359
|
# description - string - Description for the this Automation.
|
360
|
+
# disabled - boolean - If true, this automation will not run.
|
349
361
|
# name - string - Name for this automation.
|
350
362
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
351
363
|
# 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
|
@@ -81,7 +81,7 @@ module Files
|
|
81
81
|
@attributes[:clickwrap_body] = value
|
82
82
|
end
|
83
83
|
|
84
|
-
# Custom Form to use
|
84
|
+
# FormFieldSet - Custom Form to use
|
85
85
|
def form_field_set
|
86
86
|
@attributes[:form_field_set]
|
87
87
|
end
|
@@ -90,6 +90,33 @@ module Files
|
|
90
90
|
@attributes[:form_field_set] = value
|
91
91
|
end
|
92
92
|
|
93
|
+
# boolean - BundleRegistrations can be saved without providing name?
|
94
|
+
def skip_name
|
95
|
+
@attributes[:skip_name]
|
96
|
+
end
|
97
|
+
|
98
|
+
def skip_name=(value)
|
99
|
+
@attributes[:skip_name] = value
|
100
|
+
end
|
101
|
+
|
102
|
+
# boolean - BundleRegistrations can be saved without providing email?
|
103
|
+
def skip_email
|
104
|
+
@attributes[:skip_email]
|
105
|
+
end
|
106
|
+
|
107
|
+
def skip_email=(value)
|
108
|
+
@attributes[:skip_email] = value
|
109
|
+
end
|
110
|
+
|
111
|
+
# boolean - BundleRegistrations can be saved without providing company?
|
112
|
+
def skip_company
|
113
|
+
@attributes[:skip_company]
|
114
|
+
end
|
115
|
+
|
116
|
+
def skip_company=(value)
|
117
|
+
@attributes[:skip_company] = value
|
118
|
+
end
|
119
|
+
|
93
120
|
# int64 - Bundle ID
|
94
121
|
def id
|
95
122
|
@attributes[:id]
|
@@ -167,7 +194,7 @@ module Files
|
|
167
194
|
@attributes[:inbox_id] = value
|
168
195
|
end
|
169
196
|
|
170
|
-
# Preview watermark image applied to all bundle items.
|
197
|
+
# Image - Preview watermark image applied to all bundle items.
|
171
198
|
def watermark_attachment
|
172
199
|
@attributes[:watermark_attachment]
|
173
200
|
end
|
@@ -272,6 +299,9 @@ module Files
|
|
272
299
|
# preview_only - boolean - Restrict users to previewing files only?
|
273
300
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
274
301
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
302
|
+
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
303
|
+
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
304
|
+
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
275
305
|
# watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
276
306
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
277
307
|
def update(params = {})
|
@@ -380,6 +410,9 @@ module Files
|
|
380
410
|
# clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
381
411
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
382
412
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
413
|
+
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
414
|
+
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
415
|
+
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
383
416
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
384
417
|
def self.create(params = {}, options = {})
|
385
418
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -432,6 +465,9 @@ module Files
|
|
432
465
|
# preview_only - boolean - Restrict users to previewing files only?
|
433
466
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
434
467
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
468
|
+
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
469
|
+
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
470
|
+
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
435
471
|
# watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
436
472
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
437
473
|
def self.update(id, params = {}, options = {})
|
@@ -285,7 +285,7 @@ module Files
|
|
285
285
|
@attributes[:preview_id] = value
|
286
286
|
end
|
287
287
|
|
288
|
-
# File preview
|
288
|
+
# Preview - File preview
|
289
289
|
def preview
|
290
290
|
@attributes[:preview]
|
291
291
|
end
|
@@ -294,6 +294,15 @@ module Files
|
|
294
294
|
@attributes[:preview] = value
|
295
295
|
end
|
296
296
|
|
297
|
+
# boolean - Create parent directories if they do not exist?
|
298
|
+
def mkdir_parents
|
299
|
+
@attributes[:mkdir_parents]
|
300
|
+
end
|
301
|
+
|
302
|
+
def mkdir_parents=(value)
|
303
|
+
@attributes[:mkdir_parents] = value
|
304
|
+
end
|
305
|
+
|
297
306
|
def save
|
298
307
|
new_obj = Folder.create(path, @attributes, @options)
|
299
308
|
@attributes = new_obj.attributes
|
@@ -327,6 +336,7 @@ module Files
|
|
327
336
|
|
328
337
|
# Parameters:
|
329
338
|
# path (required) - string - Path to operate on.
|
339
|
+
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
330
340
|
def self.create(path, params = {}, options = {})
|
331
341
|
params ||= {}
|
332
342
|
params[:path] = path
|
@@ -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
|
@@ -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
|
@@ -31,42 +31,6 @@ module Files
|
|
31
31
|
@attributes[:language] = value
|
32
32
|
end
|
33
33
|
|
34
|
-
# string - Login token. If set, this token will allow your user to log in via browser at the domain in `login_token_domain`.
|
35
|
-
def login_token
|
36
|
-
@attributes[:login_token]
|
37
|
-
end
|
38
|
-
|
39
|
-
def login_token=(value)
|
40
|
-
@attributes[:login_token] = value
|
41
|
-
end
|
42
|
-
|
43
|
-
# string - Domain to use with `login_token`.
|
44
|
-
def login_token_domain
|
45
|
-
@attributes[:login_token_domain]
|
46
|
-
end
|
47
|
-
|
48
|
-
def login_token_domain=(value)
|
49
|
-
@attributes[:login_token_domain] = value
|
50
|
-
end
|
51
|
-
|
52
|
-
# int64 - Maximum number of files to retrieve per folder for a directory listing. This is based on the user's plan.
|
53
|
-
def max_dir_listing_size
|
54
|
-
@attributes[:max_dir_listing_size]
|
55
|
-
end
|
56
|
-
|
57
|
-
def max_dir_listing_size=(value)
|
58
|
-
@attributes[:max_dir_listing_size] = value
|
59
|
-
end
|
60
|
-
|
61
|
-
# boolean - Can access multiple regions?
|
62
|
-
def multiple_regions
|
63
|
-
@attributes[:multiple_regions]
|
64
|
-
end
|
65
|
-
|
66
|
-
def multiple_regions=(value)
|
67
|
-
@attributes[:multiple_regions] = value
|
68
|
-
end
|
69
|
-
|
70
34
|
# boolean - Is this session read only?
|
71
35
|
def read_only
|
72
36
|
@attributes[:read_only]
|
@@ -76,15 +40,6 @@ module Files
|
|
76
40
|
@attributes[:read_only] = value
|
77
41
|
end
|
78
42
|
|
79
|
-
# string - Initial root path to start the user's session in.
|
80
|
-
def root_path
|
81
|
-
@attributes[:root_path]
|
82
|
-
end
|
83
|
-
|
84
|
-
def root_path=(value)
|
85
|
-
@attributes[:root_path] = value
|
86
|
-
end
|
87
|
-
|
88
43
|
# 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.)
|
89
44
|
def sftp_insecure_ciphers
|
90
45
|
@attributes[:sftp_insecure_ciphers]
|
@@ -94,105 +49,6 @@ module Files
|
|
94
49
|
@attributes[:sftp_insecure_ciphers] = value
|
95
50
|
end
|
96
51
|
|
97
|
-
# int64 - Site ID
|
98
|
-
def site_id
|
99
|
-
@attributes[:site_id]
|
100
|
-
end
|
101
|
-
|
102
|
-
def site_id=(value)
|
103
|
-
@attributes[:site_id] = value
|
104
|
-
end
|
105
|
-
|
106
|
-
# boolean - Is SSL required for this user? (If so, ensure all your communications with this user use SSL.)
|
107
|
-
def ssl_required
|
108
|
-
@attributes[:ssl_required]
|
109
|
-
end
|
110
|
-
|
111
|
-
def ssl_required=(value)
|
112
|
-
@attributes[:ssl_required] = value
|
113
|
-
end
|
114
|
-
|
115
|
-
# 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.)
|
116
|
-
def tls_disabled
|
117
|
-
@attributes[:tls_disabled]
|
118
|
-
end
|
119
|
-
|
120
|
-
def tls_disabled=(value)
|
121
|
-
@attributes[:tls_disabled] = value
|
122
|
-
end
|
123
|
-
|
124
|
-
# boolean - If true, this user needs to add a Two Factor Authentication method before performing any further actions.
|
125
|
-
def two_factor_setup_needed
|
126
|
-
@attributes[:two_factor_setup_needed]
|
127
|
-
end
|
128
|
-
|
129
|
-
def two_factor_setup_needed=(value)
|
130
|
-
@attributes[:two_factor_setup_needed] = value
|
131
|
-
end
|
132
|
-
|
133
|
-
# boolean - Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
|
134
|
-
def allowed_2fa_method_sms
|
135
|
-
@attributes[:allowed_2fa_method_sms]
|
136
|
-
end
|
137
|
-
|
138
|
-
def allowed_2fa_method_sms=(value)
|
139
|
-
@attributes[:allowed_2fa_method_sms] = value
|
140
|
-
end
|
141
|
-
|
142
|
-
# boolean - Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
|
143
|
-
def allowed_2fa_method_totp
|
144
|
-
@attributes[:allowed_2fa_method_totp]
|
145
|
-
end
|
146
|
-
|
147
|
-
def allowed_2fa_method_totp=(value)
|
148
|
-
@attributes[:allowed_2fa_method_totp] = value
|
149
|
-
end
|
150
|
-
|
151
|
-
# boolean - Sent only if 2FA setup is needed. Is U2F two factor authentication allowed?
|
152
|
-
def allowed_2fa_method_u2f
|
153
|
-
@attributes[:allowed_2fa_method_u2f]
|
154
|
-
end
|
155
|
-
|
156
|
-
def allowed_2fa_method_u2f=(value)
|
157
|
-
@attributes[:allowed_2fa_method_u2f] = value
|
158
|
-
end
|
159
|
-
|
160
|
-
# boolean - Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
|
161
|
-
def allowed_2fa_method_webauthn
|
162
|
-
@attributes[:allowed_2fa_method_webauthn]
|
163
|
-
end
|
164
|
-
|
165
|
-
def allowed_2fa_method_webauthn=(value)
|
166
|
-
@attributes[:allowed_2fa_method_webauthn] = value
|
167
|
-
end
|
168
|
-
|
169
|
-
# boolean - Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
|
170
|
-
def allowed_2fa_method_yubi
|
171
|
-
@attributes[:allowed_2fa_method_yubi]
|
172
|
-
end
|
173
|
-
|
174
|
-
def allowed_2fa_method_yubi=(value)
|
175
|
-
@attributes[:allowed_2fa_method_yubi] = value
|
176
|
-
end
|
177
|
-
|
178
|
-
# boolean - Allow the user to provide file/folder modified at dates? If false, the server will always use the current date/time.
|
179
|
-
def use_provided_modified_at
|
180
|
-
@attributes[:use_provided_modified_at]
|
181
|
-
end
|
182
|
-
|
183
|
-
def use_provided_modified_at=(value)
|
184
|
-
@attributes[:use_provided_modified_at] = value
|
185
|
-
end
|
186
|
-
|
187
|
-
# boolean - Does this user want to use Windows line-ending emulation? (CR vs CRLF)
|
188
|
-
def windows_mode_ftp
|
189
|
-
@attributes[:windows_mode_ftp]
|
190
|
-
end
|
191
|
-
|
192
|
-
def windows_mode_ftp=(value)
|
193
|
-
@attributes[:windows_mode_ftp] = value
|
194
|
-
end
|
195
|
-
|
196
52
|
# string - Username to sign in as
|
197
53
|
def username
|
198
54
|
@attributes[:username]
|
@@ -79,7 +79,7 @@ module Files
|
|
79
79
|
@attributes[:bundle_require_share_recipient]
|
80
80
|
end
|
81
81
|
|
82
|
-
# Preview watermark image applied to all bundle items.
|
82
|
+
# Image - Preview watermark image applied to all bundle items.
|
83
83
|
def bundle_watermark_attachment
|
84
84
|
@attributes[:bundle_watermark_attachment]
|
85
85
|
end
|
@@ -239,22 +239,22 @@ module Files
|
|
239
239
|
@attributes[:hipaa]
|
240
240
|
end
|
241
241
|
|
242
|
-
# Branded icon 128x128
|
242
|
+
# Image - Branded icon 128x128
|
243
243
|
def icon128
|
244
244
|
@attributes[:icon128]
|
245
245
|
end
|
246
246
|
|
247
|
-
# Branded icon 16x16
|
247
|
+
# Image - Branded icon 16x16
|
248
248
|
def icon16
|
249
249
|
@attributes[:icon16]
|
250
250
|
end
|
251
251
|
|
252
|
-
# Branded icon 32x32
|
252
|
+
# Image - Branded icon 32x32
|
253
253
|
def icon32
|
254
254
|
@attributes[:icon32]
|
255
255
|
end
|
256
256
|
|
257
|
-
# Branded icon 48x48
|
257
|
+
# Image - Branded icon 48x48
|
258
258
|
def icon48
|
259
259
|
@attributes[:icon48]
|
260
260
|
end
|
@@ -359,7 +359,7 @@ module Files
|
|
359
359
|
@attributes[:login_help_text]
|
360
360
|
end
|
361
361
|
|
362
|
-
# Branded logo
|
362
|
+
# Image - Branded logo
|
363
363
|
def logo
|
364
364
|
@attributes[:logo]
|
365
365
|
end
|
@@ -469,7 +469,7 @@ module Files
|
|
469
469
|
@attributes[:require_2fa_user_type]
|
470
470
|
end
|
471
471
|
|
472
|
-
# Current session
|
472
|
+
# Session - Current session
|
473
473
|
def session
|
474
474
|
@attributes[:session]
|
475
475
|
end
|
@@ -584,7 +584,7 @@ module Files
|
|
584
584
|
@attributes[:use_provided_modified_at]
|
585
585
|
end
|
586
586
|
|
587
|
-
# User of current session
|
587
|
+
# User - User of current session
|
588
588
|
def user
|
589
589
|
@attributes[:user]
|
590
590
|
end
|
@@ -624,6 +624,11 @@ module Files
|
|
624
624
|
@attributes[:welcome_email_cc]
|
625
625
|
end
|
626
626
|
|
627
|
+
# string - Include this email subject in welcome emails if enabled
|
628
|
+
def welcome_email_subject
|
629
|
+
@attributes[:welcome_email_subject]
|
630
|
+
end
|
631
|
+
|
627
632
|
# boolean - Will the welcome email be sent to new users?
|
628
633
|
def welcome_email_enabled
|
629
634
|
@attributes[:welcome_email_enabled]
|
@@ -669,6 +674,7 @@ module Files
|
|
669
674
|
# ask_about_overwrites - boolean - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
670
675
|
# show_request_access_link - boolean - Show request access link for users without access? Currently unused.
|
671
676
|
# welcome_email_cc - string - Include this email in welcome emails if enabled
|
677
|
+
# welcome_email_subject - string - Include this email subject in welcome emails if enabled
|
672
678
|
# welcome_custom_text - string - Custom text send in user welcome email
|
673
679
|
# language - string - Site default language
|
674
680
|
# windows_mode_ftp - boolean - Does FTP user Windows emulation mode?
|
@@ -781,6 +787,7 @@ module Files
|
|
781
787
|
raise InvalidParameterError.new("Bad parameter: reply_to_email must be an String") if params.dig(:reply_to_email) and !params.dig(:reply_to_email).is_a?(String)
|
782
788
|
raise InvalidParameterError.new("Bad parameter: bundle_expiration must be an Integer") if params.dig(:bundle_expiration) and !params.dig(:bundle_expiration).is_a?(Integer)
|
783
789
|
raise InvalidParameterError.new("Bad parameter: welcome_email_cc must be an String") if params.dig(:welcome_email_cc) and !params.dig(:welcome_email_cc).is_a?(String)
|
790
|
+
raise InvalidParameterError.new("Bad parameter: welcome_email_subject must be an String") if params.dig(:welcome_email_subject) and !params.dig(:welcome_email_subject).is_a?(String)
|
784
791
|
raise InvalidParameterError.new("Bad parameter: welcome_custom_text must be an String") if params.dig(:welcome_custom_text) and !params.dig(:welcome_custom_text).is_a?(String)
|
785
792
|
raise InvalidParameterError.new("Bad parameter: language must be an String") if params.dig(:language) and !params.dig(:language).is_a?(String)
|
786
793
|
raise InvalidParameterError.new("Bad parameter: default_time_zone must be an String") if params.dig(:default_time_zone) and !params.dig(:default_time_zone).is_a?(String)
|