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.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/account.md +155 -0
- data/docs/action_log.md +21 -1
- data/docs/action_notification_export_result.md +17 -0
- data/docs/action_webhook_failure.md +28 -0
- data/docs/agent_proxy_identity.md +49 -0
- data/docs/agent_proxy_identity_endpoint.md +11 -0
- data/docs/agent_proxy_identity_result.md +24 -0
- data/docs/agent_v2_auth.md +17 -0
- data/docs/ai_assistant_personality.md +14 -0
- data/docs/ai_task.md +14 -0
- data/docs/announcement.md +57 -0
- data/docs/api_key.md +27 -1
- data/docs/api_request_log.md +21 -1
- data/docs/app.md +15 -0
- data/docs/as2_incoming_message.md +18 -0
- data/docs/as2_outgoing_message.md +18 -0
- data/docs/as2_partner.md +14 -0
- data/docs/as2_station.md +14 -0
- data/docs/automation.md +22 -1
- data/docs/automation_log.md +21 -1
- data/docs/automation_run.md +19 -0
- data/docs/bandwidth_snapshot.md +18 -0
- data/docs/behavior.md +14 -0
- data/docs/blog_post.md +57 -0
- data/docs/bundle.md +50 -1
- data/docs/bundle_action.md +25 -0
- data/docs/bundle_download.md +23 -0
- data/docs/bundle_notification.md +19 -0
- data/docs/bundle_recipient.md +21 -0
- data/docs/bundle_recipient_registration.md +39 -0
- data/docs/bundle_registration.md +61 -0
- data/docs/certificate.md +258 -0
- data/docs/chat_session.md +14 -0
- data/docs/child_site.md +583 -0
- data/docs/child_site_management_policy.md +9 -0
- data/docs/clickwrap.md +13 -0
- data/docs/clickwrap_acceptance.md +30 -0
- data/docs/client_log.md +17 -0
- data/docs/crash_report.md +50 -0
- data/docs/custom_domain.md +13 -0
- data/docs/custom_domain_for_proxy.md +23 -0
- data/docs/desktop_configuration_profile.md +14 -0
- data/docs/dns_record.md +9 -0
- data/docs/email_incoming_message.md +19 -0
- data/docs/email_log.md +20 -1
- data/docs/email_preference.md +108 -0
- data/docs/email_preference_bundle_notification.md +15 -0
- data/docs/email_preference_notification.md +17 -0
- data/docs/event_channel.md +14 -0
- data/docs/event_delivery_attempt.md +14 -0
- data/docs/event_record.md +19 -0
- data/docs/event_subscription.md +14 -0
- data/docs/event_target.md +14 -0
- data/docs/exavault_api_request_log.md +21 -1
- data/docs/expectation.md +14 -0
- data/docs/expectation_evaluation.md +14 -0
- data/docs/expectation_incident.md +14 -0
- data/docs/export.md +90 -0
- data/docs/external_event.md +18 -0
- data/docs/file.md +90 -2
- data/docs/file_migration.md +32 -0
- data/docs/file_migration_log.md +20 -1
- data/docs/file_upload_part.md +3 -1
- data/docs/folder.md +20 -0
- data/docs/form_field_set.md +15 -0
- data/docs/front_end_server.md +111 -0
- data/docs/frontend_metric.md +34 -0
- data/docs/ftp_action_log.md +21 -1
- data/docs/gpg_key.md +21 -0
- data/docs/group.md +19 -0
- data/docs/group_user.md +22 -2
- data/docs/history.md +85 -0
- data/docs/history_export_result.md +17 -0
- data/docs/holiday_region.md +9 -0
- data/docs/inbound_s3_log.md +21 -1
- data/docs/inbox.md +102 -0
- data/docs/inbox_recipient.md +19 -0
- data/docs/inbox_recipient_registration.md +35 -0
- data/docs/inbox_registration.md +57 -0
- data/docs/inbox_upload.md +18 -0
- data/docs/invoice.md +9 -0
- data/docs/ip.md +63 -0
- data/docs/ip_abuse_entry.md +47 -0
- data/docs/ip_address.md +59 -0
- data/docs/key_lifecycle_rule.md +14 -0
- data/docs/label.md +9 -0
- data/docs/lead.md +161 -0
- data/docs/lock.md +15 -0
- data/docs/message.md +17 -0
- data/docs/message_comment.md +18 -0
- data/docs/message_comment_reaction.md +18 -0
- data/docs/message_reaction.md +17 -0
- data/docs/metadata_category.md +13 -0
- data/docs/monitoring_stat.md +38 -0
- data/docs/monitoring_stats.md +15 -0
- data/docs/mover_package.md +68 -0
- data/docs/notification.md +20 -0
- data/docs/nps_response.md +75 -0
- data/docs/oauth_redirect.md +11 -0
- data/docs/outbound_connection_log.md +21 -1
- data/docs/paired_api_key.md +19 -0
- data/docs/partner.md +14 -0
- data/docs/partner_channel.md +14 -0
- data/docs/partner_site_request.md +14 -0
- data/docs/payment.md +9 -0
- data/docs/paypal_express_info.md +31 -0
- data/docs/paypal_express_url.md +11 -0
- data/docs/pending_work_event.md +18 -0
- data/docs/permission.md +22 -0
- data/docs/plan.md +107 -0
- data/docs/preview.md +57 -0
- data/docs/project.md +9 -0
- data/docs/public_hosting_request_log.md +21 -1
- data/docs/public_hosting_session_pairing.md +15 -0
- data/docs/public_inbox.md +121 -0
- data/docs/public_key.md +21 -0
- data/docs/public_url.md +59 -0
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +83 -0
- data/docs/release_package.md +19 -0
- data/docs/remote_bandwidth_snapshot.md +18 -0
- data/docs/remote_mount_backend.md +13 -0
- data/docs/remote_server.md +233 -0
- data/docs/remote_server_credential.md +15 -0
- data/docs/request.md +17 -0
- data/docs/restore.md +14 -0
- data/docs/revision.md +40 -0
- data/docs/safe_plan.md +0 -0
- data/docs/scheduled_export.md +15 -0
- data/docs/scim_log.md +13 -0
- data/docs/session.md +232 -1
- data/docs/session_available_site.md +26 -0
- data/docs/setting.md +33 -0
- data/docs/settings.md +498 -0
- data/docs/settings_change.md +16 -0
- data/docs/sftp_action_log.md +21 -1
- data/docs/sftp_host_key.md +9 -0
- data/docs/share_group.md +15 -0
- data/docs/siem_http_destination.md +9 -0
- data/docs/siem_http_destination_event.md +18 -0
- data/docs/site.md +179 -0
- data/docs/site_subdomain_redirect.md +13 -0
- data/docs/snapshot.md +9 -0
- data/docs/ssl_certificate.md +37 -0
- data/docs/sso_event.md +19 -0
- data/docs/sso_strategy.md +406 -0
- data/docs/staging_site.md +591 -0
- data/docs/support_request.md +126 -0
- data/docs/sync.md +14 -0
- data/docs/sync_api_usage_snapshot.md +23 -0
- data/docs/sync_api_usage_snapshot_report.md +71 -0
- data/docs/sync_bandwidth_snapshot.md +48 -0
- data/docs/sync_log.md +20 -1
- data/docs/sync_run.md +21 -0
- data/docs/two_factor_authentication_method.md +169 -0
- data/docs/usage_daily_snapshot.md +18 -0
- data/docs/usage_snapshot.md +9 -0
- data/docs/user.md +49 -2
- data/docs/user_cipher_use.md +21 -0
- data/docs/user_lifecycle_rule.md +14 -0
- data/docs/user_request.md +9 -0
- data/docs/user_security_event.md +18 -0
- data/docs/user_sftp_client_use.md +15 -0
- data/docs/warning.md +36 -0
- data/docs/web_dav_action_log.md +21 -1
- data/docs/webauthn_sign_request.md +13 -0
- data/docs/workspace.md +15 -0
- data/docs/zip_download.md +32 -0
- data/docs/zip_download_file.md +45 -0
- data/docs/zip_download_files.md +23 -0
- data/lib/files.com/models/account.rb +346 -0
- data/lib/files.com/models/action_log.rb +24 -0
- data/lib/files.com/models/action_notification_export_result.rb +12 -0
- data/lib/files.com/models/action_webhook_failure.rb +34 -0
- data/lib/files.com/models/agent_proxy_identity.rb +47 -0
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
- data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
- data/lib/files.com/models/agent_v2_auth.rb +32 -0
- data/lib/files.com/models/ai_assistant_personality.rb +11 -0
- data/lib/files.com/models/ai_task.rb +11 -0
- data/lib/files.com/models/announcement.rb +89 -0
- data/lib/files.com/models/api_key.rb +39 -5
- data/lib/files.com/models/api_request_log.rb +24 -0
- data/lib/files.com/models/app.rb +13 -0
- data/lib/files.com/models/as2_incoming_message.rb +19 -0
- data/lib/files.com/models/as2_outgoing_message.rb +19 -0
- data/lib/files.com/models/as2_partner.rb +11 -0
- data/lib/files.com/models/as2_station.rb +11 -0
- data/lib/files.com/models/automation.rb +30 -0
- data/lib/files.com/models/automation_log.rb +24 -0
- data/lib/files.com/models/automation_run.rb +16 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/behavior.rb +11 -0
- data/lib/files.com/models/blog_post.rb +84 -0
- data/lib/files.com/models/bundle.rb +52 -0
- data/lib/files.com/models/bundle_action.rb +25 -0
- data/lib/files.com/models/bundle_download.rb +23 -0
- data/lib/files.com/models/bundle_notification.rb +15 -0
- data/lib/files.com/models/bundle_recipient.rb +27 -0
- data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
- data/lib/files.com/models/bundle_registration.rb +125 -0
- data/lib/files.com/models/certificate.rb +455 -0
- data/lib/files.com/models/chat_session.rb +11 -0
- data/lib/files.com/models/child_site.rb +1756 -0
- data/lib/files.com/models/child_site_management_policy.rb +5 -0
- data/lib/files.com/models/clickwrap.rb +9 -0
- data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
- data/lib/files.com/models/client_log.rb +25 -0
- data/lib/files.com/models/crash_report.rb +151 -0
- data/lib/files.com/models/custom_domain.rb +9 -0
- data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
- data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/email_incoming_message.rb +21 -0
- data/lib/files.com/models/email_log.rb +22 -0
- data/lib/files.com/models/email_preference.rb +124 -0
- data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
- data/lib/files.com/models/email_preference_notification.rb +32 -0
- data/lib/files.com/models/event_channel.rb +11 -0
- data/lib/files.com/models/event_delivery_attempt.rb +11 -0
- data/lib/files.com/models/event_record.rb +21 -0
- data/lib/files.com/models/event_subscription.rb +11 -0
- data/lib/files.com/models/event_target.rb +11 -0
- data/lib/files.com/models/exavault_api_request_log.rb +24 -0
- data/lib/files.com/models/expectation.rb +11 -0
- data/lib/files.com/models/expectation_evaluation.rb +11 -0
- data/lib/files.com/models/expectation_incident.rb +11 -0
- data/lib/files.com/models/export.rb +153 -0
- data/lib/files.com/models/external_event.rb +19 -0
- data/lib/files.com/models/file.rb +207 -0
- data/lib/files.com/models/file_migration.rb +27 -0
- data/lib/files.com/models/file_migration_log.rb +22 -0
- data/lib/files.com/models/file_upload_part.rb +5 -0
- data/lib/files.com/models/folder.rb +69 -0
- data/lib/files.com/models/form_field_set.rb +9 -0
- data/lib/files.com/models/front_end_server.rb +335 -0
- data/lib/files.com/models/frontend_metric.rb +65 -0
- data/lib/files.com/models/ftp_action_log.rb +24 -0
- data/lib/files.com/models/gpg_key.rb +21 -0
- data/lib/files.com/models/group.rb +16 -0
- data/lib/files.com/models/group_user.rb +21 -1
- data/lib/files.com/models/history.rb +94 -0
- data/lib/files.com/models/history_export_result.rb +12 -0
- data/lib/files.com/models/holiday_region.rb +5 -0
- data/lib/files.com/models/inbound_s3_log.rb +24 -0
- data/lib/files.com/models/inbox.rb +123 -0
- data/lib/files.com/models/inbox_recipient.rb +25 -0
- data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
- data/lib/files.com/models/inbox_registration.rb +121 -0
- data/lib/files.com/models/inbox_upload.rb +19 -0
- data/lib/files.com/models/invoice.rb +5 -0
- data/lib/files.com/models/ip.rb +82 -0
- data/lib/files.com/models/ip_abuse_entry.rb +96 -0
- data/lib/files.com/models/ip_address.rb +37 -0
- data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/label.rb +22 -0
- data/lib/files.com/models/lead.rb +434 -0
- data/lib/files.com/models/lock.rb +27 -0
- data/lib/files.com/models/message.rb +12 -0
- data/lib/files.com/models/message_comment.rb +14 -0
- data/lib/files.com/models/message_comment_reaction.rb +14 -0
- data/lib/files.com/models/message_reaction.rb +12 -0
- data/lib/files.com/models/metadata_category.rb +9 -0
- data/lib/files.com/models/monitoring_stat.rb +43 -0
- data/lib/files.com/models/monitoring_stats.rb +22 -0
- data/lib/files.com/models/mover_package.rb +80 -0
- data/lib/files.com/models/notification.rb +18 -0
- data/lib/files.com/models/nps_response.rb +128 -0
- data/lib/files.com/models/oauth_redirect.rb +17 -0
- data/lib/files.com/models/outbound_connection_log.rb +24 -0
- data/lib/files.com/models/paired_api_key.rb +37 -0
- data/lib/files.com/models/partner.rb +11 -0
- data/lib/files.com/models/partner_channel.rb +11 -0
- data/lib/files.com/models/partner_site_request.rb +11 -0
- data/lib/files.com/models/payment.rb +5 -0
- data/lib/files.com/models/paypal_express_info.rb +67 -0
- data/lib/files.com/models/paypal_express_url.rb +17 -0
- data/lib/files.com/models/pending_work_event.rb +19 -0
- data/lib/files.com/models/permission.rb +22 -0
- data/lib/files.com/models/plan.rb +209 -0
- data/lib/files.com/models/preview.rb +57 -0
- data/lib/files.com/models/project.rb +5 -0
- data/lib/files.com/models/public_hosting_request_log.rb +24 -0
- data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
- data/lib/files.com/models/public_inbox.rb +142 -0
- data/lib/files.com/models/public_key.rb +21 -0
- data/lib/files.com/models/public_url.rb +177 -0
- data/lib/files.com/models/regional_migration.rb +12 -0
- data/lib/files.com/models/release.rb +153 -0
- data/lib/files.com/models/release_package.rb +37 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/remote_mount_backend.rb +9 -0
- data/lib/files.com/models/remote_server.rb +297 -0
- data/lib/files.com/models/remote_server_credential.rb +13 -0
- data/lib/files.com/models/request.rb +12 -0
- data/lib/files.com/models/restore.rb +11 -0
- data/lib/files.com/models/revision.rb +53 -0
- data/lib/files.com/models/safe_plan.rb +12 -0
- data/lib/files.com/models/scheduled_export.rb +13 -0
- data/lib/files.com/models/scim_log.rb +9 -0
- data/lib/files.com/models/session.rb +493 -0
- data/lib/files.com/models/session_available_site.rb +47 -0
- data/lib/files.com/models/setting.rb +36 -0
- data/lib/files.com/models/settings.rb +1072 -0
- data/lib/files.com/models/settings_change.rb +16 -0
- data/lib/files.com/models/sftp_action_log.rb +24 -0
- data/lib/files.com/models/sftp_host_key.rb +5 -0
- data/lib/files.com/models/share_group.rb +9 -0
- data/lib/files.com/models/siem_http_destination.rb +5 -0
- data/lib/files.com/models/siem_http_destination_event.rb +19 -0
- data/lib/files.com/models/site.rb +1021 -0
- data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
- data/lib/files.com/models/snapshot.rb +5 -0
- data/lib/files.com/models/ssl_certificate.rb +77 -0
- data/lib/files.com/models/sso_event.rb +21 -0
- data/lib/files.com/models/sso_strategy.rb +632 -0
- data/lib/files.com/models/staging_site.rb +1781 -0
- data/lib/files.com/models/support_request.rb +209 -0
- data/lib/files.com/models/sync.rb +11 -0
- data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
- data/lib/files.com/models/sync_log.rb +22 -0
- data/lib/files.com/models/sync_run.rb +21 -0
- data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
- data/lib/files.com/models/usage_snapshot.rb +5 -0
- data/lib/files.com/models/user.rb +59 -0
- data/lib/files.com/models/user_cipher_use.rb +21 -0
- data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/user_request.rb +5 -0
- data/lib/files.com/models/user_security_event.rb +19 -0
- data/lib/files.com/models/user_sftp_client_use.rb +9 -0
- data/lib/files.com/models/warning.rb +38 -0
- data/lib/files.com/models/web_dav_action_log.rb +24 -0
- data/lib/files.com/models/webauthn_sign_request.rb +17 -0
- data/lib/files.com/models/workspace.rb +13 -0
- data/lib/files.com/models/zip_download.rb +73 -0
- data/lib/files.com/models/zip_download_file.rb +111 -0
- data/lib/files.com/models/zip_download_files.rb +42 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +59 -0
- metadata +120 -2
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# CrashReport
|
|
2
|
+
|
|
3
|
+
## Example CrashReport Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1
|
|
8
|
+
}
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
* `id` (int64): Crash Report ID
|
|
12
|
+
* `build` (string):
|
|
13
|
+
* `platform` (string):
|
|
14
|
+
* `product_name` (string):
|
|
15
|
+
* `version` (string):
|
|
16
|
+
* `comment` (string):
|
|
17
|
+
* `email` (string):
|
|
18
|
+
* `platform_version` (string):
|
|
19
|
+
* `release_channel` (string):
|
|
20
|
+
* `dump_file` (file):
|
|
21
|
+
* `log_file` (file):
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Endpoint for the Desktop App to post information about a crash for further review by our desktop app team
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
Files::CrashReport.create(
|
|
30
|
+
build: "123",
|
|
31
|
+
platform: "win32",
|
|
32
|
+
product_name: "Files.com",
|
|
33
|
+
version: "1.0.0",
|
|
34
|
+
comment: "Comment",
|
|
35
|
+
email: "johndoe@gmail.com"
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
* `build` (string): Required -
|
|
42
|
+
* `platform` (string): Required -
|
|
43
|
+
* `product_name` (string): Required -
|
|
44
|
+
* `version` (string): Required -
|
|
45
|
+
* `comment` (string):
|
|
46
|
+
* `email` (string):
|
|
47
|
+
* `platform_version` (string):
|
|
48
|
+
* `release_channel` (string):
|
|
49
|
+
* `dump_file` (file):
|
|
50
|
+
* `log_file` (file):
|
data/docs/custom_domain.md
CHANGED
|
@@ -76,6 +76,19 @@ Files::CustomDomain.create(
|
|
|
76
76
|
* `domain` (string): Required - Customer-owned domain name.
|
|
77
77
|
|
|
78
78
|
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Create an export CSV of Custom Domain resources
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
Files::CustomDomain.create_export
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
|
|
90
|
+
|
|
91
|
+
|
|
79
92
|
---
|
|
80
93
|
|
|
81
94
|
## Update Custom Domain
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CustomDomainForProxy
|
|
2
|
+
|
|
3
|
+
## Example CustomDomainForProxy Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"domain": "example",
|
|
9
|
+
"destination": "example",
|
|
10
|
+
"ssl_certificate_id": 1,
|
|
11
|
+
"certificate": "example",
|
|
12
|
+
"private_key": "example",
|
|
13
|
+
"intermediates": "example"
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
* `id` (int64): Custom Domain ID.
|
|
18
|
+
* `domain` (string): Customer-owned domain name.
|
|
19
|
+
* `destination` (string): Routing destination: `site_alias`, `public_hosting`, or `s3_endpoint`.
|
|
20
|
+
* `ssl_certificate_id` (int64): Attached SslCertificate ID.
|
|
21
|
+
* `certificate` (string): The text of the certificate itself.
|
|
22
|
+
* `private_key` (string): Private key used to generate the certificate.
|
|
23
|
+
* `intermediates` (string): Intermediate certificates, if available.
|
|
@@ -75,6 +75,20 @@ Files::DesktopConfigurationProfile.create(
|
|
|
75
75
|
* `disable_drive_mounting` (boolean): Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile
|
|
76
76
|
|
|
77
77
|
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## Create an export CSV of Desktop Configuration Profile resources
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
Files::DesktopConfigurationProfile.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 `workspace_id` and `name`.
|
|
89
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
90
|
+
|
|
91
|
+
|
|
78
92
|
---
|
|
79
93
|
|
|
80
94
|
## Update Desktop Configuration Profile
|
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: 10000, 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 an export CSV of Email Incoming Message resources
|
|
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 `[ inbox_id, created_at ]`, `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, status ]`, `[ status, sender ]`, `[ inbox_id, status, created_at ]`, `[ status, sender, created_at ]`, `[ inbox_id, status, sender ]` or `[ inbox_id, status, sender, created_at ]`.
|
|
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
|
@@ -13,7 +13,8 @@
|
|
|
13
13
|
"delivery_method": "example",
|
|
14
14
|
"smtp_hostname": "example",
|
|
15
15
|
"smtp_ip": "example",
|
|
16
|
-
"created_at": "2000-01-01T01:00:00Z"
|
|
16
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
17
|
+
"log_type": "example"
|
|
17
18
|
}
|
|
18
19
|
```
|
|
19
20
|
|
|
@@ -27,6 +28,7 @@
|
|
|
27
28
|
* `smtp_hostname` (string): Customer SMTP Hostname used.
|
|
28
29
|
* `smtp_ip` (string): Customer SMTP IP address as resolved for use (useful for troubleshooting DNS issues with customer SMTP).
|
|
29
30
|
* `created_at` (date-time): Start Time of Action
|
|
31
|
+
* `log_type` (string): Log Type
|
|
30
32
|
|
|
31
33
|
|
|
32
34
|
---
|
|
@@ -46,3 +48,20 @@ Files::EmailLog.list
|
|
|
46
48
|
* `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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
47
49
|
* `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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
48
50
|
* `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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Create an export CSV of Email Log resources
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
Files::EmailLog.create_export
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `created_at`. Valid field combinations are `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
64
|
+
* `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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
65
|
+
* `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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
66
|
+
* `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 `[ status ]`, `[ created_at ]` or `[ status, 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`. Valid field combinations are `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# EmailPreference
|
|
2
|
+
|
|
3
|
+
## Example EmailPreference Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"email": "john.doe@files.com",
|
|
8
|
+
"notifications": [
|
|
9
|
+
{
|
|
10
|
+
"id": 1,
|
|
11
|
+
"path": "example",
|
|
12
|
+
"send_interval": "fifteen_minutes",
|
|
13
|
+
"unsubscribed": true
|
|
14
|
+
}
|
|
15
|
+
],
|
|
16
|
+
"bundle_notifications": [
|
|
17
|
+
{
|
|
18
|
+
"id": 1,
|
|
19
|
+
"bundle_code": "example",
|
|
20
|
+
"unsubscribed": true
|
|
21
|
+
}
|
|
22
|
+
],
|
|
23
|
+
"receive_admin_alerts": true,
|
|
24
|
+
"notify_on_all_site_warnings": true,
|
|
25
|
+
"notify_on_all_sso_failures": true,
|
|
26
|
+
"notify_on_all_user_security_events": true,
|
|
27
|
+
"notify_on_all_pending_work_failures": true,
|
|
28
|
+
"notify_on_all_siem_http_destination_failures": true,
|
|
29
|
+
"notify_on_all_sync_failures": true,
|
|
30
|
+
"notify_on_all_automation_failures": true,
|
|
31
|
+
"notify_on_all_expectation_failures": true,
|
|
32
|
+
"receive_marketing_mail": true,
|
|
33
|
+
"receive_transactional_mail": true
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
* `email` (email): Email address
|
|
38
|
+
* `notifications` (array(object)): A list of notifications
|
|
39
|
+
* `bundle_notifications` (array(object)): A list of bundle notifications
|
|
40
|
+
* `receive_admin_alerts` (boolean): Deprecated. Use granular admin email preferences instead.
|
|
41
|
+
* `notify_on_all_site_warnings` (boolean): Receive site warnings?
|
|
42
|
+
* `notify_on_all_sso_failures` (boolean): Receive sso/scim/ldap configuration/sync failures?
|
|
43
|
+
* `notify_on_all_user_security_events` (boolean): Receive user security events?
|
|
44
|
+
* `notify_on_all_pending_work_failures` (boolean): Receive pending work failures?
|
|
45
|
+
* `notify_on_all_siem_http_destination_failures` (boolean): Receive siem failures?
|
|
46
|
+
* `notify_on_all_sync_failures` (boolean): Receive sync failures?
|
|
47
|
+
* `notify_on_all_automation_failures` (boolean): Receive automation failures?
|
|
48
|
+
* `notify_on_all_expectation_failures` (boolean): Receive expectation failures and misses?
|
|
49
|
+
* `receive_marketing_mail` (boolean): Receive marketing mail?
|
|
50
|
+
* `receive_transactional_mail` (boolean): Receive transactional (service-related) mail?
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Show Email Preference
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
Files::EmailPreference.get(token)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
* `token` (string): Required - Email preferences token.
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Update Email Preference
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
Files::EmailPreference.update(token,
|
|
72
|
+
user[receive_admin_alerts]: false,
|
|
73
|
+
user[notify_on_all_site_warnings]: false,
|
|
74
|
+
user[notify_on_all_sso_failures]: false,
|
|
75
|
+
user[notify_on_all_user_security_events]: false,
|
|
76
|
+
user[notify_on_all_pending_work_failures]: false,
|
|
77
|
+
user[notify_on_all_siem_http_destination_failures]: false,
|
|
78
|
+
user[notify_on_all_sync_failures]: false,
|
|
79
|
+
user[notify_on_all_automation_failures]: false,
|
|
80
|
+
user[notify_on_all_expectation_failures]: false,
|
|
81
|
+
user[unsubscribe_marketing]: false,
|
|
82
|
+
user[unsubscribe_transactional]: false,
|
|
83
|
+
user[unsubscribe]: false,
|
|
84
|
+
user[notifications][send_interval]: "hour"
|
|
85
|
+
)
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
* `token` (string): Required - Email preferences token.
|
|
91
|
+
* `user[receive_admin_alerts]` (boolean):
|
|
92
|
+
* `user[notify_on_all_site_warnings]` (boolean):
|
|
93
|
+
* `user[notify_on_all_sso_failures]` (boolean):
|
|
94
|
+
* `user[notify_on_all_user_security_events]` (boolean):
|
|
95
|
+
* `user[notify_on_all_pending_work_failures]` (boolean):
|
|
96
|
+
* `user[notify_on_all_siem_http_destination_failures]` (boolean):
|
|
97
|
+
* `user[notify_on_all_sync_failures]` (boolean):
|
|
98
|
+
* `user[notify_on_all_automation_failures]` (boolean):
|
|
99
|
+
* `user[notify_on_all_expectation_failures]` (boolean):
|
|
100
|
+
* `user[unsubscribe_marketing]` (boolean):
|
|
101
|
+
* `user[unsubscribe_transactional]` (boolean):
|
|
102
|
+
* `user[unsubscribe]` (boolean):
|
|
103
|
+
* `user[notifications][id]` (array(int64)):
|
|
104
|
+
* `user[notifications][group]` (array(boolean)):
|
|
105
|
+
* `user[notifications][send_interval]` (array(string)):
|
|
106
|
+
* `user[notifications][unsubscribe]` (array(boolean)):
|
|
107
|
+
* `user[bundle_notifications][id]` (array(int64)):
|
|
108
|
+
* `user[bundle_notifications][unsubscribe]` (array(boolean)):
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# EmailPreferenceBundleNotification
|
|
2
|
+
|
|
3
|
+
## Example EmailPreferenceBundleNotification Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"bundle_code": "example",
|
|
9
|
+
"unsubscribed": true
|
|
10
|
+
}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
* `id` (int64): Email preferences ID
|
|
14
|
+
* `bundle_code` (string): Bundle code
|
|
15
|
+
* `unsubscribed` (boolean): Is unsubscribed?
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# EmailPreferenceNotification
|
|
2
|
+
|
|
3
|
+
## Example EmailPreferenceNotification Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"path": "example",
|
|
9
|
+
"send_interval": "fifteen_minutes",
|
|
10
|
+
"unsubscribed": true
|
|
11
|
+
}
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
* `id` (int64): Email preferences ID
|
|
15
|
+
* `path` (string): Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
16
|
+
* `send_interval` (string): The time interval that notifications are aggregated to. Can be five_minutes, fifteen_minutes, hourly, or daily
|
|
17
|
+
* `unsubscribed` (boolean): Is unsubscribed?
|
data/docs/event_channel.md
CHANGED
|
@@ -77,6 +77,20 @@ Files::EventChannel.create(
|
|
|
77
77
|
* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
|
|
78
78
|
|
|
79
79
|
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Create an export CSV of Event Channel resources
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
Files::EventChannel.create_export
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `enabled`, `default_channel` or `workspace_id`.
|
|
91
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `default_channel` or `workspace_id`. Valid field combinations are `[ workspace_id, enabled ]` and `[ workspace_id, default_channel ]`.
|
|
92
|
+
|
|
93
|
+
|
|
80
94
|
---
|
|
81
95
|
|
|
82
96
|
## Update Event Channel
|
|
@@ -66,3 +66,17 @@ Files::EventDeliveryAttempt.find(id)
|
|
|
66
66
|
### Parameters
|
|
67
67
|
|
|
68
68
|
* `id` (int64): Required - Event Delivery Attempt ID.
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Create an export CSV of Event Delivery Attempt resources
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
Files::EventDeliveryAttempt.create_export
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Parameters
|
|
80
|
+
|
|
81
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status`, `event_record_id`, `event_target_id` or `workspace_id`.
|
|
82
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id`, `event_record_id` or `event_target_id`. Valid field combinations are `[ workspace_id, status ]`, `[ workspace_id, event_record_id ]` or `[ workspace_id, event_target_id ]`.
|
data/docs/event_record.md
CHANGED
|
@@ -75,3 +75,22 @@ Files::EventRecord.find(id)
|
|
|
75
75
|
### Parameters
|
|
76
76
|
|
|
77
77
|
* `id` (int64): Required - Event Record ID.
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Create an export CSV of Event Record resources
|
|
83
|
+
|
|
84
|
+
```
|
|
85
|
+
Files::EventRecord.create_export
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `event_type`, `created_at` or `workspace_id`.
|
|
91
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type` or `workspace_id`. Valid field combinations are `[ event_type, created_at ]`, `[ workspace_id, created_at ]`, `[ workspace_id, event_type ]` or `[ workspace_id, event_type, created_at ]`.
|
|
92
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
93
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
94
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `event_type`.
|
|
95
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
96
|
+
* `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/event_subscription.md
CHANGED
|
@@ -96,6 +96,20 @@ Files::EventSubscription.create(
|
|
|
96
96
|
* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
|
|
97
97
|
|
|
98
98
|
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Create an export CSV of Event Subscription resources
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
Files::EventSubscription.create_export
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Parameters
|
|
108
|
+
|
|
109
|
+
* `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`.
|
|
110
|
+
* `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 ]`.
|
|
111
|
+
|
|
112
|
+
|
|
99
113
|
---
|
|
100
114
|
|
|
101
115
|
## Update Event Subscription
|
data/docs/event_target.md
CHANGED
|
@@ -85,6 +85,20 @@ Files::EventTarget.create(
|
|
|
85
85
|
* `delivery_policy` (object): Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.
|
|
86
86
|
|
|
87
87
|
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Create an export CSV of Event Target resources
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
Files::EventTarget.create_export
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
* `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`.
|
|
99
|
+
* `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 ]`.
|
|
100
|
+
|
|
101
|
+
|
|
88
102
|
---
|
|
89
103
|
|
|
90
104
|
## Update Event Target
|
|
@@ -15,7 +15,8 @@
|
|
|
15
15
|
"response_code": 1,
|
|
16
16
|
"success": true,
|
|
17
17
|
"duration_ms": 1,
|
|
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
|
* `success` (boolean): `false` if HTTP Response Code is 4xx or 5xx
|
|
32
33
|
* `duration_ms` (int64): Duration (in milliseconds)
|
|
33
34
|
* `created_at` (date-time): Start Time of Action
|
|
35
|
+
* `log_type` (string): Log Type
|
|
34
36
|
|
|
35
37
|
|
|
36
38
|
---
|
|
@@ -51,3 +53,21 @@ Files::ExavaultApiRequestLog.list
|
|
|
51
53
|
* `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 ]`.
|
|
52
54
|
* `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 ]`.
|
|
53
55
|
* `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 ]`.
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Create an export CSV of Exavault API Request Log resources
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
Files::ExavaultApiRequestLog.create_export
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
* `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 ]`.
|
|
69
|
+
* `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 ]`.
|
|
70
|
+
* `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 ]`.
|
|
71
|
+
* `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 ]`.
|
|
72
|
+
* `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 ]`.
|
|
73
|
+
* `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 ]`.
|
data/docs/expectation.md
CHANGED
|
@@ -169,6 +169,20 @@ Files::Expectation.trigger_evaluation(id)
|
|
|
169
169
|
* `id` (int64): Required - Expectation ID.
|
|
170
170
|
|
|
171
171
|
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Create an export CSV of Expectation resources
|
|
175
|
+
|
|
176
|
+
```
|
|
177
|
+
Files::Expectation.create_export
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Parameters
|
|
181
|
+
|
|
182
|
+
* `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`.
|
|
183
|
+
* `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 ]`.
|
|
184
|
+
|
|
185
|
+
|
|
172
186
|
---
|
|
173
187
|
|
|
174
188
|
## Update Expectation
|
|
@@ -78,3 +78,17 @@ Files::ExpectationEvaluation.find(id)
|
|
|
78
78
|
### Parameters
|
|
79
79
|
|
|
80
80
|
* `id` (int64): Required - Expectation Evaluation ID.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Create an export CSV of Expectation Evaluation resources
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
Files::ExpectationEvaluation.create_export
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Parameters
|
|
92
|
+
|
|
93
|
+
* `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`.
|
|
94
|
+
* `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 ]`.
|
|
@@ -110,6 +110,20 @@ Files::ExpectationIncident.acknowledge(id)
|
|
|
110
110
|
* `id` (int64): Required - Expectation Incident ID.
|
|
111
111
|
|
|
112
112
|
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Create an export CSV of Expectation Incident resources
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
Files::ExpectationIncident.create_export
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Parameters
|
|
122
|
+
|
|
123
|
+
* `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`.
|
|
124
|
+
* `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 ]`.
|
|
125
|
+
|
|
126
|
+
|
|
113
127
|
---
|
|
114
128
|
|
|
115
129
|
## Resolve an expectation incident
|
data/docs/export.md
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Export
|
|
2
|
+
|
|
3
|
+
## Example Export Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"export_status": "example",
|
|
9
|
+
"export_type": "example",
|
|
10
|
+
"export_rows": 1,
|
|
11
|
+
"download_uri": "example",
|
|
12
|
+
"message": "example"
|
|
13
|
+
}
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
* `id` (int64): ID for this Export
|
|
17
|
+
* `export_status` (string): Status of the Export
|
|
18
|
+
* `export_type` (string): Type of data being exported
|
|
19
|
+
* `export_rows` (int64): Number of rows exported
|
|
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
|
+
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## List Exports
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
Files::Export.list(
|
|
31
|
+
user_id: 1
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
38
|
+
* `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.
|
|
39
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
40
|
+
* `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`.
|
|
41
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
|
|
42
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Show Export
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
Files::Export.find(id)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
* `id` (int64): Required - Export ID.
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Create Export
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
Files::Export.create(
|
|
64
|
+
user_id: 1,
|
|
65
|
+
export_type: "export_type"
|
|
66
|
+
)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
72
|
+
* `export_type` (string): Required - Export Report Type
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Create an export CSV of Export resources
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
Files::Export.create_export(
|
|
81
|
+
user_id: 1
|
|
82
|
+
)
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
88
|
+
* `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`.
|
|
89
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
|
|
90
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
|
data/docs/external_event.md
CHANGED
|
@@ -69,3 +69,21 @@ Files::ExternalEvent.create(
|
|
|
69
69
|
|
|
70
70
|
* `status` (string): Required - Status of event.
|
|
71
71
|
* `body` (string): Required - Event body
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Create an export CSV of External Event resources
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
Files::ExternalEvent.create_export
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Parameters
|
|
83
|
+
|
|
84
|
+
* `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`.
|
|
85
|
+
* `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 ]`.
|
|
86
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
87
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
88
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
89
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|