files.com 1.1.669 → 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 (347) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  3. data/_VERSION +1 -1
  4. data/docs/account.md +155 -0
  5. data/docs/action_log.md +21 -1
  6. data/docs/action_notification_export_result.md +17 -0
  7. data/docs/action_webhook_failure.md +28 -0
  8. data/docs/agent_proxy_identity.md +49 -0
  9. data/docs/agent_proxy_identity_endpoint.md +11 -0
  10. data/docs/agent_proxy_identity_result.md +24 -0
  11. data/docs/agent_v2_auth.md +17 -0
  12. data/docs/ai_assistant_personality.md +14 -0
  13. data/docs/ai_task.md +14 -0
  14. data/docs/announcement.md +57 -0
  15. data/docs/api_key.md +27 -1
  16. data/docs/api_request_log.md +21 -1
  17. data/docs/app.md +15 -0
  18. data/docs/as2_incoming_message.md +18 -0
  19. data/docs/as2_outgoing_message.md +18 -0
  20. data/docs/as2_partner.md +14 -0
  21. data/docs/as2_station.md +14 -0
  22. data/docs/automation.md +22 -1
  23. data/docs/automation_log.md +21 -1
  24. data/docs/automation_run.md +19 -0
  25. data/docs/bandwidth_snapshot.md +18 -0
  26. data/docs/behavior.md +14 -0
  27. data/docs/blog_post.md +57 -0
  28. data/docs/bundle.md +50 -1
  29. data/docs/bundle_action.md +25 -0
  30. data/docs/bundle_download.md +23 -0
  31. data/docs/bundle_notification.md +19 -0
  32. data/docs/bundle_recipient.md +21 -0
  33. data/docs/bundle_recipient_registration.md +39 -0
  34. data/docs/bundle_registration.md +61 -0
  35. data/docs/certificate.md +258 -0
  36. data/docs/chat_session.md +14 -0
  37. data/docs/child_site.md +583 -0
  38. data/docs/child_site_management_policy.md +9 -0
  39. data/docs/clickwrap.md +13 -0
  40. data/docs/clickwrap_acceptance.md +30 -0
  41. data/docs/client_log.md +17 -0
  42. data/docs/crash_report.md +50 -0
  43. data/docs/custom_domain.md +13 -0
  44. data/docs/custom_domain_for_proxy.md +23 -0
  45. data/docs/desktop_configuration_profile.md +14 -0
  46. data/docs/dns_record.md +9 -0
  47. data/docs/email_incoming_message.md +19 -0
  48. data/docs/email_log.md +20 -1
  49. data/docs/email_preference.md +108 -0
  50. data/docs/email_preference_bundle_notification.md +15 -0
  51. data/docs/email_preference_notification.md +17 -0
  52. data/docs/event_channel.md +14 -0
  53. data/docs/event_delivery_attempt.md +14 -0
  54. data/docs/event_record.md +19 -0
  55. data/docs/event_subscription.md +14 -0
  56. data/docs/event_target.md +14 -0
  57. data/docs/exavault_api_request_log.md +21 -1
  58. data/docs/expectation.md +14 -0
  59. data/docs/expectation_evaluation.md +14 -0
  60. data/docs/expectation_incident.md +14 -0
  61. data/docs/export.md +90 -0
  62. data/docs/external_event.md +18 -0
  63. data/docs/file.md +90 -2
  64. data/docs/file_migration.md +32 -0
  65. data/docs/file_migration_log.md +20 -1
  66. data/docs/file_upload_part.md +3 -1
  67. data/docs/folder.md +20 -0
  68. data/docs/form_field_set.md +15 -0
  69. data/docs/front_end_server.md +111 -0
  70. data/docs/frontend_metric.md +34 -0
  71. data/docs/ftp_action_log.md +21 -1
  72. data/docs/gpg_key.md +21 -0
  73. data/docs/group.md +19 -0
  74. data/docs/group_user.md +22 -2
  75. data/docs/history.md +85 -0
  76. data/docs/history_export_result.md +17 -0
  77. data/docs/holiday_region.md +9 -0
  78. data/docs/inbound_s3_log.md +21 -1
  79. data/docs/inbox.md +102 -0
  80. data/docs/inbox_recipient.md +19 -0
  81. data/docs/inbox_recipient_registration.md +35 -0
  82. data/docs/inbox_registration.md +57 -0
  83. data/docs/inbox_upload.md +18 -0
  84. data/docs/invoice.md +9 -0
  85. data/docs/ip.md +63 -0
  86. data/docs/ip_abuse_entry.md +47 -0
  87. data/docs/ip_address.md +59 -0
  88. data/docs/key_lifecycle_rule.md +14 -0
  89. data/docs/label.md +9 -0
  90. data/docs/lead.md +161 -0
  91. data/docs/lock.md +15 -0
  92. data/docs/message.md +17 -0
  93. data/docs/message_comment.md +18 -0
  94. data/docs/message_comment_reaction.md +18 -0
  95. data/docs/message_reaction.md +17 -0
  96. data/docs/metadata_category.md +13 -0
  97. data/docs/monitoring_stat.md +38 -0
  98. data/docs/monitoring_stats.md +15 -0
  99. data/docs/mover_package.md +68 -0
  100. data/docs/notification.md +20 -0
  101. data/docs/nps_response.md +75 -0
  102. data/docs/oauth_redirect.md +11 -0
  103. data/docs/outbound_connection_log.md +21 -1
  104. data/docs/paired_api_key.md +19 -0
  105. data/docs/partner.md +14 -0
  106. data/docs/partner_channel.md +14 -0
  107. data/docs/partner_site_request.md +14 -0
  108. data/docs/payment.md +9 -0
  109. data/docs/paypal_express_info.md +31 -0
  110. data/docs/paypal_express_url.md +11 -0
  111. data/docs/pending_work_event.md +18 -0
  112. data/docs/permission.md +22 -0
  113. data/docs/plan.md +107 -0
  114. data/docs/preview.md +57 -0
  115. data/docs/project.md +9 -0
  116. data/docs/public_hosting_request_log.md +21 -1
  117. data/docs/public_hosting_session_pairing.md +15 -0
  118. data/docs/public_inbox.md +121 -0
  119. data/docs/public_key.md +21 -0
  120. data/docs/public_url.md +59 -0
  121. data/docs/regional_migration.md +0 -0
  122. data/docs/release.md +83 -0
  123. data/docs/release_package.md +19 -0
  124. data/docs/remote_bandwidth_snapshot.md +18 -0
  125. data/docs/remote_mount_backend.md +13 -0
  126. data/docs/remote_server.md +233 -0
  127. data/docs/remote_server_credential.md +15 -0
  128. data/docs/request.md +17 -0
  129. data/docs/restore.md +14 -0
  130. data/docs/revision.md +40 -0
  131. data/docs/safe_plan.md +0 -0
  132. data/docs/scheduled_export.md +15 -0
  133. data/docs/scim_log.md +13 -0
  134. data/docs/session.md +232 -1
  135. data/docs/session_available_site.md +26 -0
  136. data/docs/setting.md +33 -0
  137. data/docs/settings.md +498 -0
  138. data/docs/settings_change.md +16 -0
  139. data/docs/sftp_action_log.md +21 -1
  140. data/docs/sftp_host_key.md +9 -0
  141. data/docs/share_group.md +15 -0
  142. data/docs/siem_http_destination.md +9 -0
  143. data/docs/siem_http_destination_event.md +18 -0
  144. data/docs/site.md +179 -0
  145. data/docs/site_subdomain_redirect.md +13 -0
  146. data/docs/snapshot.md +9 -0
  147. data/docs/ssl_certificate.md +37 -0
  148. data/docs/sso_event.md +19 -0
  149. data/docs/sso_strategy.md +406 -0
  150. data/docs/staging_site.md +591 -0
  151. data/docs/support_request.md +126 -0
  152. data/docs/sync.md +14 -0
  153. data/docs/sync_api_usage_snapshot.md +23 -0
  154. data/docs/sync_api_usage_snapshot_report.md +71 -0
  155. data/docs/sync_bandwidth_snapshot.md +48 -0
  156. data/docs/sync_log.md +20 -1
  157. data/docs/sync_run.md +21 -0
  158. data/docs/two_factor_authentication_method.md +169 -0
  159. data/docs/usage_daily_snapshot.md +18 -0
  160. data/docs/usage_snapshot.md +9 -0
  161. data/docs/user.md +49 -2
  162. data/docs/user_cipher_use.md +21 -0
  163. data/docs/user_lifecycle_rule.md +14 -0
  164. data/docs/user_request.md +9 -0
  165. data/docs/user_security_event.md +18 -0
  166. data/docs/user_sftp_client_use.md +15 -0
  167. data/docs/warning.md +36 -0
  168. data/docs/web_dav_action_log.md +21 -1
  169. data/docs/webauthn_sign_request.md +13 -0
  170. data/docs/workspace.md +15 -0
  171. data/docs/zip_download.md +32 -0
  172. data/docs/zip_download_file.md +45 -0
  173. data/docs/zip_download_files.md +23 -0
  174. data/lib/files.com/errors.rb +1 -0
  175. data/lib/files.com/models/account.rb +346 -0
  176. data/lib/files.com/models/action_log.rb +24 -0
  177. data/lib/files.com/models/action_notification_export_result.rb +12 -0
  178. data/lib/files.com/models/action_webhook_failure.rb +34 -0
  179. data/lib/files.com/models/agent_proxy_identity.rb +47 -0
  180. data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
  181. data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
  182. data/lib/files.com/models/agent_v2_auth.rb +32 -0
  183. data/lib/files.com/models/ai_assistant_personality.rb +11 -0
  184. data/lib/files.com/models/ai_task.rb +11 -0
  185. data/lib/files.com/models/announcement.rb +89 -0
  186. data/lib/files.com/models/api_key.rb +39 -5
  187. data/lib/files.com/models/api_request_log.rb +24 -0
  188. data/lib/files.com/models/app.rb +13 -0
  189. data/lib/files.com/models/as2_incoming_message.rb +19 -0
  190. data/lib/files.com/models/as2_outgoing_message.rb +19 -0
  191. data/lib/files.com/models/as2_partner.rb +11 -0
  192. data/lib/files.com/models/as2_station.rb +11 -0
  193. data/lib/files.com/models/automation.rb +30 -0
  194. data/lib/files.com/models/automation_log.rb +24 -0
  195. data/lib/files.com/models/automation_run.rb +16 -0
  196. data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
  197. data/lib/files.com/models/behavior.rb +11 -0
  198. data/lib/files.com/models/blog_post.rb +84 -0
  199. data/lib/files.com/models/bundle.rb +52 -0
  200. data/lib/files.com/models/bundle_action.rb +25 -0
  201. data/lib/files.com/models/bundle_download.rb +23 -0
  202. data/lib/files.com/models/bundle_notification.rb +15 -0
  203. data/lib/files.com/models/bundle_recipient.rb +27 -0
  204. data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
  205. data/lib/files.com/models/bundle_registration.rb +125 -0
  206. data/lib/files.com/models/certificate.rb +455 -0
  207. data/lib/files.com/models/chat_session.rb +11 -0
  208. data/lib/files.com/models/child_site.rb +1756 -0
  209. data/lib/files.com/models/child_site_management_policy.rb +5 -0
  210. data/lib/files.com/models/clickwrap.rb +9 -0
  211. data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
  212. data/lib/files.com/models/client_log.rb +25 -0
  213. data/lib/files.com/models/crash_report.rb +151 -0
  214. data/lib/files.com/models/custom_domain.rb +9 -0
  215. data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
  216. data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
  217. data/lib/files.com/models/dns_record.rb +5 -0
  218. data/lib/files.com/models/email_incoming_message.rb +21 -0
  219. data/lib/files.com/models/email_log.rb +22 -0
  220. data/lib/files.com/models/email_preference.rb +124 -0
  221. data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
  222. data/lib/files.com/models/email_preference_notification.rb +32 -0
  223. data/lib/files.com/models/event_channel.rb +11 -0
  224. data/lib/files.com/models/event_delivery_attempt.rb +11 -0
  225. data/lib/files.com/models/event_record.rb +21 -0
  226. data/lib/files.com/models/event_subscription.rb +11 -0
  227. data/lib/files.com/models/event_target.rb +11 -0
  228. data/lib/files.com/models/exavault_api_request_log.rb +24 -0
  229. data/lib/files.com/models/expectation.rb +11 -0
  230. data/lib/files.com/models/expectation_evaluation.rb +11 -0
  231. data/lib/files.com/models/expectation_incident.rb +11 -0
  232. data/lib/files.com/models/export.rb +153 -0
  233. data/lib/files.com/models/external_event.rb +19 -0
  234. data/lib/files.com/models/file.rb +207 -0
  235. data/lib/files.com/models/file_migration.rb +27 -0
  236. data/lib/files.com/models/file_migration_log.rb +22 -0
  237. data/lib/files.com/models/file_upload_part.rb +5 -0
  238. data/lib/files.com/models/folder.rb +69 -0
  239. data/lib/files.com/models/form_field_set.rb +9 -0
  240. data/lib/files.com/models/front_end_server.rb +335 -0
  241. data/lib/files.com/models/frontend_metric.rb +65 -0
  242. data/lib/files.com/models/ftp_action_log.rb +24 -0
  243. data/lib/files.com/models/gpg_key.rb +21 -0
  244. data/lib/files.com/models/group.rb +16 -0
  245. data/lib/files.com/models/group_user.rb +21 -1
  246. data/lib/files.com/models/history.rb +94 -0
  247. data/lib/files.com/models/history_export_result.rb +12 -0
  248. data/lib/files.com/models/holiday_region.rb +5 -0
  249. data/lib/files.com/models/inbound_s3_log.rb +24 -0
  250. data/lib/files.com/models/inbox.rb +123 -0
  251. data/lib/files.com/models/inbox_recipient.rb +25 -0
  252. data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
  253. data/lib/files.com/models/inbox_registration.rb +121 -0
  254. data/lib/files.com/models/inbox_upload.rb +19 -0
  255. data/lib/files.com/models/invoice.rb +5 -0
  256. data/lib/files.com/models/ip.rb +82 -0
  257. data/lib/files.com/models/ip_abuse_entry.rb +96 -0
  258. data/lib/files.com/models/ip_address.rb +37 -0
  259. data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
  260. data/lib/files.com/models/label.rb +22 -0
  261. data/lib/files.com/models/lead.rb +434 -0
  262. data/lib/files.com/models/lock.rb +27 -0
  263. data/lib/files.com/models/message.rb +12 -0
  264. data/lib/files.com/models/message_comment.rb +14 -0
  265. data/lib/files.com/models/message_comment_reaction.rb +14 -0
  266. data/lib/files.com/models/message_reaction.rb +12 -0
  267. data/lib/files.com/models/metadata_category.rb +9 -0
  268. data/lib/files.com/models/monitoring_stat.rb +43 -0
  269. data/lib/files.com/models/monitoring_stats.rb +22 -0
  270. data/lib/files.com/models/mover_package.rb +80 -0
  271. data/lib/files.com/models/notification.rb +18 -0
  272. data/lib/files.com/models/nps_response.rb +128 -0
  273. data/lib/files.com/models/oauth_redirect.rb +17 -0
  274. data/lib/files.com/models/outbound_connection_log.rb +24 -0
  275. data/lib/files.com/models/paired_api_key.rb +37 -0
  276. data/lib/files.com/models/partner.rb +11 -0
  277. data/lib/files.com/models/partner_channel.rb +11 -0
  278. data/lib/files.com/models/partner_site_request.rb +11 -0
  279. data/lib/files.com/models/payment.rb +5 -0
  280. data/lib/files.com/models/paypal_express_info.rb +67 -0
  281. data/lib/files.com/models/paypal_express_url.rb +17 -0
  282. data/lib/files.com/models/pending_work_event.rb +19 -0
  283. data/lib/files.com/models/permission.rb +22 -0
  284. data/lib/files.com/models/plan.rb +209 -0
  285. data/lib/files.com/models/preview.rb +57 -0
  286. data/lib/files.com/models/project.rb +5 -0
  287. data/lib/files.com/models/public_hosting_request_log.rb +24 -0
  288. data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
  289. data/lib/files.com/models/public_inbox.rb +142 -0
  290. data/lib/files.com/models/public_key.rb +21 -0
  291. data/lib/files.com/models/public_url.rb +177 -0
  292. data/lib/files.com/models/regional_migration.rb +12 -0
  293. data/lib/files.com/models/release.rb +153 -0
  294. data/lib/files.com/models/release_package.rb +37 -0
  295. data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
  296. data/lib/files.com/models/remote_mount_backend.rb +9 -0
  297. data/lib/files.com/models/remote_server.rb +297 -0
  298. data/lib/files.com/models/remote_server_credential.rb +13 -0
  299. data/lib/files.com/models/request.rb +12 -0
  300. data/lib/files.com/models/restore.rb +11 -0
  301. data/lib/files.com/models/revision.rb +53 -0
  302. data/lib/files.com/models/safe_plan.rb +12 -0
  303. data/lib/files.com/models/scheduled_export.rb +13 -0
  304. data/lib/files.com/models/scim_log.rb +9 -0
  305. data/lib/files.com/models/session.rb +493 -0
  306. data/lib/files.com/models/session_available_site.rb +47 -0
  307. data/lib/files.com/models/setting.rb +36 -0
  308. data/lib/files.com/models/settings.rb +1072 -0
  309. data/lib/files.com/models/settings_change.rb +16 -0
  310. data/lib/files.com/models/sftp_action_log.rb +24 -0
  311. data/lib/files.com/models/sftp_host_key.rb +5 -0
  312. data/lib/files.com/models/share_group.rb +9 -0
  313. data/lib/files.com/models/siem_http_destination.rb +5 -0
  314. data/lib/files.com/models/siem_http_destination_event.rb +19 -0
  315. data/lib/files.com/models/site.rb +1021 -0
  316. data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
  317. data/lib/files.com/models/snapshot.rb +5 -0
  318. data/lib/files.com/models/ssl_certificate.rb +77 -0
  319. data/lib/files.com/models/sso_event.rb +21 -0
  320. data/lib/files.com/models/sso_strategy.rb +632 -0
  321. data/lib/files.com/models/staging_site.rb +1781 -0
  322. data/lib/files.com/models/support_request.rb +209 -0
  323. data/lib/files.com/models/sync.rb +11 -0
  324. data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
  325. data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
  326. data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
  327. data/lib/files.com/models/sync_log.rb +22 -0
  328. data/lib/files.com/models/sync_run.rb +21 -0
  329. data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
  330. data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
  331. data/lib/files.com/models/usage_snapshot.rb +5 -0
  332. data/lib/files.com/models/user.rb +59 -0
  333. data/lib/files.com/models/user_cipher_use.rb +21 -0
  334. data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
  335. data/lib/files.com/models/user_request.rb +5 -0
  336. data/lib/files.com/models/user_security_event.rb +19 -0
  337. data/lib/files.com/models/user_sftp_client_use.rb +9 -0
  338. data/lib/files.com/models/warning.rb +38 -0
  339. data/lib/files.com/models/web_dav_action_log.rb +24 -0
  340. data/lib/files.com/models/webauthn_sign_request.rb +17 -0
  341. data/lib/files.com/models/workspace.rb +13 -0
  342. data/lib/files.com/models/zip_download.rb +73 -0
  343. data/lib/files.com/models/zip_download_file.rb +111 -0
  344. data/lib/files.com/models/zip_download_files.rb +42 -0
  345. data/lib/files.com/version.rb +1 -1
  346. data/lib/files.com.rb +59 -0
  347. metadata +120 -2
@@ -0,0 +1,126 @@
1
+ # SupportRequest
2
+
3
+ ## Example SupportRequest Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "subject": "example",
9
+ "comment": "example",
10
+ "created_at": "2000-01-01T01:00:00Z",
11
+ "access_until": "2000-01-01T01:00:00Z",
12
+ "customer_success_access": "`no`",
13
+ "priority": "`low`",
14
+ "name": "John Doe",
15
+ "phone_number": "555-555-5555"
16
+ }
17
+ ```
18
+
19
+ * `id` (int64): ID
20
+ * `subject` (string): Subject of the support request.
21
+ * `comment` (string): Main body of the support request.
22
+ * `created_at` (date): When this support request was made.
23
+ * `access_until` (date): Customer Support can access your user account up through this date/time.
24
+ * `customer_success_access` (string): Enable Customer Support access to your user account?
25
+ * `priority` (string): Priority. Can be `low` (e.g. general or billing/account questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
26
+ * `name` (string): Support Request name
27
+ * `phone_number` (string): Support Request phone number
28
+ * `access_reset` (boolean): If set to `true`, will reset the customer success access window.
29
+ * `email` (string): Email address of the user requesting support.
30
+ * `attachments_files` (array(file)):
31
+
32
+
33
+ ---
34
+
35
+ ## List Support Requests
36
+
37
+ ```
38
+ Files::SupportRequest.list
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
44
+ * `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
45
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
46
+
47
+
48
+ ---
49
+
50
+ ## Create Support Request
51
+
52
+ ```
53
+ Files::SupportRequest.create(
54
+ customer_success_access: "`no`",
55
+ access_reset: false,
56
+ email: "email",
57
+ subject: "example",
58
+ comment: "example",
59
+ priority: "`low`",
60
+ phone_number: "555-555-5555",
61
+ name: "John Doe"
62
+ )
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ * `customer_success_access` (string): Enable Customer Support access to your user account?
68
+ * `access_reset` (boolean): If set to `true`, will reset the customer success access window.
69
+ * `email` (string): Required - Email address of the user requesting support.
70
+ * `subject` (string): Required - Subject of the support request.
71
+ * `comment` (string): Required - Main body of the support request.
72
+ * `priority` (string): Priority. Can be `low` (e.g. general or billing/account questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
73
+ * `phone_number` (string): Support Request phone number
74
+ * `name` (string): Support Request name
75
+ * `attachments_files` (array(file)):
76
+
77
+
78
+ ---
79
+
80
+ ## Create an export CSV of Support Request resources
81
+
82
+ ```
83
+ Files::SupportRequest.create_export
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
89
+
90
+
91
+ ---
92
+
93
+ ## Update Support Request
94
+
95
+ ```
96
+ Files::SupportRequest.update(id,
97
+ customer_success_access: "`no`",
98
+ access_reset: false
99
+ )
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ * `id` (int64): Required - Support Request ID.
105
+ * `customer_success_access` (string): Enable Customer Support access to your user account?
106
+ * `access_reset` (boolean): If set to `true`, will reset the customer success access window.
107
+
108
+
109
+ ---
110
+
111
+ ## Update Support Request
112
+
113
+ ```
114
+ support_request = Files::SupportRequest.list.first
115
+
116
+ support_request.update(
117
+ customer_success_access: "`no`",
118
+ access_reset: false
119
+ )
120
+ ```
121
+
122
+ ### Parameters
123
+
124
+ * `id` (int64): Required - Support Request ID.
125
+ * `customer_success_access` (string): Enable Customer Support access to your user account?
126
+ * `access_reset` (boolean): If set to `true`, will reset the customer success access window.
data/docs/sync.md CHANGED
@@ -230,6 +230,20 @@ Files::Sync.manual_run(id)
230
230
  * `id` (int64): Required - Sync ID.
231
231
 
232
232
 
233
+ ---
234
+
235
+ ## Create an export CSV of Sync resources
236
+
237
+ ```
238
+ Files::Sync.create_export
239
+ ```
240
+
241
+ ### Parameters
242
+
243
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id` or `name`.
244
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `disabled`, `src_remote_server_id` or `dest_remote_server_id`. Valid field combinations are `[ workspace_id, disabled ]`, `[ workspace_id, src_remote_server_id ]`, `[ workspace_id, dest_remote_server_id ]`, `[ disabled, src_remote_server_id ]`, `[ disabled, dest_remote_server_id ]`, `[ workspace_id, disabled, src_remote_server_id ]` or `[ workspace_id, disabled, dest_remote_server_id ]`.
245
+
246
+
233
247
  ---
234
248
 
235
249
  ## Update Sync
@@ -0,0 +1,23 @@
1
+ # SyncApiUsageSnapshot
2
+
3
+ ## Example SyncApiUsageSnapshot Object
4
+
5
+ ```
6
+ {
7
+ "ifname": "example",
8
+ "api_reads": 1,
9
+ "api_writes": 1,
10
+ "list_cache_hits": 1,
11
+ "list_cache_misses": 1,
12
+ "stat_cache_hits": 1,
13
+ "stat_cache_misses": 1
14
+ }
15
+ ```
16
+
17
+ * `ifname` (string): Interface Name
18
+ * `api_reads` (int64): API Reads
19
+ * `api_writes` (int64): API Writes
20
+ * `list_cache_hits` (int64): List Cache Hits
21
+ * `list_cache_misses` (int64): List Cache Misses
22
+ * `stat_cache_hits` (int64): Stat Cache Hits
23
+ * `stat_cache_misses` (int64): Stat Cache Misses
@@ -0,0 +1,71 @@
1
+ # SyncApiUsageSnapshotReport
2
+
3
+ ## Example SyncApiUsageSnapshotReport Object
4
+
5
+ ```
6
+ {
7
+ "start_time": "2000-01-01T01:00:00Z",
8
+ "end_time": "2000-01-01T01:00:00Z",
9
+ "uuid": "example",
10
+ "auth_cache_hits": 1,
11
+ "auth_cache_misses": 1,
12
+ "auth_api_requests_for_sftp": 1,
13
+ "auth_api_requests_for_ftp": 1,
14
+ "auth_api_requests_for_dav": 1,
15
+ "auth_api_requests_for_desktop": 1,
16
+ "auth_api_requests_for_restapi": 1,
17
+ "number_of_sync_api_usage_snapshots": 1,
18
+ "sync_api_usage_snapshots": [
19
+
20
+ ]
21
+ }
22
+ ```
23
+
24
+ * `start_time` (date-time): start time of statistics collection
25
+ * `end_time` (date-time): end time of statistics collection
26
+ * `uuid` (string): Unique ID for this entry
27
+ * `auth_cache_hits` (int64): Numbers of hits of the authentication cache
28
+ * `auth_cache_misses` (int64): Numbers of misses of the authentication cache
29
+ * `auth_api_requests_for_sftp` (int64): A count of api authentications requests for SFTP
30
+ * `auth_api_requests_for_ftp` (int64): A count of api authentications requests for FTP
31
+ * `auth_api_requests_for_dav` (int64): A count of api authentications requests for DAV
32
+ * `auth_api_requests_for_desktop` (int64): A count of api authentications requests for Desktop
33
+ * `auth_api_requests_for_restapi` (int64): A count of api authentications requests for Restapi
34
+ * `number_of_sync_api_usage_snapshots` (int64): A count of the number of api usage logs
35
+ * `sync_api_usage_snapshots` (array(object)): A list of all the api usage logs
36
+
37
+
38
+ ---
39
+
40
+ ## Create Sync API Usage Snapshot Report
41
+
42
+ ```
43
+ Files::SyncApiUsageSnapshotReport.create(
44
+ start_time: "2000-01-01T01:00:00Z",
45
+ end_time: "2000-01-01T01:00:00Z",
46
+ uuid: "example",
47
+ auth_cache_hits: 1,
48
+ auth_cache_misses: 1,
49
+ auth_api_requests_for_sftp: 1,
50
+ auth_api_requests_for_ftp: 1,
51
+ auth_api_requests_for_dav: 1,
52
+ auth_api_requests_for_desktop: 1,
53
+ auth_api_requests_for_restapi: 1,
54
+ number_of_sync_api_usage_snapshots: 1
55
+ )
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ * `start_time` (string): start time of statistics collection
61
+ * `end_time` (string): end time of statistics collection
62
+ * `uuid` (string): Unique ID for this entry
63
+ * `auth_cache_hits` (int64): Numbers of hits of the authentication cache
64
+ * `auth_cache_misses` (int64): Numbers of misses of the authentication cache
65
+ * `auth_api_requests_for_sftp` (int64): A count of api authentications requests for SFTP
66
+ * `auth_api_requests_for_ftp` (int64): A count of api authentications requests for FTP
67
+ * `auth_api_requests_for_dav` (int64): A count of api authentications requests for DAV
68
+ * `auth_api_requests_for_desktop` (int64): A count of api authentications requests for Desktop
69
+ * `auth_api_requests_for_restapi` (int64): A count of api authentications requests for Restapi
70
+ * `number_of_sync_api_usage_snapshots` (int64): A count of the number of api usage logs
71
+ * `sync_api_usage_snapshots` (array(object)):
@@ -0,0 +1,48 @@
1
+ # SyncBandwidthSnapshot
2
+
3
+ ## Example SyncBandwidthSnapshot Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "site_id": 123,
9
+ "sync_bytes_received": "1.0",
10
+ "sync_bytes_sent": "1.0",
11
+ "created_at": "2000-01-01T01:00:00Z"
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): sync bandwidth snapshot ID
16
+ * `site_id` (int64): Site ID
17
+ * `sync_bytes_received` (decimal): bytes received
18
+ * `sync_bytes_sent` (decimal): bytes sent
19
+ * `created_at` (date-time): sync bandwidth snapshot created at date/time
20
+ * `remote_server_id` (int64): ID for the remote server consuming sync bandwidth
21
+
22
+
23
+ ---
24
+
25
+ ## Create Sync Bandwidth Snapshot
26
+
27
+ ```
28
+ Files::SyncBandwidthSnapshot.create(
29
+ remote_server_id: 1,
30
+ sync_bytes_sent: 1,
31
+ sync_bytes_received: 1
32
+ )
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ * `remote_server_id` (int64): Required - ID for the remote server consuming sync bandwidth
38
+ * `sync_bytes_sent` (int64): Required - Sync bytes sent
39
+ * `sync_bytes_received` (int64): Required - Sync bytes received
40
+
41
+
42
+ ---
43
+
44
+ ## Create Sync Bandwidth Snapshots
45
+
46
+ ```
47
+ Files::SyncBandwidthSnapshot.create_batch
48
+ ```
data/docs/sync_log.md CHANGED
@@ -15,7 +15,8 @@
15
15
  "size": 1,
16
16
  "file_type": "example",
17
17
  "status": "success",
18
- "created_at": "2000-01-01T01:00:00Z"
18
+ "created_at": "2000-01-01T01:00:00Z",
19
+ "log_type": "example"
19
20
  }
20
21
  ```
21
22
 
@@ -31,6 +32,7 @@
31
32
  * `file_type` (string): File type
32
33
  * `status` (string): Status
33
34
  * `created_at` (date-time): Start Time of Action
35
+ * `log_type` (string): Log Type
34
36
 
35
37
 
36
38
  ---
@@ -50,3 +52,20 @@ Files::SyncLog.list
50
52
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
51
53
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
52
54
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
55
+
56
+
57
+ ---
58
+
59
+ ## Create an export CSV of Sync Log resources
60
+
61
+ ```
62
+ Files::SyncLog.create_export
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `external_event_id`, `operation`, `status`, `sync_id`, `created_at` or `sync_run_id`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
68
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
69
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
70
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
71
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ sync_run_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ external_event_id, sync_run_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ operation, sync_run_id ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ status, sync_run_id ]`, `[ sync_id, created_at ]`, `[ sync_id, sync_run_id ]`, `[ created_at, sync_run_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, operation, sync_run_id ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, status, sync_run_id ]`, `[ external_event_id, sync_id, created_at ]`, `[ external_event_id, sync_id, sync_run_id ]`, `[ external_event_id, created_at, sync_run_id ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, status, sync_run_id ]`, `[ operation, sync_id, created_at ]`, `[ operation, sync_id, sync_run_id ]`, `[ operation, created_at, sync_run_id ]`, `[ status, sync_id, created_at ]`, `[ status, sync_id, sync_run_id ]`, `[ status, created_at, sync_run_id ]`, `[ sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, status, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, operation, sync_id, sync_run_id ]`, `[ external_event_id, operation, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ external_event_id, status, sync_id, sync_run_id ]`, `[ external_event_id, status, created_at, sync_run_id ]`, `[ external_event_id, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at ]`, `[ operation, status, sync_id, sync_run_id ]`, `[ operation, status, created_at, sync_run_id ]`, `[ operation, sync_id, created_at, sync_run_id ]`, `[ status, sync_id, created_at, sync_run_id ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, sync_run_id ]`, `[ external_event_id, operation, status, created_at, sync_run_id ]`, `[ external_event_id, operation, sync_id, created_at, sync_run_id ]`, `[ external_event_id, status, sync_id, created_at, sync_run_id ]`, `[ operation, status, sync_id, created_at, sync_run_id ]` or `[ external_event_id, operation, status, sync_id, created_at, sync_run_id ]`.
data/docs/sync_run.md CHANGED
@@ -101,3 +101,24 @@ Files::SyncRun.find(id)
101
101
  ### Parameters
102
102
 
103
103
  * `id` (int64): Required - Sync Run ID.
104
+
105
+
106
+ ---
107
+
108
+ ## Create an export CSV of Sync Run resources
109
+
110
+ ```
111
+ Files::SyncRun.create_export(
112
+ user_id: 1
113
+ )
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
119
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id`, `sync_id`, `created_at` or `status`.
120
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `workspace_id`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ workspace_id, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ workspace_id, status ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ workspace_id, src_remote_server_type ]`, `[ workspace_id, dest_remote_server_type ]`, `[ workspace_id, sync_id ]`, `[ workspace_id, status, created_at ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]`, `[ sync_id, status, created_at ]`, `[ workspace_id, src_remote_server_type, created_at ]`, `[ workspace_id, dest_remote_server_type, created_at ]`, `[ workspace_id, sync_id, created_at ]`, `[ workspace_id, src_remote_server_type, status ]`, `[ workspace_id, dest_remote_server_type, status ]`, `[ workspace_id, sync_id, status ]`, `[ workspace_id, src_remote_server_type, status, created_at ]`, `[ workspace_id, dest_remote_server_type, status, created_at ]` or `[ workspace_id, sync_id, status, created_at ]`.
121
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
122
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
123
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
124
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
@@ -0,0 +1,169 @@
1
+ # TwoFactorAuthenticationMethod
2
+
3
+ ## Example TwoFactorAuthenticationMethod Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "name": "My Verizon Phone",
9
+ "method_type": "sms",
10
+ "phone_number": "+15555555555",
11
+ "phone_number_country": "US",
12
+ "phone_number_national_format": "+15555555555",
13
+ "secret_tokens": [
14
+ "example"
15
+ ],
16
+ "setup_expired": true,
17
+ "setup_complete": true,
18
+ "setup_expires_at": "2000-01-01T01:00:00Z",
19
+ "totp_provisioning_uri": "https://...",
20
+ "webauthn_registration_options": {
21
+ "key": "example value"
22
+ },
23
+ "bypass_for_ftp_sftp_dav": true
24
+ }
25
+ ```
26
+
27
+ * `id` (int64): 2fa ID
28
+ * `name` (string): 2fa method name
29
+ * `method_type` (string): Type of 2fa
30
+ * `phone_number` (string): 2fa phone number (if SMS)
31
+ * `phone_number_country` (string): 2fa phone number country (if SMS)
32
+ * `phone_number_national_format` (string): 2fa phone number national format (if SMS)
33
+ * `secret_tokens` (array(string)): For the Static method type, this is the list of tokens which can be used
34
+ * `setup_expired` (boolean): 2fa setup expired?
35
+ * `setup_complete` (boolean): 2fa setup complete?
36
+ * `setup_expires_at` (date-time): 2fa setup expires at this date/time (typically 10 minutes after a new method is created)
37
+ * `totp_provisioning_uri` (string): TOTP provisioning URI (if TOTP)
38
+ * `webauthn_registration_options` (object): WebAuthn / FIDO 2 registration options (if WebAuthn)
39
+ * `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
40
+ * `otp` (string): Current value of OTP, Yubikey string, or Webauthn response value.
41
+
42
+
43
+ ---
44
+
45
+ ## List current user's 2FA methods
46
+
47
+ ```
48
+ Files::TwoFactorAuthenticationMethod.get
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
54
+ * `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
55
+
56
+
57
+ ---
58
+
59
+ ## Create 2FA method on current user
60
+
61
+ ```
62
+ Files::TwoFactorAuthenticationMethod.create(
63
+ method_type: "sms",
64
+ name: "My Verizon Phone",
65
+ phone_number: "+15555555555",
66
+ bypass_for_ftp_sftp_dav: false
67
+ )
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ * `method_type` (string): Required - Type of 2fa
73
+ * `name` (string): 2fa method name
74
+ * `phone_number` (string): 2fa phone number (if SMS)
75
+ * `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
76
+
77
+
78
+ ---
79
+
80
+ ## Generate (and send if applicable) a one time password for current user's primary 2FA method
81
+
82
+ ```
83
+ Files::TwoFactorAuthenticationMethod.send_code(
84
+ webauthn_only: false
85
+ )
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ * `webauthn_only` (boolean): Set to `true` to only generate an OTP for Webauthn keys and skip things like SMS.
91
+
92
+
93
+ ---
94
+
95
+ ## List current user's 2FA methods
96
+
97
+ ```
98
+ Files::TwoFactorAuthenticationMethod.create_export
99
+ ```
100
+
101
+
102
+ ---
103
+
104
+ ## Update 2fa
105
+
106
+ ```
107
+ Files::TwoFactorAuthenticationMethod.update(id,
108
+ otp: "123456",
109
+ name: "My Verizon Phone",
110
+ bypass_for_ftp_sftp_dav: false
111
+ )
112
+ ```
113
+
114
+ ### Parameters
115
+
116
+ * `id` (int64): Required - 2fa ID.
117
+ * `otp` (string): Current value of OTP, Yubikey string, or Webauthn response value.
118
+ * `name` (string): 2fa method name
119
+ * `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
120
+
121
+
122
+ ---
123
+
124
+ ## Delete 2fa
125
+
126
+ ```
127
+ Files::TwoFactorAuthenticationMethod.delete(id)
128
+ ```
129
+
130
+ ### Parameters
131
+
132
+ * `id` (int64): Required - 2fa ID.
133
+
134
+
135
+ ---
136
+
137
+ ## Update 2fa
138
+
139
+ ```
140
+ two_factor_authentication_method = Files::TwoFactorAuthenticationMethod.find(id)
141
+
142
+ two_factor_authentication_method.update(
143
+ otp: "123456",
144
+ name: "My Verizon Phone",
145
+ bypass_for_ftp_sftp_dav: false
146
+ )
147
+ ```
148
+
149
+ ### Parameters
150
+
151
+ * `id` (int64): Required - 2fa ID.
152
+ * `otp` (string): Current value of OTP, Yubikey string, or Webauthn response value.
153
+ * `name` (string): 2fa method name
154
+ * `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
155
+
156
+
157
+ ---
158
+
159
+ ## Delete 2fa
160
+
161
+ ```
162
+ two_factor_authentication_method = Files::TwoFactorAuthenticationMethod.find(id)
163
+
164
+ two_factor_authentication_method.delete
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+ * `id` (int64): Required - 2fa ID.
@@ -57,3 +57,21 @@ Files::UsageDailySnapshot.list
57
57
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
58
58
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
59
59
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.
60
+
61
+
62
+ ---
63
+
64
+ ## Create an export CSV of Usage Daily Snapshot resources
65
+
66
+ ```
67
+ Files::UsageDailySnapshot.create_export
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
73
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
74
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
75
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
76
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
77
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.
@@ -57,3 +57,12 @@ Files::UsageSnapshot.list
57
57
 
58
58
  * `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
59
59
  * `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
60
+
61
+
62
+ ---
63
+
64
+ ## Create an export CSV of Usage Snapshot resources
65
+
66
+ ```
67
+ Files::UsageSnapshot.create_export
68
+ ```