files.com 1.1.670 → 1.1.671

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.
Files changed (345) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/account.md +155 -0
  4. data/docs/action_log.md +21 -1
  5. data/docs/action_notification_export_result.md +17 -0
  6. data/docs/action_webhook_failure.md +28 -0
  7. data/docs/agent_proxy_identity.md +49 -0
  8. data/docs/agent_proxy_identity_endpoint.md +11 -0
  9. data/docs/agent_proxy_identity_result.md +24 -0
  10. data/docs/agent_v2_auth.md +17 -0
  11. data/docs/ai_assistant_personality.md +14 -0
  12. data/docs/ai_task.md +14 -0
  13. data/docs/announcement.md +57 -0
  14. data/docs/api_key.md +27 -1
  15. data/docs/api_request_log.md +21 -1
  16. data/docs/app.md +15 -0
  17. data/docs/as2_incoming_message.md +18 -0
  18. data/docs/as2_outgoing_message.md +18 -0
  19. data/docs/as2_partner.md +14 -0
  20. data/docs/as2_station.md +14 -0
  21. data/docs/automation.md +22 -1
  22. data/docs/automation_log.md +21 -1
  23. data/docs/automation_run.md +19 -0
  24. data/docs/bandwidth_snapshot.md +18 -0
  25. data/docs/behavior.md +14 -0
  26. data/docs/blog_post.md +57 -0
  27. data/docs/bundle.md +50 -1
  28. data/docs/bundle_action.md +25 -0
  29. data/docs/bundle_download.md +23 -0
  30. data/docs/bundle_notification.md +19 -0
  31. data/docs/bundle_recipient.md +21 -0
  32. data/docs/bundle_recipient_registration.md +39 -0
  33. data/docs/bundle_registration.md +61 -0
  34. data/docs/certificate.md +258 -0
  35. data/docs/chat_session.md +14 -0
  36. data/docs/child_site.md +583 -0
  37. data/docs/child_site_management_policy.md +9 -0
  38. data/docs/clickwrap.md +13 -0
  39. data/docs/clickwrap_acceptance.md +30 -0
  40. data/docs/client_log.md +17 -0
  41. data/docs/crash_report.md +50 -0
  42. data/docs/custom_domain.md +13 -0
  43. data/docs/custom_domain_for_proxy.md +23 -0
  44. data/docs/desktop_configuration_profile.md +14 -0
  45. data/docs/dns_record.md +9 -0
  46. data/docs/email_incoming_message.md +19 -0
  47. data/docs/email_log.md +20 -1
  48. data/docs/email_preference.md +108 -0
  49. data/docs/email_preference_bundle_notification.md +15 -0
  50. data/docs/email_preference_notification.md +17 -0
  51. data/docs/event_channel.md +14 -0
  52. data/docs/event_delivery_attempt.md +14 -0
  53. data/docs/event_record.md +19 -0
  54. data/docs/event_subscription.md +14 -0
  55. data/docs/event_target.md +14 -0
  56. data/docs/exavault_api_request_log.md +21 -1
  57. data/docs/expectation.md +14 -0
  58. data/docs/expectation_evaluation.md +14 -0
  59. data/docs/expectation_incident.md +14 -0
  60. data/docs/export.md +90 -0
  61. data/docs/external_event.md +18 -0
  62. data/docs/file.md +90 -2
  63. data/docs/file_migration.md +32 -0
  64. data/docs/file_migration_log.md +20 -1
  65. data/docs/file_upload_part.md +3 -1
  66. data/docs/folder.md +20 -0
  67. data/docs/form_field_set.md +15 -0
  68. data/docs/front_end_server.md +111 -0
  69. data/docs/frontend_metric.md +34 -0
  70. data/docs/ftp_action_log.md +21 -1
  71. data/docs/gpg_key.md +21 -0
  72. data/docs/group.md +19 -0
  73. data/docs/group_user.md +22 -2
  74. data/docs/history.md +85 -0
  75. data/docs/history_export_result.md +17 -0
  76. data/docs/holiday_region.md +9 -0
  77. data/docs/inbound_s3_log.md +21 -1
  78. data/docs/inbox.md +102 -0
  79. data/docs/inbox_recipient.md +19 -0
  80. data/docs/inbox_recipient_registration.md +35 -0
  81. data/docs/inbox_registration.md +57 -0
  82. data/docs/inbox_upload.md +18 -0
  83. data/docs/invoice.md +9 -0
  84. data/docs/ip.md +63 -0
  85. data/docs/ip_abuse_entry.md +47 -0
  86. data/docs/ip_address.md +59 -0
  87. data/docs/key_lifecycle_rule.md +14 -0
  88. data/docs/label.md +9 -0
  89. data/docs/lead.md +161 -0
  90. data/docs/lock.md +15 -0
  91. data/docs/message.md +17 -0
  92. data/docs/message_comment.md +18 -0
  93. data/docs/message_comment_reaction.md +18 -0
  94. data/docs/message_reaction.md +17 -0
  95. data/docs/metadata_category.md +13 -0
  96. data/docs/monitoring_stat.md +38 -0
  97. data/docs/monitoring_stats.md +15 -0
  98. data/docs/mover_package.md +68 -0
  99. data/docs/notification.md +20 -0
  100. data/docs/nps_response.md +75 -0
  101. data/docs/oauth_redirect.md +11 -0
  102. data/docs/outbound_connection_log.md +21 -1
  103. data/docs/paired_api_key.md +19 -0
  104. data/docs/partner.md +14 -0
  105. data/docs/partner_channel.md +14 -0
  106. data/docs/partner_site_request.md +14 -0
  107. data/docs/payment.md +9 -0
  108. data/docs/paypal_express_info.md +31 -0
  109. data/docs/paypal_express_url.md +11 -0
  110. data/docs/pending_work_event.md +18 -0
  111. data/docs/permission.md +22 -0
  112. data/docs/plan.md +107 -0
  113. data/docs/preview.md +57 -0
  114. data/docs/project.md +9 -0
  115. data/docs/public_hosting_request_log.md +21 -1
  116. data/docs/public_hosting_session_pairing.md +15 -0
  117. data/docs/public_inbox.md +121 -0
  118. data/docs/public_key.md +21 -0
  119. data/docs/public_url.md +59 -0
  120. data/docs/regional_migration.md +0 -0
  121. data/docs/release.md +83 -0
  122. data/docs/release_package.md +19 -0
  123. data/docs/remote_bandwidth_snapshot.md +18 -0
  124. data/docs/remote_mount_backend.md +13 -0
  125. data/docs/remote_server.md +233 -0
  126. data/docs/remote_server_credential.md +15 -0
  127. data/docs/request.md +17 -0
  128. data/docs/restore.md +14 -0
  129. data/docs/revision.md +40 -0
  130. data/docs/safe_plan.md +0 -0
  131. data/docs/scheduled_export.md +15 -0
  132. data/docs/scim_log.md +13 -0
  133. data/docs/session.md +232 -1
  134. data/docs/session_available_site.md +26 -0
  135. data/docs/setting.md +33 -0
  136. data/docs/settings.md +498 -0
  137. data/docs/settings_change.md +16 -0
  138. data/docs/sftp_action_log.md +21 -1
  139. data/docs/sftp_host_key.md +9 -0
  140. data/docs/share_group.md +15 -0
  141. data/docs/siem_http_destination.md +9 -0
  142. data/docs/siem_http_destination_event.md +18 -0
  143. data/docs/site.md +179 -0
  144. data/docs/site_subdomain_redirect.md +13 -0
  145. data/docs/snapshot.md +9 -0
  146. data/docs/ssl_certificate.md +37 -0
  147. data/docs/sso_event.md +19 -0
  148. data/docs/sso_strategy.md +406 -0
  149. data/docs/staging_site.md +591 -0
  150. data/docs/support_request.md +126 -0
  151. data/docs/sync.md +14 -0
  152. data/docs/sync_api_usage_snapshot.md +23 -0
  153. data/docs/sync_api_usage_snapshot_report.md +71 -0
  154. data/docs/sync_bandwidth_snapshot.md +48 -0
  155. data/docs/sync_log.md +20 -1
  156. data/docs/sync_run.md +21 -0
  157. data/docs/two_factor_authentication_method.md +169 -0
  158. data/docs/usage_daily_snapshot.md +18 -0
  159. data/docs/usage_snapshot.md +9 -0
  160. data/docs/user.md +49 -2
  161. data/docs/user_cipher_use.md +21 -0
  162. data/docs/user_lifecycle_rule.md +14 -0
  163. data/docs/user_request.md +9 -0
  164. data/docs/user_security_event.md +18 -0
  165. data/docs/user_sftp_client_use.md +15 -0
  166. data/docs/warning.md +36 -0
  167. data/docs/web_dav_action_log.md +21 -1
  168. data/docs/webauthn_sign_request.md +13 -0
  169. data/docs/workspace.md +15 -0
  170. data/docs/zip_download.md +32 -0
  171. data/docs/zip_download_file.md +45 -0
  172. data/docs/zip_download_files.md +23 -0
  173. data/lib/files.com/models/account.rb +346 -0
  174. data/lib/files.com/models/action_log.rb +24 -0
  175. data/lib/files.com/models/action_notification_export_result.rb +12 -0
  176. data/lib/files.com/models/action_webhook_failure.rb +34 -0
  177. data/lib/files.com/models/agent_proxy_identity.rb +47 -0
  178. data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
  179. data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
  180. data/lib/files.com/models/agent_v2_auth.rb +32 -0
  181. data/lib/files.com/models/ai_assistant_personality.rb +11 -0
  182. data/lib/files.com/models/ai_task.rb +11 -0
  183. data/lib/files.com/models/announcement.rb +89 -0
  184. data/lib/files.com/models/api_key.rb +39 -5
  185. data/lib/files.com/models/api_request_log.rb +24 -0
  186. data/lib/files.com/models/app.rb +13 -0
  187. data/lib/files.com/models/as2_incoming_message.rb +19 -0
  188. data/lib/files.com/models/as2_outgoing_message.rb +19 -0
  189. data/lib/files.com/models/as2_partner.rb +11 -0
  190. data/lib/files.com/models/as2_station.rb +11 -0
  191. data/lib/files.com/models/automation.rb +30 -0
  192. data/lib/files.com/models/automation_log.rb +24 -0
  193. data/lib/files.com/models/automation_run.rb +16 -0
  194. data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
  195. data/lib/files.com/models/behavior.rb +11 -0
  196. data/lib/files.com/models/blog_post.rb +84 -0
  197. data/lib/files.com/models/bundle.rb +52 -0
  198. data/lib/files.com/models/bundle_action.rb +25 -0
  199. data/lib/files.com/models/bundle_download.rb +23 -0
  200. data/lib/files.com/models/bundle_notification.rb +15 -0
  201. data/lib/files.com/models/bundle_recipient.rb +27 -0
  202. data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
  203. data/lib/files.com/models/bundle_registration.rb +125 -0
  204. data/lib/files.com/models/certificate.rb +455 -0
  205. data/lib/files.com/models/chat_session.rb +11 -0
  206. data/lib/files.com/models/child_site.rb +1756 -0
  207. data/lib/files.com/models/child_site_management_policy.rb +5 -0
  208. data/lib/files.com/models/clickwrap.rb +9 -0
  209. data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
  210. data/lib/files.com/models/client_log.rb +25 -0
  211. data/lib/files.com/models/crash_report.rb +151 -0
  212. data/lib/files.com/models/custom_domain.rb +9 -0
  213. data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
  214. data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
  215. data/lib/files.com/models/dns_record.rb +5 -0
  216. data/lib/files.com/models/email_incoming_message.rb +21 -0
  217. data/lib/files.com/models/email_log.rb +22 -0
  218. data/lib/files.com/models/email_preference.rb +124 -0
  219. data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
  220. data/lib/files.com/models/email_preference_notification.rb +32 -0
  221. data/lib/files.com/models/event_channel.rb +11 -0
  222. data/lib/files.com/models/event_delivery_attempt.rb +11 -0
  223. data/lib/files.com/models/event_record.rb +21 -0
  224. data/lib/files.com/models/event_subscription.rb +11 -0
  225. data/lib/files.com/models/event_target.rb +11 -0
  226. data/lib/files.com/models/exavault_api_request_log.rb +24 -0
  227. data/lib/files.com/models/expectation.rb +11 -0
  228. data/lib/files.com/models/expectation_evaluation.rb +11 -0
  229. data/lib/files.com/models/expectation_incident.rb +11 -0
  230. data/lib/files.com/models/export.rb +153 -0
  231. data/lib/files.com/models/external_event.rb +19 -0
  232. data/lib/files.com/models/file.rb +207 -0
  233. data/lib/files.com/models/file_migration.rb +27 -0
  234. data/lib/files.com/models/file_migration_log.rb +22 -0
  235. data/lib/files.com/models/file_upload_part.rb +5 -0
  236. data/lib/files.com/models/folder.rb +69 -0
  237. data/lib/files.com/models/form_field_set.rb +9 -0
  238. data/lib/files.com/models/front_end_server.rb +335 -0
  239. data/lib/files.com/models/frontend_metric.rb +65 -0
  240. data/lib/files.com/models/ftp_action_log.rb +24 -0
  241. data/lib/files.com/models/gpg_key.rb +21 -0
  242. data/lib/files.com/models/group.rb +16 -0
  243. data/lib/files.com/models/group_user.rb +21 -1
  244. data/lib/files.com/models/history.rb +94 -0
  245. data/lib/files.com/models/history_export_result.rb +12 -0
  246. data/lib/files.com/models/holiday_region.rb +5 -0
  247. data/lib/files.com/models/inbound_s3_log.rb +24 -0
  248. data/lib/files.com/models/inbox.rb +123 -0
  249. data/lib/files.com/models/inbox_recipient.rb +25 -0
  250. data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
  251. data/lib/files.com/models/inbox_registration.rb +121 -0
  252. data/lib/files.com/models/inbox_upload.rb +19 -0
  253. data/lib/files.com/models/invoice.rb +5 -0
  254. data/lib/files.com/models/ip.rb +82 -0
  255. data/lib/files.com/models/ip_abuse_entry.rb +96 -0
  256. data/lib/files.com/models/ip_address.rb +37 -0
  257. data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
  258. data/lib/files.com/models/label.rb +22 -0
  259. data/lib/files.com/models/lead.rb +434 -0
  260. data/lib/files.com/models/lock.rb +27 -0
  261. data/lib/files.com/models/message.rb +12 -0
  262. data/lib/files.com/models/message_comment.rb +14 -0
  263. data/lib/files.com/models/message_comment_reaction.rb +14 -0
  264. data/lib/files.com/models/message_reaction.rb +12 -0
  265. data/lib/files.com/models/metadata_category.rb +9 -0
  266. data/lib/files.com/models/monitoring_stat.rb +43 -0
  267. data/lib/files.com/models/monitoring_stats.rb +22 -0
  268. data/lib/files.com/models/mover_package.rb +80 -0
  269. data/lib/files.com/models/notification.rb +18 -0
  270. data/lib/files.com/models/nps_response.rb +128 -0
  271. data/lib/files.com/models/oauth_redirect.rb +17 -0
  272. data/lib/files.com/models/outbound_connection_log.rb +24 -0
  273. data/lib/files.com/models/paired_api_key.rb +37 -0
  274. data/lib/files.com/models/partner.rb +11 -0
  275. data/lib/files.com/models/partner_channel.rb +11 -0
  276. data/lib/files.com/models/partner_site_request.rb +11 -0
  277. data/lib/files.com/models/payment.rb +5 -0
  278. data/lib/files.com/models/paypal_express_info.rb +67 -0
  279. data/lib/files.com/models/paypal_express_url.rb +17 -0
  280. data/lib/files.com/models/pending_work_event.rb +19 -0
  281. data/lib/files.com/models/permission.rb +22 -0
  282. data/lib/files.com/models/plan.rb +209 -0
  283. data/lib/files.com/models/preview.rb +57 -0
  284. data/lib/files.com/models/project.rb +5 -0
  285. data/lib/files.com/models/public_hosting_request_log.rb +24 -0
  286. data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
  287. data/lib/files.com/models/public_inbox.rb +142 -0
  288. data/lib/files.com/models/public_key.rb +21 -0
  289. data/lib/files.com/models/public_url.rb +177 -0
  290. data/lib/files.com/models/regional_migration.rb +12 -0
  291. data/lib/files.com/models/release.rb +153 -0
  292. data/lib/files.com/models/release_package.rb +37 -0
  293. data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
  294. data/lib/files.com/models/remote_mount_backend.rb +9 -0
  295. data/lib/files.com/models/remote_server.rb +297 -0
  296. data/lib/files.com/models/remote_server_credential.rb +13 -0
  297. data/lib/files.com/models/request.rb +12 -0
  298. data/lib/files.com/models/restore.rb +11 -0
  299. data/lib/files.com/models/revision.rb +53 -0
  300. data/lib/files.com/models/safe_plan.rb +12 -0
  301. data/lib/files.com/models/scheduled_export.rb +13 -0
  302. data/lib/files.com/models/scim_log.rb +9 -0
  303. data/lib/files.com/models/session.rb +493 -0
  304. data/lib/files.com/models/session_available_site.rb +47 -0
  305. data/lib/files.com/models/setting.rb +36 -0
  306. data/lib/files.com/models/settings.rb +1072 -0
  307. data/lib/files.com/models/settings_change.rb +16 -0
  308. data/lib/files.com/models/sftp_action_log.rb +24 -0
  309. data/lib/files.com/models/sftp_host_key.rb +5 -0
  310. data/lib/files.com/models/share_group.rb +9 -0
  311. data/lib/files.com/models/siem_http_destination.rb +5 -0
  312. data/lib/files.com/models/siem_http_destination_event.rb +19 -0
  313. data/lib/files.com/models/site.rb +1021 -0
  314. data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
  315. data/lib/files.com/models/snapshot.rb +5 -0
  316. data/lib/files.com/models/ssl_certificate.rb +77 -0
  317. data/lib/files.com/models/sso_event.rb +21 -0
  318. data/lib/files.com/models/sso_strategy.rb +632 -0
  319. data/lib/files.com/models/staging_site.rb +1781 -0
  320. data/lib/files.com/models/support_request.rb +209 -0
  321. data/lib/files.com/models/sync.rb +11 -0
  322. data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
  323. data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
  324. data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
  325. data/lib/files.com/models/sync_log.rb +22 -0
  326. data/lib/files.com/models/sync_run.rb +21 -0
  327. data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
  328. data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
  329. data/lib/files.com/models/usage_snapshot.rb +5 -0
  330. data/lib/files.com/models/user.rb +59 -0
  331. data/lib/files.com/models/user_cipher_use.rb +21 -0
  332. data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
  333. data/lib/files.com/models/user_request.rb +5 -0
  334. data/lib/files.com/models/user_security_event.rb +19 -0
  335. data/lib/files.com/models/user_sftp_client_use.rb +9 -0
  336. data/lib/files.com/models/warning.rb +38 -0
  337. data/lib/files.com/models/web_dav_action_log.rb +24 -0
  338. data/lib/files.com/models/webauthn_sign_request.rb +17 -0
  339. data/lib/files.com/models/workspace.rb +13 -0
  340. data/lib/files.com/models/zip_download.rb +73 -0
  341. data/lib/files.com/models/zip_download_file.rb +111 -0
  342. data/lib/files.com/models/zip_download_files.rb +42 -0
  343. data/lib/files.com/version.rb +1 -1
  344. data/lib/files.com.rb +59 -0
  345. metadata +120 -2
@@ -31,6 +31,78 @@ module Files
31
31
  @attributes[:language] = value
32
32
  end
33
33
 
34
+ # string - AWS Secret Key for validating AWS-style signatures in the Inbound S3 endpoint.
35
+ def aws_secret_key
36
+ @attributes[:aws_secret_key]
37
+ end
38
+
39
+ def aws_secret_key=(value)
40
+ @attributes[:aws_secret_key] = value
41
+ end
42
+
43
+ # int64 - AI Assistant Personality ID for the in-app AI Assistant.
44
+ def ai_assistant_personality_id
45
+ @attributes[:ai_assistant_personality_id]
46
+ end
47
+
48
+ def ai_assistant_personality_id=(value)
49
+ @attributes[:ai_assistant_personality_id] = value
50
+ end
51
+
52
+ # string - System prompt for the in-app AI Assistant.
53
+ def ai_assistant_personality_system_prompt
54
+ @attributes[:ai_assistant_personality_system_prompt]
55
+ end
56
+
57
+ def ai_assistant_personality_system_prompt=(value)
58
+ @attributes[:ai_assistant_personality_system_prompt] = value
59
+ end
60
+
61
+ # string - Login token. If set, this token will allow your user to log in via browser at the domain in `login_token_domain`.
62
+ def login_token
63
+ @attributes[:login_token]
64
+ end
65
+
66
+ def login_token=(value)
67
+ @attributes[:login_token] = value
68
+ end
69
+
70
+ # string - Domain to use with `login_token`.
71
+ def login_token_domain
72
+ @attributes[:login_token_domain]
73
+ end
74
+
75
+ def login_token_domain=(value)
76
+ @attributes[:login_token_domain] = value
77
+ end
78
+
79
+ # int64 - Workspace ID the user should land in by default when more than one Workspace is available.
80
+ def default_workspace_id
81
+ @attributes[:default_workspace_id]
82
+ end
83
+
84
+ def default_workspace_id=(value)
85
+ @attributes[:default_workspace_id] = value
86
+ end
87
+
88
+ # int64 - Maximum number of files to retrieve per folder for a directory listing. This is based on the user's plan.
89
+ def max_dir_listing_size
90
+ @attributes[:max_dir_listing_size]
91
+ end
92
+
93
+ def max_dir_listing_size=(value)
94
+ @attributes[:max_dir_listing_size] = value
95
+ end
96
+
97
+ # boolean - Can access multiple regions?
98
+ def multiple_regions
99
+ @attributes[:multiple_regions]
100
+ end
101
+
102
+ def multiple_regions=(value)
103
+ @attributes[:multiple_regions] = value
104
+ end
105
+
34
106
  # boolean - Is this session read only?
35
107
  def read_only
36
108
  @attributes[:read_only]
@@ -40,6 +112,24 @@ module Files
40
112
  @attributes[:read_only] = value
41
113
  end
42
114
 
115
+ # string - Root path to restrict the user's session to.
116
+ def root_path
117
+ @attributes[:root_path]
118
+ end
119
+
120
+ def root_path=(value)
121
+ @attributes[:root_path] = value
122
+ end
123
+
124
+ # string - Initial path to start the user's session in.
125
+ def home_path
126
+ @attributes[:home_path]
127
+ end
128
+
129
+ def home_path=(value)
130
+ @attributes[:home_path] = value
131
+ end
132
+
43
133
  # 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.)
44
134
  def sftp_insecure_ciphers
45
135
  @attributes[:sftp_insecure_ciphers]
@@ -49,6 +139,177 @@ module Files
49
139
  @attributes[:sftp_insecure_ciphers] = value
50
140
  end
51
141
 
142
+ # int64 - Site ID
143
+ def site_id
144
+ @attributes[:site_id]
145
+ end
146
+
147
+ def site_id=(value)
148
+ @attributes[:site_id] = value
149
+ end
150
+
151
+ # boolean - Is SSL required for this user? (If so, ensure all your communications with this user use SSL.)
152
+ def ssl_required
153
+ @attributes[:ssl_required]
154
+ end
155
+
156
+ def ssl_required=(value)
157
+ @attributes[:ssl_required] = value
158
+ end
159
+
160
+ # date-time - Session timeout datetime
161
+ def timeout_at
162
+ @attributes[:timeout_at]
163
+ end
164
+
165
+ def timeout_at=(value)
166
+ @attributes[:timeout_at] = value
167
+ end
168
+
169
+ # boolean - Can this session tolerate IP and User-Agent mismatches?
170
+ def trusted
171
+ @attributes[:trusted]
172
+ end
173
+
174
+ def trusted=(value)
175
+ @attributes[:trusted] = value
176
+ end
177
+
178
+ # boolean - If true, this user needs to add a Two Factor Authentication method before performing any further actions.
179
+ def two_factor_setup_needed
180
+ @attributes[:two_factor_setup_needed]
181
+ end
182
+
183
+ def two_factor_setup_needed=(value)
184
+ @attributes[:two_factor_setup_needed] = value
185
+ end
186
+
187
+ # boolean - Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
188
+ def allowed_2fa_method_sms
189
+ @attributes[:allowed_2fa_method_sms]
190
+ end
191
+
192
+ def allowed_2fa_method_sms=(value)
193
+ @attributes[:allowed_2fa_method_sms] = value
194
+ end
195
+
196
+ # boolean - Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
197
+ def allowed_2fa_method_totp
198
+ @attributes[:allowed_2fa_method_totp]
199
+ end
200
+
201
+ def allowed_2fa_method_totp=(value)
202
+ @attributes[:allowed_2fa_method_totp] = value
203
+ end
204
+
205
+ # boolean - Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
206
+ def allowed_2fa_method_webauthn
207
+ @attributes[:allowed_2fa_method_webauthn]
208
+ end
209
+
210
+ def allowed_2fa_method_webauthn=(value)
211
+ @attributes[:allowed_2fa_method_webauthn] = value
212
+ end
213
+
214
+ # boolean - Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
215
+ def allowed_2fa_method_yubi
216
+ @attributes[:allowed_2fa_method_yubi]
217
+ end
218
+
219
+ def allowed_2fa_method_yubi=(value)
220
+ @attributes[:allowed_2fa_method_yubi] = value
221
+ end
222
+
223
+ # boolean - Calculate CRC32 checksum for incoming files?
224
+ def calculate_file_checksums_crc32
225
+ @attributes[:calculate_file_checksums_crc32]
226
+ end
227
+
228
+ def calculate_file_checksums_crc32=(value)
229
+ @attributes[:calculate_file_checksums_crc32] = value
230
+ end
231
+
232
+ # boolean - Calculate MD5 checksum for incoming files?
233
+ def calculate_file_checksums_md5
234
+ @attributes[:calculate_file_checksums_md5]
235
+ end
236
+
237
+ def calculate_file_checksums_md5=(value)
238
+ @attributes[:calculate_file_checksums_md5] = value
239
+ end
240
+
241
+ # boolean - Calculate SHA1 checksum for incoming files?
242
+ def calculate_file_checksums_sha1
243
+ @attributes[:calculate_file_checksums_sha1]
244
+ end
245
+
246
+ def calculate_file_checksums_sha1=(value)
247
+ @attributes[:calculate_file_checksums_sha1] = value
248
+ end
249
+
250
+ # boolean - Calculate SHA256 checksum for incoming files?
251
+ def calculate_file_checksums_sha256
252
+ @attributes[:calculate_file_checksums_sha256]
253
+ end
254
+
255
+ def calculate_file_checksums_sha256=(value)
256
+ @attributes[:calculate_file_checksums_sha256] = value
257
+ end
258
+
259
+ # boolean - Use legacy checksums mode?
260
+ def legacy_checksums_mode
261
+ @attributes[:legacy_checksums_mode]
262
+ end
263
+
264
+ def legacy_checksums_mode=(value)
265
+ @attributes[:legacy_checksums_mode] = value
266
+ end
267
+
268
+ # boolean - Finalize partial SFTP uploads?
269
+ def finalize_partial_uploads
270
+ @attributes[:finalize_partial_uploads]
271
+ end
272
+
273
+ def finalize_partial_uploads=(value)
274
+ @attributes[:finalize_partial_uploads] = value
275
+ end
276
+
277
+ # boolean - Allow the user to provide file/folder modified at dates? If false, the server will always use the current date/time.
278
+ def use_provided_modified_at
279
+ @attributes[:use_provided_modified_at]
280
+ end
281
+
282
+ def use_provided_modified_at=(value)
283
+ @attributes[:use_provided_modified_at] = value
284
+ end
285
+
286
+ # boolean - Does this user want to use Windows line-ending emulation? (CR vs CRLF)
287
+ def windows_mode_ftp
288
+ @attributes[:windows_mode_ftp]
289
+ end
290
+
291
+ def windows_mode_ftp=(value)
292
+ @attributes[:windows_mode_ftp] = value
293
+ end
294
+
295
+ # boolean
296
+ def user_belongs_to_parent_site
297
+ @attributes[:user_belongs_to_parent_site]
298
+ end
299
+
300
+ def user_belongs_to_parent_site=(value)
301
+ @attributes[:user_belongs_to_parent_site] = value
302
+ end
303
+
304
+ # int64 - User ID of the Site Admin who initiated a Read-Only session impersonating this session's user
305
+ def impersonator_user_id
306
+ @attributes[:impersonator_user_id]
307
+ end
308
+
309
+ def impersonator_user_id=(value)
310
+ @attributes[:impersonator_user_id] = value
311
+ end
312
+
52
313
  # string - Username to sign in as
53
314
  def username
54
315
  @attributes[:username]
@@ -67,6 +328,105 @@ module Files
67
328
  @attributes[:password] = value
68
329
  end
69
330
 
331
+ # string - AWS Access Key ID for signing in with AWS credentials
332
+ def aws_access_key_id
333
+ @attributes[:aws_access_key_id]
334
+ end
335
+
336
+ def aws_access_key_id=(value)
337
+ @attributes[:aws_access_key_id] = value
338
+ end
339
+
340
+ # string
341
+ def change_password
342
+ @attributes[:change_password]
343
+ end
344
+
345
+ def change_password=(value)
346
+ @attributes[:change_password] = value
347
+ end
348
+
349
+ # string
350
+ def change_password_confirmation
351
+ @attributes[:change_password_confirmation]
352
+ end
353
+
354
+ def change_password_confirmation=(value)
355
+ @attributes[:change_password_confirmation] = value
356
+ end
357
+
358
+ # string
359
+ def interface
360
+ @attributes[:interface]
361
+ end
362
+
363
+ def interface=(value)
364
+ @attributes[:interface] = value
365
+ end
366
+
367
+ # string
368
+ def ssh_client_identification
369
+ @attributes[:ssh_client_identification]
370
+ end
371
+
372
+ def ssh_client_identification=(value)
373
+ @attributes[:ssh_client_identification] = value
374
+ end
375
+
376
+ # string
377
+ def locale
378
+ @attributes[:locale]
379
+ end
380
+
381
+ def locale=(value)
382
+ @attributes[:locale] = value
383
+ end
384
+
385
+ # boolean
386
+ def no_cookie
387
+ @attributes[:no_cookie]
388
+ end
389
+
390
+ def no_cookie=(value)
391
+ @attributes[:no_cookie] = value
392
+ end
393
+
394
+ # string
395
+ def oauth_provider
396
+ @attributes[:oauth_provider]
397
+ end
398
+
399
+ def oauth_provider=(value)
400
+ @attributes[:oauth_provider] = value
401
+ end
402
+
403
+ # string
404
+ def oauth_label
405
+ @attributes[:oauth_label]
406
+ end
407
+
408
+ def oauth_label=(value)
409
+ @attributes[:oauth_label] = value
410
+ end
411
+
412
+ # string
413
+ def oauth_code
414
+ @attributes[:oauth_code]
415
+ end
416
+
417
+ def oauth_code=(value)
418
+ @attributes[:oauth_code] = value
419
+ end
420
+
421
+ # string
422
+ def oauth_state
423
+ @attributes[:oauth_state]
424
+ end
425
+
426
+ def oauth_state=(value)
427
+ @attributes[:oauth_state] = value
428
+ end
429
+
70
430
  # string - If this user has a 2FA device, provide its OTP or code here.
71
431
  def otp
72
432
  @attributes[:otp]
@@ -99,11 +459,32 @@ module Files
99
459
  # Parameters:
100
460
  # username - string - Username to sign in as
101
461
  # password - string - Password for sign in
462
+ # aws_access_key_id - string - AWS Access Key ID for signing in with AWS credentials
463
+ # change_password - string
464
+ # change_password_confirmation - string
465
+ # interface - string
466
+ # ssh_client_identification - string
467
+ # locale - string
468
+ # no_cookie - boolean
469
+ # oauth_provider - string
470
+ # oauth_label - string
471
+ # oauth_code - string
472
+ # oauth_state - string
102
473
  # otp - string - If this user has a 2FA device, provide its OTP or code here.
103
474
  # partial_session_id - string - Identifier for a partially-completed login
104
475
  def self.create(params = {}, options = {})
105
476
  raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
106
477
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
478
+ raise InvalidParameterError.new("Bad parameter: aws_access_key_id must be an String") if params[:aws_access_key_id] and !params[:aws_access_key_id].is_a?(String)
479
+ raise InvalidParameterError.new("Bad parameter: change_password must be an String") if params[:change_password] and !params[:change_password].is_a?(String)
480
+ raise InvalidParameterError.new("Bad parameter: change_password_confirmation must be an String") if params[:change_password_confirmation] and !params[:change_password_confirmation].is_a?(String)
481
+ raise InvalidParameterError.new("Bad parameter: interface must be an String") if params[:interface] and !params[:interface].is_a?(String)
482
+ raise InvalidParameterError.new("Bad parameter: ssh_client_identification must be an String") if params[:ssh_client_identification] and !params[:ssh_client_identification].is_a?(String)
483
+ raise InvalidParameterError.new("Bad parameter: locale must be an String") if params[:locale] and !params[:locale].is_a?(String)
484
+ raise InvalidParameterError.new("Bad parameter: oauth_provider must be an String") if params[:oauth_provider] and !params[:oauth_provider].is_a?(String)
485
+ raise InvalidParameterError.new("Bad parameter: oauth_label must be an String") if params[:oauth_label] and !params[:oauth_label].is_a?(String)
486
+ raise InvalidParameterError.new("Bad parameter: oauth_code must be an String") if params[:oauth_code] and !params[:oauth_code].is_a?(String)
487
+ raise InvalidParameterError.new("Bad parameter: oauth_state must be an String") if params[:oauth_state] and !params[:oauth_state].is_a?(String)
107
488
  raise InvalidParameterError.new("Bad parameter: otp must be an String") if params[:otp] and !params[:otp].is_a?(String)
108
489
  raise InvalidParameterError.new("Bad parameter: partial_session_id must be an String") if params[:partial_session_id] and !params[:partial_session_id].is_a?(String)
109
490
 
@@ -111,6 +492,118 @@ module Files
111
492
  Session.new(response.data, options)
112
493
  end
113
494
 
495
+ # Parameters:
496
+ # subdomain (required) - string - Site subdomain to login to
497
+ def self.subdomain(params = {}, options = {})
498
+ raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
499
+ raise MissingParameterError.new("Parameter missing: subdomain") unless params[:subdomain]
500
+
501
+ response, options = Api.send_request("/sessions/subdomain", :post, params, options)
502
+ Session.new(response.data, options)
503
+ end
504
+
505
+ # Parameters:
506
+ # user_id (required) - string - User id to login as
507
+ def self.as_user(params = {}, options = {})
508
+ raise InvalidParameterError.new("Bad parameter: user_id must be an String") if params[:user_id] and !params[:user_id].is_a?(String)
509
+ raise MissingParameterError.new("Parameter missing: user_id") unless params[:user_id]
510
+
511
+ response, options = Api.send_request("/sessions/as_user", :post, params, options)
512
+ Session.new(response.data, options)
513
+ end
514
+
515
+ # Parameters:
516
+ # session_id (required) - string - Session ID to convert to a trusted session
517
+ def self.trusted(params = {}, options = {})
518
+ raise InvalidParameterError.new("Bad parameter: session_id must be an String") if params[:session_id] and !params[:session_id].is_a?(String)
519
+ raise MissingParameterError.new("Parameter missing: session_id") unless params[:session_id]
520
+
521
+ response, options = Api.send_request("/sessions/trusted", :post, params, options)
522
+ Session.new(response.data, options)
523
+ end
524
+
525
+ # Parameters:
526
+ # code (required) - string
527
+ # password (required) - string
528
+ # confirm_password - string
529
+ # interface - string
530
+ # locale - string
531
+ # otp - string
532
+ def self.forgot_reset(params = {}, options = {})
533
+ raise InvalidParameterError.new("Bad parameter: code must be an String") if params[:code] and !params[:code].is_a?(String)
534
+ raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
535
+ raise InvalidParameterError.new("Bad parameter: confirm_password must be an String") if params[:confirm_password] and !params[:confirm_password].is_a?(String)
536
+ raise InvalidParameterError.new("Bad parameter: interface must be an String") if params[:interface] and !params[:interface].is_a?(String)
537
+ raise InvalidParameterError.new("Bad parameter: locale must be an String") if params[:locale] and !params[:locale].is_a?(String)
538
+ raise InvalidParameterError.new("Bad parameter: otp must be an String") if params[:otp] and !params[:otp].is_a?(String)
539
+ raise MissingParameterError.new("Parameter missing: code") unless params[:code]
540
+ raise MissingParameterError.new("Parameter missing: password") unless params[:password]
541
+
542
+ Api.send_request("/sessions/forgot/reset", :post, params, options)
543
+ nil
544
+ end
545
+
546
+ # Parameters:
547
+ # code (required) - string
548
+ def self.forgot_validate(params = {}, options = {})
549
+ raise InvalidParameterError.new("Bad parameter: code must be an String") if params[:code] and !params[:code].is_a?(String)
550
+ raise MissingParameterError.new("Parameter missing: code") unless params[:code]
551
+
552
+ Api.send_request("/sessions/forgot/validate", :post, params, options)
553
+ nil
554
+ end
555
+
556
+ # Parameters:
557
+ # email - string
558
+ # username - string
559
+ # username_or_email - string
560
+ def self.forgot(params = {}, options = {})
561
+ raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
562
+ raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
563
+ raise InvalidParameterError.new("Bad parameter: username_or_email must be an String") if params[:username_or_email] and !params[:username_or_email].is_a?(String)
564
+
565
+ Api.send_request("/sessions/forgot", :post, params, options)
566
+ nil
567
+ end
568
+
569
+ # Parameters:
570
+ # return_to (required) - string - Public Hosting URL to return to after authentication
571
+ def self.public_hosting(params = {}, options = {})
572
+ raise InvalidParameterError.new("Bad parameter: return_to must be an String") if params[:return_to] and !params[:return_to].is_a?(String)
573
+ raise MissingParameterError.new("Parameter missing: return_to") unless params[:return_to]
574
+
575
+ response, options = Api.send_request("/sessions/public_hosting", :post, params, options)
576
+ PublicHostingSessionPairing.new(response.data, options)
577
+ end
578
+
579
+ # Parameters:
580
+ # key (required) - string - The pairing key to reserve for login. Cannot be reused
581
+ def self.pairing_key(key, params = {}, options = {})
582
+ params ||= {}
583
+ params[:key] = key
584
+ raise InvalidParameterError.new("Bad parameter: key must be an String") if params[:key] and !params[:key].is_a?(String)
585
+ raise MissingParameterError.new("Parameter missing: key") unless params[:key]
586
+
587
+ response, options = Api.send_request("/sessions/pairing_key/#{params[:key]}", :post, params, options)
588
+ PairedApiKey.new(response.data, options)
589
+ end
590
+
591
+ # Parameters:
592
+ # provider (required) - string
593
+ # label - string
594
+ # state - string
595
+ # host - string
596
+ def self.oauth(params = {}, options = {})
597
+ raise InvalidParameterError.new("Bad parameter: provider must be an String") if params[:provider] and !params[:provider].is_a?(String)
598
+ raise InvalidParameterError.new("Bad parameter: label must be an String") if params[:label] and !params[:label].is_a?(String)
599
+ raise InvalidParameterError.new("Bad parameter: state must be an String") if params[:state] and !params[:state].is_a?(String)
600
+ raise InvalidParameterError.new("Bad parameter: host must be an String") if params[:host] and !params[:host].is_a?(String)
601
+ raise MissingParameterError.new("Parameter missing: provider") unless params[:provider]
602
+
603
+ response, options = Api.send_request("/sessions/oauth", :post, params, options)
604
+ OauthRedirect.new(response.data, options)
605
+ end
606
+
114
607
  def self.delete(params = {}, options = {})
115
608
  Api.send_request("/sessions", :delete, params, options)
116
609
  nil
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class SessionAvailableSite
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - Site Id
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # string - Site name
18
+ def name
19
+ @attributes[:name]
20
+ end
21
+
22
+ # string - Custom domain
23
+ def domain
24
+ @attributes[:domain]
25
+ end
26
+
27
+ # string - Site subdomain
28
+ def subdomain
29
+ @attributes[:subdomain]
30
+ end
31
+
32
+ # Image - Branded logo
33
+ def logo
34
+ @attributes[:logo]
35
+ end
36
+
37
+ # string - Top bar background color
38
+ def color2_top
39
+ @attributes[:color2_top]
40
+ end
41
+
42
+ # boolean - If true, permissions for this site must be bound to a group (not a user).
43
+ def folder_permissions_groups_only
44
+ @attributes[:folder_permissions_groups_only]
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class Setting
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ def self.languages(params = {}, options = {})
13
+ Api.send_request("/settings/languages", :get, params, options)
14
+ nil
15
+ end
16
+
17
+ def self.list(params = {}, options = {})
18
+ response, options = Api.send_request("/settings", :get, params, options)
19
+ Settings.new(response.data, options)
20
+ end
21
+
22
+ def self.all(params = {}, options = {})
23
+ list(params, options)
24
+ end
25
+
26
+ # Parameters:
27
+ # domain (required) - string
28
+ def self.get_domain(params = {}, options = {})
29
+ raise InvalidParameterError.new("Bad parameter: domain must be an String") if params[:domain] and !params[:domain].is_a?(String)
30
+ raise MissingParameterError.new("Parameter missing: domain") unless params[:domain]
31
+
32
+ response, options = Api.send_request("/settings/domain", :get, params, options)
33
+ Settings.new(response.data, options)
34
+ end
35
+ end
36
+ end