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
@@ -220,6 +220,17 @@ module Files
220
220
  EventSubscription.new(response.data, options)
221
221
  end
222
222
 
223
+ # Parameters:
224
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `enabled`, `event_channel_id` or `workspace_id`.
225
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `event_channel_id` or `workspace_id`. Valid field combinations are `[ enabled, event_channel_id ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, event_channel_id ]`.
226
+ def self.create_export(params = {}, options = {})
227
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
228
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
229
+
230
+ response, options = Api.send_request("/event_subscriptions/create_export", :post, params, options)
231
+ Export.new(response.data, options)
232
+ end
233
+
223
234
  # Parameters:
224
235
  # event_channel_id - int64 - Event Channel ID
225
236
  # workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
@@ -196,6 +196,17 @@ module Files
196
196
  EventTarget.new(response.data, options)
197
197
  end
198
198
 
199
+ # Parameters:
200
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `enabled` or `workspace_id`.
201
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `target_type` or `workspace_id`. Valid field combinations are `[ enabled, target_type ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, target_type ]`.
202
+ def self.create_export(params = {}, options = {})
203
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
204
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
205
+
206
+ response, options = Api.send_request("/event_targets/create_export", :post, params, options)
207
+ Export.new(response.data, options)
208
+ end
209
+
199
210
  # Parameters:
200
211
  # name - string - Event Target name.
201
212
  # workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
@@ -69,6 +69,11 @@ module Files
69
69
  @attributes[:created_at]
70
70
  end
71
71
 
72
+ # string - Log Type
73
+ def log_type
74
+ @attributes[:log_type]
75
+ end
76
+
72
77
  # Parameters:
73
78
  # 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.
74
79
  # per_page - int64 - Number of records to show per page. (Max: 2000, 1,000 or less is recommended).
@@ -96,5 +101,24 @@ module Files
96
101
  def self.all(params = {}, options = {})
97
102
  list(params, options)
98
103
  end
104
+
105
+ # Parameters:
106
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `request_ip`, `request_method`, `success` or `created_at`. Valid field combinations are `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
107
+ # 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 `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
108
+ # 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 `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
109
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `request_ip` and `request_method`. Valid field combinations are `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
110
+ # 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 `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
111
+ # 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 `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
112
+ def self.create_export(params = {}, options = {})
113
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
114
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
115
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
116
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
117
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
118
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
119
+
120
+ response, options = Api.send_request("/exavault_api_request_logs/create_export", :post, params, options)
121
+ Export.new(response.data, options)
122
+ end
99
123
  end
100
124
  end
@@ -419,6 +419,17 @@ module Files
419
419
  ExpectationEvaluation.new(response.data, options)
420
420
  end
421
421
 
422
+ # Parameters:
423
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name` or `disabled`.
424
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled` and `workspace_id`. Valid field combinations are `[ workspace_id, disabled ]`.
425
+ def self.create_export(params = {}, options = {})
426
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
427
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
428
+
429
+ response, options = Api.send_request("/expectations/create_export", :post, params, options)
430
+ Export.new(response.data, options)
431
+ end
432
+
422
433
  # Parameters:
423
434
  # name - string - Expectation name.
424
435
  # description - string - Expectation description.
@@ -134,5 +134,16 @@ module Files
134
134
  def self.get(id, params = {}, options = {})
135
135
  find(id, params, options)
136
136
  end
137
+
138
+ # Parameters:
139
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `expectation_id`.
140
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expectation_id` and `workspace_id`. Valid field combinations are `[ workspace_id, expectation_id ]`.
141
+ def self.create_export(params = {}, options = {})
142
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
143
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
144
+
145
+ response, options = Api.send_request("/expectation_evaluations/create_export", :post, params, options)
146
+ Export.new(response.data, options)
147
+ end
137
148
  end
138
149
  end
@@ -195,5 +195,16 @@ module Files
195
195
  response, options = Api.send_request("/expectation_incidents/#{params[:id]}/acknowledge", :post, params, options)
196
196
  ExpectationIncident.new(response.data, options)
197
197
  end
198
+
199
+ # Parameters:
200
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `expectation_id`.
201
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expectation_id` and `workspace_id`. Valid field combinations are `[ workspace_id, expectation_id ]`.
202
+ def self.create_export(params = {}, options = {})
203
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
204
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
205
+
206
+ response, options = Api.send_request("/expectation_incidents/create_export", :post, params, options)
207
+ Export.new(response.data, options)
208
+ end
198
209
  end
199
210
  end
@@ -0,0 +1,153 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class Export
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - ID for this Export
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ def id=(value)
18
+ @attributes[:id] = value
19
+ end
20
+
21
+ # string - Status of the Export
22
+ def export_status
23
+ @attributes[:export_status]
24
+ end
25
+
26
+ def export_status=(value)
27
+ @attributes[:export_status] = value
28
+ end
29
+
30
+ # string - Type of data being exported
31
+ def export_type
32
+ @attributes[:export_type]
33
+ end
34
+
35
+ def export_type=(value)
36
+ @attributes[:export_type] = value
37
+ end
38
+
39
+ # int64 - Number of rows exported
40
+ def export_rows
41
+ @attributes[:export_rows]
42
+ end
43
+
44
+ def export_rows=(value)
45
+ @attributes[:export_rows] = value
46
+ end
47
+
48
+ # string - Link to download Export file.
49
+ def download_uri
50
+ @attributes[:download_uri]
51
+ end
52
+
53
+ def download_uri=(value)
54
+ @attributes[:download_uri] = value
55
+ end
56
+
57
+ # string - Export message
58
+ def message
59
+ @attributes[:message]
60
+ end
61
+
62
+ def message=(value)
63
+ @attributes[:message] = value
64
+ end
65
+
66
+ # int64 - User ID. Provide a value of `0` to operate the current session's user.
67
+ def user_id
68
+ @attributes[:user_id]
69
+ end
70
+
71
+ def user_id=(value)
72
+ @attributes[:user_id] = value
73
+ end
74
+
75
+ def save
76
+ if @attributes[:id]
77
+ raise NotImplementedError.new("The Export object doesn't support updates.")
78
+ else
79
+ new_obj = Export.create(@attributes, @options)
80
+ end
81
+
82
+ @attributes = new_obj.attributes
83
+ true
84
+ end
85
+
86
+ # Parameters:
87
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
88
+ # 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.
89
+ # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
90
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
91
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
92
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
93
+ def self.list(params = {}, options = {})
94
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
95
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
96
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
97
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
98
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
99
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
100
+
101
+ List.new(Export, params) do
102
+ Api.send_request("/exports", :get, params, options)
103
+ end
104
+ end
105
+
106
+ def self.all(params = {}, options = {})
107
+ list(params, options)
108
+ end
109
+
110
+ # Parameters:
111
+ # id (required) - int64 - Export ID.
112
+ def self.find(id, params = {}, options = {})
113
+ params ||= {}
114
+ params[:id] = id
115
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
116
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
117
+
118
+ response, options = Api.send_request("/exports/#{params[:id]}", :get, params, options)
119
+ Export.new(response.data, options)
120
+ end
121
+
122
+ def self.get(id, params = {}, options = {})
123
+ find(id, params, options)
124
+ end
125
+
126
+ # Parameters:
127
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
128
+ # export_type (required) - string - Export Report Type
129
+ def self.create(params = {}, options = {})
130
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
131
+ raise InvalidParameterError.new("Bad parameter: export_type must be an String") if params[:export_type] and !params[:export_type].is_a?(String)
132
+ raise MissingParameterError.new("Parameter missing: export_type") unless params[:export_type]
133
+
134
+ response, options = Api.send_request("/exports", :post, params, options)
135
+ Export.new(response.data, options)
136
+ end
137
+
138
+ # Parameters:
139
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
140
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
141
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
142
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
143
+ def self.create_export(params = {}, options = {})
144
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
145
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
146
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
147
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
148
+
149
+ response, options = Api.send_request("/exports/create_export", :post, params, options)
150
+ Export.new(response.data, options)
151
+ end
152
+ end
153
+ end
@@ -126,5 +126,24 @@ module Files
126
126
  response, options = Api.send_request("/external_events", :post, params, options)
127
127
  ExternalEvent.new(response.data, options)
128
128
  end
129
+
130
+ # Parameters:
131
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `event_type`.
132
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `status`. Valid field combinations are `[ status, created_at ]`.
133
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
134
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
135
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
136
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
137
+ def self.create_export(params = {}, options = {})
138
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
139
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
140
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
141
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
142
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
143
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
144
+
145
+ response, options = Api.send_request("/external_events/create_export", :post, params, options)
146
+ Export.new(response.data, options)
147
+ end
129
148
  end
130
149
  end