files.com 1.1.671 → 1.1.673

data/docs/crash_report.md

@@ -1,50 +0,0 @@
-# CrashReport
-
-## Example CrashReport Object
-
-```
-{
-  "id": 1
-}
-```
-
-* `id` (int64): Crash Report ID
-* `build` (string): 
-* `platform` (string): 
-* `product_name` (string): 
-* `version` (string): 
-* `comment` (string): 
-* `email` (string): 
-* `platform_version` (string): 
-* `release_channel` (string): 
-* `dump_file` (file): 
-* `log_file` (file): 
-
-
----
-
-## Endpoint for the Desktop App to post information about a crash for further review by our desktop app team
-
-```
-Files::CrashReport.create(
-  build: "123", 
-  platform: "win32", 
-  product_name: "Files.com", 
-  version: "1.0.0", 
-  comment: "Comment", 
-  email: "johndoe@gmail.com"
-)
-```
-
-### Parameters
-
-* `build` (string): Required - 
-* `platform` (string): Required - 
-* `product_name` (string): Required - 
-* `version` (string): Required - 
-* `comment` (string): 
-* `email` (string): 
-* `platform_version` (string): 
-* `release_channel` (string): 
-* `dump_file` (file): 
-* `log_file` (file): 

data/docs/custom_domain_for_proxy.md

@@ -1,23 +0,0 @@
-# CustomDomainForProxy
-
-## Example CustomDomainForProxy Object
-
-```
-{
-  "id": 1,
-  "domain": "example",
-  "destination": "example",
-  "ssl_certificate_id": 1,
-  "certificate": "example",
-  "private_key": "example",
-  "intermediates": "example"
-}
-```
-
-* `id` (int64): Custom Domain ID.
-* `domain` (string): Customer-owned domain name.
-* `destination` (string): Routing destination: `site_alias`, `public_hosting`, or `s3_endpoint`.
-* `ssl_certificate_id` (int64): Attached SslCertificate ID.
-* `certificate` (string): The text of the certificate itself.
-* `private_key` (string): Private key used to generate the certificate.
-* `intermediates` (string): Intermediate certificates, if available.

data/docs/email_preference.md

@@ -1,108 +0,0 @@
-# EmailPreference
-
-## Example EmailPreference Object
-
-```
-{
-  "email": "john.doe@files.com",
-  "notifications": [
-    {
-      "id": 1,
-      "path": "example",
-      "send_interval": "fifteen_minutes",
-      "unsubscribed": true
-    }
-  ],
-  "bundle_notifications": [
-    {
-      "id": 1,
-      "bundle_code": "example",
-      "unsubscribed": true
-    }
-  ],
-  "receive_admin_alerts": true,
-  "notify_on_all_site_warnings": true,
-  "notify_on_all_sso_failures": true,
-  "notify_on_all_user_security_events": true,
-  "notify_on_all_pending_work_failures": true,
-  "notify_on_all_siem_http_destination_failures": true,
-  "notify_on_all_sync_failures": true,
-  "notify_on_all_automation_failures": true,
-  "notify_on_all_expectation_failures": true,
-  "receive_marketing_mail": true,
-  "receive_transactional_mail": true
-}
-```
-
-* `email` (email): Email address
-* `notifications` (array(object)): A list of notifications
-* `bundle_notifications` (array(object)): A list of bundle notifications
-* `receive_admin_alerts` (boolean): Deprecated. Use granular admin email preferences instead.
-* `notify_on_all_site_warnings` (boolean): Receive site warnings?
-* `notify_on_all_sso_failures` (boolean): Receive sso/scim/ldap configuration/sync failures?
-* `notify_on_all_user_security_events` (boolean): Receive user security events?
-* `notify_on_all_pending_work_failures` (boolean): Receive pending work failures?
-* `notify_on_all_siem_http_destination_failures` (boolean): Receive siem failures?
-* `notify_on_all_sync_failures` (boolean): Receive sync failures?
-* `notify_on_all_automation_failures` (boolean): Receive automation failures?
-* `notify_on_all_expectation_failures` (boolean): Receive expectation failures and misses?
-* `receive_marketing_mail` (boolean): Receive marketing mail?
-* `receive_transactional_mail` (boolean): Receive transactional (service-related) mail?
-
-
----
-
-## Show Email Preference
-
-```
-Files::EmailPreference.get(token)
-```
-
-### Parameters
-
-* `token` (string): Required - Email preferences token.
-
-
----
-
-## Update Email Preference
-
-```
-Files::EmailPreference.update(token, 
-  user[receive_admin_alerts]: false, 
-  user[notify_on_all_site_warnings]: false, 
-  user[notify_on_all_sso_failures]: false, 
-  user[notify_on_all_user_security_events]: false, 
-  user[notify_on_all_pending_work_failures]: false, 
-  user[notify_on_all_siem_http_destination_failures]: false, 
-  user[notify_on_all_sync_failures]: false, 
-  user[notify_on_all_automation_failures]: false, 
-  user[notify_on_all_expectation_failures]: false, 
-  user[unsubscribe_marketing]: false, 
-  user[unsubscribe_transactional]: false, 
-  user[unsubscribe]: false, 
-  user[notifications][send_interval]: "hour"
-)
-```
-
-### Parameters
-
-* `token` (string): Required - Email preferences token.
-* `user[receive_admin_alerts]` (boolean): 
-* `user[notify_on_all_site_warnings]` (boolean): 
-* `user[notify_on_all_sso_failures]` (boolean): 
-* `user[notify_on_all_user_security_events]` (boolean): 
-* `user[notify_on_all_pending_work_failures]` (boolean): 
-* `user[notify_on_all_siem_http_destination_failures]` (boolean): 
-* `user[notify_on_all_sync_failures]` (boolean): 
-* `user[notify_on_all_automation_failures]` (boolean): 
-* `user[notify_on_all_expectation_failures]` (boolean): 
-* `user[unsubscribe_marketing]` (boolean): 
-* `user[unsubscribe_transactional]` (boolean): 
-* `user[unsubscribe]` (boolean): 
-* `user[notifications][id]` (array(int64)): 
-* `user[notifications][group]` (array(boolean)): 
-* `user[notifications][send_interval]` (array(string)): 
-* `user[notifications][unsubscribe]` (array(boolean)): 
-* `user[bundle_notifications][id]` (array(int64)): 
-* `user[bundle_notifications][unsubscribe]` (array(boolean)): 

data/docs/email_preference_bundle_notification.md

@@ -1,15 +0,0 @@
-# EmailPreferenceBundleNotification
-
-## Example EmailPreferenceBundleNotification Object
-
-```
-{
-  "id": 1,
-  "bundle_code": "example",
-  "unsubscribed": true
-}
-```
-
-* `id` (int64): Email preferences ID
-* `bundle_code` (string): Bundle code
-* `unsubscribed` (boolean): Is unsubscribed?

data/docs/email_preference_notification.md

@@ -1,17 +0,0 @@
-# EmailPreferenceNotification
-
-## Example EmailPreferenceNotification Object
-
-```
-{
-  "id": 1,
-  "path": "example",
-  "send_interval": "fifteen_minutes",
-  "unsubscribed": true
-}
-```
-
-* `id` (int64): Email preferences ID
-* `path` (string): Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
-* `send_interval` (string): The time interval that notifications are aggregated to.  Can be five_minutes, fifteen_minutes, hourly, or daily
-* `unsubscribed` (boolean): Is unsubscribed?

data/docs/export.md

@@ -1,90 +0,0 @@
-# Export
-
-## Example Export Object
-
-```
-{
-  "id": 1,
-  "export_status": "example",
-  "export_type": "example",
-  "export_rows": 1,
-  "download_uri": "example",
-  "message": "example"
-}
-```
-
-* `id` (int64): ID for this Export
-* `export_status` (string): Status of the Export
-* `export_type` (string): Type of data being exported
-* `export_rows` (int64): Number of rows exported
-* `download_uri` (string): Link to download Export file.
-* `message` (string): Export message
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-
-
----
-
-## List Exports
-
-```
-Files::Export.list(
-  user_id: 1
-)
-```
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `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.
-* `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-
-
----
-
-## Show Export
-
-```
-Files::Export.find(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Export ID.
-
-
----
-
-## Create Export
-
-```
-Files::Export.create(
-  user_id: 1, 
-  export_type: "export_type"
-)
-```
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `export_type` (string): Required - Export Report Type
-
-
----
-
-## Create an export CSV of Export resources
-
-```
-Files::Export.create_export(
-  user_id: 1
-)
-```
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.

data/docs/front_end_server.md

@@ -1,111 +0,0 @@
-# FrontEndServer
-
-## Example FrontEndServer Object
-
-```
-{
-  "ip": "example",
-  "external_ip": "example",
-  "assigned": true,
-  "site": {
-    "name": "example",
-    "certificate": "example",
-    "private_key": "example",
-    "key": "example",
-    "intermediates": "example",
-    "id": 1,
-    "domain_hsts_header": true,
-    "ftps_enabled": true,
-    "https_enabled": true,
-    "sftp_insecure_ciphers": true,
-    "tls_disabled": true,
-    "subdomain": "example",
-    "domains": [
-      "example"
-    ]
-  },
-  "ftp_enabled": true,
-  "sftp_enabled": true,
-  "sftp_host_key_type": "example",
-  "sftp_host_key_private_key": "example",
-  "site_id": 1,
-  "motd_text": "example",
-  "motd_use_for_ftp": true,
-  "motd_use_for_sftp": true,
-  "custom_domains": [
-    {
-      "id": 1,
-      "domain": "example",
-      "destination": "example",
-      "ssl_certificate_id": 1,
-      "certificate": "example",
-      "private_key": "example",
-      "intermediates": "example"
-    }
-  ],
-  "pair_type": "example"
-}
-```
-
-* `ip` (string): Private IP of the server.
-* `external_ip` (string): Public IP of the server.
-* `assigned` (boolean): Flag to signal to other systems to use this config
-* `site` (SslCertificate): SSL certificate information for the site associated with this IP, if available.
-* `ftp_enabled` (boolean): 
-* `sftp_enabled` (boolean): 
-* `sftp_host_key_type` (string): Which SFTP host key to use.
-* `sftp_host_key_private_key` (string): SFTP Host Key private key if using a custom key.
-* `site_id` (int64): Site Id
-* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
-* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
-* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
-* `custom_domains` (array(object)): Active Custom Domains for the site associated with this IP, with their attached SSL certificate content.
-* `pair_type` (string): Pair type for General Use Public IPs
-* `name` (string): Server's short name.
-* `hostname` (string): Server's full hostname.
-* `zone` (string): Availability zone where this server lives.
-* `ips` (array(string)): An array of public and private ip address pairs.
-* `primary_ip` (string): Primary Internal IP.
-* `primary_ip_public` (string): Primary Public IP.
-* `soo_ip` (string): Security Opt Out Internal IP.
-* `soo_ip_public` (string): Security Opt Out Public IP.
-* `exavault_ip` (string): Exavault Internal IP.
-* `exavault_ip_public` (string): Exavault Public IP.
-* `exavault_soo_ip` (string): Exavault Security Opt Out Internal IP.
-* `exavault_soo_ip_public` (string): Exavault Security Opt Out Public IP.
-* `smartfile_ip` (string): Smartfile Internal IP.
-* `smartfile_ip_public` (string): Smartfile Public IP.
-* `smartfile_soo_ip` (string): Smartfile Security Opt Out Internal IP.
-* `smartfile_soo_ip_public` (string): Smartfile Security Opt Out Public IP.
-
-
----
-
-## Create or update a front end server and perform a checkin for the given IPs
-
-```
-Files::FrontEndServer.create(
-  name: "name"
-)
-```
-
-### Parameters
-
-* `name` (string): Required - Server's short name.
-* `hostname` (string): Server's full hostname.
-* `zone` (string): Availability zone where this server lives.
-* `ips` (array(string)): An array of public and private ip address pairs.
-* `ips[private_ip]` (array(string)): Private IP address associated with the server.
-* `ips[public_ip]` (array(string)): Public IP address associated with the server.
-* `primary_ip` (string): Primary Internal IP.
-* `primary_ip_public` (string): Primary Public IP.
-* `soo_ip` (string): Security Opt Out Internal IP.
-* `soo_ip_public` (string): Security Opt Out Public IP.
-* `exavault_ip` (string): Exavault Internal IP.
-* `exavault_ip_public` (string): Exavault Public IP.
-* `exavault_soo_ip` (string): Exavault Security Opt Out Internal IP.
-* `exavault_soo_ip_public` (string): Exavault Security Opt Out Public IP.
-* `smartfile_ip` (string): Smartfile Internal IP.
-* `smartfile_ip_public` (string): Smartfile Public IP.
-* `smartfile_soo_ip` (string): Smartfile Security Opt Out Internal IP.
-* `smartfile_soo_ip_public` (string): Smartfile Security Opt Out Public IP.

data/docs/frontend_metric.md

@@ -1,34 +0,0 @@
-# FrontendMetric
-
-## Example FrontendMetric Object
-
-```
-{
-  "metric_type": "increment",
-  "subkey": "abc123",
-  "ms": 100
-}
-```
-
-* `metric_type` (string): Statsd metric type
-* `subkey` (string): Where in statsd to store the metric. The final key in statsd will be `files-react.[environment].[subkey]`
-* `ms` (int64): For timing metrics, the number of milliseconds. Required if `metric_type` is `timing`.
-
-
----
-
-## Submit Frontend Metric data
-
-```
-Files::FrontendMetric.create(
-  metric_type: "metric_type", 
-  subkey: "abc123", 
-  ms: 100
-)
-```
-
-### Parameters
-
-* `metric_type` (string): Required - Statsd metric type.  Use `timing` to submit the amount of time something took, or `increment` to increment a counter
-* `subkey` (string): Required - Where in statsd to store the metric. The final key in statsd will be `files-react.[environment].[subkey]`
-* `ms` (int64): For timing metrics, the number of milliseconds. Required if `metric_type` is `timing`.

data/docs/inbox.md

@@ -1,102 +0,0 @@
-# Inbox
-
-## Example Inbox Object
-
-```
-{
-  "title": "example",
-  "description": "My inbox",
-  "help_text": "If you need any help submitting your application, please call our front desk.",
-  "key": "application-form",
-  "show_on_login_page": true,
-  "has_password": true,
-  "require_registration": true,
-  "dont_allow_folders_in_uploads": true,
-  "clickwrap_body": "[Legal text]",
-  "form_field_set": {
-    "id": 1,
-    "title": "Sample Form Title",
-    "form_layout": [
-      1,
-      2,
-      3,
-      4
-    ],
-    "form_fields": [
-      {
-        "id": 1,
-        "label": "Sample Label",
-        "required": true,
-        "help_text": "Help Text",
-        "field_type": "text",
-        "options_for_select": [
-          "red",
-          "green",
-          "blue"
-        ],
-        "default_option": "red",
-        "form_field_set_id": 1
-      }
-    ],
-    "skip_name": true,
-    "skip_email": true,
-    "skip_company": true,
-    "in_use": true
-  },
-  "notify_senders_on_successful_uploads_via_email": true,
-  "notify_senders_on_successful_uploads_via_web": true,
-  "allow_whitelisting": true,
-  "whitelist": [
-    "example"
-  ],
-  "disable_web_upload": true,
-  "inbound_email_address": "example"
-}
-```
-
-* `title` (string): Inbox title
-* `description` (string): User description
-* `help_text` (string): Text that will be shown to the users on the Inbox.  Use this field to provide custom instructions.
-* `key` (string): Unique key for inbox
-* `show_on_login_page` (boolean): Show this inbox on site login page?
-* `has_password` (boolean): Is this inbox password protected?
-* `require_registration` (boolean): Does this inbox require registration?
-* `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
-* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Inbox.
-* `form_field_set` (FormFieldSet): Custom Form to use
-* `notify_senders_on_successful_uploads_via_email` (boolean): Notify senders on successful uploads via email
-* `notify_senders_on_successful_uploads_via_web` (boolean): Notify senders on successful uploads via web
-* `allow_whitelisting` (boolean): allow/disallow whitelist
-* `whitelist` (array(string)): A list of emails and domain names for whitelisting
-* `disable_web_upload` (boolean): This will disable the upload URL and can only be done if uploads via email are enabled
-* `inbound_email_address` (string): inbound email address to the inbox
-
-
----
-
-## List Inboxes
-
-```
-Files::Inbox.list
-```
-
-### Parameters
-
-* `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.
-* `per_page` (int64): Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `allow_whitelisting`.
-
-
----
-
-## Create an export CSV of Inbox resources
-
-```
-Files::Inbox.create_export
-```
-
-### Parameters
-
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
-* `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_registration.md

@@ -1,35 +0,0 @@
-# InboxRecipientRegistration
-
-## Example InboxRecipientRegistration Object
-
-```
-{
-  "code": "example",
-  "inbox_registration_code": "example",
-  "recipient": "example",
-  "name": "example",
-  "company": "example"
-}
-```
-
-* `code` (string): The inbox recipient registration code. Use this to register for the inbox.
-* `inbox_registration_code` (string): If the recipient has already registered for this inbox, this is their registration code to get the inbox contents.
-* `recipient` (string): The recipient's email address.
-* `name` (string): The recipient's name.
-* `company` (string): The recipient's company.
-* `inbox_recipient_code` (string): Inbox recipient code
-
-
----
-
-## Create Inbox Recipient Registration
-
-```
-Files::InboxRecipientRegistration.create(
-  inbox_recipient_code: "inbox_recipient_code"
-)
-```
-
-### Parameters
-
-* `inbox_recipient_code` (string): Required - Inbox recipient code

data/docs/ip.md

@@ -1,63 +0,0 @@
-# Ip
-
-## Example Ip Object
-
-```
-{
-  "ip": "example",
-  "external_ip": "example",
-  "assigned": true,
-  "site": {
-    "name": "example",
-    "certificate": "example",
-    "private_key": "example",
-    "key": "example",
-    "intermediates": "example",
-    "id": 1,
-    "domain_hsts_header": true,
-    "ftps_enabled": true,
-    "https_enabled": true,
-    "sftp_insecure_ciphers": true,
-    "tls_disabled": true,
-    "subdomain": "example",
-    "domains": [
-      "example"
-    ]
-  },
-  "ftp_enabled": true,
-  "sftp_enabled": true,
-  "sftp_host_key_type": "example",
-  "sftp_host_key_private_key": "example",
-  "site_id": 1,
-  "motd_text": "example",
-  "motd_use_for_ftp": true,
-  "motd_use_for_sftp": true,
-  "custom_domains": [
-    {
-      "id": 1,
-      "domain": "example",
-      "destination": "example",
-      "ssl_certificate_id": 1,
-      "certificate": "example",
-      "private_key": "example",
-      "intermediates": "example"
-    }
-  ],
-  "pair_type": "example"
-}
-```
-
-* `ip` (string): Private IP of the server.
-* `external_ip` (string): Public IP of the server.
-* `assigned` (boolean): Flag to signal to other systems to use this config
-* `site` (SslCertificate): SSL certificate information for the site associated with this IP, if available.
-* `ftp_enabled` (boolean): 
-* `sftp_enabled` (boolean): 
-* `sftp_host_key_type` (string): Which SFTP host key to use.
-* `sftp_host_key_private_key` (string): SFTP Host Key private key if using a custom key.
-* `site_id` (int64): Site Id
-* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
-* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
-* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
-* `custom_domains` (array(object)): Active Custom Domains for the site associated with this IP, with their attached SSL certificate content.
-* `pair_type` (string): Pair type for General Use Public IPs