files.com 1.1.177 → 1.1.179

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/action_notification_export_result.md +17 -0
  4. data/docs/api_key.md +21 -0
  5. data/docs/api_request_log.md +14 -0
  6. data/docs/app.md +15 -0
  7. data/docs/as2_incoming_message.md +21 -0
  8. data/docs/as2_outgoing_message.md +21 -0
  9. data/docs/as2_partner.md +9 -0
  10. data/docs/as2_station.md +9 -0
  11. data/docs/automation.md +18 -0
  12. data/docs/automation_log.md +14 -0
  13. data/docs/automation_run.md +17 -0
  14. data/docs/bandwidth_snapshot.md +18 -0
  15. data/docs/behavior.md +15 -0
  16. data/docs/bundle.md +22 -0
  17. data/docs/bundle_action.md +18 -0
  18. data/docs/bundle_download.md +23 -0
  19. data/docs/bundle_notification.md +14 -0
  20. data/docs/bundle_recipient.md +17 -0
  21. data/docs/bundle_registration.md +15 -0
  22. data/docs/clickwrap.md +9 -0
  23. data/docs/dns_record.md +9 -0
  24. data/docs/email_incoming_message.md +19 -0
  25. data/docs/email_log.md +14 -0
  26. data/docs/exavault_api_request_log.md +14 -0
  27. data/docs/export.md +27 -1
  28. data/docs/external_event.md +19 -0
  29. data/docs/file_migration_log.md +14 -0
  30. data/docs/form_field_set.md +15 -0
  31. data/docs/ftp_action_log.md +14 -0
  32. data/docs/gpg_key.md +16 -0
  33. data/docs/group.md +27 -3
  34. data/docs/group_user.md +17 -0
  35. data/docs/history.md +85 -0
  36. data/docs/history_export_result.md +17 -0
  37. data/docs/inbox_recipient.md +17 -0
  38. data/docs/inbox_registration.md +15 -0
  39. data/docs/inbox_upload.md +20 -7
  40. data/docs/invoice.md +9 -0
  41. data/docs/ip_address.md +36 -0
  42. data/docs/message.md +17 -0
  43. data/docs/message_comment.md +17 -0
  44. data/docs/message_comment_reaction.md +17 -0
  45. data/docs/message_reaction.md +17 -0
  46. data/docs/notification.md +20 -0
  47. data/docs/outbound_connection_log.md +14 -0
  48. data/docs/payment.md +9 -0
  49. data/docs/permission.md +21 -0
  50. data/docs/priority.md +13 -0
  51. data/docs/project.md +9 -0
  52. data/docs/public_hosting_request_log.md +14 -0
  53. data/docs/public_key.md +15 -0
  54. data/docs/remote_bandwidth_snapshot.md +18 -0
  55. data/docs/remote_server.md +15 -0
  56. data/docs/request.md +17 -0
  57. data/docs/settings_change.md +14 -0
  58. data/docs/sftp_action_log.md +14 -0
  59. data/docs/sftp_host_key.md +9 -0
  60. data/docs/share_group.md +15 -0
  61. data/docs/siem_http_destination.md +9 -0
  62. data/docs/site.md +1 -0
  63. data/docs/snapshot.md +9 -0
  64. data/docs/sso_strategy.md +9 -0
  65. data/docs/sync_log.md +14 -0
  66. data/docs/usage_daily_snapshot.md +18 -0
  67. data/docs/usage_snapshot.md +9 -0
  68. data/docs/user.md +31 -2
  69. data/docs/user_cipher_use.md +15 -0
  70. data/docs/user_request.md +9 -0
  71. data/docs/user_sftp_client_use.md +15 -0
  72. data/docs/web_dav_action_log.md +14 -0
  73. data/lib/files.com/models/action_notification_export_result.rb +14 -0
  74. data/lib/files.com/models/api_key.rb +23 -0
  75. data/lib/files.com/models/api_request_log.rb +13 -0
  76. data/lib/files.com/models/app.rb +15 -0
  77. data/lib/files.com/models/as2_incoming_message.rb +23 -0
  78. data/lib/files.com/models/as2_outgoing_message.rb +23 -0
  79. data/lib/files.com/models/as2_partner.rb +7 -0
  80. data/lib/files.com/models/as2_station.rb +7 -0
  81. data/lib/files.com/models/automation.rb +21 -0
  82. data/lib/files.com/models/automation_log.rb +13 -0
  83. data/lib/files.com/models/automation_run.rb +16 -0
  84. data/lib/files.com/models/bandwidth_snapshot.rb +21 -0
  85. data/lib/files.com/models/behavior.rb +15 -0
  86. data/lib/files.com/models/bundle.rb +25 -0
  87. data/lib/files.com/models/bundle_action.rb +21 -0
  88. data/lib/files.com/models/bundle_download.rb +25 -0
  89. data/lib/files.com/models/bundle_notification.rb +13 -0
  90. data/lib/files.com/models/bundle_recipient.rb +16 -0
  91. data/lib/files.com/models/bundle_registration.rb +11 -0
  92. data/lib/files.com/models/clickwrap.rb +7 -0
  93. data/lib/files.com/models/dns_record.rb +7 -0
  94. data/lib/files.com/models/email_incoming_message.rb +23 -0
  95. data/lib/files.com/models/email_log.rb +13 -0
  96. data/lib/files.com/models/exavault_api_request_log.rb +13 -0
  97. data/lib/files.com/models/export.rb +98 -0
  98. data/lib/files.com/models/external_event.rb +23 -0
  99. data/lib/files.com/models/file_migration_log.rb +13 -0
  100. data/lib/files.com/models/form_field_set.rb +11 -0
  101. data/lib/files.com/models/ftp_action_log.rb +13 -0
  102. data/lib/files.com/models/gpg_key.rb +13 -0
  103. data/lib/files.com/models/group.rb +29 -1
  104. data/lib/files.com/models/group_user.rb +13 -0
  105. data/lib/files.com/models/history.rb +104 -0
  106. data/lib/files.com/models/history_export_result.rb +14 -0
  107. data/lib/files.com/models/inbox_recipient.rb +16 -0
  108. data/lib/files.com/models/inbox_registration.rb +11 -0
  109. data/lib/files.com/models/inbox_upload.rb +22 -5
  110. data/lib/files.com/models/invoice.rb +7 -0
  111. data/lib/files.com/models/ip_address.rb +28 -0
  112. data/lib/files.com/models/message.rb +14 -0
  113. data/lib/files.com/models/message_comment.rb +14 -0
  114. data/lib/files.com/models/message_comment_reaction.rb +14 -0
  115. data/lib/files.com/models/message_reaction.rb +14 -0
  116. data/lib/files.com/models/notification.rb +20 -0
  117. data/lib/files.com/models/outbound_connection_log.rb +13 -0
  118. data/lib/files.com/models/payment.rb +7 -0
  119. data/lib/files.com/models/permission.rb +22 -0
  120. data/lib/files.com/models/priority.rb +14 -0
  121. data/lib/files.com/models/project.rb +7 -0
  122. data/lib/files.com/models/public_hosting_request_log.rb +13 -0
  123. data/lib/files.com/models/public_key.rb +11 -0
  124. data/lib/files.com/models/remote_bandwidth_snapshot.rb +21 -0
  125. data/lib/files.com/models/remote_server.rb +15 -0
  126. data/lib/files.com/models/request.rb +14 -0
  127. data/lib/files.com/models/settings_change.rb +13 -0
  128. data/lib/files.com/models/sftp_action_log.rb +13 -0
  129. data/lib/files.com/models/sftp_host_key.rb +7 -0
  130. data/lib/files.com/models/share_group.rb +11 -0
  131. data/lib/files.com/models/siem_http_destination.rb +7 -0
  132. data/lib/files.com/models/snapshot.rb +7 -0
  133. data/lib/files.com/models/sso_strategy.rb +7 -0
  134. data/lib/files.com/models/sync_log.rb +13 -0
  135. data/lib/files.com/models/usage_daily_snapshot.rb +21 -0
  136. data/lib/files.com/models/usage_snapshot.rb +7 -0
  137. data/lib/files.com/models/user.rb +39 -1
  138. data/lib/files.com/models/user_cipher_use.rb +11 -0
  139. data/lib/files.com/models/user_request.rb +7 -0
  140. data/lib/files.com/models/user_sftp_client_use.rb +11 -0
  141. data/lib/files.com/models/web_dav_action_log.rb +13 -0
  142. data/lib/files.com/version.rb +1 -1
  143. metadata +2 -2
data/docs/behavior.md CHANGED
@@ -134,6 +134,21 @@ Files::Behavior.webhook_test(
134
134
  * `action` (string): Action for test body.
135
135
 
136
136
 
137
+ ---
138
+
139
+ ## Create Export Behavior
140
+
141
+ ```
142
+ Files::Behavior.create_export
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
148
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
149
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
150
+
151
+
137
152
  ---
138
153
 
139
154
  ## Update Behavior
data/docs/bundle.md CHANGED
@@ -236,6 +236,28 @@ Files::Bundle.create(
236
236
  * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
237
237
 
238
238
 
239
+ ---
240
+
241
+ ## Create Export Bundle
242
+
243
+ ```
244
+ Files::Bundle.create_export(
245
+ user_id: 1
246
+ )
247
+ ```
248
+
249
+ ### Parameters
250
+
251
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
252
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `code` or `note`.
253
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `code`, `note` or `created_at`.
254
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
255
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
256
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code` and `note`.
257
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
258
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
259
+
260
+
239
261
  ---
240
262
 
241
263
  ## Send email(s) with a link to bundle
@@ -55,3 +55,21 @@ Files::BundleAction.list
55
55
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
56
56
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
57
57
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
58
+
59
+
60
+ ---
61
+
62
+ ## Create Export Bundle Action
63
+
64
+ ```
65
+ Files::BundleAction.create_export
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
71
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`.
72
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
73
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
74
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
75
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
@@ -56,3 +56,26 @@ Files::BundleDownload.list(
56
56
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
57
57
  * `bundle_id` (int64): Bundle ID
58
58
  * `bundle_registration_id` (int64): BundleRegistration ID
59
+
60
+
61
+ ---
62
+
63
+ ## Create Export Bundle Download
64
+
65
+ ```
66
+ Files::BundleDownload.create_export(
67
+ bundle_id: 1,
68
+ bundle_registration_id: 1
69
+ )
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
75
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
76
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
77
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
78
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
79
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
80
+ * `bundle_id` (int64): Bundle ID
81
+ * `bundle_registration_id` (int64): BundleRegistration ID
@@ -69,6 +69,20 @@ Files::BundleNotification.create(
69
69
  * `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
70
70
 
71
71
 
72
+ ---
73
+
74
+ ## Create Export Bundle Notification
75
+
76
+ ```
77
+ Files::BundleNotification.create_export
78
+ ```
79
+
80
+ ### Parameters
81
+
82
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
83
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
84
+
85
+
72
86
  ---
73
87
 
74
88
  ## Update Bundle Notification
@@ -63,3 +63,20 @@ Files::BundleRecipient.create(
63
63
  * `company` (string): Company of recipient.
64
64
  * `note` (string): Note to include in email.
65
65
  * `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
66
+
67
+
68
+ ---
69
+
70
+ ## Create Export Bundle Recipient
71
+
72
+ ```
73
+ Files::BundleRecipient.create_export(
74
+ bundle_id: 1
75
+ )
76
+ ```
77
+
78
+ ### Parameters
79
+
80
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
81
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
82
+ * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
@@ -52,3 +52,18 @@ Files::BundleRegistration.list(
52
52
  * `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.
53
53
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
54
54
  * `bundle_id` (int64): ID of the associated Bundle
55
+
56
+
57
+ ---
58
+
59
+ ## Create Export Bundle Registration
60
+
61
+ ```
62
+ Files::BundleRegistration.create_export(
63
+ bundle_id: 1
64
+ )
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ * `bundle_id` (int64): ID of the associated Bundle
data/docs/clickwrap.md CHANGED
@@ -71,6 +71,15 @@ Files::Clickwrap.create(
71
71
  * `use_with_users` (string): Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
72
72
 
73
73
 
74
+ ---
75
+
76
+ ## Create Export Clickwrap
77
+
78
+ ```
79
+ Files::Clickwrap.create_export
80
+ ```
81
+
82
+
74
83
  ---
75
84
 
76
85
  ## Update Clickwrap
data/docs/dns_record.md CHANGED
@@ -29,3 +29,12 @@ Files::DnsRecord.list
29
29
 
30
30
  * `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.
31
31
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
32
+
33
+
34
+ ---
35
+
36
+ ## Show site DNS configuration
37
+
38
+ ```
39
+ Files::DnsRecord.create_export
40
+ ```
@@ -46,3 +46,22 @@ Files::EmailIncomingMessage.list
46
46
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
47
47
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
48
48
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
49
+
50
+
51
+ ---
52
+
53
+ ## Create Export Email Incoming Message
54
+
55
+ ```
56
+ Files::EmailIncomingMessage.create_export
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
62
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ created_at, inbox_id ]`, `[ created_at, sender ]`, `[ created_at, status ]`, `[ inbox_id, status ]`, `[ created_at, inbox_id, status ]`, `[ inbox_id, sender, status ]` or `[ created_at, inbox_id, sender, status ]`.
63
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
64
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
65
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
66
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
67
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
data/docs/email_log.md CHANGED
@@ -41,3 +41,17 @@ Files::EmailLog.list
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
42
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
43
43
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
44
+
45
+
46
+ ---
47
+
48
+ ## Create Export Email Log
49
+
50
+ ```
51
+ Files::EmailLog.create_export
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
57
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, status ]` or `[ end_date, status ]`.
@@ -45,3 +45,17 @@ Files::ExavaultApiRequestLog.list
45
45
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
46
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `request_ip`, `request_method` or `success`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
47
47
  * `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 `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
48
+
49
+
50
+ ---
51
+
52
+ ## Create Export Exavault API Request Log
53
+
54
+ ```
55
+ Files::ExavaultApiRequestLog.create_export
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `request_ip`, `request_method` or `success`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
61
+ * `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 `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.
data/docs/export.md CHANGED
@@ -7,14 +7,22 @@
7
7
  "id": 1,
8
8
  "export_status": "example",
9
9
  "export_type": "example",
10
- "download_uri": "example"
10
+ "export_rows": 1,
11
+ "download_uri": "example",
12
+ "message": "example"
11
13
  }
12
14
  ```
13
15
 
14
16
  * `id` (int64): ID for this Export
15
17
  * `export_status` (string): Status of the Export
16
18
  * `export_type` (string): Type of data being exported
19
+ * `export_rows` (int64): Number of rows exported
17
20
  * `download_uri` (string): Link to download Export file.
21
+ * `message` (string): Export message
22
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
23
+ * `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`.
24
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
25
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
18
26
 
19
27
 
20
28
  ---
@@ -48,3 +56,21 @@ Files::Export.find(id)
48
56
  ### Parameters
49
57
 
50
58
  * `id` (int64): Required - Export ID.
59
+
60
+
61
+ ---
62
+
63
+ ## Create Export Export
64
+
65
+ ```
66
+ Files::Export.create(
67
+ user_id: 1
68
+ )
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
74
+ * `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`.
75
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
76
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
@@ -86,3 +86,22 @@ Files::ExternalEvent.create(
86
86
 
87
87
  * `status` (string): Required - Status of event.
88
88
  * `body` (string): Required - Event body
89
+
90
+
91
+ ---
92
+
93
+ ## Create Export External Event
94
+
95
+ ```
96
+ Files::ExternalEvent.create_export
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `folder_behavior_id`, `siem_http_destination_id`, `created_at`, `event_type` or `status`.
102
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type ]`, `[ created_at, remote_server_type ]`, `[ created_at, status ]`, `[ event_type, status ]` or `[ created_at, event_type, status ]`.
103
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
104
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
105
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
106
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
107
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
@@ -39,3 +39,17 @@ Files::FileMigrationLog.list
39
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
40
40
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `file_migration_id`, `operation`, `status` or `type`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, file_migration_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, file_migration_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ operation, status ]`, `[ operation, type ]`, `[ status, type ]`, `[ start_date, end_date, file_migration_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, file_migration_id, operation ]`, `[ start_date, file_migration_id, status ]`, `[ start_date, file_migration_id, type ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, status, type ]`, `[ end_date, file_migration_id, operation ]`, `[ end_date, file_migration_id, status ]`, `[ end_date, file_migration_id, type ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, status, type ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, status, type ]`, `[ operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation ]`, `[ start_date, end_date, file_migration_id, status ]`, `[ start_date, end_date, file_migration_id, type ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, file_migration_id, operation, status ]`, `[ start_date, file_migration_id, operation, type ]`, `[ start_date, file_migration_id, status, type ]`, `[ start_date, operation, status, type ]`, `[ end_date, file_migration_id, operation, status ]`, `[ end_date, file_migration_id, operation, type ]`, `[ end_date, file_migration_id, status, type ]`, `[ end_date, operation, status, type ]`, `[ file_migration_id, operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation, status ]`, `[ start_date, end_date, file_migration_id, operation, type ]`, `[ start_date, end_date, file_migration_id, status, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, file_migration_id, operation, status, type ]` or `[ end_date, file_migration_id, operation, status, type ]`.
41
41
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation` and `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, file_migration_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, file_migration_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ operation, status ]`, `[ operation, type ]`, `[ status, type ]`, `[ start_date, end_date, file_migration_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, file_migration_id, operation ]`, `[ start_date, file_migration_id, status ]`, `[ start_date, file_migration_id, type ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, status, type ]`, `[ end_date, file_migration_id, operation ]`, `[ end_date, file_migration_id, status ]`, `[ end_date, file_migration_id, type ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, status, type ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, status, type ]`, `[ operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation ]`, `[ start_date, end_date, file_migration_id, status ]`, `[ start_date, end_date, file_migration_id, type ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, file_migration_id, operation, status ]`, `[ start_date, file_migration_id, operation, type ]`, `[ start_date, file_migration_id, status, type ]`, `[ start_date, operation, status, type ]`, `[ end_date, file_migration_id, operation, status ]`, `[ end_date, file_migration_id, operation, type ]`, `[ end_date, file_migration_id, status, type ]`, `[ end_date, operation, status, type ]`, `[ file_migration_id, operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation, status ]`, `[ start_date, end_date, file_migration_id, operation, type ]`, `[ start_date, end_date, file_migration_id, status, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, file_migration_id, operation, status, type ]` or `[ end_date, file_migration_id, operation, status, type ]`.
42
+
43
+
44
+ ---
45
+
46
+ ## Create Export File Migration Log
47
+
48
+ ```
49
+ Files::FileMigrationLog.create_export
50
+ ```
51
+
52
+ ### Parameters
53
+
54
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `file_migration_id`, `operation`, `status` or `type`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, file_migration_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, file_migration_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ operation, status ]`, `[ operation, type ]`, `[ status, type ]`, `[ start_date, end_date, file_migration_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, file_migration_id, operation ]`, `[ start_date, file_migration_id, status ]`, `[ start_date, file_migration_id, type ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, status, type ]`, `[ end_date, file_migration_id, operation ]`, `[ end_date, file_migration_id, status ]`, `[ end_date, file_migration_id, type ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, status, type ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, status, type ]`, `[ operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation ]`, `[ start_date, end_date, file_migration_id, status ]`, `[ start_date, end_date, file_migration_id, type ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, file_migration_id, operation, status ]`, `[ start_date, file_migration_id, operation, type ]`, `[ start_date, file_migration_id, status, type ]`, `[ start_date, operation, status, type ]`, `[ end_date, file_migration_id, operation, status ]`, `[ end_date, file_migration_id, operation, type ]`, `[ end_date, file_migration_id, status, type ]`, `[ end_date, operation, status, type ]`, `[ file_migration_id, operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation, status ]`, `[ start_date, end_date, file_migration_id, operation, type ]`, `[ start_date, end_date, file_migration_id, status, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, file_migration_id, operation, status, type ]` or `[ end_date, file_migration_id, operation, status, type ]`.
55
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation` and `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ start_date, end_date ]`, `[ start_date, file_migration_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, type ]`, `[ end_date, file_migration_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, type ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ operation, status ]`, `[ operation, type ]`, `[ status, type ]`, `[ start_date, end_date, file_migration_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, type ]`, `[ start_date, file_migration_id, operation ]`, `[ start_date, file_migration_id, status ]`, `[ start_date, file_migration_id, type ]`, `[ start_date, operation, status ]`, `[ start_date, operation, type ]`, `[ start_date, status, type ]`, `[ end_date, file_migration_id, operation ]`, `[ end_date, file_migration_id, status ]`, `[ end_date, file_migration_id, type ]`, `[ end_date, operation, status ]`, `[ end_date, operation, type ]`, `[ end_date, status, type ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, status, type ]`, `[ operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation ]`, `[ start_date, end_date, file_migration_id, status ]`, `[ start_date, end_date, file_migration_id, type ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, type ]`, `[ start_date, end_date, status, type ]`, `[ start_date, file_migration_id, operation, status ]`, `[ start_date, file_migration_id, operation, type ]`, `[ start_date, file_migration_id, status, type ]`, `[ start_date, operation, status, type ]`, `[ end_date, file_migration_id, operation, status ]`, `[ end_date, file_migration_id, operation, type ]`, `[ end_date, file_migration_id, status, type ]`, `[ end_date, operation, status, type ]`, `[ file_migration_id, operation, status, type ]`, `[ start_date, end_date, file_migration_id, operation, status ]`, `[ start_date, end_date, file_migration_id, operation, type ]`, `[ start_date, end_date, file_migration_id, status, type ]`, `[ start_date, end_date, operation, status, type ]`, `[ start_date, file_migration_id, operation, status, type ]` or `[ end_date, file_migration_id, operation, status, type ]`.
@@ -99,6 +99,21 @@ Files::FormFieldSet.create(
99
99
  * `form_fields` (array(object)):
100
100
 
101
101
 
102
+ ---
103
+
104
+ ## Create Export Form Field Set
105
+
106
+ ```
107
+ Files::FormFieldSet.create_export(
108
+ user_id: 1
109
+ )
110
+ ```
111
+
112
+ ### Parameters
113
+
114
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
115
+
116
+
102
117
  ---
103
118
 
104
119
  ## Update Form Field Set