files.com 1.1.671 → 1.1.672
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/action_log.md +1 -21
- data/docs/action_notification_export_result.md +0 -17
- data/docs/ai_assistant_personality.md +0 -14
- data/docs/ai_task.md +0 -14
- data/docs/api_key.md +1 -27
- data/docs/api_request_log.md +1 -21
- data/docs/app.md +0 -15
- data/docs/as2_incoming_message.md +0 -18
- data/docs/as2_outgoing_message.md +0 -18
- data/docs/as2_partner.md +0 -14
- data/docs/as2_station.md +0 -14
- data/docs/automation.md +1 -22
- data/docs/automation_log.md +1 -21
- data/docs/automation_run.md +0 -19
- data/docs/bandwidth_snapshot.md +0 -18
- data/docs/behavior.md +0 -14
- data/docs/bundle.md +1 -50
- data/docs/bundle_action.md +0 -25
- data/docs/bundle_download.md +0 -23
- data/docs/bundle_notification.md +0 -19
- data/docs/bundle_recipient.md +0 -21
- data/docs/bundle_registration.md +0 -61
- data/docs/chat_session.md +2 -14
- data/docs/child_site_management_policy.md +0 -9
- data/docs/clickwrap.md +0 -13
- data/docs/custom_domain.md +0 -13
- data/docs/desktop_configuration_profile.md +0 -14
- data/docs/dns_record.md +0 -9
- data/docs/email_incoming_message.md +0 -19
- data/docs/email_log.md +1 -20
- data/docs/event_channel.md +0 -14
- data/docs/event_delivery_attempt.md +0 -14
- data/docs/event_record.md +0 -19
- data/docs/event_subscription.md +0 -14
- data/docs/event_target.md +0 -14
- data/docs/exavault_api_request_log.md +1 -21
- data/docs/expectation.md +0 -14
- data/docs/expectation_evaluation.md +0 -14
- data/docs/expectation_incident.md +0 -14
- data/docs/external_event.md +0 -18
- data/docs/file.md +2 -90
- data/docs/file_migration.md +0 -32
- data/docs/file_migration_log.md +1 -20
- data/docs/file_upload_part.md +1 -3
- data/docs/folder.md +0 -20
- data/docs/form_field_set.md +0 -15
- data/docs/ftp_action_log.md +1 -21
- data/docs/gpg_key.md +0 -21
- data/docs/group.md +0 -19
- data/docs/group_user.md +2 -22
- data/docs/history.md +0 -85
- data/docs/history_export_result.md +0 -17
- data/docs/holiday_region.md +0 -9
- data/docs/inbound_s3_log.md +1 -21
- data/docs/inbox_recipient.md +0 -19
- data/docs/inbox_registration.md +0 -57
- data/docs/inbox_upload.md +0 -18
- data/docs/invoice.md +0 -9
- data/docs/ip_address.md +0 -59
- data/docs/key_lifecycle_rule.md +0 -14
- data/docs/lock.md +0 -15
- data/docs/message.md +0 -17
- data/docs/message_comment.md +0 -18
- data/docs/message_comment_reaction.md +0 -18
- data/docs/message_reaction.md +0 -17
- data/docs/metadata_category.md +0 -13
- data/docs/notification.md +0 -20
- data/docs/outbound_connection_log.md +1 -21
- data/docs/partner.md +0 -14
- data/docs/partner_channel.md +0 -14
- data/docs/partner_site_request.md +0 -14
- data/docs/payment.md +0 -9
- data/docs/pending_work_event.md +0 -18
- data/docs/permission.md +0 -22
- data/docs/preview.md +0 -57
- data/docs/project.md +0 -9
- data/docs/public_hosting_request_log.md +1 -21
- data/docs/public_key.md +0 -21
- data/docs/remote_bandwidth_snapshot.md +0 -18
- data/docs/remote_mount_backend.md +0 -13
- data/docs/remote_server.md +0 -233
- data/docs/remote_server_credential.md +0 -15
- data/docs/request.md +0 -17
- data/docs/restore.md +0 -14
- data/docs/scheduled_export.md +0 -15
- data/docs/scim_log.md +0 -13
- data/docs/session.md +1 -232
- data/docs/settings_change.md +0 -16
- data/docs/sftp_action_log.md +1 -21
- data/docs/sftp_host_key.md +0 -9
- data/docs/share_group.md +0 -15
- data/docs/siem_http_destination.md +0 -9
- data/docs/siem_http_destination_event.md +0 -18
- data/docs/site.md +0 -179
- data/docs/site_subdomain_redirect.md +0 -13
- data/docs/snapshot.md +0 -9
- data/docs/sso_event.md +0 -19
- data/docs/sso_strategy.md +0 -406
- data/docs/sync.md +0 -14
- data/docs/sync_log.md +1 -20
- data/docs/sync_run.md +0 -21
- data/docs/usage_daily_snapshot.md +0 -18
- data/docs/usage_snapshot.md +0 -9
- data/docs/user.md +2 -49
- data/docs/user_cipher_use.md +0 -21
- data/docs/user_lifecycle_rule.md +0 -14
- data/docs/user_request.md +0 -9
- data/docs/user_security_event.md +0 -18
- data/docs/user_sftp_client_use.md +0 -15
- data/docs/web_dav_action_log.md +1 -21
- data/docs/workspace.md +0 -15
- data/lib/files.com/models/action_log.rb +0 -24
- data/lib/files.com/models/action_notification_export_result.rb +0 -12
- data/lib/files.com/models/ai_assistant_personality.rb +0 -11
- data/lib/files.com/models/ai_task.rb +0 -11
- data/lib/files.com/models/api_key.rb +5 -39
- data/lib/files.com/models/api_request_log.rb +0 -24
- data/lib/files.com/models/app.rb +0 -13
- data/lib/files.com/models/as2_incoming_message.rb +0 -19
- data/lib/files.com/models/as2_outgoing_message.rb +0 -19
- data/lib/files.com/models/as2_partner.rb +0 -11
- data/lib/files.com/models/as2_station.rb +0 -11
- data/lib/files.com/models/automation.rb +0 -30
- data/lib/files.com/models/automation_log.rb +0 -24
- data/lib/files.com/models/automation_run.rb +0 -16
- data/lib/files.com/models/bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/behavior.rb +0 -11
- data/lib/files.com/models/bundle.rb +0 -52
- data/lib/files.com/models/bundle_action.rb +0 -25
- data/lib/files.com/models/bundle_download.rb +0 -23
- data/lib/files.com/models/bundle_notification.rb +0 -15
- data/lib/files.com/models/bundle_recipient.rb +0 -27
- data/lib/files.com/models/bundle_registration.rb +0 -125
- data/lib/files.com/models/chat_session.rb +5 -11
- data/lib/files.com/models/child_site_management_policy.rb +0 -5
- data/lib/files.com/models/clickwrap.rb +0 -9
- data/lib/files.com/models/custom_domain.rb +0 -9
- data/lib/files.com/models/desktop_configuration_profile.rb +0 -11
- data/lib/files.com/models/dns_record.rb +0 -5
- data/lib/files.com/models/email_incoming_message.rb +0 -21
- data/lib/files.com/models/email_log.rb +0 -22
- data/lib/files.com/models/event_channel.rb +0 -11
- data/lib/files.com/models/event_delivery_attempt.rb +0 -11
- data/lib/files.com/models/event_record.rb +0 -21
- data/lib/files.com/models/event_subscription.rb +0 -11
- data/lib/files.com/models/event_target.rb +0 -11
- data/lib/files.com/models/exavault_api_request_log.rb +0 -24
- data/lib/files.com/models/expectation.rb +0 -11
- data/lib/files.com/models/expectation_evaluation.rb +0 -11
- data/lib/files.com/models/expectation_incident.rb +0 -11
- data/lib/files.com/models/external_event.rb +0 -19
- data/lib/files.com/models/file.rb +0 -207
- data/lib/files.com/models/file_migration.rb +0 -27
- data/lib/files.com/models/file_migration_log.rb +0 -22
- data/lib/files.com/models/file_upload_part.rb +0 -5
- data/lib/files.com/models/folder.rb +0 -69
- data/lib/files.com/models/form_field_set.rb +0 -9
- data/lib/files.com/models/ftp_action_log.rb +0 -24
- data/lib/files.com/models/gpg_key.rb +0 -21
- data/lib/files.com/models/group.rb +0 -16
- data/lib/files.com/models/group_user.rb +1 -21
- data/lib/files.com/models/history.rb +0 -94
- data/lib/files.com/models/history_export_result.rb +0 -12
- data/lib/files.com/models/holiday_region.rb +0 -5
- data/lib/files.com/models/inbound_s3_log.rb +0 -24
- data/lib/files.com/models/inbox_recipient.rb +0 -25
- data/lib/files.com/models/inbox_registration.rb +0 -121
- data/lib/files.com/models/inbox_upload.rb +0 -19
- data/lib/files.com/models/invoice.rb +0 -5
- data/lib/files.com/models/ip_address.rb +0 -37
- data/lib/files.com/models/key_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/lock.rb +0 -27
- data/lib/files.com/models/message.rb +0 -12
- data/lib/files.com/models/message_comment.rb +0 -14
- data/lib/files.com/models/message_comment_reaction.rb +0 -14
- data/lib/files.com/models/message_reaction.rb +0 -12
- data/lib/files.com/models/metadata_category.rb +0 -9
- data/lib/files.com/models/notification.rb +0 -18
- data/lib/files.com/models/outbound_connection_log.rb +0 -24
- data/lib/files.com/models/partner.rb +0 -11
- data/lib/files.com/models/partner_channel.rb +0 -11
- data/lib/files.com/models/partner_site_request.rb +0 -11
- data/lib/files.com/models/payment.rb +0 -5
- data/lib/files.com/models/pending_work_event.rb +0 -19
- data/lib/files.com/models/permission.rb +0 -22
- data/lib/files.com/models/preview.rb +0 -57
- data/lib/files.com/models/project.rb +0 -5
- data/lib/files.com/models/public_hosting_request_log.rb +0 -24
- data/lib/files.com/models/public_key.rb +0 -21
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +0 -19
- data/lib/files.com/models/remote_mount_backend.rb +0 -9
- data/lib/files.com/models/remote_server.rb +0 -297
- data/lib/files.com/models/remote_server_credential.rb +0 -13
- data/lib/files.com/models/request.rb +0 -12
- data/lib/files.com/models/restore.rb +0 -11
- data/lib/files.com/models/scheduled_export.rb +0 -13
- data/lib/files.com/models/scim_log.rb +0 -9
- data/lib/files.com/models/session.rb +0 -493
- data/lib/files.com/models/settings_change.rb +0 -16
- data/lib/files.com/models/sftp_action_log.rb +0 -24
- data/lib/files.com/models/sftp_host_key.rb +0 -5
- data/lib/files.com/models/share_group.rb +0 -9
- data/lib/files.com/models/siem_http_destination.rb +0 -5
- data/lib/files.com/models/siem_http_destination_event.rb +0 -19
- data/lib/files.com/models/site.rb +0 -1021
- data/lib/files.com/models/site_subdomain_redirect.rb +0 -9
- data/lib/files.com/models/snapshot.rb +0 -5
- data/lib/files.com/models/sso_event.rb +0 -21
- data/lib/files.com/models/sso_strategy.rb +0 -632
- data/lib/files.com/models/sync.rb +0 -11
- data/lib/files.com/models/sync_log.rb +0 -22
- data/lib/files.com/models/sync_run.rb +0 -21
- data/lib/files.com/models/usage_daily_snapshot.rb +0 -19
- data/lib/files.com/models/usage_snapshot.rb +0 -5
- data/lib/files.com/models/user.rb +0 -59
- data/lib/files.com/models/user_cipher_use.rb +0 -21
- data/lib/files.com/models/user_lifecycle_rule.rb +0 -11
- data/lib/files.com/models/user_request.rb +0 -5
- data/lib/files.com/models/user_security_event.rb +0 -19
- data/lib/files.com/models/user_sftp_client_use.rb +0 -9
- data/lib/files.com/models/web_dav_action_log.rb +0 -24
- data/lib/files.com/models/workspace.rb +0 -13
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- metadata +1 -119
- data/docs/account.md +0 -155
- data/docs/action_webhook_failure.md +0 -28
- data/docs/agent_proxy_identity.md +0 -49
- data/docs/agent_proxy_identity_endpoint.md +0 -11
- data/docs/agent_proxy_identity_result.md +0 -24
- data/docs/agent_v2_auth.md +0 -17
- data/docs/announcement.md +0 -57
- data/docs/blog_post.md +0 -57
- data/docs/bundle_recipient_registration.md +0 -39
- data/docs/certificate.md +0 -258
- data/docs/child_site.md +0 -583
- data/docs/clickwrap_acceptance.md +0 -30
- data/docs/client_log.md +0 -17
- data/docs/crash_report.md +0 -50
- data/docs/custom_domain_for_proxy.md +0 -23
- data/docs/email_preference.md +0 -108
- data/docs/email_preference_bundle_notification.md +0 -15
- data/docs/email_preference_notification.md +0 -17
- data/docs/export.md +0 -90
- data/docs/front_end_server.md +0 -111
- data/docs/frontend_metric.md +0 -34
- data/docs/inbox.md +0 -102
- data/docs/inbox_recipient_registration.md +0 -35
- data/docs/ip.md +0 -63
- data/docs/ip_abuse_entry.md +0 -47
- data/docs/label.md +0 -9
- data/docs/lead.md +0 -161
- data/docs/monitoring_stat.md +0 -38
- data/docs/monitoring_stats.md +0 -15
- data/docs/mover_package.md +0 -68
- data/docs/nps_response.md +0 -75
- data/docs/oauth_redirect.md +0 -11
- data/docs/paired_api_key.md +0 -19
- data/docs/paypal_express_info.md +0 -31
- data/docs/paypal_express_url.md +0 -11
- data/docs/plan.md +0 -107
- data/docs/public_hosting_session_pairing.md +0 -15
- data/docs/public_inbox.md +0 -121
- data/docs/public_url.md +0 -59
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +0 -83
- data/docs/release_package.md +0 -19
- data/docs/revision.md +0 -40
- data/docs/safe_plan.md +0 -0
- data/docs/session_available_site.md +0 -26
- data/docs/setting.md +0 -33
- data/docs/settings.md +0 -498
- data/docs/ssl_certificate.md +0 -37
- data/docs/staging_site.md +0 -591
- data/docs/support_request.md +0 -126
- data/docs/sync_api_usage_snapshot.md +0 -23
- data/docs/sync_api_usage_snapshot_report.md +0 -71
- data/docs/sync_bandwidth_snapshot.md +0 -48
- data/docs/two_factor_authentication_method.md +0 -169
- data/docs/warning.md +0 -36
- data/docs/webauthn_sign_request.md +0 -13
- data/docs/zip_download.md +0 -32
- data/docs/zip_download_file.md +0 -45
- data/docs/zip_download_files.md +0 -23
- data/lib/files.com/models/account.rb +0 -346
- data/lib/files.com/models/action_webhook_failure.rb +0 -34
- data/lib/files.com/models/agent_proxy_identity.rb +0 -47
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +0 -17
- data/lib/files.com/models/agent_proxy_identity_result.rb +0 -27
- data/lib/files.com/models/agent_v2_auth.rb +0 -32
- data/lib/files.com/models/announcement.rb +0 -89
- data/lib/files.com/models/blog_post.rb +0 -84
- data/lib/files.com/models/bundle_recipient_registration.rb +0 -105
- data/lib/files.com/models/certificate.rb +0 -455
- data/lib/files.com/models/child_site.rb +0 -1756
- data/lib/files.com/models/clickwrap_acceptance.rb +0 -56
- data/lib/files.com/models/client_log.rb +0 -25
- data/lib/files.com/models/crash_report.rb +0 -151
- data/lib/files.com/models/custom_domain_for_proxy.rb +0 -47
- data/lib/files.com/models/email_preference.rb +0 -124
- data/lib/files.com/models/email_preference_bundle_notification.rb +0 -27
- data/lib/files.com/models/email_preference_notification.rb +0 -32
- data/lib/files.com/models/export.rb +0 -153
- data/lib/files.com/models/front_end_server.rb +0 -335
- data/lib/files.com/models/frontend_metric.rb +0 -65
- data/lib/files.com/models/inbox.rb +0 -123
- data/lib/files.com/models/inbox_recipient_registration.rb +0 -87
- data/lib/files.com/models/ip.rb +0 -82
- data/lib/files.com/models/ip_abuse_entry.rb +0 -96
- data/lib/files.com/models/label.rb +0 -22
- data/lib/files.com/models/lead.rb +0 -434
- data/lib/files.com/models/monitoring_stat.rb +0 -43
- data/lib/files.com/models/monitoring_stats.rb +0 -22
- data/lib/files.com/models/mover_package.rb +0 -80
- data/lib/files.com/models/nps_response.rb +0 -128
- data/lib/files.com/models/oauth_redirect.rb +0 -17
- data/lib/files.com/models/paired_api_key.rb +0 -37
- data/lib/files.com/models/paypal_express_info.rb +0 -67
- data/lib/files.com/models/paypal_express_url.rb +0 -17
- data/lib/files.com/models/plan.rb +0 -209
- data/lib/files.com/models/public_hosting_session_pairing.rb +0 -27
- data/lib/files.com/models/public_inbox.rb +0 -142
- data/lib/files.com/models/public_url.rb +0 -177
- data/lib/files.com/models/regional_migration.rb +0 -12
- data/lib/files.com/models/release.rb +0 -153
- data/lib/files.com/models/release_package.rb +0 -37
- data/lib/files.com/models/revision.rb +0 -53
- data/lib/files.com/models/safe_plan.rb +0 -12
- data/lib/files.com/models/session_available_site.rb +0 -47
- data/lib/files.com/models/setting.rb +0 -36
- data/lib/files.com/models/settings.rb +0 -1072
- data/lib/files.com/models/ssl_certificate.rb +0 -77
- data/lib/files.com/models/staging_site.rb +0 -1781
- data/lib/files.com/models/support_request.rb +0 -209
- data/lib/files.com/models/sync_api_usage_snapshot.rb +0 -47
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +0 -162
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +0 -104
- data/lib/files.com/models/two_factor_authentication_method.rb +0 -250
- data/lib/files.com/models/warning.rb +0 -38
- data/lib/files.com/models/webauthn_sign_request.rb +0 -17
- data/lib/files.com/models/zip_download.rb +0 -73
- data/lib/files.com/models/zip_download_file.rb +0 -111
- data/lib/files.com/models/zip_download_files.rb +0 -42
data/docs/clickwrap.md
CHANGED
|
@@ -72,19 +72,6 @@ Files::Clickwrap.create(
|
|
|
72
72
|
* `use_with_users` (string): Use this Clickwrap for Users? Values: `none`, `require` (new user signup via email invitation only), `require_all_users_once` (show to all users at their next web login; once accepted, not shown again), `require_all_users_always` (show to all users on every web login).
|
|
73
73
|
|
|
74
74
|
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
## Create an export CSV of Clickwrap resources
|
|
78
|
-
|
|
79
|
-
```
|
|
80
|
-
Files::Clickwrap.create_export
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
### Parameters
|
|
84
|
-
|
|
85
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
86
|
-
|
|
87
|
-
|
|
88
75
|
---
|
|
89
76
|
|
|
90
77
|
## Update Clickwrap
|
data/docs/custom_domain.md
CHANGED
|
@@ -76,19 +76,6 @@ 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
|
-
|
|
92
79
|
---
|
|
93
80
|
|
|
94
81
|
## Update Custom Domain
|
|
@@ -75,20 +75,6 @@ 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
|
-
|
|
92
78
|
---
|
|
93
79
|
|
|
94
80
|
## Update Desktop Configuration Profile
|
data/docs/dns_record.md
CHANGED
|
@@ -29,12 +29,3 @@ 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,22 +46,3 @@ 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,8 +13,7 @@
|
|
|
13
13
|
"delivery_method": "example",
|
|
14
14
|
"smtp_hostname": "example",
|
|
15
15
|
"smtp_ip": "example",
|
|
16
|
-
"created_at": "2000-01-01T01:00:00Z"
|
|
17
|
-
"log_type": "example"
|
|
16
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
18
17
|
}
|
|
19
18
|
```
|
|
20
19
|
|
|
@@ -28,7 +27,6 @@
|
|
|
28
27
|
* `smtp_hostname` (string): Customer SMTP Hostname used.
|
|
29
28
|
* `smtp_ip` (string): Customer SMTP IP address as resolved for use (useful for troubleshooting DNS issues with customer SMTP).
|
|
30
29
|
* `created_at` (date-time): Start Time of Action
|
|
31
|
-
* `log_type` (string): Log Type
|
|
32
30
|
|
|
33
31
|
|
|
34
32
|
---
|
|
@@ -48,20 +46,3 @@ Files::EmailLog.list
|
|
|
48
46
|
* `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 ]`.
|
|
49
47
|
* `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 ]`.
|
|
50
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`. 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 ]`.
|
data/docs/event_channel.md
CHANGED
|
@@ -77,20 +77,6 @@ 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
|
-
|
|
94
80
|
---
|
|
95
81
|
|
|
96
82
|
## Update Event Channel
|
|
@@ -66,17 +66,3 @@ 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,22 +75,3 @@ 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,20 +96,6 @@ 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
|
-
|
|
113
99
|
---
|
|
114
100
|
|
|
115
101
|
## Update Event Subscription
|
data/docs/event_target.md
CHANGED
|
@@ -85,20 +85,6 @@ 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
|
-
|
|
102
88
|
---
|
|
103
89
|
|
|
104
90
|
## Update Event Target
|
|
@@ -15,8 +15,7 @@
|
|
|
15
15
|
"response_code": 1,
|
|
16
16
|
"success": true,
|
|
17
17
|
"duration_ms": 1,
|
|
18
|
-
"created_at": "2000-01-01T01:00:00Z"
|
|
19
|
-
"log_type": "example"
|
|
18
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
20
19
|
}
|
|
21
20
|
```
|
|
22
21
|
|
|
@@ -32,7 +31,6 @@
|
|
|
32
31
|
* `success` (boolean): `false` if HTTP Response Code is 4xx or 5xx
|
|
33
32
|
* `duration_ms` (int64): Duration (in milliseconds)
|
|
34
33
|
* `created_at` (date-time): Start Time of Action
|
|
35
|
-
* `log_type` (string): Log Type
|
|
36
34
|
|
|
37
35
|
|
|
38
36
|
---
|
|
@@ -53,21 +51,3 @@ Files::ExavaultApiRequestLog.list
|
|
|
53
51
|
* `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 ]`.
|
|
54
52
|
* `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 ]`.
|
|
55
53
|
* `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,20 +169,6 @@ 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
|
-
|
|
186
172
|
---
|
|
187
173
|
|
|
188
174
|
## Update Expectation
|
|
@@ -78,17 +78,3 @@ 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,20 +110,6 @@ 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
|
-
|
|
127
113
|
---
|
|
128
114
|
|
|
129
115
|
## Resolve an expectation incident
|
data/docs/external_event.md
CHANGED
|
@@ -69,21 +69,3 @@ 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`.
|
data/docs/file.md
CHANGED
|
@@ -7,9 +7,7 @@ may places where a Ruby File object can be used.
|
|
|
7
7
|
|
|
8
8
|
```
|
|
9
9
|
{
|
|
10
|
-
"id": 1,
|
|
11
10
|
"path": "path/file.txt",
|
|
12
|
-
"path_absolute": "path/file.txt",
|
|
13
11
|
"created_by_id": 1,
|
|
14
12
|
"created_by_api_key_id": 1,
|
|
15
13
|
"created_by_as2_incoming_message_id": 1,
|
|
@@ -42,14 +40,6 @@ may places where a Ruby File object can be used.
|
|
|
42
40
|
"permissions": "rwd",
|
|
43
41
|
"subfolders_locked?": true,
|
|
44
42
|
"is_locked": true,
|
|
45
|
-
"remote_server_id": 1,
|
|
46
|
-
"headers": {
|
|
47
|
-
"key": "example value"
|
|
48
|
-
},
|
|
49
|
-
"socks_ips": [
|
|
50
|
-
"example"
|
|
51
|
-
],
|
|
52
|
-
"internal_download_uri": "example",
|
|
53
43
|
"download_uri": "https://mysite.files.com/...",
|
|
54
44
|
"priority_color": "red",
|
|
55
45
|
"preview_id": 1,
|
|
@@ -63,9 +53,7 @@ may places where a Ruby File object can be used.
|
|
|
63
53
|
}
|
|
64
54
|
```
|
|
65
55
|
|
|
66
|
-
* `id` (int64): File/Folder ID. Used only for ExaVault compatibility API. Do not use for other purposes, as this value will not always be set.
|
|
67
56
|
* `path` (string): File/Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
68
|
-
* `path_absolute` (string): File/Folder absolute path for Bundle Trusted Relay use
|
|
69
57
|
* `created_by_id` (int64): User ID of the User who created the file/folder
|
|
70
58
|
* `created_by_api_key_id` (int64): ID of the API key that created the file/folder
|
|
71
59
|
* `created_by_as2_incoming_message_id` (int64): ID of the AS2 Incoming Message that created the file/folder
|
|
@@ -96,33 +84,20 @@ may places where a Ruby File object can be used.
|
|
|
96
84
|
* `permissions` (string): A short string representing the current user's permissions. Can be `r` (Read),`w` (Write),`d` (Delete), `l` (List) or any combination
|
|
97
85
|
* `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
|
|
98
86
|
* `is_locked` (boolean): Is this folder locked and unable to be modified?
|
|
99
|
-
* `remote_server_id` (int64): Used for internal bandwidth tracking
|
|
100
|
-
* `headers` (object): Used for internal url management
|
|
101
|
-
* `socks_ips` (array(string)): Used for internal url management
|
|
102
|
-
* `internal_download_uri` (string): For use with internal services and should also be with headers and socks_ips
|
|
103
87
|
* `download_uri` (string): Link to download file. Provided only in response to a download request.
|
|
104
88
|
* `priority_color` (string): Bookmark/priority color of file/folder
|
|
105
89
|
* `preview_id` (int64): File preview ID
|
|
106
90
|
* `preview` (Preview): File preview
|
|
107
|
-
* `copy_destination` (string):
|
|
108
|
-
* `move_destination` (string):
|
|
109
91
|
* `action` (string): The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
|
110
|
-
* `action_attributes` (object): Attributes to pass through for recording the Action. Used for overriding action types (i.e. representing copy/move)
|
|
111
|
-
* `file` (object):
|
|
112
|
-
* `crc32b` (string):
|
|
113
92
|
* `length` (int64): Length of file.
|
|
114
93
|
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
|
115
|
-
* `overwrite` (boolean): Overwrite existing file(s) in the destination?
|
|
116
94
|
* `part` (int64): Part if uploading a part.
|
|
117
95
|
* `parts` (int64): How many parts to fetch?
|
|
118
|
-
* `prefer_spdy` (boolean):
|
|
119
96
|
* `ref` (string):
|
|
120
97
|
* `restart` (int64): File byte offset to restart from.
|
|
121
98
|
* `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
122
99
|
* `structure` (string): If copying folder, copy just the structure?
|
|
123
100
|
* `with_rename` (boolean): Allow file rename instead of overwrite?
|
|
124
|
-
* `inbox_registration_code` (string):
|
|
125
|
-
* `bundle_registration_code` (string):
|
|
126
101
|
* `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
|
|
127
102
|
|
|
128
103
|
|
|
@@ -132,10 +107,8 @@ may places where a Ruby File object can be used.
|
|
|
132
107
|
|
|
133
108
|
```
|
|
134
109
|
Files::File.download(path,
|
|
135
|
-
prefer_spdy: false,
|
|
136
110
|
with_previews: false,
|
|
137
|
-
with_priority_color: false
|
|
138
|
-
full_document_preview: false
|
|
111
|
+
with_priority_color: false
|
|
139
112
|
)
|
|
140
113
|
```
|
|
141
114
|
|
|
@@ -143,12 +116,9 @@ Files::File.download(path,
|
|
|
143
116
|
|
|
144
117
|
* `path` (string): Required - Path to operate on.
|
|
145
118
|
* `action` (string): Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
|
|
146
|
-
* `bundle_registration_code` (string):
|
|
147
|
-
* `prefer_spdy` (boolean):
|
|
148
119
|
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
149
120
|
* `with_previews` (boolean): Include file preview information?
|
|
150
121
|
* `with_priority_color` (boolean): Include file priority color information?
|
|
151
|
-
* `full_document_preview` (boolean): If true, always return a proxied download uri
|
|
152
122
|
|
|
153
123
|
|
|
154
124
|
---
|
|
@@ -157,18 +127,12 @@ Files::File.download(path,
|
|
|
157
127
|
|
|
158
128
|
```
|
|
159
129
|
Files::File.create(path,
|
|
160
|
-
crc32: "70976923",
|
|
161
130
|
length: 1,
|
|
162
|
-
md5: "17c54824e9931a4688ca032d03f6663c",
|
|
163
131
|
mkdir_parents: false,
|
|
164
|
-
overwrite: false,
|
|
165
132
|
part: 1,
|
|
166
133
|
parts: 1,
|
|
167
|
-
prefer_spdy: false,
|
|
168
134
|
provided_mtime: "2000-01-01T01:00:00Z",
|
|
169
135
|
restart: 1,
|
|
170
|
-
sha1: "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
|
|
171
|
-
sha256: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
|
|
172
136
|
size: 1,
|
|
173
137
|
copy_behaviors: false,
|
|
174
138
|
with_rename: false,
|
|
@@ -179,33 +143,20 @@ Files::File.create(path,
|
|
|
179
143
|
### Parameters
|
|
180
144
|
|
|
181
145
|
* `path` (string): Required - Path to operate on.
|
|
182
|
-
* `copy_destination` (string):
|
|
183
|
-
* `move_destination` (string):
|
|
184
146
|
* `action` (string): The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
|
185
|
-
* `action_attributes` (object): Attributes to pass through for recording the Action. Used for overriding action types (i.e. representing copy/move)
|
|
186
|
-
* `file` (object):
|
|
187
|
-
* `crc32` (string):
|
|
188
|
-
* `crc32b` (string):
|
|
189
147
|
* `etags[etag]` (array(string)): etag identifier.
|
|
190
148
|
* `etags[part]` (array(int64)): Part number.
|
|
191
149
|
* `length` (int64): Length of file.
|
|
192
|
-
* `md5` (string):
|
|
193
150
|
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
|
194
|
-
* `overwrite` (boolean): Overwrite existing file(s) in the destination?
|
|
195
151
|
* `part` (int64): Part if uploading a part.
|
|
196
152
|
* `parts` (int64): How many parts to fetch?
|
|
197
|
-
* `prefer_spdy` (boolean):
|
|
198
153
|
* `provided_mtime` (string): User provided modification time.
|
|
199
154
|
* `ref` (string):
|
|
200
155
|
* `restart` (int64): File byte offset to restart from.
|
|
201
|
-
* `sha1` (string):
|
|
202
|
-
* `sha256` (string):
|
|
203
156
|
* `size` (int64): Size of file.
|
|
204
157
|
* `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
205
158
|
* `structure` (string): If copying folder, copy just the structure?
|
|
206
159
|
* `with_rename` (boolean): Allow file rename instead of overwrite?
|
|
207
|
-
* `inbox_registration_code` (string):
|
|
208
|
-
* `bundle_registration_code` (string):
|
|
209
160
|
* `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
|
|
210
161
|
|
|
211
162
|
|
|
@@ -243,26 +194,6 @@ Files::File.delete(path,
|
|
|
243
194
|
|
|
244
195
|
* `path` (string): Required - Path to operate on.
|
|
245
196
|
* `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
|
246
|
-
* `bundle_registration_code` (string):
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
---
|
|
250
|
-
|
|
251
|
-
## Find File/Folder by ID
|
|
252
|
-
|
|
253
|
-
```
|
|
254
|
-
Files::File.find_id(id,
|
|
255
|
-
with_previews: false,
|
|
256
|
-
with_priority_color: false
|
|
257
|
-
)
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
### Parameters
|
|
261
|
-
|
|
262
|
-
* `id` (int64): Required - File/Folder ID
|
|
263
|
-
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
264
|
-
* `with_previews` (boolean): Include file preview information?
|
|
265
|
-
* `with_priority_color` (boolean): Include file priority color information?
|
|
266
197
|
|
|
267
198
|
|
|
268
199
|
---
|
|
@@ -282,7 +213,6 @@ Files::File.find(path,
|
|
|
282
213
|
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
283
214
|
* `with_previews` (boolean): Include file preview information?
|
|
284
215
|
* `with_priority_color` (boolean): Include file priority color information?
|
|
285
|
-
* `bundle_registration_code` (string):
|
|
286
216
|
|
|
287
217
|
|
|
288
218
|
---
|
|
@@ -318,7 +248,6 @@ Files::File.copy(path,
|
|
|
318
248
|
* `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
319
249
|
* `structure` (boolean): Copy structure only?
|
|
320
250
|
* `overwrite` (boolean): Overwrite existing file(s) in the destination?
|
|
321
|
-
* `bundle_registration_code` (string):
|
|
322
251
|
|
|
323
252
|
|
|
324
253
|
---
|
|
@@ -337,7 +266,6 @@ Files::File.move(path,
|
|
|
337
266
|
* `path` (string): Required - Path to operate on.
|
|
338
267
|
* `destination` (string): Required - Move destination path.
|
|
339
268
|
* `overwrite` (boolean): Overwrite existing file(s) in the destination?
|
|
340
|
-
* `bundle_registration_code` (string):
|
|
341
269
|
|
|
342
270
|
|
|
343
271
|
---
|
|
@@ -464,7 +392,6 @@ Files::File.begin_upload(path,
|
|
|
464
392
|
mkdir_parents: false,
|
|
465
393
|
part: 1,
|
|
466
394
|
parts: 1,
|
|
467
|
-
prefer_spdy: false,
|
|
468
395
|
ref: "upload-1",
|
|
469
396
|
restart: 1,
|
|
470
397
|
size: 1,
|
|
@@ -479,13 +406,10 @@ Files::File.begin_upload(path,
|
|
|
479
406
|
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
|
480
407
|
* `part` (int64): Part if uploading a part.
|
|
481
408
|
* `parts` (int64): How many parts to fetch?
|
|
482
|
-
* `prefer_spdy` (boolean):
|
|
483
409
|
* `ref` (string):
|
|
484
410
|
* `restart` (int64): File byte offset to restart from.
|
|
485
411
|
* `size` (int64): Total bytes of file being uploaded (include bytes being retained if appending/restarting).
|
|
486
412
|
* `with_rename` (boolean): Allow file rename instead of overwrite?
|
|
487
|
-
* `action` (string):
|
|
488
|
-
* `bundle_registration_code` (string):
|
|
489
413
|
* `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
|
|
490
414
|
|
|
491
415
|
|
|
@@ -497,10 +421,8 @@ Files::File.begin_upload(path,
|
|
|
497
421
|
file = Files::File.find(path)
|
|
498
422
|
|
|
499
423
|
file.download(
|
|
500
|
-
prefer_spdy: false,
|
|
501
424
|
with_previews: false,
|
|
502
|
-
with_priority_color: false
|
|
503
|
-
full_document_preview: false
|
|
425
|
+
with_priority_color: false
|
|
504
426
|
)
|
|
505
427
|
```
|
|
506
428
|
|
|
@@ -508,12 +430,9 @@ file.download(
|
|
|
508
430
|
|
|
509
431
|
* `path` (string): Required - Path to operate on.
|
|
510
432
|
* `action` (string): Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
|
|
511
|
-
* `bundle_registration_code` (string):
|
|
512
|
-
* `prefer_spdy` (boolean):
|
|
513
433
|
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
514
434
|
* `with_previews` (boolean): Include file preview information?
|
|
515
435
|
* `with_priority_color` (boolean): Include file priority color information?
|
|
516
|
-
* `full_document_preview` (boolean): If true, always return a proxied download uri
|
|
517
436
|
|
|
518
437
|
|
|
519
438
|
---
|
|
@@ -554,7 +473,6 @@ file.delete(
|
|
|
554
473
|
|
|
555
474
|
* `path` (string): Required - Path to operate on.
|
|
556
475
|
* `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
|
557
|
-
* `bundle_registration_code` (string):
|
|
558
476
|
|
|
559
477
|
|
|
560
478
|
---
|
|
@@ -594,7 +512,6 @@ file.copy(
|
|
|
594
512
|
* `copy_behaviors` (boolean): If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
595
513
|
* `structure` (boolean): Copy structure only?
|
|
596
514
|
* `overwrite` (boolean): Overwrite existing file(s) in the destination?
|
|
597
|
-
* `bundle_registration_code` (string):
|
|
598
515
|
|
|
599
516
|
|
|
600
517
|
---
|
|
@@ -615,7 +532,6 @@ file.move(
|
|
|
615
532
|
* `path` (string): Required - Path to operate on.
|
|
616
533
|
* `destination` (string): Required - Move destination path.
|
|
617
534
|
* `overwrite` (boolean): Overwrite existing file(s) in the destination?
|
|
618
|
-
* `bundle_registration_code` (string):
|
|
619
535
|
|
|
620
536
|
|
|
621
537
|
---
|
|
@@ -733,7 +649,6 @@ file.begin_upload(
|
|
|
733
649
|
mkdir_parents: false,
|
|
734
650
|
part: 1,
|
|
735
651
|
parts: 1,
|
|
736
|
-
prefer_spdy: false,
|
|
737
652
|
ref: "upload-1",
|
|
738
653
|
restart: 1,
|
|
739
654
|
size: 1,
|
|
@@ -748,11 +663,8 @@ file.begin_upload(
|
|
|
748
663
|
* `mkdir_parents` (boolean): Create parent directories if they do not exist?
|
|
749
664
|
* `part` (int64): Part if uploading a part.
|
|
750
665
|
* `parts` (int64): How many parts to fetch?
|
|
751
|
-
* `prefer_spdy` (boolean):
|
|
752
666
|
* `ref` (string):
|
|
753
667
|
* `restart` (int64): File byte offset to restart from.
|
|
754
668
|
* `size` (int64): Total bytes of file being uploaded (include bytes being retained if appending/restarting).
|
|
755
669
|
* `with_rename` (boolean): Allow file rename instead of overwrite?
|
|
756
|
-
* `action` (string):
|
|
757
|
-
* `bundle_registration_code` (string):
|
|
758
670
|
* `buffered_upload` (boolean): If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
|