files.com 1.1.230 → 1.1.231

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8309425829c7f947659200c185cd061e3422038dbb790345755409d62a6bc5b7
-  data.tar.gz: 1e87980008366266db66e2486cdd327c372926cebdbffcd932640d49d521d738
+  metadata.gz: 4be4b7ffa8ffd7a3db512b9f4b79cf66081245d9d6832c13c0f0c1f66d8c85fc
+  data.tar.gz: ebb0ee8688dbd4424fc452ad979d292681d5b4332bd9bba964d1519d1a8d331a
 SHA512:
-  metadata.gz: 3d08e1655d0a13bceb234f114e8df87f5a4e59a782da391542bf3d2710ea2ba38babb94a776f72122f4c35fd3f3bd81bfb4140dbe2e886c32730d8c5f5c6837a
-  data.tar.gz: 1b8364527619fa335e5addc27969e046e7f85d4175bf7f9c9017b1a4e55001f8d0315020476d0ccb80fa6cbf69ae1f5cf8875bfc6c4192f7193a3e286ea51100
+  metadata.gz: 27c04b53793b214060e51c42bd0fb7f55a115761da323e4eedf1eb76ca5bc703c6a38e0e38835bb0962615d03be9dea2722af2ed1a015ee53b2a30755742b84b
+  data.tar.gz: 90f86d10af31aed54120001cc4e392058ceb9376e67dc2e86d784c84799b83e83e5f29cb3cd6240a4676be8bff8701d79f6ff0956e11adf1ae2927027355aa0d

data/_VERSION

@@ -1 +1 @@
-1.1.230
+1.1.231

data/docs/action_notification_export.md

@@ -5,7 +5,7 @@
 ```
 {
   "id": 1,
-  "export_version": "example",
+  "export_version": "20201213.2",
   "start_at": "2000-01-01T01:00:00Z",
   "end_at": "2000-01-01T01:00:00Z",
   "status": "ready",

data/docs/automation.md

@@ -45,7 +45,18 @@
   "recurring_day": 25,
   "retry_on_failure_interval_in_minutes": 60,
   "retry_on_failure_number_of_attempts": 10,
-  "schedule": "example",
+  "schedule": {
+    "days_of_week": [
+      0,
+      2,
+      4
+    ],
+    "times_of_day": [
+      "06:30",
+      "14:30"
+    ],
+    "time_zone": "Eastern Time (US & Canada)"
+  },
   "human_readable_schedule": "Triggered every Monday, Wednesday at 6:30 AM,\n  2:30 PM Eastern Time (US & Canada) TZ",
   "schedule_days_of_week": [
     0,

data/docs/automation_run.md

@@ -8,7 +8,7 @@
   "automation_id": 1,
   "completed_at": "2000-01-01T01:00:00Z",
   "created_at": "2000-01-01T01:00:00Z",
-  "retry_at": "example",
+  "retry_at": "2000-01-01T01:00:00Z",
   "retried_at": "2000-01-01T01:00:00Z",
   "retried_in_run_id": 1,
   "retry_of_run_id": 1,
@@ -24,7 +24,7 @@
 * `automation_id` (int64): ID of the associated Automation.
 * `completed_at` (date-time): Automation run completion/failure date/time.
 * `created_at` (date-time): Automation run start date/time.
-* `retry_at` (string): If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
+* `retry_at` (date-time): If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
 * `retried_at` (date-time): If set, this Automation run was retried due to `failure` or `partial_failure`.
 * `retried_in_run_id` (int64): ID of the run that is or will be retrying this run.
 * `retry_of_run_id` (int64): ID of the original run that this run is retrying.

data/docs/behavior.md

@@ -11,7 +11,7 @@
   "name": "example",
   "description": "example",
   "value": {
-    "key": "example value"
+    "method": "GET"
   },
   "disable_parent_folder_behavior": true,
   "recursive": true

data/docs/dns_record.md

@@ -4,7 +4,7 @@
 
 ```
 {
-  "id": "example",
+  "id": "customdomain.com-CNAME-site.files.com",
   "domain": "my-custom-domain.com",
   "rrtype": "CNAME",
   "value": "mysite.files.com"

data/docs/group.md

@@ -10,7 +10,7 @@
   "admin_ids": "1",
   "notes": "example",
   "user_ids": "1",
-  "usernames": "example",
+  "usernames": "user",
   "ftp_permission": true,
   "sftp_permission": true,
   "dav_permission": true,

data/docs/group_user.md

@@ -4,7 +4,7 @@
 
 ```
 {
-  "group_name": "example",
+  "group_name": "My Group",
   "group_id": 1,
   "user_id": 1,
   "admin": true,

data/docs/history_export.md

@@ -5,7 +5,7 @@
 ```
 {
   "id": 1,
-  "history_version": "example",
+  "history_version": "20201213.2",
   "start_at": "2000-01-01T01:00:00Z",
   "end_at": "2000-01-01T01:00:00Z",
   "status": "ready",

data/docs/inbox_upload.md

@@ -4,7 +4,22 @@
 
 ```
 {
-  "inbox_registration": "example",
+  "inbox_registration": {
+    "code": "abc123",
+    "name": "account",
+    "company": "Action Verb",
+    "email": "john.doe@files.com",
+    "ip": "10.1.1.1",
+    "clickwrap_body": "example",
+    "form_field_set_id": 1,
+    "form_field_data": {
+      "key": "example value"
+    },
+    "inbox_id": 1,
+    "inbox_recipient_id": 1,
+    "inbox_title": "example",
+    "created_at": "2000-01-01T01:00:00Z"
+  },
   "path": "a/b/test.txt",
   "created_at": "2000-01-01T01:00:00Z"
 }

data/docs/request.md

@@ -8,7 +8,7 @@
   "path": "example",
   "source": "example",
   "destination": "example",
-  "automation_id": "example",
+  "automation_id": 1,
   "user_display_name": "example"
 }
 ```
@@ -17,7 +17,7 @@
 * `path` (string): Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `source` (string): Source filename, if applicable
 * `destination` (string): Destination filename
-* `automation_id` (string): ID of automation that created request
+* `automation_id` (int64): ID of automation that created request
 * `user_display_name` (string): User making the request (if applicable)
 * `user_ids` (string): A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.

data/docs/sftp_host_key.md

@@ -5,9 +5,9 @@
 ```
 {
   "id": 1,
-  "name": "example",
-  "fingerprint_md5": "example",
-  "fingerprint_sha256": "example"
+  "name": "My Key",
+  "fingerprint_md5": "12:7e:f8:61:78:a4:b2:c2:ee:12:51:92:25:a7:42:cc",
+  "fingerprint_sha256": "SHA256:5ANRkDpXWA+PgOquzZAG9RtQ1Bt8KXYAH2hecr7LQk8"
 }
 ```
 
@@ -51,7 +51,7 @@ Files::SftpHostKey.find(id)
 
 ```
 Files::SftpHostKey.create(
-  name: "example"
+  name: "My Key"
 )
 ```
 
@@ -67,7 +67,7 @@ Files::SftpHostKey.create(
 
 ```
 Files::SftpHostKey.update(id, 
-  name: "example"
+  name: "My Key"
 )
 ```
 
@@ -99,7 +99,7 @@ Files::SftpHostKey.delete(id)
 sftp_host_key = Files::SftpHostKey.find(id)
 
 sftp_host_key.update(
-  name: "example"
+  name: "My Key"
 )
 ```
 

data/docs/site.md

@@ -78,9 +78,9 @@
   "domain": "my-custom-domain.com",
   "domain_hsts_header": true,
   "domain_letsencrypt_chain": "example",
-  "email": "example",
+  "email": "john.doe@files.com",
   "ftp_enabled": true,
-  "reply_to_email": "example",
+  "reply_to_email": "jane.doe@files.com",
   "non_sso_groups_allowed": true,
   "non_sso_users_allowed": true,
   "folder_permissions_groups_only": true,
@@ -231,7 +231,7 @@
     "dav_permission": true,
     "disabled": true,
     "disabled_expired_or_inactive": true,
-    "email": "example",
+    "email": "john.doe@files.com",
     "first_login_at": "2000-01-01T01:00:00Z",
     "ftp_permission": true,
     "group_ids": "example",
@@ -501,8 +501,8 @@ Files::Site.update(
   domain: "my-custom-domain.com", 
   domain_hsts_header: false, 
   domain_letsencrypt_chain: "example", 
-  email: "example", 
-  reply_to_email: "example", 
+  email: "john.doe@files.com", 
+  reply_to_email: "jane.doe@files.com", 
   allow_bundle_names: false, 
   bundle_expiration: 1, 
   welcome_email_enabled: false, 

data/docs/style.md

@@ -7,7 +7,10 @@
   "id": 1,
   "path": "example",
   "logo": "https://mysite.files.com/...",
-  "thumbnail": "example"
+  "thumbnail": {
+    "name": "My logo",
+    "uri": "https://mysite.files.com/.../my_image.png"
+  }
 }
 ```
 

data/docs/usage_by_top_level_dir.md

@@ -0,0 +1,15 @@
+# UsageByTopLevelDir
+
+## Example UsageByTopLevelDir Object
+
+```
+{
+  "dir": "",
+  "size": 1,
+  "count": 1
+}
+```
+
+* `dir` (string): Directory name
+* `size` (int64): Usage
+* `count` (int64): File count

data/docs/usage_daily_snapshot.md

@@ -10,13 +10,17 @@
   "read_api_usage": 1,
   "write_api_usage": 1,
   "user_count": 1,
-  "current_storage": 1,
-  "deleted_files_storage": 1,
-  "deleted_files_counted_in_minimum": 1,
-  "root_storage": 1,
-  "usage_by_top_level_dir": {
-    "key": "example value"
-  }
+  "current_storage": 1.0,
+  "deleted_files_storage": 1.0,
+  "deleted_files_counted_in_minimum": 1.0,
+  "root_storage": 1.0,
+  "usage_by_top_level_dir": [
+    {
+      "dir": "dir",
+      "size": 100,
+      "count": 10
+    }
+  ]
 }
 ```
 
@@ -26,11 +30,11 @@
 * `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` (object): Usage broken down by each top-level folder
+* `current_storage` (double): GB of Files Native Storage used on this day.
+* `deleted_files_storage` (double): 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` (double): 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` (double): 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(object)): Usage broken down by each top-level folder
 
 
 ---

data/docs/usage_snapshot.md

@@ -7,12 +7,9 @@
   "id": 1,
   "start_at": "2000-01-01T01:00:00Z",
   "end_at": "2000-01-01T01:00:00Z",
-  "high_water_user_count": 1.0,
+  "high_water_user_count": 1,
   "current_storage": 1.0,
   "high_water_storage": 1.0,
-  "usage_by_top_level_dir": {
-    "key": "example value"
-  },
   "root_storage": 1.0,
   "deleted_files_counted_in_minimum": 1.0,
   "deleted_files_storage": 1.0,
@@ -20,17 +17,23 @@
   "total_billable_transfer_usage": 1.0,
   "bytes_sent": 1.0,
   "sync_bytes_received": 1.0,
-  "sync_bytes_sent": 1.0
+  "sync_bytes_sent": 1.0,
+  "usage_by_top_level_dir": [
+    {
+      "dir": "dir",
+      "size": 100,
+      "count": 10
+    }
+  ]
 }
 ```
 
 * `id` (int64): Usage snapshot ID
 * `start_at` (date-time): Usage snapshot start date/time
 * `end_at` (date-time): Usage snapshot end date/time
-* `high_water_user_count` (double): Highest user count number in time period
+* `high_water_user_count` (int64): 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)
-* `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)
@@ -39,6 +42,7 @@
 * `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)
+* `usage_by_top_level_dir` (array(object)): Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)
 
 
 ---

data/docs/user.md

@@ -23,7 +23,7 @@
   "dav_permission": true,
   "disabled": true,
   "disabled_expired_or_inactive": true,
-  "email": "example",
+  "email": "john.doe@files.com",
   "first_login_at": "2000-01-01T01:00:00Z",
   "ftp_permission": true,
   "group_ids": "example",
@@ -199,7 +199,7 @@ Files::User.find(id)
 ```
 Files::User.create(
   avatar_delete: false, 
-  email: "example", 
+  email: "john.doe@files.com", 
   group_id: 1, 
   group_ids: "example", 
   announcements_read: false, 
@@ -338,7 +338,7 @@ Files::User.user_2fa_reset(id)
 ```
 Files::User.update(id, 
   avatar_delete: false, 
-  email: "example", 
+  email: "john.doe@files.com", 
   group_id: 1, 
   group_ids: "example", 
   announcements_read: false, 
@@ -499,7 +499,7 @@ user = Files::User.find(id)
 
 user.update(
   avatar_delete: false,
-  email: "example",
+  email: "john.doe@files.com",
   group_id: 1,
   group_ids: "example",
   announcements_read: false,

data/docs/user_request.md

@@ -6,7 +6,7 @@
 {
   "id": 1,
   "name": "John Doe",
-  "email": "example",
+  "email": "john.doe@files.com",
   "details": "Changed Departments",
   "company": "Acme Inc."
 }

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

@@ -29,7 +29,7 @@ module Files
       @attributes[:created_at]
     end
 
-    # string - If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
+    # date-time - If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
     def retry_at
       @attributes[:retry_at]
     end

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

@@ -45,7 +45,7 @@ module Files
       @attributes[:destination] = value
     end
 
-    # string - ID of automation that created request
+    # int64 - ID of automation that created request
     def automation_id
       @attributes[:automation_id]
     end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Files
+  class UsageByTopLevelDir
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Directory name
+    def dir
+      @attributes[:dir]
+    end
+
+    # int64 - Usage
+    def size
+      @attributes[:size]
+    end
+
+    # int64 - File count
+    def count
+      @attributes[:count]
+    end
+  end
+end

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

@@ -39,27 +39,27 @@ module Files
       @attributes[:user_count]
     end
 
-    # int64 - GB of Files Native Storage used on this day.
+    # double - 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.
+    # double - 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.
+    # double - 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`
+    # double - 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
 
-    # object - Usage broken down by each top-level folder
+    # array(object) - Usage broken down by each top-level folder
     def usage_by_top_level_dir
       @attributes[:usage_by_top_level_dir]
     end

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

@@ -24,7 +24,7 @@ module Files
       @attributes[:end_at]
     end
 
-    # double - Highest user count number in time period
+    # int64 - Highest user count number in time period
     def high_water_user_count
       @attributes[:high_water_user_count]
     end
@@ -39,11 +39,6 @@ module Files
       @attributes[:high_water_storage]
     end
 
-    # 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 - 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]
@@ -84,6 +79,11 @@ module Files
       @attributes[:sync_bytes_sent]
     end
 
+    # array(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
+
     # 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: 10,000, 1,000 or less is recommended).

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.230"
+  VERSION = "1.1.231"
 end

data/lib/files.com.rb

@@ -120,6 +120,7 @@ require "files.com/models/sso_strategy"
 require "files.com/models/status"
 require "files.com/models/style"
 require "files.com/models/sync_log"
+require "files.com/models/usage_by_top_level_dir"
 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.1.230
+  version: 1.1.231
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -203,6 +203,7 @@ files:
 - docs/status.md
 - docs/style.md
 - docs/sync_log.md
+- docs/usage_by_top_level_dir.md
 - docs/usage_daily_snapshot.md
 - docs/usage_snapshot.md
 - docs/user.md
@@ -307,6 +308,7 @@ files:
 - lib/files.com/models/status.rb
 - lib/files.com/models/style.rb
 - lib/files.com/models/sync_log.rb
+- lib/files.com/models/usage_by_top_level_dir.rb
 - lib/files.com/models/usage_daily_snapshot.rb
 - lib/files.com/models/usage_snapshot.rb
 - lib/files.com/models/user.rb