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
data/docs/gpg_key.md
CHANGED
|
@@ -108,6 +108,27 @@ Files::GpgKey.create(
|
|
|
108
108
|
* `generate_email` (string): Email address of the key owner. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
|
|
109
109
|
|
|
110
110
|
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Create an export CSV of GPG Key resources
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
Files::GpgKey.create_export(
|
|
117
|
+
user_id: 1
|
|
118
|
+
)
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Parameters
|
|
122
|
+
|
|
123
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
124
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name` or `expires_at`.
|
|
125
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, expires_at ]`.
|
|
126
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
|
|
127
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
|
|
128
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
|
|
129
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`.
|
|
130
|
+
|
|
131
|
+
|
|
111
132
|
---
|
|
112
133
|
|
|
113
134
|
## Update GPG Key
|
data/docs/group.md
CHANGED
|
@@ -110,6 +110,25 @@ Files::Group.create(
|
|
|
110
110
|
* `workspace_id` (int64): Workspace ID
|
|
111
111
|
|
|
112
112
|
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Create an export CSV of Group resources
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
Files::Group.create_export(
|
|
119
|
+
include_parent_site_groups: false
|
|
120
|
+
)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id` or `name`.
|
|
126
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `workspace_id`. Valid field combinations are `[ workspace_id, name ]`.
|
|
127
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
128
|
+
* `ids` (string): Comma-separated list of group ids to include in results.
|
|
129
|
+
* `include_parent_site_groups` (boolean): Include groups from the parent site.
|
|
130
|
+
|
|
131
|
+
|
|
113
132
|
---
|
|
114
133
|
|
|
115
134
|
## Update Group
|
data/docs/group_user.md
CHANGED
|
@@ -8,7 +8,9 @@
|
|
|
8
8
|
"group_id": 1,
|
|
9
9
|
"user_id": 1,
|
|
10
10
|
"admin": true,
|
|
11
|
-
"username": "example"
|
|
11
|
+
"username": "example",
|
|
12
|
+
"name": "example",
|
|
13
|
+
"id": 1
|
|
12
14
|
}
|
|
13
15
|
```
|
|
14
16
|
|
|
@@ -17,7 +19,8 @@
|
|
|
17
19
|
* `user_id` (int64): User ID
|
|
18
20
|
* `admin` (boolean): Is this user an administrator of this group?
|
|
19
21
|
* `username` (string): Username of the user
|
|
20
|
-
* `
|
|
22
|
+
* `name` (string):
|
|
23
|
+
* `id` (int64):
|
|
21
24
|
|
|
22
25
|
|
|
23
26
|
---
|
|
@@ -58,6 +61,23 @@ Files::GroupUser.create(
|
|
|
58
61
|
* `admin` (boolean): Is the user a group administrator?
|
|
59
62
|
|
|
60
63
|
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Create an export CSV of Group User resources
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
Files::GroupUser.create_export(
|
|
70
|
+
group_id: 1,
|
|
71
|
+
user_id: 1
|
|
72
|
+
)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
* `group_id` (int64): Group ID. If provided, will return group_users of this group.
|
|
78
|
+
* `user_id` (int64): User ID. If provided, will return group_users of this user.
|
|
79
|
+
|
|
80
|
+
|
|
61
81
|
---
|
|
62
82
|
|
|
63
83
|
## Update Group User
|
data/docs/history.md
CHANGED
|
@@ -140,3 +140,88 @@ Files::History.list(
|
|
|
140
140
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
141
141
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ ]`, `[ path ]`, `[ path ]` or `[ path ]`.
|
|
142
142
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## List history for specific file
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
Files::History.list_for_file_create_export(path)
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
|
156
|
+
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
|
157
|
+
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
|
158
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
159
|
+
* `path` (string): Required - Path to operate on.
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## List history for specific folder
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
Files::History.list_for_folder_create_export(path)
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Parameters
|
|
171
|
+
|
|
172
|
+
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
|
173
|
+
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
|
174
|
+
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
|
175
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
176
|
+
* `path` (string): Required - Path to operate on.
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## List history for specific user
|
|
182
|
+
|
|
183
|
+
```
|
|
184
|
+
Files::History.list_for_user_create_export(user_id)
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### Parameters
|
|
188
|
+
|
|
189
|
+
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
|
190
|
+
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
|
191
|
+
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
|
192
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
193
|
+
* `user_id` (int64): Required - User ID.
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## List site login history
|
|
199
|
+
|
|
200
|
+
```
|
|
201
|
+
Files::History.list_logins_create_export
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Parameters
|
|
205
|
+
|
|
206
|
+
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
|
207
|
+
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
|
208
|
+
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
|
209
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
## List site full action history
|
|
215
|
+
|
|
216
|
+
```
|
|
217
|
+
Files::History.list_create_export
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
|
223
|
+
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
|
224
|
+
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
|
225
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
226
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. Valid field combinations are `[ ]`, `[ path ]`, `[ path ]` or `[ path ]`.
|
|
227
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
@@ -78,3 +78,20 @@ Files::HistoryExportResult.list(
|
|
|
78
78
|
* `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.
|
|
79
79
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
80
80
|
* `history_export_id` (int64): Required - ID of the associated history export.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Create an export CSV of History Export Result resources
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
Files::HistoryExportResult.create_export(
|
|
89
|
+
user_id: 1,
|
|
90
|
+
history_export_id: 1
|
|
91
|
+
)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
97
|
+
* `history_export_id` (int64): Required - ID of the associated history export.
|
data/docs/holiday_region.md
CHANGED
|
@@ -25,3 +25,12 @@ Files::HolidayRegion.get_supported
|
|
|
25
25
|
|
|
26
26
|
* `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.
|
|
27
27
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## List all possible holiday regions
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
Files::HolidayRegion.supported_create_export
|
|
36
|
+
```
|
data/docs/inbound_s3_log.md
CHANGED
|
@@ -14,7 +14,8 @@
|
|
|
14
14
|
"duration_ms": 1,
|
|
15
15
|
"request_id": "example",
|
|
16
16
|
"user_agent": "example",
|
|
17
|
-
"created_at": "2000-01-01T01:00:00Z"
|
|
17
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
18
|
+
"log_type": "example"
|
|
18
19
|
}
|
|
19
20
|
```
|
|
20
21
|
|
|
@@ -29,6 +30,7 @@
|
|
|
29
30
|
* `request_id` (string): Request ID
|
|
30
31
|
* `user_agent` (string): User Agent
|
|
31
32
|
* `created_at` (date-time): Start Time of Request
|
|
33
|
+
* `log_type` (string): Log Type
|
|
32
34
|
|
|
33
35
|
|
|
34
36
|
---
|
|
@@ -49,3 +51,21 @@ Files::InboundS3Log.list
|
|
|
49
51
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `status`, `path` or `client_ip`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
50
52
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
51
53
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Create an export CSV of Inbound S3 Log resources
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
Files::InboundS3Log.create_export
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `operation`, `status`, `path`, `client_ip` or `created_at`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
67
|
+
* `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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
68
|
+
* `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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
69
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `status`, `path` or `client_ip`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
70
|
+
* `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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
|
71
|
+
* `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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, created_at ]`.
|
data/docs/inbox.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Inbox
|
|
2
|
+
|
|
3
|
+
## Example Inbox Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"title": "example",
|
|
8
|
+
"description": "My inbox",
|
|
9
|
+
"help_text": "If you need any help submitting your application, please call our front desk.",
|
|
10
|
+
"key": "application-form",
|
|
11
|
+
"show_on_login_page": true,
|
|
12
|
+
"has_password": true,
|
|
13
|
+
"require_registration": true,
|
|
14
|
+
"dont_allow_folders_in_uploads": true,
|
|
15
|
+
"clickwrap_body": "[Legal text]",
|
|
16
|
+
"form_field_set": {
|
|
17
|
+
"id": 1,
|
|
18
|
+
"title": "Sample Form Title",
|
|
19
|
+
"form_layout": [
|
|
20
|
+
1,
|
|
21
|
+
2,
|
|
22
|
+
3,
|
|
23
|
+
4
|
|
24
|
+
],
|
|
25
|
+
"form_fields": [
|
|
26
|
+
{
|
|
27
|
+
"id": 1,
|
|
28
|
+
"label": "Sample Label",
|
|
29
|
+
"required": true,
|
|
30
|
+
"help_text": "Help Text",
|
|
31
|
+
"field_type": "text",
|
|
32
|
+
"options_for_select": [
|
|
33
|
+
"red",
|
|
34
|
+
"green",
|
|
35
|
+
"blue"
|
|
36
|
+
],
|
|
37
|
+
"default_option": "red",
|
|
38
|
+
"form_field_set_id": 1
|
|
39
|
+
}
|
|
40
|
+
],
|
|
41
|
+
"skip_name": true,
|
|
42
|
+
"skip_email": true,
|
|
43
|
+
"skip_company": true,
|
|
44
|
+
"in_use": true
|
|
45
|
+
},
|
|
46
|
+
"notify_senders_on_successful_uploads_via_email": true,
|
|
47
|
+
"notify_senders_on_successful_uploads_via_web": true,
|
|
48
|
+
"allow_whitelisting": true,
|
|
49
|
+
"whitelist": [
|
|
50
|
+
"example"
|
|
51
|
+
],
|
|
52
|
+
"disable_web_upload": true,
|
|
53
|
+
"inbound_email_address": "example"
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
* `title` (string): Inbox title
|
|
58
|
+
* `description` (string): User description
|
|
59
|
+
* `help_text` (string): Text that will be shown to the users on the Inbox. Use this field to provide custom instructions.
|
|
60
|
+
* `key` (string): Unique key for inbox
|
|
61
|
+
* `show_on_login_page` (boolean): Show this inbox on site login page?
|
|
62
|
+
* `has_password` (boolean): Is this inbox password protected?
|
|
63
|
+
* `require_registration` (boolean): Does this inbox require registration?
|
|
64
|
+
* `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
|
|
65
|
+
* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Inbox.
|
|
66
|
+
* `form_field_set` (FormFieldSet): Custom Form to use
|
|
67
|
+
* `notify_senders_on_successful_uploads_via_email` (boolean): Notify senders on successful uploads via email
|
|
68
|
+
* `notify_senders_on_successful_uploads_via_web` (boolean): Notify senders on successful uploads via web
|
|
69
|
+
* `allow_whitelisting` (boolean): allow/disallow whitelist
|
|
70
|
+
* `whitelist` (array(string)): A list of emails and domain names for whitelisting
|
|
71
|
+
* `disable_web_upload` (boolean): This will disable the upload URL and can only be done if uploads via email are enabled
|
|
72
|
+
* `inbound_email_address` (string): inbound email address to the inbox
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## List Inboxes
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
Files::Inbox.list
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
* `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.
|
|
86
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
87
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
88
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `allow_whitelisting`.
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Create an export CSV of Inbox resources
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
Files::Inbox.create_export
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Parameters
|
|
100
|
+
|
|
101
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
102
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `allow_whitelisting`.
|
data/docs/inbox_recipient.md
CHANGED
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
* `recipient` (string): The recipient's email address.
|
|
19
19
|
* `sent_at` (date-time): When the Inbox was shared with this recipient.
|
|
20
20
|
* `inbox_id` (int64): Inbox to share.
|
|
21
|
+
* `method` (string): The method to use, must be email or null
|
|
21
22
|
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
|
22
23
|
|
|
23
24
|
|
|
@@ -62,4 +63,22 @@ Files::InboxRecipient.create(
|
|
|
62
63
|
* `name` (string): Name of recipient.
|
|
63
64
|
* `company` (string): Company of recipient.
|
|
64
65
|
* `note` (string): Note to include in email.
|
|
66
|
+
* `method` (string): The method to use, must be email or null
|
|
65
67
|
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Create an export CSV of Inbox Recipient resources
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
Files::InboxRecipient.create_export(
|
|
76
|
+
inbox_id: 1
|
|
77
|
+
)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Parameters
|
|
81
|
+
|
|
82
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
83
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
|
84
|
+
* `inbox_id` (int64): Required - List recipients for the inbox with this ID.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# InboxRecipientRegistration
|
|
2
|
+
|
|
3
|
+
## Example InboxRecipientRegistration Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"code": "example",
|
|
8
|
+
"inbox_registration_code": "example",
|
|
9
|
+
"recipient": "example",
|
|
10
|
+
"name": "example",
|
|
11
|
+
"company": "example"
|
|
12
|
+
}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
* `code` (string): The inbox recipient registration code. Use this to register for the inbox.
|
|
16
|
+
* `inbox_registration_code` (string): If the recipient has already registered for this inbox, this is their registration code to get the inbox contents.
|
|
17
|
+
* `recipient` (string): The recipient's email address.
|
|
18
|
+
* `name` (string): The recipient's name.
|
|
19
|
+
* `company` (string): The recipient's company.
|
|
20
|
+
* `inbox_recipient_code` (string): Inbox recipient code
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Create Inbox Recipient Registration
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Files::InboxRecipientRegistration.create(
|
|
29
|
+
inbox_recipient_code: "inbox_recipient_code"
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
* `inbox_recipient_code` (string): Required - Inbox recipient code
|
data/docs/inbox_registration.md
CHANGED
|
@@ -33,6 +33,9 @@
|
|
|
33
33
|
* `inbox_recipient_id` (int64): Id of associated inbox recipient
|
|
34
34
|
* `inbox_title` (string): Title of associated inbox
|
|
35
35
|
* `created_at` (date-time): Registration creation date/time
|
|
36
|
+
* `inbox_code` (string): Inbox URL code
|
|
37
|
+
* `inbox_recipient_registration_code` (string): Inbox recipient registration code
|
|
38
|
+
* `password` (string): Inbox password
|
|
36
39
|
|
|
37
40
|
|
|
38
41
|
---
|
|
@@ -50,3 +53,57 @@ Files::InboxRegistration.list(
|
|
|
50
53
|
* `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.
|
|
51
54
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
52
55
|
* `folder_behavior_id` (int64): ID of the associated Inbox. This is required if the user is not a site admin.
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Create Inbox Registration
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
Files::InboxRegistration.create(
|
|
64
|
+
inbox_code: "inbox_code",
|
|
65
|
+
inbox_recipient_registration_code: "abc123",
|
|
66
|
+
name: "account",
|
|
67
|
+
company: "Action Verb",
|
|
68
|
+
email: "john.doe@files.com"
|
|
69
|
+
)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
* `inbox_code` (string): Required - Inbox URL code
|
|
75
|
+
* `inbox_recipient_registration_code` (string): Inbox recipient registration code
|
|
76
|
+
* `password` (string): Inbox password
|
|
77
|
+
* `name` (string): Registrant name
|
|
78
|
+
* `company` (string): Registrant company name
|
|
79
|
+
* `email` (string): Registrant email address
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Update the last time any action happened in inbox under this registration
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
Files::InboxRegistration.last_activity(
|
|
88
|
+
inbox_registration_code: "abc123"
|
|
89
|
+
)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
* `inbox_registration_code` (string): Required - Inbox registration cookie code
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Create an export CSV of Inbox Registration resources
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
Files::InboxRegistration.create_export(
|
|
103
|
+
folder_behavior_id: 1
|
|
104
|
+
)
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Parameters
|
|
108
|
+
|
|
109
|
+
* `folder_behavior_id` (int64): ID of the associated Inbox. This is required if the user is not a site admin.
|
data/docs/inbox_upload.md
CHANGED
|
@@ -48,3 +48,21 @@ Files::InboxUpload.list
|
|
|
48
48
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
49
49
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
50
50
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Create an export CSV of Inbox Upload resources
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
Files::InboxUpload.create_export
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
64
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `folder_behavior_id` or `inbox_registration_id`. Valid field combinations are `[ folder_behavior_id, created_at ]`, `[ inbox_registration_id, created_at ]`, `[ folder_behavior_id, inbox_registration_id ]` or `[ folder_behavior_id, inbox_registration_id, created_at ]`.
|
|
65
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
66
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
67
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
68
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
data/docs/invoice.md
CHANGED
data/docs/ip.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Ip
|
|
2
|
+
|
|
3
|
+
## Example Ip Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"ip": "example",
|
|
8
|
+
"external_ip": "example",
|
|
9
|
+
"assigned": true,
|
|
10
|
+
"site": {
|
|
11
|
+
"name": "example",
|
|
12
|
+
"certificate": "example",
|
|
13
|
+
"private_key": "example",
|
|
14
|
+
"key": "example",
|
|
15
|
+
"intermediates": "example",
|
|
16
|
+
"id": 1,
|
|
17
|
+
"domain_hsts_header": true,
|
|
18
|
+
"ftps_enabled": true,
|
|
19
|
+
"https_enabled": true,
|
|
20
|
+
"sftp_insecure_ciphers": true,
|
|
21
|
+
"tls_disabled": true,
|
|
22
|
+
"subdomain": "example",
|
|
23
|
+
"domains": [
|
|
24
|
+
"example"
|
|
25
|
+
]
|
|
26
|
+
},
|
|
27
|
+
"ftp_enabled": true,
|
|
28
|
+
"sftp_enabled": true,
|
|
29
|
+
"sftp_host_key_type": "example",
|
|
30
|
+
"sftp_host_key_private_key": "example",
|
|
31
|
+
"site_id": 1,
|
|
32
|
+
"motd_text": "example",
|
|
33
|
+
"motd_use_for_ftp": true,
|
|
34
|
+
"motd_use_for_sftp": true,
|
|
35
|
+
"custom_domains": [
|
|
36
|
+
{
|
|
37
|
+
"id": 1,
|
|
38
|
+
"domain": "example",
|
|
39
|
+
"destination": "example",
|
|
40
|
+
"ssl_certificate_id": 1,
|
|
41
|
+
"certificate": "example",
|
|
42
|
+
"private_key": "example",
|
|
43
|
+
"intermediates": "example"
|
|
44
|
+
}
|
|
45
|
+
],
|
|
46
|
+
"pair_type": "example"
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
* `ip` (string): Private IP of the server.
|
|
51
|
+
* `external_ip` (string): Public IP of the server.
|
|
52
|
+
* `assigned` (boolean): Flag to signal to other systems to use this config
|
|
53
|
+
* `site` (SslCertificate): SSL certificate information for the site associated with this IP, if available.
|
|
54
|
+
* `ftp_enabled` (boolean):
|
|
55
|
+
* `sftp_enabled` (boolean):
|
|
56
|
+
* `sftp_host_key_type` (string): Which SFTP host key to use.
|
|
57
|
+
* `sftp_host_key_private_key` (string): SFTP Host Key private key if using a custom key.
|
|
58
|
+
* `site_id` (int64): Site Id
|
|
59
|
+
* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
|
|
60
|
+
* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
|
|
61
|
+
* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
|
|
62
|
+
* `custom_domains` (array(object)): Active Custom Domains for the site associated with this IP, with their attached SSL certificate content.
|
|
63
|
+
* `pair_type` (string): Pair type for General Use Public IPs
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# IpAbuseEntry
|
|
2
|
+
|
|
3
|
+
* `ip` (string):
|
|
4
|
+
* `list` (string):
|
|
5
|
+
* `hostname` (string):
|
|
6
|
+
* `reason` (string):
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## List IP Abuse Entries
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
Files::IpAbuseEntry.list
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Parameters
|
|
18
|
+
|
|
19
|
+
* `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.
|
|
20
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## Create IP Abuse Entry
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
Files::IpAbuseEntry.create(
|
|
29
|
+
ip: "ip"
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
* `ip` (string): Required -
|
|
36
|
+
* `list` (string):
|
|
37
|
+
* `hostname` (string):
|
|
38
|
+
* `reason` (string):
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Create an export CSV of IP Abuse Entry resources
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
Files::IpAbuseEntry.create_export
|
|
47
|
+
```
|