files.com 1.0.15 → 1.0.16

data/docs/public_key.md

@@ -5,16 +5,16 @@
 ```
 {
   "id": 1,
+  "title": "My public key",
   "created_at": "2000-01-01 01:00:00 UTC",
-  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
-  "title": "My public key"
+  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
 }
 ```
 
 * `id` (int64): Public key ID
+* `title` (string): Public key title
 * `created_at` (date-time): Public key created at date/time
 * `fingerprint` (string): Public key fingerprint
-* `title` (string): Public key title
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `public_key` (string): Actual contents of SSH key.
 

data/docs/session.md

@@ -67,91 +67,6 @@ Files::Session.create(
 * `otp` (string): If this user has a 2FA device, provide its OTP or code here.
 
 
----
-
-## Reset password given a password reset code
-
-```
-Files::Session.forgot_reset(
-  code: "abc123", 
-  password: "password", 
-  confirm_password: "password", 
-  interface: "web", 
-  locale: "en", 
-  otp: "123456"
-)
-```
-
-### Parameters
-
-* `code` (string): Required - 
-* `password` (string): Required - 
-* `confirm_password` (string): 
-* `interface` (string): 
-* `locale` (string): 
-* `otp` (string): 
-
-
----
-
-## Validate password reset code
-
-```
-Files::Session.forgot_validate(
-  code: "abc123"
-)
-```
-
-### Parameters
-
-* `code` (string): Required - 
-
-
----
-
-## Initiate a password reset process given an email address or username
-
-```
-Files::Session.forgot(
-  email: "johndoe@gmail.com"
-)
-```
-
-### Parameters
-
-* `email` (string): 
-* `username` (string): 
-
-
----
-
-## Create long lived session (API Key) from Pairing Key
-
-```
-Files::Session.pairing_key(key)
-```
-
-### Parameters
-
-* `key` (string): Required - The pairing key to reserve for login.  Cannot be reused
-
-
----
-
-## Begin new session via Oauth
-
-```
-Files::Session.oauth(
-  provider: "okta"
-)
-```
-
-### Parameters
-
-* `provider` (string): Required - 
-* `state` (string): 
-
-
 ---
 
 ## Delete user session (log out)

data/docs/site.md

@@ -4,6 +4,7 @@
 
 ```
 {
+  "name": "My Site",
   "allowed_2fa_method_sms": true,
   "allowed_2fa_method_totp": true,
   "allowed_2fa_method_u2f": true,
@@ -59,7 +60,6 @@
   "login_help_text": "Login page help text.",
   "logo": "",
   "max_prior_passwords": 1,
-  "name": "My Site",
   "next_billing_amount": "",
   "next_billing_date": "Apr 20",
   "opt_out_global": true,
@@ -111,6 +111,7 @@
 }
 ```
 
+* `name` (string): Site name
 * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
@@ -166,7 +167,6 @@
 * `login_help_text` (string): Login help text
 * `logo`: Branded logo
 * `max_prior_passwords` (int64): Number of prior passwords to disallow
-* `name` (string): Site name
 * `next_billing_amount` (float): Next billing amount
 * `next_billing_date` (string): Next billing date
 * `opt_out_global` (boolean): Use servers in the USA only?
@@ -228,69 +228,13 @@ Files::Site.get
 
 ---
 
-## Get either the most recent usage snapshot (usage data for billing purposes) for a Site, or optionally get a specific usage snapshot
+## Get the most recent usage snapshot (usage data for billing purposes) for a Site
 
 ```
 Files::Site.get_usage
 ```
 
 
----
-
-## Show plan that will be switched to in the future. (Populated if current plan is deprecated and no longer offered beyond the current billing period.)
-
-```
-Files::Site.get_switch_to_plan
-```
-
-
----
-
-## Show the current billing plan of a site
-
-```
-Files::Site.get_plan(
-  currency: "USD"
-)
-```
-
-### Parameters
-
-* `currency` (string): Currency.
-
-
----
-
-## Complete a PayPal subscription
-
-```
-Files::Site.get_paypal_express_info(
-  paypal_token: "[token]"
-)
-```
-
-### Parameters
-
-* `paypal_token` (string): Required - Billing token for use with paypal.
-
-
----
-
-## Initiate a new PayPal subscription
-
-```
-Files::Site.get_paypal_express(
-  return_to_url: "https://app.files.com/...", 
-  plan_id: 1
-)
-```
-
-### Parameters
-
-* `return_to_url` (string): Required - URL that paypal express forwards the user to.
-* `plan_id` (int64): Required - Plan ID to switch to.
-
-
 ---
 
 ## Update site settings
@@ -479,36 +423,3 @@ Files::Site.update(
 * `ldap_password_change` (string): New LDAP password.
 * `ldap_password_change_confirmation` (string): Confirm new LDAP password.
 * `smtp_password` (string): Password for SMTP server.
-
-
----
-
-## Change the current billing plan for the site
-
-```
-Files::Site.update_plan(id, 
-  billing_frequency: 1
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Site ID.
-* `billing_frequency` (int64): The billing frequency for the site.  Must be 1(monthly) or 12(annual).
-
-
----
-
-## Change the current billing plan for the site
-
-```
-site = Files::Site.find(1)
-site.update_plan(
-  billing_frequency: 1
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Site ID.
-* `billing_frequency` (int64): The billing frequency for the site.  Must be 1(monthly) or 12(annual).

data/docs/style.md

@@ -4,14 +4,16 @@
 
 ```
 {
-  "logo": "",
+  "id": 1,
   "path": "",
+  "logo": "",
   "thumbnail": ""
 }
 ```
 
-* `logo`: Logo
+* `id` (int64): Style ID
 * `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `logo`: Logo
 * `thumbnail`: Logo thumbnail
 * `file` (file): Logo for custom branding.
 

data/docs/usage_daily_snapshot.md

@@ -0,0 +1,37 @@
+# UsageDailySnapshot
+
+## Example UsageDailySnapshot Object
+
+```
+{
+  "id": 1,
+  "date": "2020-11-21",
+  "current_storage": "65536",
+  "usage_by_top_level_dir": [
+
+  ]
+}
+```
+
+* `id` (int64): ID of the usage record
+* `date` (date): The date of this usage record
+* `current_storage` (int64): The quantity of storage held for this site
+* `usage_by_top_level_dir` (array): Usage broken down by each top-level folder
+
+
+---
+
+## List Usage Daily Snapshots
+
+```
+Files::UsageDailySnapshot.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/usage_snapshot.md

@@ -5,11 +5,11 @@
 ```
 {
   "id": 1,
+  "start_at": "2000-01-01 01:00:00 UTC",
+  "end_at": "2000-01-01 01:00:00 UTC",
   "created_at": "2000-01-01 01:00:00 UTC",
   "current_storage": "",
-  "end_at": "2000-01-01 01:00:00 UTC",
   "high_water_storage": "",
-  "start_at": "2000-01-01 01:00:00 UTC",
   "total_downloads": 1,
   "total_uploads": 1,
   "updated_at": "2000-01-01 01:00:00 UTC",
@@ -21,11 +21,11 @@
 ```
 
 * `id` (int64): Site usage ID
+* `start_at` (date-time): Site usage report start date/time
+* `end_at` (date-time): Site usage report end date/time
 * `created_at` (date-time): Site usage report created at date/time
 * `current_storage` (float): Current site usage as of report
-* `end_at` (date-time): Site usage report end date/time
 * `high_water_storage` (float): Site usage report highest usage in time period
-* `start_at` (date-time): Site usage report start date/time
 * `total_downloads` (int64): Number of downloads in report time period
 * `total_uploads` (int64): Number of uploads in time period
 * `updated_at` (date-time): The last time this site usage report was updated
@@ -33,3 +33,21 @@
 * `root_storage` (float): Usage for root folder
 * `deleted_files_counted_in_minimum` (float): Usage for files that are deleted but uploaded within last 30 days
 * `deleted_files_storage` (float): Usage for files that are deleted but retained as backups
+
+
+---
+
+## List Usage Snapshots
+
+```
+Files::UsageSnapshot.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/user.md

@@ -5,6 +5,7 @@
 ```
 {
   "id": 1,
+  "username": "user",
   "admin_group_ids": [
 
   ],
@@ -47,12 +48,12 @@
   "externally_managed": true,
   "time_zone": "Pacific Time (US & Canada)",
   "type_of_2fa": "",
-  "user_root": "",
-  "username": "user"
+  "user_root": ""
 }
 ```
 
 * `id` (int64): User ID
+* `username` (string): User's username
 * `admin_group_ids` (array): List of group IDs of which this user is an administrator
 * `allowed_ips` (string): A list of allowed IPs if applicable.  Newline delimited
 * `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)?  This field will be aliased or renamed in the future to `bundles_permission`.
@@ -92,7 +93,6 @@
 * `time_zone` (string): User time zone
 * `type_of_2fa` (string): Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.
 * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
-* `username` (string): User's username
 * `avatar_file` (file): An image file for your user avatar.
 * `avatar_delete` (boolean): If true, the avatar will be deleted.
 * `change_password` (string): Used for changing a password on an existing user.

data/docs/user_cipher_use.md

@@ -4,19 +4,19 @@
 
 ```
 {
-  "created_at": "2000-01-01 01:00:00 UTC",
   "id": 1,
-  "interface": "restapi",
   "protocol_cipher": "TLSv1.2; ECDHE-RSA-AES256-GCM-SHA384",
+  "created_at": "2000-01-01 01:00:00 UTC",
+  "interface": "restapi",
   "updated_at": "2000-01-01 01:00:00 UTC",
   "user_id": 1
 }
 ```
 
-* `created_at` (date-time): The earliest recorded use of this combination of interface and protocol and cipher (for this user)
 * `id` (int64): UserCipherUse ID
-* `interface` (string): The interface accessed
 * `protocol_cipher` (string): The protocol and cipher employed
+* `created_at` (date-time): The earliest recorded use of this combination of interface and protocol and cipher (for this user)
+* `interface` (string): The interface accessed
 * `updated_at` (date-time): The most recent use of this combination of interface and protocol and cipher (for this user)
 * `user_id` (int64): ID of the user who performed this access
 

data/lib/files.com.rb

@@ -24,14 +24,11 @@ require "files.com/util"
 
 require "files.com/models/account_line_item"
 require "files.com/models/action"
-require "files.com/models/announcement"
 require "files.com/models/api_key"
 require "files.com/models/auto"
 require "files.com/models/automation"
 require "files.com/models/behavior"
-require "files.com/models/blog_post"
 require "files.com/models/bundle"
-require "files.com/models/certificate"
 require "files.com/models/dns_record"
 require "files.com/models/errors"
 require "files.com/models/file"
@@ -53,14 +50,9 @@ require "files.com/models/message_comment"
 require "files.com/models/message_comment_reaction"
 require "files.com/models/message_reaction"
 require "files.com/models/notification"
-require "files.com/models/oauth_redirect"
-require "files.com/models/paired_api_key"
 require "files.com/models/payment"
 require "files.com/models/payment_line_item"
-require "files.com/models/paypal_express_info"
-require "files.com/models/paypal_express_url"
 require "files.com/models/permission"
-require "files.com/models/plan"
 require "files.com/models/preview"
 require "files.com/models/project"
 require "files.com/models/public_key"
@@ -68,17 +60,12 @@ require "files.com/models/remote_server"
 require "files.com/models/request"
 require "files.com/models/session"
 require "files.com/models/site"
-require "files.com/models/sso_strategy"
 require "files.com/models/status"
 require "files.com/models/style"
-require "files.com/models/support_request"
-require "files.com/models/two_factor_authentication_method"
-require "files.com/models/two_factor_authentication_method"
-require "files.com/models/u2f_sign_request"
+require "files.com/models/usage_daily_snapshot"
 require "files.com/models/usage_snapshot"
 require "files.com/models/user"
 require "files.com/models/user_cipher_use"
-require "files.com/models/zip_download"
 
 require "files.com/models/dir"
 require "files.com/models/file_utils"