files.com 1.1.671 → 1.1.673
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 +67 -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/path_util.rb +1 -1
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +0 -59
- data/shared/normalization_for_comparison_test_data.json +3 -1
- data/spec/models/file_underscore_destinations_spec.rb +24 -0
- data/spec/path_util_spec.rb +5 -0
- metadata +2 -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
|
@@ -38,6 +38,49 @@ module Files
|
|
|
38
38
|
new(path).download_file(local_path)
|
|
39
39
|
end
|
|
40
40
|
|
|
41
|
+
private_class_method def self.underscore_destination_path(root, id, relative_path = nil)
|
|
42
|
+
PathUtil.normalize("_", root, id.to_s, relative_path)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
def self.upload_to_remote_server(path, remote_server_id, destination = nil, options = {}, params: {})
|
|
46
|
+
destination ||= ::File.basename(path)
|
|
47
|
+
upload_file(path, underscore_destination_path("RemoteServers", remote_server_id, destination), options, params: params)
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
def self.copy_to_remote_server(path, remote_server_id, destination, params = {}, options = {})
|
|
51
|
+
copy(path, params.merge(destination: underscore_destination_path("RemoteServers", remote_server_id, destination)), options)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
def self.move_to_remote_server(path, remote_server_id, destination, params = {}, options = {})
|
|
55
|
+
move(path, params.merge(destination: underscore_destination_path("RemoteServers", remote_server_id, destination)), options)
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
def self.upload_to_snapshot(path, snapshot_id, destination = nil, options = {}, params: {})
|
|
59
|
+
destination ||= ::File.basename(path)
|
|
60
|
+
upload_file(path, underscore_destination_path("Snapshots", snapshot_id, destination), options, params: params)
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
def self.copy_to_snapshot(path, snapshot_id, destination, params = {}, options = {})
|
|
64
|
+
copy(path, params.merge(destination: underscore_destination_path("Snapshots", snapshot_id, destination)), options)
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
def self.move_to_snapshot(path, snapshot_id, destination, params = {}, options = {})
|
|
68
|
+
move(path, params.merge(destination: underscore_destination_path("Snapshots", snapshot_id, destination)), options)
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def self.upload_to_child_site(path, site_id, destination = nil, options = {}, params: {})
|
|
72
|
+
destination ||= ::File.basename(path)
|
|
73
|
+
upload_file(path, underscore_destination_path("Sites", site_id, destination), options, params: params)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
def self.copy_to_child_site(path, site_id, destination, params = {}, options = {})
|
|
77
|
+
copy(path, params.merge(destination: underscore_destination_path("Sites", site_id, destination)), options)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def self.move_to_child_site(path, site_id, destination, params = {}, options = {})
|
|
81
|
+
move(path, params.merge(destination: underscore_destination_path("Sites", site_id, destination)), options)
|
|
82
|
+
end
|
|
83
|
+
|
|
41
84
|
def self.exist?(path, options = {})
|
|
42
85
|
find(path, {}, options)
|
|
43
86
|
true
|
|
@@ -187,6 +230,30 @@ module Files
|
|
|
187
230
|
@bytes_written = 0
|
|
188
231
|
end
|
|
189
232
|
|
|
233
|
+
def copy_to_remote_server(remote_server_id, destination, params = {})
|
|
234
|
+
self.class.copy_to_remote_server(path, remote_server_id, destination, params, @options)
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
def move_to_remote_server(remote_server_id, destination, params = {})
|
|
238
|
+
self.class.move_to_remote_server(path, remote_server_id, destination, params, @options)
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
def copy_to_snapshot(snapshot_id, destination, params = {})
|
|
242
|
+
self.class.copy_to_snapshot(path, snapshot_id, destination, params, @options)
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
def move_to_snapshot(snapshot_id, destination, params = {})
|
|
246
|
+
self.class.move_to_snapshot(path, snapshot_id, destination, params, @options)
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
def copy_to_child_site(site_id, destination, params = {})
|
|
250
|
+
self.class.copy_to_child_site(path, site_id, destination, params, @options)
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
def move_to_child_site(site_id, destination, params = {})
|
|
254
|
+
self.class.move_to_child_site(path, site_id, destination, params, @options)
|
|
255
|
+
end
|
|
256
|
+
|
|
190
257
|
def advise(*_args); end
|
|
191
258
|
|
|
192
259
|
def atime
|
|
@@ -566,15 +633,6 @@ module Files
|
|
|
566
633
|
@write_io.write_nonblock *args
|
|
567
634
|
end
|
|
568
635
|
|
|
569
|
-
# int64 - File/Folder ID. Used only for ExaVault compatibility API. Do not use for other purposes, as this value will not always be set.
|
|
570
|
-
def id
|
|
571
|
-
@attributes[:id]
|
|
572
|
-
end
|
|
573
|
-
|
|
574
|
-
def id=(value)
|
|
575
|
-
@attributes[:id] = value
|
|
576
|
-
end
|
|
577
|
-
|
|
578
636
|
# string - File/Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
579
637
|
def path
|
|
580
638
|
@attributes[:path]
|
|
@@ -584,15 +642,6 @@ module Files
|
|
|
584
642
|
@attributes[:path] = value
|
|
585
643
|
end
|
|
586
644
|
|
|
587
|
-
# string - File/Folder absolute path for Bundle Trusted Relay use
|
|
588
|
-
def path_absolute
|
|
589
|
-
@attributes[:path_absolute]
|
|
590
|
-
end
|
|
591
|
-
|
|
592
|
-
def path_absolute=(value)
|
|
593
|
-
@attributes[:path_absolute] = value
|
|
594
|
-
end
|
|
595
|
-
|
|
596
645
|
# int64 - User ID of the User who created the file/folder
|
|
597
646
|
def created_by_id
|
|
598
647
|
@attributes[:created_by_id]
|
|
@@ -859,42 +908,6 @@ module Files
|
|
|
859
908
|
@attributes[:is_locked] = value
|
|
860
909
|
end
|
|
861
910
|
|
|
862
|
-
# int64 - Used for internal bandwidth tracking
|
|
863
|
-
def remote_server_id
|
|
864
|
-
@attributes[:remote_server_id]
|
|
865
|
-
end
|
|
866
|
-
|
|
867
|
-
def remote_server_id=(value)
|
|
868
|
-
@attributes[:remote_server_id] = value
|
|
869
|
-
end
|
|
870
|
-
|
|
871
|
-
# object - Used for internal url management
|
|
872
|
-
def headers
|
|
873
|
-
@attributes[:headers]
|
|
874
|
-
end
|
|
875
|
-
|
|
876
|
-
def headers=(value)
|
|
877
|
-
@attributes[:headers] = value
|
|
878
|
-
end
|
|
879
|
-
|
|
880
|
-
# array(string) - Used for internal url management
|
|
881
|
-
def socks_ips
|
|
882
|
-
@attributes[:socks_ips]
|
|
883
|
-
end
|
|
884
|
-
|
|
885
|
-
def socks_ips=(value)
|
|
886
|
-
@attributes[:socks_ips] = value
|
|
887
|
-
end
|
|
888
|
-
|
|
889
|
-
# string - For use with internal services and should also be with headers and socks_ips
|
|
890
|
-
def internal_download_uri
|
|
891
|
-
@attributes[:internal_download_uri]
|
|
892
|
-
end
|
|
893
|
-
|
|
894
|
-
def internal_download_uri=(value)
|
|
895
|
-
@attributes[:internal_download_uri] = value
|
|
896
|
-
end
|
|
897
|
-
|
|
898
911
|
# string - Link to download file. Provided only in response to a download request.
|
|
899
912
|
def download_uri
|
|
900
913
|
@attributes[:download_uri]
|
|
@@ -931,24 +944,6 @@ module Files
|
|
|
931
944
|
@attributes[:preview] = value
|
|
932
945
|
end
|
|
933
946
|
|
|
934
|
-
# string
|
|
935
|
-
def copy_destination
|
|
936
|
-
@attributes[:copy_destination]
|
|
937
|
-
end
|
|
938
|
-
|
|
939
|
-
def copy_destination=(value)
|
|
940
|
-
@attributes[:copy_destination] = value
|
|
941
|
-
end
|
|
942
|
-
|
|
943
|
-
# string
|
|
944
|
-
def move_destination
|
|
945
|
-
@attributes[:move_destination]
|
|
946
|
-
end
|
|
947
|
-
|
|
948
|
-
def move_destination=(value)
|
|
949
|
-
@attributes[:move_destination] = value
|
|
950
|
-
end
|
|
951
|
-
|
|
952
947
|
# string - The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
|
953
948
|
def action
|
|
954
949
|
@attributes[:action]
|
|
@@ -958,33 +953,6 @@ module Files
|
|
|
958
953
|
@attributes[:action] = value
|
|
959
954
|
end
|
|
960
955
|
|
|
961
|
-
# object - Attributes to pass through for recording the Action. Used for overriding action types (i.e. representing copy/move)
|
|
962
|
-
def action_attributes
|
|
963
|
-
@attributes[:action_attributes]
|
|
964
|
-
end
|
|
965
|
-
|
|
966
|
-
def action_attributes=(value)
|
|
967
|
-
@attributes[:action_attributes] = value
|
|
968
|
-
end
|
|
969
|
-
|
|
970
|
-
# object
|
|
971
|
-
def file
|
|
972
|
-
@attributes[:file]
|
|
973
|
-
end
|
|
974
|
-
|
|
975
|
-
def file=(value)
|
|
976
|
-
@attributes[:file] = value
|
|
977
|
-
end
|
|
978
|
-
|
|
979
|
-
# string
|
|
980
|
-
def crc32b
|
|
981
|
-
@attributes[:crc32b]
|
|
982
|
-
end
|
|
983
|
-
|
|
984
|
-
def crc32b=(value)
|
|
985
|
-
@attributes[:crc32b] = value
|
|
986
|
-
end
|
|
987
|
-
|
|
988
956
|
# int64 - Length of file.
|
|
989
957
|
def length
|
|
990
958
|
@attributes[:length]
|
|
@@ -1003,15 +971,6 @@ module Files
|
|
|
1003
971
|
@attributes[:mkdir_parents] = value
|
|
1004
972
|
end
|
|
1005
973
|
|
|
1006
|
-
# boolean - Overwrite existing file(s) in the destination?
|
|
1007
|
-
def overwrite
|
|
1008
|
-
@attributes[:overwrite]
|
|
1009
|
-
end
|
|
1010
|
-
|
|
1011
|
-
def overwrite=(value)
|
|
1012
|
-
@attributes[:overwrite] = value
|
|
1013
|
-
end
|
|
1014
|
-
|
|
1015
974
|
# int64 - Part if uploading a part.
|
|
1016
975
|
def part
|
|
1017
976
|
@attributes[:part]
|
|
@@ -1030,15 +989,6 @@ module Files
|
|
|
1030
989
|
@attributes[:parts] = value
|
|
1031
990
|
end
|
|
1032
991
|
|
|
1033
|
-
# boolean
|
|
1034
|
-
def prefer_spdy
|
|
1035
|
-
@attributes[:prefer_spdy]
|
|
1036
|
-
end
|
|
1037
|
-
|
|
1038
|
-
def prefer_spdy=(value)
|
|
1039
|
-
@attributes[:prefer_spdy] = value
|
|
1040
|
-
end
|
|
1041
|
-
|
|
1042
992
|
# string -
|
|
1043
993
|
def ref
|
|
1044
994
|
@attributes[:ref]
|
|
@@ -1084,24 +1034,6 @@ module Files
|
|
|
1084
1034
|
@attributes[:with_rename] = value
|
|
1085
1035
|
end
|
|
1086
1036
|
|
|
1087
|
-
# string
|
|
1088
|
-
def inbox_registration_code
|
|
1089
|
-
@attributes[:inbox_registration_code]
|
|
1090
|
-
end
|
|
1091
|
-
|
|
1092
|
-
def inbox_registration_code=(value)
|
|
1093
|
-
@attributes[:inbox_registration_code] = value
|
|
1094
|
-
end
|
|
1095
|
-
|
|
1096
|
-
# string
|
|
1097
|
-
def bundle_registration_code
|
|
1098
|
-
@attributes[:bundle_registration_code]
|
|
1099
|
-
end
|
|
1100
|
-
|
|
1101
|
-
def bundle_registration_code=(value)
|
|
1102
|
-
@attributes[:bundle_registration_code] = value
|
|
1103
|
-
end
|
|
1104
|
-
|
|
1105
1037
|
# 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.
|
|
1106
1038
|
def buffered_upload
|
|
1107
1039
|
@attributes[:buffered_upload]
|
|
@@ -1115,19 +1047,15 @@ module Files
|
|
|
1115
1047
|
#
|
|
1116
1048
|
# Parameters:
|
|
1117
1049
|
# 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.
|
|
1118
|
-
# bundle_registration_code - string
|
|
1119
|
-
# prefer_spdy - boolean
|
|
1120
1050
|
# preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
1121
1051
|
# with_previews - boolean - Include file preview information?
|
|
1122
1052
|
# with_priority_color - boolean - Include file priority color information?
|
|
1123
|
-
# full_document_preview - boolean - If true, always return a proxied download uri
|
|
1124
1053
|
def download(params = {})
|
|
1125
1054
|
params ||= {}
|
|
1126
1055
|
params[:path] = @attributes[:path]
|
|
1127
1056
|
raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
|
|
1128
1057
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1129
1058
|
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
|
1130
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1131
1059
|
raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
|
|
1132
1060
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1133
1061
|
|
|
@@ -1152,13 +1080,11 @@ module Files
|
|
|
1152
1080
|
|
|
1153
1081
|
# Parameters:
|
|
1154
1082
|
# recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
|
1155
|
-
# bundle_registration_code - string
|
|
1156
1083
|
def delete(params = {})
|
|
1157
1084
|
params ||= {}
|
|
1158
1085
|
params[:path] = @attributes[:path]
|
|
1159
1086
|
raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
|
|
1160
1087
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1161
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1162
1088
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1163
1089
|
|
|
1164
1090
|
Api.send_request("/files/#{@attributes[:path]}", :delete, params, @options)
|
|
@@ -1187,14 +1113,12 @@ module Files
|
|
|
1187
1113
|
# copy_behaviors - boolean - If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
1188
1114
|
# structure - boolean - Copy structure only?
|
|
1189
1115
|
# overwrite - boolean - Overwrite existing file(s) in the destination?
|
|
1190
|
-
# bundle_registration_code - string
|
|
1191
1116
|
def copy(params = {})
|
|
1192
1117
|
params ||= {}
|
|
1193
1118
|
params[:path] = @attributes[:path]
|
|
1194
1119
|
raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
|
|
1195
1120
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1196
1121
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
|
|
1197
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1198
1122
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1199
1123
|
raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
|
|
1200
1124
|
|
|
@@ -1206,14 +1130,12 @@ module Files
|
|
|
1206
1130
|
# Parameters:
|
|
1207
1131
|
# destination (required) - string - Move destination path.
|
|
1208
1132
|
# overwrite - boolean - Overwrite existing file(s) in the destination?
|
|
1209
|
-
# bundle_registration_code - string
|
|
1210
1133
|
def move(params = {})
|
|
1211
1134
|
params ||= {}
|
|
1212
1135
|
params[:path] = @attributes[:path]
|
|
1213
1136
|
raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
|
|
1214
1137
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1215
1138
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
|
|
1216
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1217
1139
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1218
1140
|
raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
|
|
1219
1141
|
|
|
@@ -1321,13 +1243,10 @@ module Files
|
|
|
1321
1243
|
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
|
1322
1244
|
# part - int64 - Part if uploading a part.
|
|
1323
1245
|
# parts - int64 - How many parts to fetch?
|
|
1324
|
-
# prefer_spdy - boolean
|
|
1325
1246
|
# ref - string -
|
|
1326
1247
|
# restart - int64 - File byte offset to restart from.
|
|
1327
1248
|
# size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting).
|
|
1328
1249
|
# with_rename - boolean - Allow file rename instead of overwrite?
|
|
1329
|
-
# action - string
|
|
1330
|
-
# bundle_registration_code - string
|
|
1331
1250
|
# 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.
|
|
1332
1251
|
def begin_upload(params = {})
|
|
1333
1252
|
params ||= {}
|
|
@@ -1339,8 +1258,6 @@ module Files
|
|
|
1339
1258
|
raise InvalidParameterError.new("Bad parameter: ref must be an String") if params[:ref] and !params[:ref].is_a?(String)
|
|
1340
1259
|
raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params[:restart] and !params[:restart].is_a?(Integer)
|
|
1341
1260
|
raise InvalidParameterError.new("Bad parameter: size must be an Integer") if params[:size] and !params[:size].is_a?(Integer)
|
|
1342
|
-
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
|
1343
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1344
1261
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1345
1262
|
|
|
1346
1263
|
Api.send_request("/file_actions/begin_upload/#{@attributes[:path]}", :post, params, @options)
|
|
@@ -1356,18 +1273,14 @@ module Files
|
|
|
1356
1273
|
#
|
|
1357
1274
|
# Parameters:
|
|
1358
1275
|
# 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.
|
|
1359
|
-
# bundle_registration_code - string
|
|
1360
|
-
# prefer_spdy - boolean
|
|
1361
1276
|
# preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
1362
1277
|
# with_previews - boolean - Include file preview information?
|
|
1363
1278
|
# with_priority_color - boolean - Include file priority color information?
|
|
1364
|
-
# full_document_preview - boolean - If true, always return a proxied download uri
|
|
1365
1279
|
def self.download(path, params = {}, options = {})
|
|
1366
1280
|
params ||= {}
|
|
1367
1281
|
params[:path] = path
|
|
1368
1282
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1369
1283
|
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
|
1370
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1371
1284
|
raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
|
|
1372
1285
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1373
1286
|
|
|
@@ -1377,58 +1290,34 @@ module Files
|
|
|
1377
1290
|
|
|
1378
1291
|
# Parameters:
|
|
1379
1292
|
# path (required) - string - Path to operate on.
|
|
1380
|
-
# copy_destination - string
|
|
1381
|
-
# move_destination - string
|
|
1382
1293
|
# action - string - The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
|
1383
|
-
# action_attributes - object - Attributes to pass through for recording the Action. Used for overriding action types (i.e. representing copy/move)
|
|
1384
|
-
# file - object
|
|
1385
|
-
# crc32 - string
|
|
1386
|
-
# crc32b - string
|
|
1387
1294
|
# etags[etag] (required) - array(string) - etag identifier.
|
|
1388
1295
|
# etags[part] (required) - array(int64) - Part number.
|
|
1389
1296
|
# length - int64 - Length of file.
|
|
1390
|
-
# md5 - string
|
|
1391
1297
|
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
|
1392
|
-
# overwrite - boolean - Overwrite existing file(s) in the destination?
|
|
1393
1298
|
# part - int64 - Part if uploading a part.
|
|
1394
1299
|
# parts - int64 - How many parts to fetch?
|
|
1395
|
-
# prefer_spdy - boolean
|
|
1396
1300
|
# provided_mtime - string - User provided modification time.
|
|
1397
1301
|
# ref - string -
|
|
1398
1302
|
# restart - int64 - File byte offset to restart from.
|
|
1399
|
-
# sha1 - string
|
|
1400
|
-
# sha256 - string
|
|
1401
1303
|
# size - int64 - Size of file.
|
|
1402
1304
|
# copy_behaviors - boolean - If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
1403
1305
|
# structure - string - If copying folder, copy just the structure?
|
|
1404
1306
|
# with_rename - boolean - Allow file rename instead of overwrite?
|
|
1405
|
-
# inbox_registration_code - string
|
|
1406
|
-
# bundle_registration_code - string
|
|
1407
1307
|
# 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.
|
|
1408
1308
|
def self.create(path, params = {}, options = {})
|
|
1409
1309
|
params ||= {}
|
|
1410
1310
|
params[:path] = path
|
|
1411
1311
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1412
|
-
raise InvalidParameterError.new("Bad parameter: copy_destination must be an String") if params[:copy_destination] and !params[:copy_destination].is_a?(String)
|
|
1413
|
-
raise InvalidParameterError.new("Bad parameter: move_destination must be an String") if params[:move_destination] and !params[:move_destination].is_a?(String)
|
|
1414
1312
|
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
|
1415
|
-
raise InvalidParameterError.new("Bad parameter: action_attributes must be an Hash") if params[:action_attributes] and !params[:action_attributes].is_a?(Hash)
|
|
1416
|
-
raise InvalidParameterError.new("Bad parameter: file must be an Hash") if params[:file] and !params[:file].is_a?(Hash)
|
|
1417
|
-
raise InvalidParameterError.new("Bad parameter: crc32 must be an String") if params[:crc32] and !params[:crc32].is_a?(String)
|
|
1418
|
-
raise InvalidParameterError.new("Bad parameter: crc32b must be an String") if params[:crc32b] and !params[:crc32b].is_a?(String)
|
|
1419
1313
|
raise InvalidParameterError.new("Bad parameter: length must be an Integer") if params[:length] and !params[:length].is_a?(Integer)
|
|
1420
|
-
raise InvalidParameterError.new("Bad parameter: md5 must be an String") if params[:md5] and !params[:md5].is_a?(String)
|
|
1421
1314
|
raise InvalidParameterError.new("Bad parameter: part must be an Integer") if params[:part] and !params[:part].is_a?(Integer)
|
|
1422
1315
|
raise InvalidParameterError.new("Bad parameter: parts must be an Integer") if params[:parts] and !params[:parts].is_a?(Integer)
|
|
1423
1316
|
raise InvalidParameterError.new("Bad parameter: provided_mtime must be an String") if params[:provided_mtime] and !params[:provided_mtime].is_a?(String)
|
|
1424
1317
|
raise InvalidParameterError.new("Bad parameter: ref must be an String") if params[:ref] and !params[:ref].is_a?(String)
|
|
1425
1318
|
raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params[:restart] and !params[:restart].is_a?(Integer)
|
|
1426
|
-
raise InvalidParameterError.new("Bad parameter: sha1 must be an String") if params[:sha1] and !params[:sha1].is_a?(String)
|
|
1427
|
-
raise InvalidParameterError.new("Bad parameter: sha256 must be an String") if params[:sha256] and !params[:sha256].is_a?(String)
|
|
1428
1319
|
raise InvalidParameterError.new("Bad parameter: size must be an Integer") if params[:size] and !params[:size].is_a?(Integer)
|
|
1429
1320
|
raise InvalidParameterError.new("Bad parameter: structure must be an String") if params[:structure] and !params[:structure].is_a?(String)
|
|
1430
|
-
raise InvalidParameterError.new("Bad parameter: inbox_registration_code must be an String") if params[:inbox_registration_code] and !params[:inbox_registration_code].is_a?(String)
|
|
1431
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1432
1321
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1433
1322
|
|
|
1434
1323
|
response, options = Api.send_request("/files/#{params[:path]}", :post, params, options)
|
|
@@ -1454,12 +1343,10 @@ module Files
|
|
|
1454
1343
|
|
|
1455
1344
|
# Parameters:
|
|
1456
1345
|
# recursive - boolean - If true, will recursively delete folders. Otherwise, will error on non-empty folders.
|
|
1457
|
-
# bundle_registration_code - string
|
|
1458
1346
|
def self.delete(path, params = {}, options = {})
|
|
1459
1347
|
params ||= {}
|
|
1460
1348
|
params[:path] = path
|
|
1461
1349
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1462
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1463
1350
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1464
1351
|
|
|
1465
1352
|
Api.send_request("/files/#{params[:path]}", :delete, params, options)
|
|
@@ -1471,34 +1358,16 @@ module Files
|
|
|
1471
1358
|
nil
|
|
1472
1359
|
end
|
|
1473
1360
|
|
|
1474
|
-
# Parameters:
|
|
1475
|
-
# id (required) - int64 - File/Folder ID
|
|
1476
|
-
# preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
1477
|
-
# with_previews - boolean - Include file preview information?
|
|
1478
|
-
# with_priority_color - boolean - Include file priority color information?
|
|
1479
|
-
def self.find_id(id, params = {}, options = {})
|
|
1480
|
-
params ||= {}
|
|
1481
|
-
params[:id] = id
|
|
1482
|
-
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
1483
|
-
raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
|
|
1484
|
-
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
1485
|
-
|
|
1486
|
-
response, options = Api.send_request("/file_actions/id/#{params[:id]}", :get, params, options)
|
|
1487
|
-
File.new(response.data, options)
|
|
1488
|
-
end
|
|
1489
|
-
|
|
1490
1361
|
# Parameters:
|
|
1491
1362
|
# path (required) - string - Path to operate on.
|
|
1492
1363
|
# preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
1493
1364
|
# with_previews - boolean - Include file preview information?
|
|
1494
1365
|
# with_priority_color - boolean - Include file priority color information?
|
|
1495
|
-
# bundle_registration_code - string
|
|
1496
1366
|
def self.find(path, params = {}, options = {})
|
|
1497
1367
|
params ||= {}
|
|
1498
1368
|
params[:path] = path
|
|
1499
1369
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1500
1370
|
raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
|
|
1501
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1502
1371
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1503
1372
|
|
|
1504
1373
|
response, options = Api.send_request("/file_actions/metadata/#{params[:path]}", :get, params, options)
|
|
@@ -1529,13 +1398,11 @@ module Files
|
|
|
1529
1398
|
# copy_behaviors - boolean - If copying a folder, also copy supported behaviors to the destination folder tree?
|
|
1530
1399
|
# structure - boolean - Copy structure only?
|
|
1531
1400
|
# overwrite - boolean - Overwrite existing file(s) in the destination?
|
|
1532
|
-
# bundle_registration_code - string
|
|
1533
1401
|
def self.copy(path, params = {}, options = {})
|
|
1534
1402
|
params ||= {}
|
|
1535
1403
|
params[:path] = path
|
|
1536
1404
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1537
1405
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
|
|
1538
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1539
1406
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1540
1407
|
raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
|
|
1541
1408
|
|
|
@@ -1548,13 +1415,11 @@ module Files
|
|
|
1548
1415
|
# Parameters:
|
|
1549
1416
|
# destination (required) - string - Move destination path.
|
|
1550
1417
|
# overwrite - boolean - Overwrite existing file(s) in the destination?
|
|
1551
|
-
# bundle_registration_code - string
|
|
1552
1418
|
def self.move(path, params = {}, options = {})
|
|
1553
1419
|
params ||= {}
|
|
1554
1420
|
params[:path] = path
|
|
1555
1421
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
1556
1422
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
|
|
1557
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1558
1423
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1559
1424
|
raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
|
|
1560
1425
|
|
|
@@ -1677,13 +1542,10 @@ module Files
|
|
|
1677
1542
|
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
|
1678
1543
|
# part - int64 - Part if uploading a part.
|
|
1679
1544
|
# parts - int64 - How many parts to fetch?
|
|
1680
|
-
# prefer_spdy - boolean
|
|
1681
1545
|
# ref - string -
|
|
1682
1546
|
# restart - int64 - File byte offset to restart from.
|
|
1683
1547
|
# size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting).
|
|
1684
1548
|
# with_rename - boolean - Allow file rename instead of overwrite?
|
|
1685
|
-
# action - string
|
|
1686
|
-
# bundle_registration_code - string
|
|
1687
1549
|
# 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.
|
|
1688
1550
|
def self.begin_upload(path, params = {}, options = {})
|
|
1689
1551
|
params ||= {}
|
|
@@ -1694,8 +1556,6 @@ module Files
|
|
|
1694
1556
|
raise InvalidParameterError.new("Bad parameter: ref must be an String") if params[:ref] and !params[:ref].is_a?(String)
|
|
1695
1557
|
raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params[:restart] and !params[:restart].is_a?(Integer)
|
|
1696
1558
|
raise InvalidParameterError.new("Bad parameter: size must be an Integer") if params[:size] and !params[:size].is_a?(Integer)
|
|
1697
|
-
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
|
1698
|
-
raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
|
|
1699
1559
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
|
1700
1560
|
|
|
1701
1561
|
response, options = Api.send_request("/file_actions/begin_upload/#{params[:path]}", :post, params, options)
|
|
@@ -59,24 +59,6 @@ module Files
|
|
|
59
59
|
@attributes[:log_url]
|
|
60
60
|
end
|
|
61
61
|
|
|
62
|
-
# Parameters:
|
|
63
|
-
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
64
|
-
# 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.
|
|
65
|
-
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
66
|
-
def self.list(params = {}, options = {})
|
|
67
|
-
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
68
|
-
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
69
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
70
|
-
|
|
71
|
-
List.new(FileMigration, params) do
|
|
72
|
-
Api.send_request("/file_migrations", :get, params, options)
|
|
73
|
-
end
|
|
74
|
-
end
|
|
75
|
-
|
|
76
|
-
def self.all(params = {}, options = {})
|
|
77
|
-
list(params, options)
|
|
78
|
-
end
|
|
79
|
-
|
|
80
62
|
# Parameters:
|
|
81
63
|
# id (required) - int64 - File Migration ID.
|
|
82
64
|
def self.find(id, params = {}, options = {})
|
|
@@ -92,14 +74,5 @@ module Files
|
|
|
92
74
|
def self.get(id, params = {}, options = {})
|
|
93
75
|
find(id, params, options)
|
|
94
76
|
end
|
|
95
|
-
|
|
96
|
-
# Parameters:
|
|
97
|
-
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
98
|
-
def self.create_export(params = {}, options = {})
|
|
99
|
-
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
100
|
-
|
|
101
|
-
response, options = Api.send_request("/file_migrations/create_export", :post, params, options)
|
|
102
|
-
Export.new(response.data, options)
|
|
103
|
-
end
|
|
104
77
|
end
|
|
105
78
|
end
|
|
@@ -54,11 +54,6 @@ module Files
|
|
|
54
54
|
@attributes[:created_at]
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
-
# string - Log Type
|
|
58
|
-
def log_type
|
|
59
|
-
@attributes[:log_type]
|
|
60
|
-
end
|
|
61
|
-
|
|
62
57
|
# Parameters:
|
|
63
58
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
64
59
|
# per_page - int64 - Number of records to show per page. (Max: 2000, 1,000 or less is recommended).
|
|
@@ -84,22 +79,5 @@ module Files
|
|
|
84
79
|
def self.all(params = {}, options = {})
|
|
85
80
|
list(params, options)
|
|
86
81
|
end
|
|
87
|
-
|
|
88
|
-
# Parameters:
|
|
89
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `file_migration_id`, `operation`, `status`, `type` or `created_at`. Valid field combinations are `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
|
|
90
|
-
# 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 `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
|
|
91
|
-
# 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 `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
|
|
92
|
-
# 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 `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
|
|
93
|
-
# 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 `[ file_migration_id ]`, `[ operation ]`, `[ status ]`, `[ type ]`, `[ created_at ]`, `[ file_migration_id, operation ]`, `[ file_migration_id, status ]`, `[ file_migration_id, type ]`, `[ file_migration_id, created_at ]`, `[ operation, status ]`, `[ operation, type ]`, `[ operation, created_at ]`, `[ status, type ]`, `[ status, created_at ]`, `[ type, created_at ]`, `[ file_migration_id, operation, status ]`, `[ file_migration_id, operation, type ]`, `[ file_migration_id, operation, created_at ]`, `[ file_migration_id, status, type ]`, `[ file_migration_id, status, created_at ]`, `[ file_migration_id, type, created_at ]`, `[ operation, status, type ]`, `[ operation, status, created_at ]`, `[ operation, type, created_at ]`, `[ status, type, created_at ]`, `[ file_migration_id, operation, status, type ]`, `[ file_migration_id, operation, status, created_at ]`, `[ file_migration_id, operation, type, created_at ]`, `[ file_migration_id, status, type, created_at ]`, `[ operation, status, type, created_at ]` or `[ file_migration_id, operation, status, type, created_at ]`.
|
|
94
|
-
def self.create_export(params = {}, options = {})
|
|
95
|
-
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
96
|
-
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
|
97
|
-
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
98
|
-
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
99
|
-
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
100
|
-
|
|
101
|
-
response, options = Api.send_request("/file_migration_logs/create_export", :post, params, options)
|
|
102
|
-
Export.new(response.data, options)
|
|
103
|
-
end
|
|
104
82
|
end
|
|
105
83
|
end
|