files.com 1.0.234 → 1.0.238

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c9aa203cb23d5b4c1ae48b589c8f069cd78f39d26289679392443c18ba83f0
-  data.tar.gz: 1c1cbeda7895467928e54e512a1ffcf4a54a97ed3b650c5ee8b77db264096a7f
+  metadata.gz: 702a974ca2b9858e24c5906f60f5c4ffeac5968bdbc9bae74cc4cea3cf9b265a
+  data.tar.gz: b267aeae588b6b132d8824691624a53160f80a49231b632f217a0ac01f4c6621
 SHA512:
-  metadata.gz: 2d46ad77c62175cc52cfdfac5447e55157a68f68015cf89a6f60f51f92c3fbd99c4b60e7605eb8b3f80c33832bd1e8c4c787487d6b770cebf432356ad9a78052
-  data.tar.gz: 9f4fc11df51decb6117de8aa532886dd8943fa04f90d90d1f50ffac2e8ee8befc8717fc845a23ddd797d2965ed0a84ed632aa56e46c151b46ac7dcfcc811636d
+  metadata.gz: bcbd8b164d5ea6992cd87aeb84cc8c66643b7e6bf2ec59278905087639f83e16b37c176ecdd6477558ac0465296769c7d064af0d7a99567039484ab02369b7e1
+  data.tar.gz: ef1b9b6f097f5a4a9f0a5c90b5196afc65c499c24bf37ece5d21bffe50f404f7b5515e75f4570aa8a7ae31394f05d0b933727798dc969c651421fe08eb4fed34

data/_VERSION

@@ -1 +1 @@
-1.0.234
+1.0.238

data/docs/automation.md

@@ -40,7 +40,6 @@
   ],
   "webhook_url": "https://app.files.com/api/webhooks/abc123",
   "trigger_actions": "[ \"create\" ]",
-  "trigger_action_path": "path/to/file/or/folder",
   "value": "{\"limit\": \"1\"}"
 }
 ```
@@ -62,7 +61,6 @@
 * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
 * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
 * `trigger_actions` (string): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 * `value` (object): A Hash of attributes specific to the automation type.
 * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
 
@@ -120,7 +118,6 @@ Files::Automation.create(
   schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}", 
   trigger: "realtime", 
   trigger_actions: "[ \"create\" ]", 
-  trigger_action_path: "path/to/file/or/folder", 
   value: "{\"limit\": \"1\"}"
 )
 ```
@@ -142,7 +139,6 @@ Files::Automation.create(
 * `name` (string): Name for this automation.
 * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 * `value` (object): A Hash of attributes specific to the automation type.
 
 
@@ -161,7 +157,6 @@ Files::Automation.update(id,
   schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}", 
   trigger: "realtime", 
   trigger_actions: "[ \"create\" ]", 
-  trigger_action_path: "path/to/file/or/folder", 
   value: "{\"limit\": \"1\"}"
 )
 ```
@@ -184,7 +179,6 @@ Files::Automation.update(id,
 * `name` (string): Name for this automation.
 * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 * `value` (object): A Hash of attributes specific to the automation type.
 
 
@@ -218,7 +212,6 @@ automation.update(
   schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
   trigger: "realtime",
   trigger_actions: "[ \"create\" ]",
-  trigger_action_path: "path/to/file/or/folder",
   value: "{\"limit\": \"1\"}"
 )
 ```
@@ -241,7 +234,6 @@ automation.update(
 * `name` (string): Name for this automation.
 * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
 * `value` (object): A Hash of attributes specific to the automation type.
 
 

data/docs/remote_server.md

@@ -5,6 +5,7 @@
 ```
 {
   "id": 1,
+  "disabled": true,
   "authentication_method": "password",
   "hostname": "remote-server.com",
   "remote_home_path": "/home/user1",
@@ -40,6 +41,7 @@
 ```
 
 * `id` (int64): Remote server ID
+* `disabled` (boolean): If true, this server has been disabled due to failures.  Make any change or set disabled to false to clear this flag.
 * `authentication_method` (string): Type of authentication method
 * `hostname` (string): Hostname or IP address
 * `remote_home_path` (string): Initial home folder on remote server

data/docs/session.md

@@ -20,6 +20,7 @@
   "allowed_2fa_method_sms": true,
   "allowed_2fa_method_totp": true,
   "allowed_2fa_method_u2f": true,
+  "allowed_2fa_method_webauthn": true,
   "allowed_2fa_method_yubi": true,
   "use_provided_modified_at": true,
   "windows_mode_ftp": true
@@ -42,6 +43,7 @@
 * `allowed_2fa_method_sms` (boolean): Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Sent only if 2FA setup is needed. Is U2F two factor authentication allowed?
+* `allowed_2fa_method_webauthn` (boolean): Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
 * `allowed_2fa_method_yubi` (boolean): Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
 * `use_provided_modified_at` (boolean): Allow the user to provide file/folder modified at dates?  If false, the server will always use the current date/time.
 * `windows_mode_ftp` (boolean): Does this user want to use Windows line-ending emulation?  (CR vs CRLF)

data/docs/site.md

@@ -8,6 +8,7 @@
   "allowed_2fa_method_sms": true,
   "allowed_2fa_method_totp": true,
   "allowed_2fa_method_u2f": true,
+  "allowed_2fa_method_webauthn": true,
   "allowed_2fa_method_yubi": true,
   "admin_user_id": 1,
   "allow_bundle_names": true,
@@ -130,6 +131,7 @@
     "allowed_2fa_method_sms": true,
     "allowed_2fa_method_totp": true,
     "allowed_2fa_method_u2f": true,
+    "allowed_2fa_method_webauthn": true,
     "allowed_2fa_method_yubi": true,
     "use_provided_modified_at": true,
     "windows_mode_ftp": false
@@ -226,6 +228,7 @@
 * `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?
+* `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
 * `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
 * `admin_user_id` (int64): User ID for the main site administrator
 * `allow_bundle_names` (boolean): Are manual Bundle names allowed?
@@ -439,6 +442,7 @@ Files::Site.update(
   allowed_2fa_method_sms: true, 
   allowed_2fa_method_u2f: true, 
   allowed_2fa_method_totp: true, 
+  allowed_2fa_method_webauthn: true, 
   allowed_2fa_method_yubi: true, 
   require_2fa: true, 
   require_2fa_user_type: "`site_admins`", 
@@ -545,6 +549,7 @@ Files::Site.update(
 * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
+* `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
 * `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
 * `require_2fa` (boolean): Require two-factor authentication for all users?
 * `require_2fa_user_type` (string): What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?

data/docs/sso_strategy.md

@@ -85,7 +85,7 @@
 * `provision_company` (string): Default company for auto provisioned users.
 * `ldap_base_dn` (string): Base DN for looking up users in LDAP server
 * `ldap_domain` (string): Domain name that will be appended to LDAP usernames
-* `enabled` (boolean): Is strategy enabled?
+* `enabled` (boolean): Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
 * `ldap_host` (string): LDAP host
 * `ldap_host_2` (string): LDAP backup host
 * `ldap_host_3` (string): LDAP backup host

data/docs/usage_daily_snapshot.md

@@ -6,7 +6,14 @@
 {
   "id": 1,
   "date": "2020-11-21",
+  "api_usage_available": true,
+  "read_api_usage": "100",
+  "write_api_usage": "50",
+  "user_count": "25",
   "current_storage": "65536",
+  "deleted_files_storage": "65536",
+  "deleted_files_counted_in_minimum": "65536",
+  "root_storage": "65536",
   "usage_by_top_level_dir": [
 
   ]
@@ -15,7 +22,14 @@
 
 * `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
+* `api_usage_available` (boolean): True if the API usage fields `read_api_usage` and `write_api_usage` can be relied upon.  If this is false, we suggest hiding that value from any UI.
+* `read_api_usage` (int64): Read API Calls used on this day. Note: only updated for days before the current day.
+* `write_api_usage` (int64): Write API Calls used on this day. Note: only updated for days before the current day.
+* `user_count` (int64): Number of billable users as of this day.
+* `current_storage` (int64): GB of Files Native Storage used on this day.
+* `deleted_files_storage` (int64): GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
+* `deleted_files_counted_in_minimum` (int64): GB of Files Native Storage used on this day for files that have been permanently deleted but were uploaded less than 30 days ago, and are still billable.
+* `root_storage` (int64): GB of Files Native Storage used for the root folder.  Included here because this value will not be part of `usage_by_top_level_dir`
 * `usage_by_top_level_dir` (array): Usage broken down by each top-level folder
 
 

data/docs/usage_snapshot.md

@@ -17,24 +17,34 @@
   "usage_by_top_level_dir": "",
   "root_storage": 1.0,
   "deleted_files_counted_in_minimum": 1.0,
-  "deleted_files_storage": 1.0
+  "deleted_files_storage": 1.0,
+  "total_billable_usage": 1.0,
+  "total_billable_transfer_usage": 1.0,
+  "bytes_sent": 1.0,
+  "sync_bytes_received": 1.0,
+  "sync_bytes_sent": 1.0
 }
 ```
 
-* `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
-* `high_water_user_count` (double): Site usage report highest usage in time period
-* `current_storage` (double): Current site usage as of report
-* `high_water_storage` (double): Site usage report highest usage in time period
-* `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
-* `usage_by_top_level_dir` (object): A map of root folders to their total usage
-* `root_storage` (double): Usage for root folder
-* `deleted_files_counted_in_minimum` (double): Usage for files that are deleted but uploaded within last 30 days
-* `deleted_files_storage` (double): Usage for files that are deleted but retained as backups
+* `id` (int64): Usage snapshot ID
+* `start_at` (date-time): Usage snapshot start date/time
+* `end_at` (date-time): Usage snapshot end date/time
+* `created_at` (date-time): DEPRECATED: Usage snapshot created at date/time
+* `high_water_user_count` (double): Highest user count number in time period
+* `current_storage` (double): Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
+* `high_water_storage` (double): Highest Storage Usage GB recorded in time period (used for billing)
+* `total_downloads` (int64): DEPRECATED: Number of downloads in report time period
+* `total_uploads` (int64): DEPRECATED: Number of uploads in time period
+* `updated_at` (date-time): DEPRECATED: The last time this site usage report was updated
+* `usage_by_top_level_dir` (object): Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)
+* `root_storage` (double): Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
+* `deleted_files_counted_in_minimum` (double): Storage Usage for files that are deleted but uploaded within last 30 days as of end date (not necessarily high water mark, which is used for billing)
+* `deleted_files_storage` (double): Storage Usage for files that are deleted but retained as backups as of end date (not necessarily high water mark, which is used for billing)
+* `total_billable_usage` (double): Storage + Transfer Usage - Total Billable amount
+* `total_billable_transfer_usage` (double): Transfer usage for period - Total Billable amount
+* `bytes_sent` (double): Transfer Usage for period - Outbound GB from Files Native Storage
+* `sync_bytes_received` (double): Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
+* `sync_bytes_sent` (double): Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
 
 
 ---

data/lib/files.com/models/automation.rb

@@ -162,15 +162,6 @@ module Files
       @attributes[:trigger_actions] = value
     end
 
-    # string - If trigger is `action`, this is the path to watch for the specified trigger actions.
-    def trigger_action_path
-      @attributes[:trigger_action_path]
-    end
-
-    def trigger_action_path=(value)
-      @attributes[:trigger_action_path] = value
-    end
-
     # object - A Hash of attributes specific to the automation type.
     def value
       @attributes[:value]
@@ -205,7 +196,6 @@ module Files
     #   name - string - Name for this automation.
     #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
     #   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-    #   trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
     #   value - object - A Hash of attributes specific to the automation type.
     def update(params = {})
       params ||= {}
@@ -226,7 +216,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
-      raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 
@@ -320,7 +309,6 @@ module Files
     #   name - string - Name for this automation.
     #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
     #   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-    #   trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
     #   value - object - A Hash of attributes specific to the automation type.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
@@ -338,7 +326,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
-      raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
 
@@ -362,7 +349,6 @@ module Files
     #   name - string - Name for this automation.
     #   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
     #   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
-    #   trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
     #   value - object - A Hash of attributes specific to the automation type.
     def self.update(id, params = {}, options = {})
       params ||= {}
@@ -383,7 +369,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
-      raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
       raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)

data/lib/files.com/models/remote_server.rb

@@ -18,6 +18,15 @@ module Files
       @attributes[:id] = value
     end
 
+    # boolean - If true, this server has been disabled due to failures.  Make any change or set disabled to false to clear this flag.
+    def disabled
+      @attributes[:disabled]
+    end
+
+    def disabled=(value)
+      @attributes[:disabled] = value
+    end
+
     # string - Type of authentication method
     def authentication_method
       @attributes[:authentication_method]

data/lib/files.com/models/session.rb

@@ -157,6 +157,15 @@ module Files
       @attributes[:allowed_2fa_method_u2f] = value
     end
 
+    # boolean - Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
+    def allowed_2fa_method_webauthn
+      @attributes[:allowed_2fa_method_webauthn]
+    end
+
+    def allowed_2fa_method_webauthn=(value)
+      @attributes[:allowed_2fa_method_webauthn] = value
+    end
+
     # boolean - Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
     def allowed_2fa_method_yubi
       @attributes[:allowed_2fa_method_yubi]

data/lib/files.com/models/site.rb

@@ -29,6 +29,11 @@ module Files
       @attributes[:allowed_2fa_method_u2f]
     end
 
+    # boolean - Is WebAuthn two factor authentication allowed?
+    def allowed_2fa_method_webauthn
+      @attributes[:allowed_2fa_method_webauthn]
+    end
+
     # boolean - Is yubikey two factor authentication allowed?
     def allowed_2fa_method_yubi
       @attributes[:allowed_2fa_method_yubi]
@@ -718,6 +723,7 @@ module Files
     #   allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
     #   allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
     #   allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
+    #   allowed_2fa_method_webauthn - boolean - Is WebAuthn two factor authentication allowed?
     #   allowed_2fa_method_yubi - boolean - Is yubikey two factor authentication allowed?
     #   require_2fa - boolean - Require two-factor authentication for all users?
     #   require_2fa_user_type - string - What type of user is required to use two-factor authentication (when require_2fa is set to `true` for this site)?

data/lib/files.com/models/sso_strategy.rb

@@ -184,7 +184,7 @@ module Files
       @attributes[:ldap_domain]
     end
 
-    # boolean - Is strategy enabled?
+    # boolean - Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
     def enabled
       @attributes[:enabled]
     end

data/lib/files.com/models/usage_daily_snapshot.rb

@@ -19,11 +19,46 @@ module Files
       @attributes[:date]
     end
 
-    # int64 - The quantity of storage held for this site
+    # boolean - True if the API usage fields `read_api_usage` and `write_api_usage` can be relied upon.  If this is false, we suggest hiding that value from any UI.
+    def api_usage_available
+      @attributes[:api_usage_available]
+    end
+
+    # int64 - Read API Calls used on this day. Note: only updated for days before the current day.
+    def read_api_usage
+      @attributes[:read_api_usage]
+    end
+
+    # int64 - Write API Calls used on this day. Note: only updated for days before the current day.
+    def write_api_usage
+      @attributes[:write_api_usage]
+    end
+
+    # int64 - Number of billable users as of this day.
+    def user_count
+      @attributes[:user_count]
+    end
+
+    # int64 - GB of Files Native Storage used on this day.
     def current_storage
       @attributes[:current_storage]
     end
 
+    # int64 - GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
+    def deleted_files_storage
+      @attributes[:deleted_files_storage]
+    end
+
+    # int64 - GB of Files Native Storage used on this day for files that have been permanently deleted but were uploaded less than 30 days ago, and are still billable.
+    def deleted_files_counted_in_minimum
+      @attributes[:deleted_files_counted_in_minimum]
+    end
+
+    # int64 - GB of Files Native Storage used for the root folder.  Included here because this value will not be part of `usage_by_top_level_dir`
+    def root_storage
+      @attributes[:root_storage]
+    end
+
     # array - Usage broken down by each top-level folder
     def usage_by_top_level_dir
       @attributes[:usage_by_top_level_dir]

data/lib/files.com/models/usage_snapshot.rb

@@ -9,76 +9,101 @@ module Files
       @options = options || {}
     end
 
-    # int64 - Site usage ID
+    # int64 - Usage snapshot ID
     def id
       @attributes[:id]
     end
 
-    # date-time - Site usage report start date/time
+    # date-time - Usage snapshot start date/time
     def start_at
       @attributes[:start_at]
     end
 
-    # date-time - Site usage report end date/time
+    # date-time - Usage snapshot end date/time
     def end_at
       @attributes[:end_at]
     end
 
-    # date-time - Site usage report created at date/time
+    # date-time - DEPRECATED: Usage snapshot created at date/time
     def created_at
       @attributes[:created_at]
     end
 
-    # double - Site usage report highest usage in time period
+    # double - Highest user count number in time period
     def high_water_user_count
       @attributes[:high_water_user_count]
     end
 
-    # double - Current site usage as of report
+    # double - Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
     def current_storage
       @attributes[:current_storage]
     end
 
-    # double - Site usage report highest usage in time period
+    # double - Highest Storage Usage GB recorded in time period (used for billing)
     def high_water_storage
       @attributes[:high_water_storage]
     end
 
-    # int64 - Number of downloads in report time period
+    # int64 - DEPRECATED: Number of downloads in report time period
     def total_downloads
       @attributes[:total_downloads]
     end
 
-    # int64 - Number of uploads in time period
+    # int64 - DEPRECATED: Number of uploads in time period
     def total_uploads
       @attributes[:total_uploads]
     end
 
-    # date-time - The last time this site usage report was updated
+    # date-time - DEPRECATED: The last time this site usage report was updated
     def updated_at
       @attributes[:updated_at]
     end
 
-    # object - A map of root folders to their total usage
+    # object - Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)
     def usage_by_top_level_dir
       @attributes[:usage_by_top_level_dir]
     end
 
-    # double - Usage for root folder
+    # double - Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
     def root_storage
       @attributes[:root_storage]
     end
 
-    # double - Usage for files that are deleted but uploaded within last 30 days
+    # double - Storage Usage for files that are deleted but uploaded within last 30 days as of end date (not necessarily high water mark, which is used for billing)
     def deleted_files_counted_in_minimum
       @attributes[:deleted_files_counted_in_minimum]
     end
 
-    # double - Usage for files that are deleted but retained as backups
+    # double - Storage Usage for files that are deleted but retained as backups as of end date (not necessarily high water mark, which is used for billing)
     def deleted_files_storage
       @attributes[:deleted_files_storage]
     end
 
+    # double - Storage + Transfer Usage - Total Billable amount
+    def total_billable_usage
+      @attributes[:total_billable_usage]
+    end
+
+    # double - Transfer usage for period - Total Billable amount
+    def total_billable_transfer_usage
+      @attributes[:total_billable_transfer_usage]
+    end
+
+    # double - Transfer Usage for period - Outbound GB from Files Native Storage
+    def bytes_sent
+      @attributes[:bytes_sent]
+    end
+
+    # double - Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
+    def sync_bytes_received
+      @attributes[:sync_bytes_received]
+    end
+
+    # double - Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
+    def sync_bytes_sent
+      @attributes[:sync_bytes_sent]
+    end
+
     # Parameters:
     #   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

data/lib/files.com.rb

@@ -94,7 +94,6 @@ 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/sync_job"
 require "files.com/models/usage_daily_snapshot"
 require "files.com/models/usage_snapshot"
 require "files.com/models/user"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.234
+  version: 1.0.238
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -154,7 +154,6 @@ files:
 - docs/sso_strategy.md
 - docs/status.md
 - docs/style.md
-- docs/sync_job.md
 - docs/usage_daily_snapshot.md
 - docs/usage_snapshot.md
 - docs/user.md
@@ -236,7 +235,6 @@ files:
 - lib/files.com/models/sso_strategy.rb
 - lib/files.com/models/status.rb
 - lib/files.com/models/style.rb
-- lib/files.com/models/sync_job.rb
 - lib/files.com/models/usage_daily_snapshot.rb
 - lib/files.com/models/usage_snapshot.rb
 - lib/files.com/models/user.rb

data/docs/sync_job.md

@@ -1,37 +0,0 @@
-# SyncJob
-
-## Example SyncJob Object
-
-```
-{
-  "queued_at": "2000-01-01T01:00:00Z",
-  "updated_at": "2000-01-01T01:00:00Z",
-  "status": "",
-  "regional_worker_status": "",
-  "uuid": "",
-  "folder_behavior_id": 1
-}
-```
-
-* `queued_at` (date-time): Job enqueued at
-* `updated_at` (date-time): Job updated at
-* `status` (string): Status of the job
-* `regional_worker_status` (string): Most recent reported status of sync worker
-* `uuid` (string): 
-* `folder_behavior_id` (int64): 
-
-
----
-
-## List Sync Jobs
-
-```
-Files::SyncJob.list(
-  per_page: 1
-)
-```
-
-### Parameters
-
-* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
-* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

data/lib/files.com/models/sync_job.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Files
-  class SyncJob
-    attr_reader :options, :attributes
-
-    def initialize(attributes = {}, options = {})
-      @attributes = attributes || {}
-      @options = options || {}
-    end
-
-    # date-time - Job enqueued at
-    def queued_at
-      @attributes[:queued_at]
-    end
-
-    # date-time - Job updated at
-    def updated_at
-      @attributes[:updated_at]
-    end
-
-    # string - Status of the job
-    def status
-      @attributes[:status]
-    end
-
-    # string - Most recent reported status of sync worker
-    def regional_worker_status
-      @attributes[:regional_worker_status]
-    end
-
-    # string -
-    def uuid
-      @attributes[:uuid]
-    end
-
-    # int64 -
-    def folder_behavior_id
-      @attributes[:folder_behavior_id]
-    end
-
-    # Parameters:
-    #   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
-    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-    def self.list(params = {}, options = {})
-      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
-
-      List.new(SyncJob, params) do
-        Api.send_request("/sync_jobs", :get, params, options)
-      end
-    end
-
-    def self.all(params = {}, options = {})
-      list(params, options)
-    end
-  end
-end