files.com 1.1.669 → 1.1.671
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -0
- data/_VERSION +1 -1
- data/docs/account.md +155 -0
- data/docs/action_log.md +21 -1
- data/docs/action_notification_export_result.md +17 -0
- data/docs/action_webhook_failure.md +28 -0
- data/docs/agent_proxy_identity.md +49 -0
- data/docs/agent_proxy_identity_endpoint.md +11 -0
- data/docs/agent_proxy_identity_result.md +24 -0
- data/docs/agent_v2_auth.md +17 -0
- data/docs/ai_assistant_personality.md +14 -0
- data/docs/ai_task.md +14 -0
- data/docs/announcement.md +57 -0
- data/docs/api_key.md +27 -1
- data/docs/api_request_log.md +21 -1
- data/docs/app.md +15 -0
- data/docs/as2_incoming_message.md +18 -0
- data/docs/as2_outgoing_message.md +18 -0
- data/docs/as2_partner.md +14 -0
- data/docs/as2_station.md +14 -0
- data/docs/automation.md +22 -1
- data/docs/automation_log.md +21 -1
- data/docs/automation_run.md +19 -0
- data/docs/bandwidth_snapshot.md +18 -0
- data/docs/behavior.md +14 -0
- data/docs/blog_post.md +57 -0
- data/docs/bundle.md +50 -1
- data/docs/bundle_action.md +25 -0
- data/docs/bundle_download.md +23 -0
- data/docs/bundle_notification.md +19 -0
- data/docs/bundle_recipient.md +21 -0
- data/docs/bundle_recipient_registration.md +39 -0
- data/docs/bundle_registration.md +61 -0
- data/docs/certificate.md +258 -0
- data/docs/chat_session.md +14 -0
- data/docs/child_site.md +583 -0
- data/docs/child_site_management_policy.md +9 -0
- data/docs/clickwrap.md +13 -0
- data/docs/clickwrap_acceptance.md +30 -0
- data/docs/client_log.md +17 -0
- data/docs/crash_report.md +50 -0
- data/docs/custom_domain.md +13 -0
- data/docs/custom_domain_for_proxy.md +23 -0
- data/docs/desktop_configuration_profile.md +14 -0
- data/docs/dns_record.md +9 -0
- data/docs/email_incoming_message.md +19 -0
- data/docs/email_log.md +20 -1
- data/docs/email_preference.md +108 -0
- data/docs/email_preference_bundle_notification.md +15 -0
- data/docs/email_preference_notification.md +17 -0
- data/docs/event_channel.md +14 -0
- data/docs/event_delivery_attempt.md +14 -0
- data/docs/event_record.md +19 -0
- data/docs/event_subscription.md +14 -0
- data/docs/event_target.md +14 -0
- data/docs/exavault_api_request_log.md +21 -1
- data/docs/expectation.md +14 -0
- data/docs/expectation_evaluation.md +14 -0
- data/docs/expectation_incident.md +14 -0
- data/docs/export.md +90 -0
- data/docs/external_event.md +18 -0
- data/docs/file.md +90 -2
- data/docs/file_migration.md +32 -0
- data/docs/file_migration_log.md +20 -1
- data/docs/file_upload_part.md +3 -1
- data/docs/folder.md +20 -0
- data/docs/form_field_set.md +15 -0
- data/docs/front_end_server.md +111 -0
- data/docs/frontend_metric.md +34 -0
- data/docs/ftp_action_log.md +21 -1
- data/docs/gpg_key.md +21 -0
- data/docs/group.md +19 -0
- data/docs/group_user.md +22 -2
- data/docs/history.md +85 -0
- data/docs/history_export_result.md +17 -0
- data/docs/holiday_region.md +9 -0
- data/docs/inbound_s3_log.md +21 -1
- data/docs/inbox.md +102 -0
- data/docs/inbox_recipient.md +19 -0
- data/docs/inbox_recipient_registration.md +35 -0
- data/docs/inbox_registration.md +57 -0
- data/docs/inbox_upload.md +18 -0
- data/docs/invoice.md +9 -0
- data/docs/ip.md +63 -0
- data/docs/ip_abuse_entry.md +47 -0
- data/docs/ip_address.md +59 -0
- data/docs/key_lifecycle_rule.md +14 -0
- data/docs/label.md +9 -0
- data/docs/lead.md +161 -0
- data/docs/lock.md +15 -0
- data/docs/message.md +17 -0
- data/docs/message_comment.md +18 -0
- data/docs/message_comment_reaction.md +18 -0
- data/docs/message_reaction.md +17 -0
- data/docs/metadata_category.md +13 -0
- data/docs/monitoring_stat.md +38 -0
- data/docs/monitoring_stats.md +15 -0
- data/docs/mover_package.md +68 -0
- data/docs/notification.md +20 -0
- data/docs/nps_response.md +75 -0
- data/docs/oauth_redirect.md +11 -0
- data/docs/outbound_connection_log.md +21 -1
- data/docs/paired_api_key.md +19 -0
- data/docs/partner.md +14 -0
- data/docs/partner_channel.md +14 -0
- data/docs/partner_site_request.md +14 -0
- data/docs/payment.md +9 -0
- data/docs/paypal_express_info.md +31 -0
- data/docs/paypal_express_url.md +11 -0
- data/docs/pending_work_event.md +18 -0
- data/docs/permission.md +22 -0
- data/docs/plan.md +107 -0
- data/docs/preview.md +57 -0
- data/docs/project.md +9 -0
- data/docs/public_hosting_request_log.md +21 -1
- data/docs/public_hosting_session_pairing.md +15 -0
- data/docs/public_inbox.md +121 -0
- data/docs/public_key.md +21 -0
- data/docs/public_url.md +59 -0
- data/docs/regional_migration.md +0 -0
- data/docs/release.md +83 -0
- data/docs/release_package.md +19 -0
- data/docs/remote_bandwidth_snapshot.md +18 -0
- data/docs/remote_mount_backend.md +13 -0
- data/docs/remote_server.md +233 -0
- data/docs/remote_server_credential.md +15 -0
- data/docs/request.md +17 -0
- data/docs/restore.md +14 -0
- data/docs/revision.md +40 -0
- data/docs/safe_plan.md +0 -0
- data/docs/scheduled_export.md +15 -0
- data/docs/scim_log.md +13 -0
- data/docs/session.md +232 -1
- data/docs/session_available_site.md +26 -0
- data/docs/setting.md +33 -0
- data/docs/settings.md +498 -0
- data/docs/settings_change.md +16 -0
- data/docs/sftp_action_log.md +21 -1
- data/docs/sftp_host_key.md +9 -0
- data/docs/share_group.md +15 -0
- data/docs/siem_http_destination.md +9 -0
- data/docs/siem_http_destination_event.md +18 -0
- data/docs/site.md +179 -0
- data/docs/site_subdomain_redirect.md +13 -0
- data/docs/snapshot.md +9 -0
- data/docs/ssl_certificate.md +37 -0
- data/docs/sso_event.md +19 -0
- data/docs/sso_strategy.md +406 -0
- data/docs/staging_site.md +591 -0
- data/docs/support_request.md +126 -0
- data/docs/sync.md +14 -0
- data/docs/sync_api_usage_snapshot.md +23 -0
- data/docs/sync_api_usage_snapshot_report.md +71 -0
- data/docs/sync_bandwidth_snapshot.md +48 -0
- data/docs/sync_log.md +20 -1
- data/docs/sync_run.md +21 -0
- data/docs/two_factor_authentication_method.md +169 -0
- data/docs/usage_daily_snapshot.md +18 -0
- data/docs/usage_snapshot.md +9 -0
- data/docs/user.md +49 -2
- data/docs/user_cipher_use.md +21 -0
- data/docs/user_lifecycle_rule.md +14 -0
- data/docs/user_request.md +9 -0
- data/docs/user_security_event.md +18 -0
- data/docs/user_sftp_client_use.md +15 -0
- data/docs/warning.md +36 -0
- data/docs/web_dav_action_log.md +21 -1
- data/docs/webauthn_sign_request.md +13 -0
- data/docs/workspace.md +15 -0
- data/docs/zip_download.md +32 -0
- data/docs/zip_download_file.md +45 -0
- data/docs/zip_download_files.md +23 -0
- data/lib/files.com/errors.rb +1 -0
- data/lib/files.com/models/account.rb +346 -0
- data/lib/files.com/models/action_log.rb +24 -0
- data/lib/files.com/models/action_notification_export_result.rb +12 -0
- data/lib/files.com/models/action_webhook_failure.rb +34 -0
- data/lib/files.com/models/agent_proxy_identity.rb +47 -0
- data/lib/files.com/models/agent_proxy_identity_endpoint.rb +17 -0
- data/lib/files.com/models/agent_proxy_identity_result.rb +27 -0
- data/lib/files.com/models/agent_v2_auth.rb +32 -0
- data/lib/files.com/models/ai_assistant_personality.rb +11 -0
- data/lib/files.com/models/ai_task.rb +11 -0
- data/lib/files.com/models/announcement.rb +89 -0
- data/lib/files.com/models/api_key.rb +39 -5
- data/lib/files.com/models/api_request_log.rb +24 -0
- data/lib/files.com/models/app.rb +13 -0
- data/lib/files.com/models/as2_incoming_message.rb +19 -0
- data/lib/files.com/models/as2_outgoing_message.rb +19 -0
- data/lib/files.com/models/as2_partner.rb +11 -0
- data/lib/files.com/models/as2_station.rb +11 -0
- data/lib/files.com/models/automation.rb +30 -0
- data/lib/files.com/models/automation_log.rb +24 -0
- data/lib/files.com/models/automation_run.rb +16 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/behavior.rb +11 -0
- data/lib/files.com/models/blog_post.rb +84 -0
- data/lib/files.com/models/bundle.rb +52 -0
- data/lib/files.com/models/bundle_action.rb +25 -0
- data/lib/files.com/models/bundle_download.rb +23 -0
- data/lib/files.com/models/bundle_notification.rb +15 -0
- data/lib/files.com/models/bundle_recipient.rb +27 -0
- data/lib/files.com/models/bundle_recipient_registration.rb +105 -0
- data/lib/files.com/models/bundle_registration.rb +125 -0
- data/lib/files.com/models/certificate.rb +455 -0
- data/lib/files.com/models/chat_session.rb +11 -0
- data/lib/files.com/models/child_site.rb +1756 -0
- data/lib/files.com/models/child_site_management_policy.rb +5 -0
- data/lib/files.com/models/clickwrap.rb +9 -0
- data/lib/files.com/models/clickwrap_acceptance.rb +56 -0
- data/lib/files.com/models/client_log.rb +25 -0
- data/lib/files.com/models/crash_report.rb +151 -0
- data/lib/files.com/models/custom_domain.rb +9 -0
- data/lib/files.com/models/custom_domain_for_proxy.rb +47 -0
- data/lib/files.com/models/desktop_configuration_profile.rb +11 -0
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/email_incoming_message.rb +21 -0
- data/lib/files.com/models/email_log.rb +22 -0
- data/lib/files.com/models/email_preference.rb +124 -0
- data/lib/files.com/models/email_preference_bundle_notification.rb +27 -0
- data/lib/files.com/models/email_preference_notification.rb +32 -0
- data/lib/files.com/models/event_channel.rb +11 -0
- data/lib/files.com/models/event_delivery_attempt.rb +11 -0
- data/lib/files.com/models/event_record.rb +21 -0
- data/lib/files.com/models/event_subscription.rb +11 -0
- data/lib/files.com/models/event_target.rb +11 -0
- data/lib/files.com/models/exavault_api_request_log.rb +24 -0
- data/lib/files.com/models/expectation.rb +11 -0
- data/lib/files.com/models/expectation_evaluation.rb +11 -0
- data/lib/files.com/models/expectation_incident.rb +11 -0
- data/lib/files.com/models/export.rb +153 -0
- data/lib/files.com/models/external_event.rb +19 -0
- data/lib/files.com/models/file.rb +207 -0
- data/lib/files.com/models/file_migration.rb +27 -0
- data/lib/files.com/models/file_migration_log.rb +22 -0
- data/lib/files.com/models/file_upload_part.rb +5 -0
- data/lib/files.com/models/folder.rb +69 -0
- data/lib/files.com/models/form_field_set.rb +9 -0
- data/lib/files.com/models/front_end_server.rb +335 -0
- data/lib/files.com/models/frontend_metric.rb +65 -0
- data/lib/files.com/models/ftp_action_log.rb +24 -0
- data/lib/files.com/models/gpg_key.rb +21 -0
- data/lib/files.com/models/group.rb +16 -0
- data/lib/files.com/models/group_user.rb +21 -1
- data/lib/files.com/models/history.rb +94 -0
- data/lib/files.com/models/history_export_result.rb +12 -0
- data/lib/files.com/models/holiday_region.rb +5 -0
- data/lib/files.com/models/inbound_s3_log.rb +24 -0
- data/lib/files.com/models/inbox.rb +123 -0
- data/lib/files.com/models/inbox_recipient.rb +25 -0
- data/lib/files.com/models/inbox_recipient_registration.rb +87 -0
- data/lib/files.com/models/inbox_registration.rb +121 -0
- data/lib/files.com/models/inbox_upload.rb +19 -0
- data/lib/files.com/models/invoice.rb +5 -0
- data/lib/files.com/models/ip.rb +82 -0
- data/lib/files.com/models/ip_abuse_entry.rb +96 -0
- data/lib/files.com/models/ip_address.rb +37 -0
- data/lib/files.com/models/key_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/label.rb +22 -0
- data/lib/files.com/models/lead.rb +434 -0
- data/lib/files.com/models/lock.rb +27 -0
- data/lib/files.com/models/message.rb +12 -0
- data/lib/files.com/models/message_comment.rb +14 -0
- data/lib/files.com/models/message_comment_reaction.rb +14 -0
- data/lib/files.com/models/message_reaction.rb +12 -0
- data/lib/files.com/models/metadata_category.rb +9 -0
- data/lib/files.com/models/monitoring_stat.rb +43 -0
- data/lib/files.com/models/monitoring_stats.rb +22 -0
- data/lib/files.com/models/mover_package.rb +80 -0
- data/lib/files.com/models/notification.rb +18 -0
- data/lib/files.com/models/nps_response.rb +128 -0
- data/lib/files.com/models/oauth_redirect.rb +17 -0
- data/lib/files.com/models/outbound_connection_log.rb +24 -0
- data/lib/files.com/models/paired_api_key.rb +37 -0
- data/lib/files.com/models/partner.rb +11 -0
- data/lib/files.com/models/partner_channel.rb +11 -0
- data/lib/files.com/models/partner_site_request.rb +11 -0
- data/lib/files.com/models/payment.rb +5 -0
- data/lib/files.com/models/paypal_express_info.rb +67 -0
- data/lib/files.com/models/paypal_express_url.rb +17 -0
- data/lib/files.com/models/pending_work_event.rb +19 -0
- data/lib/files.com/models/permission.rb +22 -0
- data/lib/files.com/models/plan.rb +209 -0
- data/lib/files.com/models/preview.rb +57 -0
- data/lib/files.com/models/project.rb +5 -0
- data/lib/files.com/models/public_hosting_request_log.rb +24 -0
- data/lib/files.com/models/public_hosting_session_pairing.rb +27 -0
- data/lib/files.com/models/public_inbox.rb +142 -0
- data/lib/files.com/models/public_key.rb +21 -0
- data/lib/files.com/models/public_url.rb +177 -0
- data/lib/files.com/models/regional_migration.rb +12 -0
- data/lib/files.com/models/release.rb +153 -0
- data/lib/files.com/models/release_package.rb +37 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +19 -0
- data/lib/files.com/models/remote_mount_backend.rb +9 -0
- data/lib/files.com/models/remote_server.rb +297 -0
- data/lib/files.com/models/remote_server_credential.rb +13 -0
- data/lib/files.com/models/request.rb +12 -0
- data/lib/files.com/models/restore.rb +11 -0
- data/lib/files.com/models/revision.rb +53 -0
- data/lib/files.com/models/safe_plan.rb +12 -0
- data/lib/files.com/models/scheduled_export.rb +13 -0
- data/lib/files.com/models/scim_log.rb +9 -0
- data/lib/files.com/models/session.rb +493 -0
- data/lib/files.com/models/session_available_site.rb +47 -0
- data/lib/files.com/models/setting.rb +36 -0
- data/lib/files.com/models/settings.rb +1072 -0
- data/lib/files.com/models/settings_change.rb +16 -0
- data/lib/files.com/models/sftp_action_log.rb +24 -0
- data/lib/files.com/models/sftp_host_key.rb +5 -0
- data/lib/files.com/models/share_group.rb +9 -0
- data/lib/files.com/models/siem_http_destination.rb +5 -0
- data/lib/files.com/models/siem_http_destination_event.rb +19 -0
- data/lib/files.com/models/site.rb +1021 -0
- data/lib/files.com/models/site_subdomain_redirect.rb +9 -0
- data/lib/files.com/models/snapshot.rb +5 -0
- data/lib/files.com/models/ssl_certificate.rb +77 -0
- data/lib/files.com/models/sso_event.rb +21 -0
- data/lib/files.com/models/sso_strategy.rb +632 -0
- data/lib/files.com/models/staging_site.rb +1781 -0
- data/lib/files.com/models/support_request.rb +209 -0
- data/lib/files.com/models/sync.rb +11 -0
- data/lib/files.com/models/sync_api_usage_snapshot.rb +47 -0
- data/lib/files.com/models/sync_api_usage_snapshot_report.rb +162 -0
- data/lib/files.com/models/sync_bandwidth_snapshot.rb +104 -0
- data/lib/files.com/models/sync_log.rb +22 -0
- data/lib/files.com/models/sync_run.rb +21 -0
- data/lib/files.com/models/two_factor_authentication_method.rb +250 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +19 -0
- data/lib/files.com/models/usage_snapshot.rb +5 -0
- data/lib/files.com/models/user.rb +59 -0
- data/lib/files.com/models/user_cipher_use.rb +21 -0
- data/lib/files.com/models/user_lifecycle_rule.rb +11 -0
- data/lib/files.com/models/user_request.rb +5 -0
- data/lib/files.com/models/user_security_event.rb +19 -0
- data/lib/files.com/models/user_sftp_client_use.rb +9 -0
- data/lib/files.com/models/warning.rb +38 -0
- data/lib/files.com/models/web_dav_action_log.rb +24 -0
- data/lib/files.com/models/webauthn_sign_request.rb +17 -0
- data/lib/files.com/models/workspace.rb +13 -0
- data/lib/files.com/models/zip_download.rb +73 -0
- data/lib/files.com/models/zip_download_file.rb +111 -0
- data/lib/files.com/models/zip_download_files.rb +42 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +59 -0
- metadata +120 -2
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# PublicInbox
|
|
2
|
+
|
|
3
|
+
## Example PublicInbox Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"color_left": "#0066a7",
|
|
8
|
+
"color_link": "#d34f5d",
|
|
9
|
+
"color_text": "#0066a7",
|
|
10
|
+
"color_top": "#000000",
|
|
11
|
+
"color_top_text": "#ffffff",
|
|
12
|
+
"title": "example",
|
|
13
|
+
"description": "My inbox",
|
|
14
|
+
"help_text": "If you need any help submitting your application, please call our front desk.",
|
|
15
|
+
"key": "application-form",
|
|
16
|
+
"show_on_login_page": true,
|
|
17
|
+
"has_password": true,
|
|
18
|
+
"require_registration": true,
|
|
19
|
+
"dont_allow_folders_in_uploads": true,
|
|
20
|
+
"clickwrap_body": "[Legal text]",
|
|
21
|
+
"form_field_set": {
|
|
22
|
+
"id": 1,
|
|
23
|
+
"title": "Sample Form Title",
|
|
24
|
+
"form_layout": [
|
|
25
|
+
1,
|
|
26
|
+
2,
|
|
27
|
+
3,
|
|
28
|
+
4
|
|
29
|
+
],
|
|
30
|
+
"form_fields": [
|
|
31
|
+
{
|
|
32
|
+
"id": 1,
|
|
33
|
+
"label": "Sample Label",
|
|
34
|
+
"required": true,
|
|
35
|
+
"help_text": "Help Text",
|
|
36
|
+
"field_type": "text",
|
|
37
|
+
"options_for_select": [
|
|
38
|
+
"red",
|
|
39
|
+
"green",
|
|
40
|
+
"blue"
|
|
41
|
+
],
|
|
42
|
+
"default_option": "red",
|
|
43
|
+
"form_field_set_id": 1
|
|
44
|
+
}
|
|
45
|
+
],
|
|
46
|
+
"skip_name": true,
|
|
47
|
+
"skip_email": true,
|
|
48
|
+
"skip_company": true,
|
|
49
|
+
"in_use": true
|
|
50
|
+
},
|
|
51
|
+
"require_logout": true,
|
|
52
|
+
"logo": {
|
|
53
|
+
"name": "My logo",
|
|
54
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
55
|
+
},
|
|
56
|
+
"logo_click_href": "https://www.example.com",
|
|
57
|
+
"thumbnail": {
|
|
58
|
+
"name": "My logo",
|
|
59
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
* `color_left` (string): Page link and button color
|
|
65
|
+
* `color_link` (string): Top bar link color
|
|
66
|
+
* `color_text` (string): Page link and button color
|
|
67
|
+
* `color_top` (string): Top bar background color
|
|
68
|
+
* `color_top_text` (string): Top bar text color
|
|
69
|
+
* `title` (string): Inbox title
|
|
70
|
+
* `description` (string): User description
|
|
71
|
+
* `help_text` (string): Text that will be shown to the users on the Inbox. Use this field to provide custom instructions.
|
|
72
|
+
* `key` (string): Unique key for inbox
|
|
73
|
+
* `show_on_login_page` (boolean): Show this inbox on site login page?
|
|
74
|
+
* `has_password` (boolean): Is this inbox password protected?
|
|
75
|
+
* `require_registration` (boolean): Does this inbox require registration?
|
|
76
|
+
* `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
|
|
77
|
+
* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Inbox.
|
|
78
|
+
* `form_field_set` (FormFieldSet): Custom Form to use
|
|
79
|
+
* `require_logout` (boolean): If true, we will hide the 'Remember Me' box on the Inbox registration page, requiring that the user logout and log back in every time they visit the page.
|
|
80
|
+
* `logo` (Image): Custom logo for Inbox folder
|
|
81
|
+
* `logo_click_href` (string): URL to open when a public visitor clicks the custom logo
|
|
82
|
+
* `thumbnail` (Image): Custom logo thumbnail for Inbox folder
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## List Public Inboxes
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
Files::PublicInbox.list
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
* `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.
|
|
96
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Show Public Inbox
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
Files::PublicInbox.get_key(key,
|
|
105
|
+
recipient_code: "abc123"
|
|
106
|
+
)
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Parameters
|
|
110
|
+
|
|
111
|
+
* `key` (string): Required - Unique key for inbox
|
|
112
|
+
* `recipient_code` (string): Inbox recipient code
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Create an export CSV of Public Inbox resources
|
|
118
|
+
|
|
119
|
+
```
|
|
120
|
+
Files::PublicInbox.create_export
|
|
121
|
+
```
|
data/docs/public_key.md
CHANGED
|
@@ -104,6 +104,27 @@ Files::PublicKey.create(
|
|
|
104
104
|
* `generate_length` (int64): Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
|
|
105
105
|
|
|
106
106
|
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Create an export CSV of Public Key resources
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
Files::PublicKey.create_export(
|
|
113
|
+
user_id: 1
|
|
114
|
+
)
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Parameters
|
|
118
|
+
|
|
119
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
120
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `user_id`, `title` or `created_at`.
|
|
121
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `workspace_id`.
|
|
122
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
123
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
124
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
125
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
126
|
+
|
|
127
|
+
|
|
107
128
|
---
|
|
108
129
|
|
|
109
130
|
## Update Public Key
|
data/docs/public_url.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# PublicUrl
|
|
2
|
+
|
|
3
|
+
## Example PublicUrl Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"http-code": 1,
|
|
8
|
+
"type": "not-found/file-not-found",
|
|
9
|
+
"http_headers": "example",
|
|
10
|
+
"body": "example",
|
|
11
|
+
"download_uri": "example",
|
|
12
|
+
"internal_download_uri": "example",
|
|
13
|
+
"redirect": "example",
|
|
14
|
+
"mime_type": "example",
|
|
15
|
+
"site_id": 1,
|
|
16
|
+
"remote_server_id": 1,
|
|
17
|
+
"headers": {
|
|
18
|
+
"key": "example value"
|
|
19
|
+
},
|
|
20
|
+
"socks_ips": [
|
|
21
|
+
"example"
|
|
22
|
+
],
|
|
23
|
+
"true_path": "example",
|
|
24
|
+
"cache_for_seconds": 1
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
* `http-code` (int64): Response HTTP code
|
|
29
|
+
* `type` (string): A short string representing which error happened, if any
|
|
30
|
+
* `http_headers` (object): Headers to include with the response
|
|
31
|
+
* `body` (string): Body of the response, if a folder listing was requested
|
|
32
|
+
* `download_uri` (string): Signed URL allowing access to the requested file
|
|
33
|
+
* `internal_download_uri` (string): For use with internal services and should also be with headers and socks_ips
|
|
34
|
+
* `redirect` (string): URL where this request should be redirected, if necessary
|
|
35
|
+
* `mime_type` (string): Used for response content-type
|
|
36
|
+
* `site_id` (int64): Site id
|
|
37
|
+
* `remote_server_id` (int64): Used for internal bandwidth tracking
|
|
38
|
+
* `headers` (object): Used for internal url management
|
|
39
|
+
* `socks_ips` (array(string)): Used for internal url management
|
|
40
|
+
* `true_path` (string): The actual path of the file or folder being accessed. Used for caching.
|
|
41
|
+
* `cache_for_seconds` (int64): Indicates how long the response should be cached, in seconds.
|
|
42
|
+
* `hostname` (string): Hostname used to request the publicly shared resource.
|
|
43
|
+
* `path` (string): Path of the resource being requested.
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Fetch a public download URL for a publicly hosted resource
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
Files::PublicUrl.create(path,
|
|
52
|
+
hostname: "hostname"
|
|
53
|
+
)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
* `hostname` (string): Required - Hostname used to request the publicly shared resource.
|
|
59
|
+
* `path` (string): Required - Path of the resource being requested.
|
|
File without changes
|
data/docs/release.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Release
|
|
2
|
+
|
|
3
|
+
## Example Release Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"version": "1.0.0",
|
|
8
|
+
"description": "The initial release of Files.com Desktop",
|
|
9
|
+
"native_release_packages": [
|
|
10
|
+
{
|
|
11
|
+
"package_link": "https://www.files.com/desktop/download",
|
|
12
|
+
"platform": "win32",
|
|
13
|
+
"architecture": "amd64",
|
|
14
|
+
"extension": "deb",
|
|
15
|
+
"sha256": "example"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"title": "Files.com",
|
|
19
|
+
"product": "desktop_v4"
|
|
20
|
+
}
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
* `version` (string): Native release version
|
|
24
|
+
* `description` (string): Native release description
|
|
25
|
+
* `native_release_packages` (array(object)): A list of native release packages
|
|
26
|
+
* `title` (string): Native release title
|
|
27
|
+
* `product` (string): Native release product
|
|
28
|
+
* `version_major` (int64):
|
|
29
|
+
* `version_minor` (int64):
|
|
30
|
+
* `version_patch` (int64):
|
|
31
|
+
* `version_build` (int64):
|
|
32
|
+
* `oem` (string):
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Show information about the latest Desktop app release
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
Files::Release.get_latest(
|
|
41
|
+
product: "desktop_v6",
|
|
42
|
+
platform: "win32",
|
|
43
|
+
architecture: "amd64",
|
|
44
|
+
ext: "exe"
|
|
45
|
+
)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
* `product` (string):
|
|
51
|
+
* `platform` (string):
|
|
52
|
+
* `architecture` (string):
|
|
53
|
+
* `ext` (string):
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Create an application release
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
Files::Release.create(
|
|
62
|
+
title: "Files.com",
|
|
63
|
+
description: "The initial release of Files.com Desktop",
|
|
64
|
+
version_major: 1,
|
|
65
|
+
version_minor: 1,
|
|
66
|
+
version_patch: 1,
|
|
67
|
+
version_build: 1,
|
|
68
|
+
product: "desktop_v4",
|
|
69
|
+
native_release_packages: [{"package_link":"https://www.files.com/desktop/download","platform":"win32","architecture":"amd64","extension":"deb","sha256":"example"}]
|
|
70
|
+
)
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
* `title` (string):
|
|
76
|
+
* `description` (string):
|
|
77
|
+
* `version_major` (int64):
|
|
78
|
+
* `version_minor` (int64):
|
|
79
|
+
* `version_patch` (int64):
|
|
80
|
+
* `version_build` (int64):
|
|
81
|
+
* `oem` (string):
|
|
82
|
+
* `product` (string):
|
|
83
|
+
* `native_release_packages` (array(object)):
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ReleasePackage
|
|
2
|
+
|
|
3
|
+
## Example ReleasePackage Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"package_link": "https://www.files.com/desktop/download",
|
|
8
|
+
"platform": "win32",
|
|
9
|
+
"architecture": "amd64",
|
|
10
|
+
"extension": "deb",
|
|
11
|
+
"sha256": "example"
|
|
12
|
+
}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
* `package_link` (string): Link to the package
|
|
16
|
+
* `platform` (string): Release platform
|
|
17
|
+
* `architecture` (string): Release architecture
|
|
18
|
+
* `extension` (string): Package file extension
|
|
19
|
+
* `sha256` (string): SHA256 hash of the package
|
|
@@ -37,3 +37,21 @@ Files::RemoteBandwidthSnapshot.list
|
|
|
37
37
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
|
38
38
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
|
39
39
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Create an export CSV of Remote Bandwidth Snapshot resources
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
Files::RemoteBandwidthSnapshot.create_export
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Parameters
|
|
51
|
+
|
|
52
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `logged_at`.
|
|
53
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
|
54
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
|
55
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
|
56
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
|
57
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
|
@@ -134,6 +134,19 @@ Files::RemoteMountBackend.reset_status(id)
|
|
|
134
134
|
* `id` (int64): Required - Remote Mount Backend ID.
|
|
135
135
|
|
|
136
136
|
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Create an export CSV of Remote Mount Backend resources
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
Files::RemoteMountBackend.create_export
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
|
|
147
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `remote_server_mount_id`.
|
|
148
|
+
|
|
149
|
+
|
|
137
150
|
---
|
|
138
151
|
|
|
139
152
|
## Update Remote Mount Backend
|
data/docs/remote_server.md
CHANGED
|
@@ -41,6 +41,7 @@
|
|
|
41
41
|
"wasabi_bucket": "my-bucket",
|
|
42
42
|
"wasabi_region": "us-west-1",
|
|
43
43
|
"wasabi_access_key": "example",
|
|
44
|
+
"auth_setup_link": "auth/:provider",
|
|
44
45
|
"auth_status": "in_setup",
|
|
45
46
|
"auth_account_name": "me@example.com",
|
|
46
47
|
"one_drive_account_type": "personal",
|
|
@@ -116,6 +117,7 @@
|
|
|
116
117
|
* `wasabi_bucket` (string): Wasabi: Bucket name
|
|
117
118
|
* `wasabi_region` (string): Wasabi: Region
|
|
118
119
|
* `wasabi_access_key` (string): Wasabi: Access Key.
|
|
120
|
+
* `auth_setup_link` (string): Returns link to login with an Oauth provider
|
|
119
121
|
* `auth_status` (string): Either `in_setup` or `complete`
|
|
120
122
|
* `auth_account_name` (string): Describes the authorized account
|
|
121
123
|
* `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
|
|
@@ -190,6 +192,19 @@ Files::RemoteServer.list
|
|
|
190
192
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
|
|
191
193
|
|
|
192
194
|
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## ping_agent Remote Server
|
|
198
|
+
|
|
199
|
+
```
|
|
200
|
+
Files::RemoteServer.find_ping_agent(id)
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
* `id` (int64): Required - Remote Server ID.
|
|
206
|
+
|
|
207
|
+
|
|
193
208
|
---
|
|
194
209
|
|
|
195
210
|
## Show Remote Server
|
|
@@ -379,6 +394,53 @@ Files::RemoteServer.agent_push_update(id)
|
|
|
379
394
|
* `id` (int64): Required - Remote Server ID.
|
|
380
395
|
|
|
381
396
|
|
|
397
|
+
---
|
|
398
|
+
|
|
399
|
+
## Disconnect a Files Agent Proxy
|
|
400
|
+
|
|
401
|
+
```
|
|
402
|
+
Files::RemoteServer.disconnect_agent(id,
|
|
403
|
+
proxy_url: "",
|
|
404
|
+
proxy_host_header: ""
|
|
405
|
+
)
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### Parameters
|
|
409
|
+
|
|
410
|
+
* `id` (int64): Required - Remote Server ID.
|
|
411
|
+
* `proxy_url` (string): Files Agent Proxy URL
|
|
412
|
+
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
## Authenticate a Files Agent Proxy
|
|
418
|
+
|
|
419
|
+
```
|
|
420
|
+
Files::RemoteServer.authenticate_agent(id,
|
|
421
|
+
proxy_registration_refresh: false,
|
|
422
|
+
downstream_proxy_port: 1,
|
|
423
|
+
supports_push_updates: false
|
|
424
|
+
)
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Parameters
|
|
428
|
+
|
|
429
|
+
* `id` (int64): Required - Remote Server ID.
|
|
430
|
+
* `signed_nonce` (string): Signed nonce
|
|
431
|
+
* `proxy_registration_refresh` (boolean): Proxy is refreshing an already validated agent registration
|
|
432
|
+
* `agent_version` (string): Agent version
|
|
433
|
+
* `peer_id` (string): Peer ID
|
|
434
|
+
* `proxy_url` (string): Files Agent Proxy URL
|
|
435
|
+
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
436
|
+
* `root` (string): Agent local root path
|
|
437
|
+
* `agent_hostname` (string): Agent local hostname used for system identification
|
|
438
|
+
* `downstream_proxy_port` (int64): Agent downstream proxy port
|
|
439
|
+
* `agent_platform` (string): Agent Platform (OS/Architecture)
|
|
440
|
+
* `permission_set` (string): Permission set
|
|
441
|
+
* `supports_push_updates` (boolean): Agent supports push updates
|
|
442
|
+
|
|
443
|
+
|
|
382
444
|
---
|
|
383
445
|
|
|
384
446
|
## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
|
|
@@ -415,6 +477,126 @@ Files::RemoteServer.configuration_file(id,
|
|
|
415
477
|
* `subdomain` (string): Files.com subdomain site name
|
|
416
478
|
|
|
417
479
|
|
|
480
|
+
---
|
|
481
|
+
|
|
482
|
+
## Create an export CSV of Remote Server resources
|
|
483
|
+
|
|
484
|
+
```
|
|
485
|
+
Files::RemoteServer.create_export
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
### Parameters
|
|
489
|
+
|
|
490
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
|
|
491
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `workspace_id`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ workspace_id, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]`, `[ linode_bucket, name ]`, `[ workspace_id, server_type ]` or `[ workspace_id, server_type, name ]`.
|
|
492
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
---
|
|
496
|
+
|
|
497
|
+
## list_for_testing Remote Server
|
|
498
|
+
|
|
499
|
+
```
|
|
500
|
+
Files::RemoteServer.list_for_testing(
|
|
501
|
+
azure_blob_storage_hierarchical_namespace: false,
|
|
502
|
+
dropbox_teams: false,
|
|
503
|
+
enable_dedicated_ips: false,
|
|
504
|
+
outbound_agent_id: 1,
|
|
505
|
+
max_connections: 1,
|
|
506
|
+
pin_to_site_region: false,
|
|
507
|
+
port: 1,
|
|
508
|
+
remote_server_id: 1,
|
|
509
|
+
remote_server_credential_id: 1,
|
|
510
|
+
reset_authentication: false,
|
|
511
|
+
s3_assume_role_duration_seconds: 1,
|
|
512
|
+
s3_compatible_virtual_hosted_style: false,
|
|
513
|
+
workspace_id: 1
|
|
514
|
+
)
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### Parameters
|
|
518
|
+
|
|
519
|
+
* `aws_access_key` (string): AWS: Access Key
|
|
520
|
+
* `aws_secret_key` (string): AWS: Secret Key
|
|
521
|
+
* `azure_blob_storage_access_key` (string): Azure Blob Storage: Secret Key
|
|
522
|
+
* `azure_blob_storage_account` (string):
|
|
523
|
+
* `azure_blob_storage_container` (string):
|
|
524
|
+
* `azure_blob_storage_dns_suffix` (string):
|
|
525
|
+
* `azure_blob_storage_hierarchical_namespace` (boolean):
|
|
526
|
+
* `azure_blob_storage_sas_token` (string): Azure Blob Storage: Shared Access Signature (SAS) token
|
|
527
|
+
* `azure_files_storage_access_key` (string): Azure Files: Access Key
|
|
528
|
+
* `azure_files_storage_account` (string):
|
|
529
|
+
* `azure_files_storage_dns_suffix` (string):
|
|
530
|
+
* `azure_files_storage_sas_token` (string): Azure Files: Shared Access Signature (SAS) token
|
|
531
|
+
* `azure_files_storage_share_name` (string):
|
|
532
|
+
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage: applicationKey
|
|
533
|
+
* `backblaze_b2_bucket` (string):
|
|
534
|
+
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage: keyID
|
|
535
|
+
* `backblaze_b2_s3_endpoint` (string):
|
|
536
|
+
* `buffer_uploads` (string): If set to always, uploads to this server will be uploaded first to Files.com before being sent to the remote server. This can improve performance in certain access patterns, such as high-latency connections. It will cause data to be temporarily stored in Files.com. If set to auto, we will perform this optimization if we believe it to be a benefit in a given situation.
|
|
537
|
+
* `cloudflare_access_key` (string): Cloudflare: Access Key
|
|
538
|
+
* `cloudflare_bucket` (string):
|
|
539
|
+
* `cloudflare_endpoint` (string):
|
|
540
|
+
* `cloudflare_secret_key` (string): Cloudflare: Secret Key
|
|
541
|
+
* `dropbox_teams` (boolean):
|
|
542
|
+
* `upload_staging_path` (string): Upload staging path
|
|
543
|
+
* `enable_dedicated_ips` (boolean):
|
|
544
|
+
* `filebase_access_key` (string): Filebase: Access Key
|
|
545
|
+
* `filebase_bucket` (string):
|
|
546
|
+
* `filebase_secret_key` (string): Filebase: Secret Key
|
|
547
|
+
* `files_api_key` (string): Files.com direct link: API key used once to pair the remote server.
|
|
548
|
+
* `files_agent_api_token` (string):
|
|
549
|
+
* `files_agent_public_key` (string):
|
|
550
|
+
* `files_agent_root` (string):
|
|
551
|
+
* `files_agent_version` (string):
|
|
552
|
+
* `outbound_agent_id` (int64): Route traffic to outbound on a files-agent
|
|
553
|
+
* `google_cloud_storage_authentication_method` (string): Google Cloud Storage: Authentication method. Can be json, hmac, or oauth.
|
|
554
|
+
* `google_cloud_storage_bucket` (string):
|
|
555
|
+
* `google_cloud_storage_credentials_json` (string): Google Cloud Storage: A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
|
556
|
+
* `google_cloud_storage_oauth_scope` (string): Google Cloud Storage: OAuth scope. Can be https://www.googleapis.com/auth/devstorage.read_only or https://www.googleapis.com/auth/devstorage.read_write.
|
|
557
|
+
* `google_cloud_storage_project_id` (string):
|
|
558
|
+
* `google_cloud_storage_s3_compatible_access_key` (string): Google Cloud Storage: S3-compatible access key
|
|
559
|
+
* `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
|
|
560
|
+
* `hostname` (string):
|
|
561
|
+
* `linode_access_key` (string): Linode: access key
|
|
562
|
+
* `linode_bucket` (string):
|
|
563
|
+
* `linode_region` (string):
|
|
564
|
+
* `linode_secret_key` (string): Linode: secret key
|
|
565
|
+
* `max_connections` (int64):
|
|
566
|
+
* `name` (string):
|
|
567
|
+
* `one_drive_account_type` (string):
|
|
568
|
+
* `password` (string): Password, if needed
|
|
569
|
+
* `pin_to_site_region` (boolean): Pin to site region?
|
|
570
|
+
* `port` (int64):
|
|
571
|
+
* `private_key_passphrase` (string): Passphrase for private key, if needed
|
|
572
|
+
* `private_key` (string): Private key if needed.
|
|
573
|
+
* `remote_server_id` (int64): Remote Server ID
|
|
574
|
+
* `remote_server_credential_id` (int64): Remote Server Credential ID
|
|
575
|
+
* `reset_authentication` (boolean): Reset authenticated account?
|
|
576
|
+
* `root` (string): Remote path to list
|
|
577
|
+
* `s3_assume_role_arn` (string):
|
|
578
|
+
* `s3_assume_role_duration_seconds` (int64):
|
|
579
|
+
* `s3_bucket` (string):
|
|
580
|
+
* `s3_compatible_access_key` (string):
|
|
581
|
+
* `s3_compatible_bucket` (string):
|
|
582
|
+
* `s3_compatible_endpoint` (string):
|
|
583
|
+
* `s3_compatible_region` (string):
|
|
584
|
+
* `s3_compatible_virtual_hosted_style` (boolean):
|
|
585
|
+
* `s3_compatible_secret_key` (string):
|
|
586
|
+
* `s3_region` (string):
|
|
587
|
+
* `server_certificate` (string):
|
|
588
|
+
* `server_host_key` (string):
|
|
589
|
+
* `server_type` (string):
|
|
590
|
+
* `ssl_certificate` (string): SSL client certificate.
|
|
591
|
+
* `ssl` (string):
|
|
592
|
+
* `username` (string):
|
|
593
|
+
* `wasabi_access_key` (string): Wasabi: Access Key
|
|
594
|
+
* `wasabi_bucket` (string):
|
|
595
|
+
* `wasabi_region` (string):
|
|
596
|
+
* `wasabi_secret_key` (string): Wasabi Secret Key
|
|
597
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
598
|
+
|
|
599
|
+
|
|
418
600
|
---
|
|
419
601
|
|
|
420
602
|
## Update Remote Server
|
|
@@ -592,6 +774,57 @@ remote_server.agent_push_update
|
|
|
592
774
|
* `id` (int64): Required - Remote Server ID.
|
|
593
775
|
|
|
594
776
|
|
|
777
|
+
---
|
|
778
|
+
|
|
779
|
+
## Disconnect a Files Agent Proxy
|
|
780
|
+
|
|
781
|
+
```
|
|
782
|
+
remote_server = Files::RemoteServer.find(id)
|
|
783
|
+
|
|
784
|
+
remote_server.disconnect_agent(
|
|
785
|
+
proxy_url: "",
|
|
786
|
+
proxy_host_header: ""
|
|
787
|
+
)
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
### Parameters
|
|
791
|
+
|
|
792
|
+
* `id` (int64): Required - Remote Server ID.
|
|
793
|
+
* `proxy_url` (string): Files Agent Proxy URL
|
|
794
|
+
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
---
|
|
798
|
+
|
|
799
|
+
## Authenticate a Files Agent Proxy
|
|
800
|
+
|
|
801
|
+
```
|
|
802
|
+
remote_server = Files::RemoteServer.find(id)
|
|
803
|
+
|
|
804
|
+
remote_server.authenticate_agent(
|
|
805
|
+
proxy_registration_refresh: false,
|
|
806
|
+
downstream_proxy_port: 1,
|
|
807
|
+
supports_push_updates: false
|
|
808
|
+
)
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
### Parameters
|
|
812
|
+
|
|
813
|
+
* `id` (int64): Required - Remote Server ID.
|
|
814
|
+
* `signed_nonce` (string): Signed nonce
|
|
815
|
+
* `proxy_registration_refresh` (boolean): Proxy is refreshing an already validated agent registration
|
|
816
|
+
* `agent_version` (string): Agent version
|
|
817
|
+
* `peer_id` (string): Peer ID
|
|
818
|
+
* `proxy_url` (string): Files Agent Proxy URL
|
|
819
|
+
* `proxy_host_header` (string): Files Agent Proxy Host Header
|
|
820
|
+
* `root` (string): Agent local root path
|
|
821
|
+
* `agent_hostname` (string): Agent local hostname used for system identification
|
|
822
|
+
* `downstream_proxy_port` (int64): Agent downstream proxy port
|
|
823
|
+
* `agent_platform` (string): Agent Platform (OS/Architecture)
|
|
824
|
+
* `permission_set` (string): Permission set
|
|
825
|
+
* `supports_push_updates` (boolean): Agent supports push updates
|
|
826
|
+
|
|
827
|
+
|
|
595
828
|
---
|
|
596
829
|
|
|
597
830
|
## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
|
|
@@ -149,6 +149,21 @@ Files::RemoteServerCredential.create(
|
|
|
149
149
|
* `copy_values_from_credential_id` (int64): ID of Remote Server Credential to copy omitted values from.
|
|
150
150
|
|
|
151
151
|
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
## Create an export CSV of Remote Server Credential resources
|
|
155
|
+
|
|
156
|
+
```
|
|
157
|
+
Files::RemoteServerCredential.create_export
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
|
|
163
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id` and `name`. Valid field combinations are `[ workspace_id, name ]`.
|
|
164
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
165
|
+
|
|
166
|
+
|
|
152
167
|
---
|
|
153
168
|
|
|
154
169
|
## Update Remote Server Credential
|
data/docs/request.md
CHANGED
|
@@ -81,6 +81,23 @@ Files::Request.create(
|
|
|
81
81
|
* `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
|
|
82
82
|
|
|
83
83
|
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Create an export CSV of Request resources
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
Files::Request.create_export(
|
|
90
|
+
mine: false
|
|
91
|
+
)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
97
|
+
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
|
98
|
+
* `path` (string): Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
|
|
99
|
+
|
|
100
|
+
|
|
84
101
|
---
|
|
85
102
|
|
|
86
103
|
## Delete Request
|