files.com 1.0.49 → 1.0.50

data/docs/crash_report.md

@@ -1,46 +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): 
-
-
----
-
-## Internal hidden endpoint.  Subject to change.  Not for public consumption
-
-```
-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): 

data/docs/email_feedback.md

@@ -1,16 +0,0 @@
-
-
----
-
-## Internal hidden endpoint.  Subject to change.  Not for public consumption
-
-```
-Files::EmailFeedback.create(
-  feedback[email]: "johndoe@gmail.com"
-)
-```
-
-### Parameters
-
-* `feedback[email]` (string): 
-* `feedback[reason]` (string): 

data/docs/email_preference.md

@@ -1,41 +0,0 @@
-# EmailPreference
-
-## Example EmailPreference Object
-
-```
-{
-  "email": "john.doe@files.com",
-  "notifications": [
-
-  ],
-  "receive_admin_alerts": true
-}
-```
-
-* `email` (email): Email address
-* `notifications` (array): A list of notifications
-* `receive_admin_alerts` (boolean): Receive admin alerts?
-
-
----
-
-## Internal hidden endpoint.  Subject to change.  Not for public consumption
-
-```
-Files::EmailPreference.update(token, 
-  user[receive_admin_alerts]: true, 
-  user[unsubscribed]: true, 
-  user[notifications][send_interval]: "hour"
-)
-```
-
-### Parameters
-
-* `token` (string): Required - Email preferences token.
-* `user[receive_admin_alerts]` (boolean): 
-* `user[unsubscribed]` (boolean): 
-* `user[notifications][id]` (array(int64)): 
-* `user[notifications][group]` (array(boolean)): 
-* `user[notifications][send_interval]` (array(string)): 
-* `user[notifications][unsubscribe]` (array(boolean)): 
-* `user[unsubscribe]` (string): 

data/docs/email_preference_notification.md

@@ -1,17 +0,0 @@
-# EmailPreferenceNotification
-
-## Example EmailPreferenceNotification Object
-
-```
-{
-  "id": 1,
-  "path": "",
-  "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/inbox.md

@@ -1,37 +0,0 @@
-# Inbox
-
-## Example Inbox Object
-
-```
-{
-  "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,
-  "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?
-* `title` (string): Inbox title
-
-
----
-
-## Internal hidden endpoint.  Subject to change.  Not for public consumption
-
-```
-Files::Inbox.list(
-  page: 1, 
-  per_page: 1
-)
-```
-
-### Parameters
-
-* `page` (int64): Current page number.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

data/docs/oauth_redirect.md

@@ -1,11 +0,0 @@
-# OauthRedirect
-
-## Example OauthRedirect Object
-
-```
-{
-  "redirect_uri": "https://provider.com/redirect..."
-}
-```
-
-* `redirect_uri` (string): Redirect URL

data/docs/paired_api_key.md

@@ -1,17 +0,0 @@
-# PairedApiKey
-
-## Example PairedApiKey Object
-
-```
-{
-  "server": "mysite.files.com",
-  "username": "@api-1",
-  "password": "password",
-  "nickname": "@api-1 @ mysite.files.com"
-}
-```
-
-* `server` (string): Site URL
-* `username` (string): Paired api key username
-* `password` (string): Paired api key password
-* `nickname` (string): Unique nickname for this api key

data/docs/paypal_express_info.md

@@ -1,31 +0,0 @@
-# PaypalExpressInfo
-
-## Example PaypalExpressInfo Object
-
-```
-{
-  "billing_email": "john.doe@files.com",
-  "billing_company_name": "Action Verb",
-  "billing_address": "123 Main St",
-  "billing_address_2": "Door 1",
-  "billing_city": "New York",
-  "billing_state": "NY",
-  "billing_country": "US",
-  "billing_zip": "000000",
-  "billing_name": "John Doe",
-  "billing_phone": "555-555-5555",
-  "paypal_payer_id": 1
-}
-```
-
-* `billing_email` (email): Paypal billing email
-* `billing_company_name` (string): Paypal billing company name
-* `billing_address` (string): Paypal billing address
-* `billing_address_2` (string): Paypal billing address 2
-* `billing_city` (string): Paypal billing city
-* `billing_state` (string): Paypal billing state
-* `billing_country` (string): Paypal billing country
-* `billing_zip` (string): Paypal billing zipcode
-* `billing_name` (string): Paypal billing name
-* `billing_phone` (string): Paypal billing phone
-* `paypal_payer_id` (int64): Paypal payer ID

data/docs/paypal_express_url.md

@@ -1,11 +0,0 @@
-# PaypalExpressUrl
-
-## Example PaypalExpressUrl Object
-
-```
-{
-  "redirect_to": "https://www.paypal.com/..."
-}
-```
-
-* `redirect_to` (string): Redirect link

data/docs/plan.md

@@ -1,145 +0,0 @@
-# Plan
-
-## Example Plan Object
-
-```
-{
-  "id": 1,
-  "advanced_behaviors": true,
-  "antivirus_advanced": true,
-  "antivirus_basic": true,
-  "audit_hours": 1,
-  "auth_google": true,
-  "auth_oauth": true,
-  "auth_oauth_custom": true,
-  "auth_user_count": 1,
-  "automations": true,
-  "custom_namespace": true,
-  "custom_smtp": true,
-  "dedicated_ip": true,
-  "dedicated_ips": 1,
-  "differences": "",
-  "domain": true,
-  "domain_count": 1,
-  "email_inboxes": true,
-  "extended_folder_permissions": true,
-  "extended_log_retention": true,
-  "free_developer_accounts": 1,
-  "ftp_sftp_webdav": true,
-  "full_text_search": true,
-  "global_acceleration": true,
-  "gpg": true,
-  "group_admins_enabled": true,
-  "group_notifications": true,
-  "hipaa": true,
-  "html_branding": true,
-  "ldap": true,
-  "legal_flexibility": true,
-  "max_folder_size": "10000",
-  "max_individual_file_size": "5 TB",
-  "name": "Enterprise",
-  "nested_groups": true,
-  "preview_page_limit": 100,
-  "regions_included": 2,
-  "remote_sync_ftp": true,
-  "remote_sync_interval": 1,
-  "remote_sync_other": true,
-  "remote_sync_s3": true,
-  "require_2fa": true,
-  "site_fields_requiring_upgrade": [
-
-  ],
-  "support_level": "standard",
-  "usage_cost": "0.1",
-  "usage_included": "2500",
-  "users": 1,
-  "watermark_documents": true,
-  "watermark_images": true,
-  "webhooks": true,
-  "webhooks_sns": true,
-  "whitelabel": true,
-  "activation_cost": "10.0",
-  "annually": "2988.0",
-  "currency": "USD",
-  "monthly": "249.0",
-  "user_cost": "5.0"
-}
-```
-
-* `id` (int64): Plan ID
-* `advanced_behaviors` (boolean): Are advanced behaviors included in plan?
-* `antivirus_advanced` (boolean): Is advanced antivirus included in plan?
-* `antivirus_basic` (boolean): Is basic antivirus included in plan?
-* `audit_hours` (int64): How many audit hours included in plan?
-* `auth_google` (boolean): Is google authentication included in plan?
-* `auth_oauth` (boolean): Is oauth included in plan?
-* `auth_oauth_custom` (boolean): Is custom oauth included in plan?
-* `auth_user_count` (int64): Number of SSO, 2FA, Desktop users included in plan
-* `automations` (boolean): Are automations included in plan?
-* `custom_namespace` (boolean): If true all usernames can be used, otherwise usernames must be unique
-* `custom_smtp` (boolean): Custom SMTP support?
-* `dedicated_ip` (boolean): Offers dedicated ip?
-* `dedicated_ips` (int64): Number of dedicated IPs
-* `differences` (object): Results of comparing with a different Plan
-* `domain` (boolean): Custom domain(s)?
-* `domain_count` (int64): Number of custom domains
-* `email_inboxes` (boolean): Does the plan include E-Mail inboxes?
-* `extended_folder_permissions` (boolean): Supports extended folder permissions like viewing history?
-* `extended_log_retention` (boolean): Can log preservation be extended?
-* `free_developer_accounts` (int64): Number of free developer accounts
-* `ftp_sftp_webdav` (boolean): Supports connections via FTP, SFTP, and WebDAV?
-* `full_text_search` (boolean): Full text search enabled?
-* `global_acceleration` (boolean): Global acceleration enabled?
-* `gpg` (boolean): Support for GPG encryption?
-* `group_admins_enabled` (boolean): Group admin functionality enabled?
-* `group_notifications` (boolean): Group notifications functionality enabled?
-* `hipaa` (boolean): Support for HIPAA regulation?
-* `html_branding` (boolean): HTML branding available?
-* `ldap` (boolean): LDAP integration enabled?
-* `legal_flexibility` (boolean): Does the plan offer any legal flexibility?
-* `max_folder_size` (int64): Max number of files in a folder
-* `max_individual_file_size` (int64): Maximum individual file size
-* `name` (string): Plan name
-* `nested_groups` (boolean): Are nested groups enabled?
-* `preview_page_limit` (int64): Number of previews available
-* `regions_included` (int64): Number of storage regions included
-* `remote_sync_ftp` (boolean): Remote sync with FTP available?
-* `remote_sync_interval` (int64): Number of hours between remote sync
-* `remote_sync_other` (boolean): Are other forms of remote sync available?
-* `remote_sync_s3` (boolean): Can sync to s3 bucket?
-* `require_2fa` (boolean): 2FA support enabled?
-* `site_fields_requiring_upgrade` (array): Site attributes which require upgrade
-* `support_level` (string): Priority of customer support
-* `usage_cost` (string): Usage cost per GB of overage
-* `usage_included` (string): Usage included per month, in GB
-* `users` (int64): # of users included.  0 or -1 mean unlimited.
-* `watermark_documents` (boolean): Watermark enabled?
-* `watermark_images` (boolean): Watermark enabled?
-* `webhooks` (boolean): Webhooks enabled?
-* `webhooks_sns` (boolean): Webhook SNS integration enabled?
-* `whitelabel` (boolean): Whitelabel site?
-* `activation_cost` (string): Activation cost (upfront)
-* `annually` (string): Price annually
-* `currency` (string): Currency
-* `monthly` (string): Price monthly
-* `user_cost` (string): Cost per additional user
-
-
----
-
-## List Plans
-
-```
-Files::Plan.list(
-  page: 1, 
-  per_page: 1, 
-  currency: "USD"
-)
-```
-
-### Parameters
-
-* `page` (int64): Current page number.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `currency` (string): Currency.

data/docs/plan_rate.md

@@ -1,31 +0,0 @@
-# PlanRate
-
-## Example PlanRate Object
-
-```
-{
-  "plan_name": 1,
-  "rates": ""
-}
-```
-
-* `plan_name` (int64): Plan Name
-* `rates` (object): Rates for each currency
-
-
----
-
-## Internal hidden endpoint.  Subject to change.  Not for public consumption
-
-```
-Files::PlanRate.list(
-  page: 1, 
-  per_page: 1
-)
-```
-
-### Parameters
-
-* `page` (int64): Current page number.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

data/docs/regional_migration.md

@@ -1,39 +0,0 @@
-# RegionalMigration
-
-## Example RegionalMigration Object
-
-```
-{
-  "id": 1,
-  "files_moved": 1,
-  "files_total": 1,
-  "path": "MyFolder",
-  "region": "USA",
-  "status": "complete"
-}
-```
-
-* `id` (int64): Regional migration ID
-* `files_moved` (int64): Number of files moved
-* `files_total` (int64): Total number of files
-* `path` (string): Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
-* `region` (string): Region
-* `status` (string): Status
-
-
----
-
-## Internal hidden endpoint.  Subject to change.  Not for public consumption
-
-```
-Files::RegionalMigration.list(
-  page: 1, 
-  per_page: 1
-)
-```
-
-### Parameters
-
-* `page` (int64): Current page number.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.