files.com 1.0.236 → 1.0.240

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 552519b04a1256d02139b97b36d9c2d398b0b35aa06e934380b2c0e6dbcc48a9
4
- data.tar.gz: 57a407a420d4f2646937ae647022f8b0f1ba8e93e8f0a52fe5fd413f1ad5fd36
3
+ metadata.gz: e34bb016ac2238fe372490914bdbf006e867d96129ff4d7498d11a6eaabe4456
4
+ data.tar.gz: aaef67d18bc72a8e1f9341a9925f5c2ebdad0fe877c4e1db0c85387510bcc711
5
5
  SHA512:
6
- metadata.gz: fd27015305911d0ed20e1dca918c11113d44a93587e57dc6888176ec4fba12704a8cc74ad20d941c9b62e79eef13340ab19419c7b9cb0698aa76e08a8f8fcf03
7
- data.tar.gz: 653f9efbd638f7b202974897bbc70ac6af3f910f85fdac4c6c6a188e40b1a25ad33de8bece0554dbe013531ec9c3a40c5a50714014255016828e97e911fcb9df
6
+ metadata.gz: 4ee29f639118d4be3cadc79989a1f301a3f61e2d9c2f17ea6589e1a1ac793f5606a3a4e7c8c1c8301d1adbe4c8d86492ee87287d1e592f4a029af41eb50c731b
7
+ data.tar.gz: b9ec81c3662ff7f73f57473d66c2c9e663d50834631dfa6819f19fdbfe393f7300be0d0fe7ff0c6f667a0393c77e224b6a1c50e8302dacad13d1928b4ca68d85
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.236
1
+ 1.0.240
data/docs/file.md CHANGED
@@ -17,7 +17,7 @@ may places where a Ruby File object can be used.
17
17
  "md5": "17c54824e9931a4688ca032d03f6663c",
18
18
  "mime_type": "application/octet-stream",
19
19
  "region": "us-east-1",
20
- "permissions": "rpw",
20
+ "permissions": "rwd",
21
21
  "subfolders_locked?": true,
22
22
  "download_uri": "https://mysite.files.com/...",
23
23
  "priority_color": "red",
@@ -42,7 +42,7 @@ may places where a Ruby File object can be used.
42
42
  * `md5` (string): File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
43
43
  * `mime_type` (string): MIME Type. This is determined by the filename extension and is not stored separately internally.
44
44
  * `region` (string): Region location
45
- * `permissions` (string): A short string representing the current user's permissions. Can be `r`,`w`,`p`, or any combination
45
+ * `permissions` (string): A short string representing the current user's permissions. Can be `r`,`w`,`d`, `l` or any combination
46
46
  * `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
47
47
  * `download_uri` (string): Link to download file. Provided only in response to a download request.
48
48
  * `priority_color` (string): Bookmark/priority color of file/folder
data/docs/folder.md CHANGED
@@ -19,7 +19,7 @@ Files::Dir is an alias of Files::Folder
19
19
  "md5": "17c54824e9931a4688ca032d03f6663c",
20
20
  "mime_type": "application/octet-stream",
21
21
  "region": "us-east-1",
22
- "permissions": "rpw",
22
+ "permissions": "rwd",
23
23
  "subfolders_locked?": true,
24
24
  "download_uri": "https://mysite.files.com/...",
25
25
  "priority_color": "red",
@@ -44,7 +44,7 @@ Files::Dir is an alias of Files::Folder
44
44
  * `md5` (string): File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
45
45
  * `mime_type` (string): MIME Type. This is determined by the filename extension and is not stored separately internally.
46
46
  * `region` (string): Region location
47
- * `permissions` (string): A short string representing the current user's permissions. Can be `r`,`w`,`p`, or any combination
47
+ * `permissions` (string): A short string representing the current user's permissions. Can be `r`,`w`,`d`, `l` or any combination
48
48
  * `subfolders_locked?` (boolean): Are subfolders locked and unable to be modified?
49
49
  * `download_uri` (string): Link to download file. Provided only in response to a download request.
50
50
  * `priority_color` (string): Bookmark/priority color of file/folder
data/docs/session.md CHANGED
@@ -20,6 +20,7 @@
20
20
  "allowed_2fa_method_sms": true,
21
21
  "allowed_2fa_method_totp": true,
22
22
  "allowed_2fa_method_u2f": true,
23
+ "allowed_2fa_method_webauthn": true,
23
24
  "allowed_2fa_method_yubi": true,
24
25
  "use_provided_modified_at": true,
25
26
  "windows_mode_ftp": true
@@ -42,6 +43,7 @@
42
43
  * `allowed_2fa_method_sms` (boolean): Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
43
44
  * `allowed_2fa_method_totp` (boolean): Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
44
45
  * `allowed_2fa_method_u2f` (boolean): Sent only if 2FA setup is needed. Is U2F two factor authentication allowed?
46
+ * `allowed_2fa_method_webauthn` (boolean): Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
45
47
  * `allowed_2fa_method_yubi` (boolean): Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
46
48
  * `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.
47
49
  * `windows_mode_ftp` (boolean): Does this user want to use Windows line-ending emulation? (CR vs CRLF)
@@ -4,7 +4,6 @@
4
4
 
5
5
  ```
6
6
  {
7
- "change_details": "{ domain: [\"olddomain.com', \"newdomain.com\"] }",
8
7
  "changes": [
9
8
  ""
10
9
  ],
@@ -13,7 +12,6 @@
13
12
  }
14
13
  ```
15
14
 
16
- * `change_details` (object): Specifics on what changed.
17
15
  * `changes` (string): Markdown-formatted change messages.
18
16
  * `created_at` (date-time): The time this change was made
19
17
  * `user_id` (int64): The user id responsible for this change
data/docs/site.md CHANGED
@@ -8,6 +8,7 @@
8
8
  "allowed_2fa_method_sms": true,
9
9
  "allowed_2fa_method_totp": true,
10
10
  "allowed_2fa_method_u2f": true,
11
+ "allowed_2fa_method_webauthn": true,
11
12
  "allowed_2fa_method_yubi": true,
12
13
  "admin_user_id": 1,
13
14
  "allow_bundle_names": true,
@@ -130,6 +131,7 @@
130
131
  "allowed_2fa_method_sms": true,
131
132
  "allowed_2fa_method_totp": true,
132
133
  "allowed_2fa_method_u2f": true,
134
+ "allowed_2fa_method_webauthn": true,
133
135
  "allowed_2fa_method_yubi": true,
134
136
  "use_provided_modified_at": true,
135
137
  "windows_mode_ftp": false
@@ -226,6 +228,7 @@
226
228
  * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
227
229
  * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
228
230
  * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
231
+ * `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
229
232
  * `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
230
233
  * `admin_user_id` (int64): User ID for the main site administrator
231
234
  * `allow_bundle_names` (boolean): Are manual Bundle names allowed?
@@ -439,6 +442,7 @@ Files::Site.update(
439
442
  allowed_2fa_method_sms: true,
440
443
  allowed_2fa_method_u2f: true,
441
444
  allowed_2fa_method_totp: true,
445
+ allowed_2fa_method_webauthn: true,
442
446
  allowed_2fa_method_yubi: true,
443
447
  require_2fa: true,
444
448
  require_2fa_user_type: "`site_admins`",
@@ -545,6 +549,7 @@ Files::Site.update(
545
549
  * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
546
550
  * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
547
551
  * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
552
+ * `allowed_2fa_method_webauthn` (boolean): Is WebAuthn two factor authentication allowed?
548
553
  * `allowed_2fa_method_yubi` (boolean): Is yubikey two factor authentication allowed?
549
554
  * `require_2fa` (boolean): Require two-factor authentication for all users?
550
555
  * `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)?
@@ -6,7 +6,14 @@
6
6
  {
7
7
  "id": 1,
8
8
  "date": "2020-11-21",
9
+ "api_usage_available": true,
10
+ "read_api_usage": "100",
11
+ "write_api_usage": "50",
12
+ "user_count": "25",
9
13
  "current_storage": "65536",
14
+ "deleted_files_storage": "65536",
15
+ "deleted_files_counted_in_minimum": "65536",
16
+ "root_storage": "65536",
10
17
  "usage_by_top_level_dir": [
11
18
 
12
19
  ]
@@ -15,7 +22,14 @@
15
22
 
16
23
  * `id` (int64): ID of the usage record
17
24
  * `date` (date): The date of this usage record
18
- * `current_storage` (int64): The quantity of storage held for this site
25
+ * `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.
26
+ * `read_api_usage` (int64): Read API Calls used on this day. Note: only updated for days before the current day.
27
+ * `write_api_usage` (int64): Write API Calls used on this day. Note: only updated for days before the current day.
28
+ * `user_count` (int64): Number of billable users as of this day.
29
+ * `current_storage` (int64): GB of Files Native Storage used on this day.
30
+ * `deleted_files_storage` (int64): GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
31
+ * `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.
32
+ * `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`
19
33
  * `usage_by_top_level_dir` (array): Usage broken down by each top-level folder
20
34
 
21
35
 
@@ -17,24 +17,34 @@
17
17
  "usage_by_top_level_dir": "",
18
18
  "root_storage": 1.0,
19
19
  "deleted_files_counted_in_minimum": 1.0,
20
- "deleted_files_storage": 1.0
20
+ "deleted_files_storage": 1.0,
21
+ "total_billable_usage": 1.0,
22
+ "total_billable_transfer_usage": 1.0,
23
+ "bytes_sent": 1.0,
24
+ "sync_bytes_received": 1.0,
25
+ "sync_bytes_sent": 1.0
21
26
  }
22
27
  ```
23
28
 
24
- * `id` (int64): Site usage ID
25
- * `start_at` (date-time): Site usage report start date/time
26
- * `end_at` (date-time): Site usage report end date/time
27
- * `created_at` (date-time): Site usage report created at date/time
28
- * `high_water_user_count` (double): Site usage report highest usage in time period
29
- * `current_storage` (double): Current site usage as of report
30
- * `high_water_storage` (double): Site usage report highest usage in time period
31
- * `total_downloads` (int64): Number of downloads in report time period
32
- * `total_uploads` (int64): Number of uploads in time period
33
- * `updated_at` (date-time): The last time this site usage report was updated
34
- * `usage_by_top_level_dir` (object): A map of root folders to their total usage
35
- * `root_storage` (double): Usage for root folder
36
- * `deleted_files_counted_in_minimum` (double): Usage for files that are deleted but uploaded within last 30 days
37
- * `deleted_files_storage` (double): Usage for files that are deleted but retained as backups
29
+ * `id` (int64): Usage snapshot ID
30
+ * `start_at` (date-time): Usage snapshot start date/time
31
+ * `end_at` (date-time): Usage snapshot end date/time
32
+ * `created_at` (date-time): DEPRECATED: Usage snapshot created at date/time
33
+ * `high_water_user_count` (double): Highest user count number in time period
34
+ * `current_storage` (double): Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
35
+ * `high_water_storage` (double): Highest Storage Usage GB recorded in time period (used for billing)
36
+ * `total_downloads` (int64): DEPRECATED: Number of downloads in report time period
37
+ * `total_uploads` (int64): DEPRECATED: Number of uploads in time period
38
+ * `updated_at` (date-time): DEPRECATED: The last time this site usage report was updated
39
+ * `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)
40
+ * `root_storage` (double): Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
41
+ * `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)
42
+ * `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)
43
+ * `total_billable_usage` (double): Storage + Transfer Usage - Total Billable amount
44
+ * `total_billable_transfer_usage` (double): Transfer usage for period - Total Billable amount
45
+ * `bytes_sent` (double): Transfer Usage for period - Outbound GB from Files Native Storage
46
+ * `sync_bytes_received` (double): Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
47
+ * `sync_bytes_sent` (double): Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
38
48
 
39
49
 
40
50
  ---
@@ -682,7 +682,7 @@ module Files
682
682
  @attributes[:region] = value
683
683
  end
684
684
 
685
- # string - A short string representing the current user's permissions. Can be `r`,`w`,`p`, or any combination
685
+ # string - A short string representing the current user's permissions. Can be `r`,`w`,`d`, `l` or any combination
686
686
  def permissions
687
687
  @attributes[:permissions]
688
688
  end
@@ -240,7 +240,7 @@ module Files
240
240
  @attributes[:region] = value
241
241
  end
242
242
 
243
- # string - A short string representing the current user's permissions. Can be `r`,`w`,`p`, or any combination
243
+ # string - A short string representing the current user's permissions. Can be `r`,`w`,`d`, `l` or any combination
244
244
  def permissions
245
245
  @attributes[:permissions]
246
246
  end
@@ -157,6 +157,15 @@ module Files
157
157
  @attributes[:allowed_2fa_method_u2f] = value
158
158
  end
159
159
 
160
+ # boolean - Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
161
+ def allowed_2fa_method_webauthn
162
+ @attributes[:allowed_2fa_method_webauthn]
163
+ end
164
+
165
+ def allowed_2fa_method_webauthn=(value)
166
+ @attributes[:allowed_2fa_method_webauthn] = value
167
+ end
168
+
160
169
  # boolean - Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
161
170
  def allowed_2fa_method_yubi
162
171
  @attributes[:allowed_2fa_method_yubi]
@@ -9,11 +9,6 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # object - Specifics on what changed.
13
- def change_details
14
- @attributes[:change_details]
15
- end
16
-
17
12
  # string - Markdown-formatted change messages.
18
13
  def changes
19
14
  @attributes[:changes]
@@ -29,6 +29,11 @@ module Files
29
29
  @attributes[:allowed_2fa_method_u2f]
30
30
  end
31
31
 
32
+ # boolean - Is WebAuthn two factor authentication allowed?
33
+ def allowed_2fa_method_webauthn
34
+ @attributes[:allowed_2fa_method_webauthn]
35
+ end
36
+
32
37
  # boolean - Is yubikey two factor authentication allowed?
33
38
  def allowed_2fa_method_yubi
34
39
  @attributes[:allowed_2fa_method_yubi]
@@ -718,6 +723,7 @@ module Files
718
723
  # allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
719
724
  # allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
720
725
  # allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
726
+ # allowed_2fa_method_webauthn - boolean - Is WebAuthn two factor authentication allowed?
721
727
  # allowed_2fa_method_yubi - boolean - Is yubikey two factor authentication allowed?
722
728
  # require_2fa - boolean - Require two-factor authentication for all users?
723
729
  # 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)?
@@ -19,11 +19,46 @@ module Files
19
19
  @attributes[:date]
20
20
  end
21
21
 
22
- # int64 - The quantity of storage held for this site
22
+ # 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.
23
+ def api_usage_available
24
+ @attributes[:api_usage_available]
25
+ end
26
+
27
+ # int64 - Read API Calls used on this day. Note: only updated for days before the current day.
28
+ def read_api_usage
29
+ @attributes[:read_api_usage]
30
+ end
31
+
32
+ # int64 - Write API Calls used on this day. Note: only updated for days before the current day.
33
+ def write_api_usage
34
+ @attributes[:write_api_usage]
35
+ end
36
+
37
+ # int64 - Number of billable users as of this day.
38
+ def user_count
39
+ @attributes[:user_count]
40
+ end
41
+
42
+ # int64 - GB of Files Native Storage used on this day.
23
43
  def current_storage
24
44
  @attributes[:current_storage]
25
45
  end
26
46
 
47
+ # int64 - GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
48
+ def deleted_files_storage
49
+ @attributes[:deleted_files_storage]
50
+ end
51
+
52
+ # 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.
53
+ def deleted_files_counted_in_minimum
54
+ @attributes[:deleted_files_counted_in_minimum]
55
+ end
56
+
57
+ # 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`
58
+ def root_storage
59
+ @attributes[:root_storage]
60
+ end
61
+
27
62
  # array - Usage broken down by each top-level folder
28
63
  def usage_by_top_level_dir
29
64
  @attributes[:usage_by_top_level_dir]
@@ -9,76 +9,101 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
- # int64 - Site usage ID
12
+ # int64 - Usage snapshot ID
13
13
  def id
14
14
  @attributes[:id]
15
15
  end
16
16
 
17
- # date-time - Site usage report start date/time
17
+ # date-time - Usage snapshot start date/time
18
18
  def start_at
19
19
  @attributes[:start_at]
20
20
  end
21
21
 
22
- # date-time - Site usage report end date/time
22
+ # date-time - Usage snapshot end date/time
23
23
  def end_at
24
24
  @attributes[:end_at]
25
25
  end
26
26
 
27
- # date-time - Site usage report created at date/time
27
+ # date-time - DEPRECATED: Usage snapshot created at date/time
28
28
  def created_at
29
29
  @attributes[:created_at]
30
30
  end
31
31
 
32
- # double - Site usage report highest usage in time period
32
+ # double - Highest user count number in time period
33
33
  def high_water_user_count
34
34
  @attributes[:high_water_user_count]
35
35
  end
36
36
 
37
- # double - Current site usage as of report
37
+ # double - Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
38
38
  def current_storage
39
39
  @attributes[:current_storage]
40
40
  end
41
41
 
42
- # double - Site usage report highest usage in time period
42
+ # double - Highest Storage Usage GB recorded in time period (used for billing)
43
43
  def high_water_storage
44
44
  @attributes[:high_water_storage]
45
45
  end
46
46
 
47
- # int64 - Number of downloads in report time period
47
+ # int64 - DEPRECATED: Number of downloads in report time period
48
48
  def total_downloads
49
49
  @attributes[:total_downloads]
50
50
  end
51
51
 
52
- # int64 - Number of uploads in time period
52
+ # int64 - DEPRECATED: Number of uploads in time period
53
53
  def total_uploads
54
54
  @attributes[:total_uploads]
55
55
  end
56
56
 
57
- # date-time - The last time this site usage report was updated
57
+ # date-time - DEPRECATED: The last time this site usage report was updated
58
58
  def updated_at
59
59
  @attributes[:updated_at]
60
60
  end
61
61
 
62
- # object - A map of root folders to their total usage
62
+ # object - Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)
63
63
  def usage_by_top_level_dir
64
64
  @attributes[:usage_by_top_level_dir]
65
65
  end
66
66
 
67
- # double - Usage for root folder
67
+ # double - Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
68
68
  def root_storage
69
69
  @attributes[:root_storage]
70
70
  end
71
71
 
72
- # double - Usage for files that are deleted but uploaded within last 30 days
72
+ # 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)
73
73
  def deleted_files_counted_in_minimum
74
74
  @attributes[:deleted_files_counted_in_minimum]
75
75
  end
76
76
 
77
- # double - Usage for files that are deleted but retained as backups
77
+ # 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)
78
78
  def deleted_files_storage
79
79
  @attributes[:deleted_files_storage]
80
80
  end
81
81
 
82
+ # double - Storage + Transfer Usage - Total Billable amount
83
+ def total_billable_usage
84
+ @attributes[:total_billable_usage]
85
+ end
86
+
87
+ # double - Transfer usage for period - Total Billable amount
88
+ def total_billable_transfer_usage
89
+ @attributes[:total_billable_transfer_usage]
90
+ end
91
+
92
+ # double - Transfer Usage for period - Outbound GB from Files Native Storage
93
+ def bytes_sent
94
+ @attributes[:bytes_sent]
95
+ end
96
+
97
+ # double - Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
98
+ def sync_bytes_received
99
+ @attributes[:sync_bytes_received]
100
+ end
101
+
102
+ # double - Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
103
+ def sync_bytes_sent
104
+ @attributes[:sync_bytes_sent]
105
+ end
106
+
82
107
  # Parameters:
83
108
  # 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.
84
109
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.236
4
+ version: 1.0.240
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-28 00:00:00.000000000 Z
11
+ date: 2022-02-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable