files.com 1.0.296 → 1.0.297

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/account_line_item.md +3 -19
  4. data/docs/action_notification_export.md +1 -1
  5. data/docs/api_key.md +4 -1
  6. data/docs/app.md +17 -15
  7. data/docs/as2_incoming_message.md +29 -25
  8. data/docs/as2_outgoing_message.md +24 -20
  9. data/docs/as2_partner.md +9 -7
  10. data/docs/as2_station.md +9 -9
  11. data/docs/automation.md +28 -24
  12. data/docs/behavior.md +15 -7
  13. data/docs/bundle.md +4 -33
  14. data/docs/bundle_download.md +2 -2
  15. data/docs/bundle_registration.md +5 -3
  16. data/docs/clickwrap.md +15 -6
  17. data/docs/dns_record.md +1 -1
  18. data/docs/external_event.md +7 -7
  19. data/docs/file.md +1 -7
  20. data/docs/file_action.md +1 -1
  21. data/docs/file_comment.md +1 -4
  22. data/docs/file_upload_part.md +11 -5
  23. data/docs/folder.md +1 -7
  24. data/docs/form_field_set.md +4 -17
  25. data/docs/group.md +5 -2
  26. data/docs/group_user.md +1 -1
  27. data/docs/history_export.md +1 -1
  28. data/docs/inbox_registration.md +5 -3
  29. data/docs/inbox_upload.md +2 -2
  30. data/docs/invoice.md +3 -19
  31. data/docs/lock.md +1 -1
  32. data/docs/message.md +1 -10
  33. data/docs/message_comment.md +1 -4
  34. data/docs/notification.md +2 -2
  35. data/docs/payment.md +3 -19
  36. data/docs/permission.md +4 -2
  37. data/docs/public_ip_address.md +2 -2
  38. data/docs/remote_server.md +15 -6
  39. data/docs/request.md +7 -6
  40. data/docs/settings_change.md +1 -1
  41. data/docs/sftp_host_key.md +6 -9
  42. data/docs/site.md +37 -115
  43. data/docs/sso_strategy.md +12 -12
  44. data/docs/status.md +4 -11
  45. data/docs/style.md +2 -2
  46. data/docs/usage_daily_snapshot.md +11 -9
  47. data/docs/usage_snapshot.md +3 -1
  48. data/docs/user.md +14 -8
  49. data/docs/user_request.md +1 -1
  50. data/docs/webhook_test.md +4 -4
  51. metadata +2 -2
data/docs/site.md CHANGED
@@ -14,16 +14,15 @@
14
14
  "admin_user_id": 1,
15
15
  "allow_bundle_names": true,
16
16
  "allowed_countries": "US,DE",
17
- "allowed_ips": "",
17
+ "allowed_ips": "example",
18
18
  "ask_about_overwrites": true,
19
19
  "bundle_expiration": 1,
20
20
  "bundle_password_required": true,
21
21
  "bundle_require_share_recipient": true,
22
- "bundle_watermark_attachment": {
23
- "name": "My logo",
24
- "uri": "https://mysite.files.com/.../my_image.png"
22
+ "bundle_watermark_attachment": "",
23
+ "bundle_watermark_value": {
24
+ "key": "example value"
25
25
  },
26
- "bundle_watermark_value": "",
27
26
  "color2_left": "#0066a7",
28
27
  "color2_link": "#d34f5d",
29
28
  "color2_text": "#0066a7",
@@ -47,39 +46,27 @@
47
46
  "disable_password_reset": true,
48
47
  "domain": "my-custom-domain.com",
49
48
  "domain_hsts_header": true,
50
- "domain_letsencrypt_chain": "",
51
- "email": "john.doe@files.com",
49
+ "domain_letsencrypt_chain": "example",
50
+ "email": "example",
52
51
  "ftp_enabled": true,
53
- "reply_to_email": "jane.doe@files.com",
52
+ "reply_to_email": "example",
54
53
  "non_sso_groups_allowed": true,
55
54
  "non_sso_users_allowed": true,
56
55
  "folder_permissions_groups_only": true,
57
56
  "hipaa": true,
58
- "icon128": {
59
- "name": "My logo",
60
- "uri": "https://mysite.files.com/.../my_image.png"
61
- },
62
- "icon16": {
63
- "name": "My logo",
64
- "uri": "https://mysite.files.com/.../my_image.png"
65
- },
66
- "icon32": {
67
- "name": "My logo",
68
- "uri": "https://mysite.files.com/.../my_image.png"
69
- },
70
- "icon48": {
71
- "name": "My logo",
72
- "uri": "https://mysite.files.com/.../my_image.png"
73
- },
57
+ "icon128": "",
58
+ "icon16": "",
59
+ "icon32": "",
60
+ "icon48": "",
74
61
  "immutable_files_set_at": "2000-01-01T01:00:00Z",
75
62
  "include_password_in_welcome_email": true,
76
63
  "language": "en",
77
- "ldap_base_dn": "",
64
+ "ldap_base_dn": "example",
78
65
  "ldap_domain": "mysite.com",
79
66
  "ldap_enabled": true,
80
67
  "ldap_group_action": "disabled",
81
- "ldap_group_exclusion": "",
82
- "ldap_group_inclusion": "",
68
+ "ldap_group_exclusion": "example",
69
+ "ldap_group_inclusion": "example",
83
70
  "ldap_host": "ldap.site.com",
84
71
  "ldap_host_2": "ldap2.site.com",
85
72
  "ldap_host_3": "ldap3.site.com",
@@ -87,16 +74,13 @@
87
74
  "ldap_secure": true,
88
75
  "ldap_type": "open_ldap",
89
76
  "ldap_user_action": "disabled",
90
- "ldap_user_include_groups": "",
77
+ "ldap_user_include_groups": "example",
91
78
  "ldap_username": "[ldap username]",
92
79
  "ldap_username_field": "sAMAccountName",
93
80
  "login_help_text": "Login page help text.",
94
- "logo": {
95
- "name": "My logo",
96
- "uri": "https://mysite.files.com/.../my_image.png"
97
- },
81
+ "logo": "",
98
82
  "max_prior_passwords": 1,
99
- "motd_text": "",
83
+ "motd_text": "example",
100
84
  "motd_use_for_ftp": true,
101
85
  "motd_use_for_sftp": true,
102
86
  "next_billing_amount": 1.0,
@@ -120,36 +104,15 @@
120
104
  "require_2fa": true,
121
105
  "require_2fa_stop_time": "2000-01-01T01:00:00Z",
122
106
  "require_2fa_user_type": "`site_admins`",
123
- "session": {
124
- "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
125
- "language": "en",
126
- "login_token": "@tok-randomcode",
127
- "login_token_domain": "https://mysite.files.com",
128
- "max_dir_listing_size": false,
129
- "multiple_regions": true,
130
- "read_only": true,
131
- "root_path": "",
132
- "sftp_insecure_ciphers": false,
133
- "site_id": 1,
134
- "ssl_required": true,
135
- "tls_disabled": false,
136
- "two_factor_setup_needed": false,
137
- "allowed_2fa_method_sms": true,
138
- "allowed_2fa_method_totp": true,
139
- "allowed_2fa_method_u2f": true,
140
- "allowed_2fa_method_webauthn": true,
141
- "allowed_2fa_method_yubi": true,
142
- "use_provided_modified_at": true,
143
- "windows_mode_ftp": false
144
- },
107
+ "session": "",
145
108
  "session_pinned_by_ip": true,
146
109
  "sftp_enabled": true,
147
110
  "sftp_insecure_ciphers": true,
148
111
  "sftp_user_root_enabled": true,
149
112
  "sharing_enabled": true,
150
113
  "show_request_access_link": true,
151
- "site_footer": "",
152
- "site_header": "",
114
+ "site_footer": "example",
115
+ "site_header": "example",
153
116
  "smtp_address": "smtp.my-mail-server.com",
154
117
  "smtp_authentication": "plain",
155
118
  "smtp_from": "me@my-mail-server.com",
@@ -164,60 +127,7 @@
164
127
  "trial_until": "2000-01-01T01:00:00Z",
165
128
  "updated_at": "2000-01-01T01:00:00Z",
166
129
  "use_provided_modified_at": true,
167
- "user": {
168
- "id": 1,
169
- "username": "user",
170
- "admin_group_ids": [
171
- 1
172
- ],
173
- "allowed_ips": "127.0.0.1",
174
- "attachments_permission": true,
175
- "api_keys_count": 1,
176
- "authenticate_until": "2000-01-01T01:00:00Z",
177
- "authentication_method": "password",
178
- "avatar_url": "",
179
- "billing_permission": false,
180
- "bypass_site_allowed_ips": false,
181
- "bypass_inactive_disable": false,
182
- "created_at": "2000-01-01T01:00:00Z",
183
- "dav_permission": true,
184
- "disabled": true,
185
- "email": "john.doe@files.com",
186
- "first_login_at": "2000-01-01T01:00:00Z",
187
- "ftp_permission": true,
188
- "group_ids": "",
189
- "header_text": "User-specific message.",
190
- "language": "en",
191
- "last_login_at": "2000-01-01T01:00:00Z",
192
- "last_protocol_cipher": "",
193
- "lockout_expires": "2000-01-01T01:00:00Z",
194
- "name": "John Doe",
195
- "company": "ACME Corp.",
196
- "notes": "Internal notes on this user.",
197
- "notification_daily_send_time": 18,
198
- "office_integration_enabled": true,
199
- "password_set_at": "2000-01-01T01:00:00Z",
200
- "password_validity_days": 1,
201
- "public_keys_count": 1,
202
- "receive_admin_alerts": true,
203
- "require_2fa": "always_require",
204
- "active_2fa": true,
205
- "require_password_change": true,
206
- "password_expired": true,
207
- "restapi_permission": true,
208
- "self_managed": true,
209
- "sftp_permission": true,
210
- "site_admin": true,
211
- "skip_welcome_screen": true,
212
- "ssl_required": "always_require",
213
- "sso_strategy_id": 1,
214
- "subscribe_to_newsletter": true,
215
- "externally_managed": true,
216
- "time_zone": "Pacific Time (US & Canada)",
217
- "type_of_2fa": "yubi",
218
- "updated_at": "2000-01-01T01:00:00Z",
219
- "user_root": ""
220
- },
130
+ "user": "",
221
131
  "user_lockout": true,
222
132
  "user_lockout_lock_period": 1,
223
133
  "user_lockout_tries": 1,
@@ -225,8 +135,8 @@
225
135
  "user_requests_enabled": true,
226
136
  "user_requests_notify_admins": true,
227
137
  "welcome_custom_text": "Welcome to my site!",
228
- "welcome_email_cc": "",
229
- "welcome_email_subject": "",
138
+ "welcome_email_cc": "example",
139
+ "welcome_email_subject": "example",
230
140
  "welcome_email_enabled": true,
231
141
  "welcome_screen": "user_controlled",
232
142
  "windows_mode_ftp": true,
@@ -399,14 +309,17 @@ Files::Site.update(
399
309
  subdomain: "mysite",
400
310
  domain: "my-custom-domain.com",
401
311
  domain_hsts_header: true,
402
- email: "john.doe@files.com",
403
- reply_to_email: "jane.doe@files.com",
312
+ domain_letsencrypt_chain: "example",
313
+ email: "example",
314
+ reply_to_email: "example",
404
315
  allow_bundle_names: true,
405
316
  bundle_expiration: 1,
406
317
  overage_notify: true,
407
318
  welcome_email_enabled: true,
408
319
  ask_about_overwrites: true,
409
320
  show_request_access_link: true,
321
+ welcome_email_cc: "example",
322
+ welcome_email_subject: "example",
410
323
  welcome_custom_text: "Welcome to my site!",
411
324
  language: "en",
412
325
  windows_mode_ftp: true,
@@ -421,6 +334,7 @@ Files::Site.update(
421
334
  welcome_screen: "user_controlled",
422
335
  office_integration_available: true,
423
336
  pin_all_remote_servers_to_site_region: true,
337
+ motd_text: "example",
424
338
  motd_use_for_ftp: true,
425
339
  motd_use_for_sftp: true,
426
340
  session_expiry: 1.0,
@@ -434,6 +348,7 @@ Files::Site.update(
434
348
  user_lockout_lock_period: 1,
435
349
  include_password_in_welcome_email: true,
436
350
  allowed_countries: "US,DE",
351
+ allowed_ips: "example",
437
352
  disallowed_countries: "US,DE",
438
353
  days_to_retain_backups: 1,
439
354
  max_prior_passwords: 1,
@@ -462,6 +377,7 @@ Files::Site.update(
462
377
  user_requests_notify_admins: true,
463
378
  ftp_enabled: true,
464
379
  sftp_enabled: true,
380
+ bundle_watermark_value: {"key":"example value"},
465
381
  allowed_2fa_method_sms: true,
466
382
  allowed_2fa_method_u2f: true,
467
383
  allowed_2fa_method_totp: true,
@@ -475,6 +391,8 @@ Files::Site.update(
475
391
  color2_link: "#d34f5d",
476
392
  color2_text: "#0066a7",
477
393
  color2_top_text: "#ffffff",
394
+ site_header: "example",
395
+ site_footer: "example",
478
396
  login_help_text: "Login page help text.",
479
397
  smtp_address: "smtp.my-mail-server.com",
480
398
  smtp_authentication: "plain",
@@ -493,6 +411,10 @@ Files::Site.update(
493
411
  ldap_domain: "mysite.com",
494
412
  ldap_user_action: "disabled",
495
413
  ldap_group_action: "disabled",
414
+ ldap_user_include_groups: "example",
415
+ ldap_group_exclusion: "example",
416
+ ldap_group_inclusion: "example",
417
+ ldap_base_dn: "example",
496
418
  icon16_delete: true,
497
419
  icon32_delete: true,
498
420
  icon48_delete: true,
data/docs/sso_strategy.md CHANGED
@@ -9,16 +9,16 @@
9
9
  "label": "My Corporate SSO Provider",
10
10
  "logo_url": "https://mysite.files.com/.../logo.png",
11
11
  "id": 1,
12
- "saml_provider_cert_fingerprint": "",
13
- "saml_provider_issuer_url": "",
14
- "saml_provider_metadata_content": "",
15
- "saml_provider_metadata_url": "",
16
- "saml_provider_slo_target_url": "",
17
- "saml_provider_sso_target_url": "",
18
- "scim_authentication_method": "",
19
- "scim_username": "",
20
- "scim_oauth_access_token": "",
21
- "scim_oauth_access_token_expires_at": "",
12
+ "saml_provider_cert_fingerprint": "example",
13
+ "saml_provider_issuer_url": "example",
14
+ "saml_provider_metadata_content": "example",
15
+ "saml_provider_metadata_url": "example",
16
+ "saml_provider_slo_target_url": "example",
17
+ "saml_provider_sso_target_url": "example",
18
+ "scim_authentication_method": "example",
19
+ "scim_username": "example",
20
+ "scim_oauth_access_token": "example",
21
+ "scim_oauth_access_token_expires_at": "example",
22
22
  "subdomain": "my-site",
23
23
  "provision_users": true,
24
24
  "provision_groups": true,
@@ -28,7 +28,7 @@
28
28
  "provision_group_default": "Employees",
29
29
  "provision_group_exclusion": "Employees",
30
30
  "provision_group_inclusion": "Employees",
31
- "provision_group_required": "",
31
+ "provision_group_required": "example",
32
32
  "provision_email_signup_groups": "Employees",
33
33
  "provision_site_admin_groups": "Employees",
34
34
  "provision_attachments_permission": true,
@@ -37,7 +37,7 @@
37
37
  "provision_sftp_permission": true,
38
38
  "provision_time_zone": "Eastern Time (US & Canada)",
39
39
  "provision_company": "ACME Corp.",
40
- "ldap_base_dn": "",
40
+ "ldap_base_dn": "example",
41
41
  "ldap_domain": "mysite.com",
42
42
  "enabled": true,
43
43
  "ldap_host": "ldap.site.com",
data/docs/status.md CHANGED
@@ -5,21 +5,14 @@
5
5
  ```
6
6
  {
7
7
  "code": 200,
8
- "message": "",
8
+ "message": "example",
9
9
  "status": "",
10
- "data": "",
10
+ "data": "example",
11
11
  "errors": [
12
- {
13
- "fields": [
14
-
15
- ],
16
- "messages": [
17
-
18
- ]
19
- }
12
+ null
20
13
  ],
21
14
  "clickwrap_id": 1,
22
- "clickwrap_body": ""
15
+ "clickwrap_body": "example"
23
16
  }
24
17
  ```
25
18
 
data/docs/style.md CHANGED
@@ -5,9 +5,9 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "path": "",
8
+ "path": "example",
9
9
  "logo": "https://mysite.files.com/...",
10
- "thumbnail": ""
10
+ "thumbnail": "example"
11
11
  }
12
12
  ```
13
13
 
@@ -5,16 +5,18 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "date": "2020-11-21",
8
+ "date": "2000-01-01T01:00:00Z",
9
9
  "api_usage_available": true,
10
- "read_api_usage": "100",
11
- "write_api_usage": "50",
12
- "user_count": "25",
13
- "current_storage": "65536",
14
- "deleted_files_storage": "65536",
15
- "deleted_files_counted_in_minimum": "65536",
16
- "root_storage": "65536",
17
- "usage_by_top_level_dir": ""
10
+ "read_api_usage": 1,
11
+ "write_api_usage": 1,
12
+ "user_count": 1,
13
+ "current_storage": 1,
14
+ "deleted_files_storage": 1,
15
+ "deleted_files_counted_in_minimum": 1,
16
+ "root_storage": 1,
17
+ "usage_by_top_level_dir": {
18
+ "key": "example value"
19
+ }
18
20
  }
19
21
  ```
20
22
 
@@ -14,7 +14,9 @@
14
14
  "total_downloads": 1,
15
15
  "total_uploads": 1,
16
16
  "updated_at": "2000-01-01T01:00:00Z",
17
- "usage_by_top_level_dir": "",
17
+ "usage_by_top_level_dir": {
18
+ "key": "example value"
19
+ },
18
20
  "root_storage": 1.0,
19
21
  "deleted_files_counted_in_minimum": 1.0,
20
22
  "deleted_files_storage": 1.0,
data/docs/user.md CHANGED
@@ -14,21 +14,21 @@
14
14
  "api_keys_count": 1,
15
15
  "authenticate_until": "2000-01-01T01:00:00Z",
16
16
  "authentication_method": "password",
17
- "avatar_url": "",
17
+ "avatar_url": "example",
18
18
  "billing_permission": true,
19
19
  "bypass_site_allowed_ips": true,
20
20
  "bypass_inactive_disable": true,
21
21
  "created_at": "2000-01-01T01:00:00Z",
22
22
  "dav_permission": true,
23
23
  "disabled": true,
24
- "email": "john.doe@files.com",
24
+ "email": "example",
25
25
  "first_login_at": "2000-01-01T01:00:00Z",
26
26
  "ftp_permission": true,
27
- "group_ids": "",
27
+ "group_ids": "example",
28
28
  "header_text": "User-specific message.",
29
29
  "language": "en",
30
30
  "last_login_at": "2000-01-01T01:00:00Z",
31
- "last_protocol_cipher": "",
31
+ "last_protocol_cipher": "example",
32
32
  "lockout_expires": "2000-01-01T01:00:00Z",
33
33
  "name": "John Doe",
34
34
  "company": "ACME Corp.",
@@ -55,7 +55,7 @@
55
55
  "time_zone": "Pacific Time (US & Canada)",
56
56
  "type_of_2fa": "yubi",
57
57
  "updated_at": "2000-01-01T01:00:00Z",
58
- "user_root": ""
58
+ "user_root": "example"
59
59
  }
60
60
  ```
61
61
 
@@ -173,8 +173,9 @@ Files::User.find(id)
173
173
  ```
174
174
  Files::User.create(
175
175
  avatar_delete: true,
176
- email: "john.doe@files.com",
176
+ email: "example",
177
177
  group_id: 1,
178
+ group_ids: "example",
178
179
  announcements_read: true,
179
180
  allowed_ips: "127.0.0.1",
180
181
  attachments_permission: true,
@@ -206,6 +207,7 @@ Files::User.create(
206
207
  subscribe_to_newsletter: true,
207
208
  require_2fa: "always_require",
208
209
  time_zone: "Pacific Time (US & Canada)",
210
+ user_root: "example",
209
211
  username: "user"
210
212
  )
211
213
  ```
@@ -304,8 +306,9 @@ Files::User.user_2fa_reset(id)
304
306
  ```
305
307
  Files::User.update(id,
306
308
  avatar_delete: true,
307
- email: "john.doe@files.com",
309
+ email: "example",
308
310
  group_id: 1,
311
+ group_ids: "example",
309
312
  announcements_read: true,
310
313
  allowed_ips: "127.0.0.1",
311
314
  attachments_permission: true,
@@ -337,6 +340,7 @@ Files::User.update(id,
337
340
  subscribe_to_newsletter: true,
338
341
  require_2fa: "always_require",
339
342
  time_zone: "Pacific Time (US & Canada)",
343
+ user_root: "example",
340
344
  username: "user"
341
345
  )
342
346
  ```
@@ -457,8 +461,9 @@ user = Files::User.list.first
457
461
 
458
462
  user.update(
459
463
  avatar_delete: true,
460
- email: "john.doe@files.com",
464
+ email: "example",
461
465
  group_id: 1,
466
+ group_ids: "example",
462
467
  announcements_read: true,
463
468
  allowed_ips: "127.0.0.1",
464
469
  attachments_permission: true,
@@ -490,6 +495,7 @@ user.update(
490
495
  subscribe_to_newsletter: true,
491
496
  require_2fa: "always_require",
492
497
  time_zone: "Pacific Time (US & Canada)",
498
+ user_root: "example",
493
499
  username: "user"
494
500
  )
495
501
  ```
data/docs/user_request.md CHANGED
@@ -6,7 +6,7 @@
6
6
  {
7
7
  "id": 1,
8
8
  "name": "John Doe",
9
- "email": "john.doe@files.com",
9
+ "email": "example",
10
10
  "details": "Changed Departments"
11
11
  }
12
12
  ```
data/docs/webhook_test.md CHANGED
@@ -7,7 +7,7 @@
7
7
  "code": 200,
8
8
  "message": "",
9
9
  "status": "",
10
- "data": "",
10
+ "data": "example",
11
11
  "success": true
12
12
  }
13
13
  ```
@@ -37,10 +37,10 @@ Files::WebhookTest.create(
37
37
  url: "https://www.site.com/...",
38
38
  method: "GET",
39
39
  encoding: "RAW",
40
- headers: "x-test-header => testvalue",
41
- body: "test-param => testvalue",
40
+ headers: {"x-test-header":"testvalue"},
41
+ body: {"test-param":"testvalue"},
42
42
  raw_body: "test body",
43
- file_as_body: "false",
43
+ file_as_body: true,
44
44
  file_form_field: "upload_file_data",
45
45
  action: "test"
46
46
  )
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.296
4
+ version: 1.0.297
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-09-23 00:00:00.000000000 Z
11
+ date: 2022-09-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable