files.com 1.0.235 → 1.0.239
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/file.md +2 -2
- data/docs/folder.md +2 -2
- data/docs/remote_server.md +2 -0
- data/docs/session.md +2 -0
- data/docs/site.md +5 -0
- data/docs/sso_strategy.md +1 -1
- data/docs/usage_daily_snapshot.md +15 -1
- data/docs/usage_snapshot.md +25 -15
- data/lib/files.com/models/file.rb +1 -1
- data/lib/files.com/models/folder.rb +1 -1
- data/lib/files.com/models/remote_server.rb +9 -0
- data/lib/files.com/models/session.rb +9 -0
- data/lib/files.com/models/site.rb +6 -0
- data/lib/files.com/models/sso_strategy.rb +1 -1
- data/lib/files.com/models/usage_daily_snapshot.rb +36 -1
- data/lib/files.com/models/usage_snapshot.rb +39 -14
- data/lib/files.com.rb +0 -1
- metadata +2 -4
- data/docs/sync_job.md +0 -37
- data/lib/files.com/models/sync_job.rb +0 -58
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 03e2cf02e3002d6cd78ea0276f4bd9791d1ca5c331f5d9e65a9c904bd3045c68
|
4
|
+
data.tar.gz: 8cc1e2b209454f7ce3da071c2510130adda84e28a6762bf575f496f809d6b576
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 12a7cb6714cce1878be90e5a6047a0eb30240d2ec720aae6de6c5188a21ff8051629c41158ddb2d8794f20b6341b644826ed4065e2424bcab069649c58ad3e0c
|
7
|
+
data.tar.gz: 26a6d166c9636017be8be6d1de23a1313a86ac3cd80932a95c7bfb9be33a6b17c7a214230ff5319097cc01940a09598802f0eab224bdfdd6c674c1f793f89938
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.239
|
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": "
|
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`,`
|
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": "
|
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`,`
|
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/remote_server.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
|
+
"disabled": true,
|
8
9
|
"authentication_method": "password",
|
9
10
|
"hostname": "remote-server.com",
|
10
11
|
"remote_home_path": "/home/user1",
|
@@ -40,6 +41,7 @@
|
|
40
41
|
```
|
41
42
|
|
42
43
|
* `id` (int64): Remote server ID
|
44
|
+
* `disabled` (boolean): If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
|
43
45
|
* `authentication_method` (string): Type of authentication method
|
44
46
|
* `hostname` (string): Hostname or IP address
|
45
47
|
* `remote_home_path` (string): Initial home folder on remote server
|
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)
|
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)?
|
data/docs/sso_strategy.md
CHANGED
@@ -85,7 +85,7 @@
|
|
85
85
|
* `provision_company` (string): Default company for auto provisioned users.
|
86
86
|
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
87
87
|
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
88
|
-
* `enabled` (boolean): Is strategy enabled?
|
88
|
+
* `enabled` (boolean): Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
89
89
|
* `ldap_host` (string): LDAP host
|
90
90
|
* `ldap_host_2` (string): LDAP backup host
|
91
91
|
* `ldap_host_3` (string): LDAP backup host
|
@@ -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
|
-
* `
|
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
|
|
data/docs/usage_snapshot.md
CHANGED
@@ -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):
|
25
|
-
* `start_at` (date-time):
|
26
|
-
* `end_at` (date-time):
|
27
|
-
* `created_at` (date-time):
|
28
|
-
* `high_water_user_count` (double):
|
29
|
-
* `current_storage` (double): Current
|
30
|
-
* `high_water_storage` (double):
|
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):
|
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`,`
|
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`,`
|
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
|
@@ -18,6 +18,15 @@ module Files
|
|
18
18
|
@attributes[:id] = value
|
19
19
|
end
|
20
20
|
|
21
|
+
# boolean - If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
|
22
|
+
def disabled
|
23
|
+
@attributes[:disabled]
|
24
|
+
end
|
25
|
+
|
26
|
+
def disabled=(value)
|
27
|
+
@attributes[:disabled] = value
|
28
|
+
end
|
29
|
+
|
21
30
|
# string - Type of authentication method
|
22
31
|
def authentication_method
|
23
32
|
@attributes[:authentication_method]
|
@@ -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]
|
@@ -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)?
|
@@ -184,7 +184,7 @@ module Files
|
|
184
184
|
@attributes[:ldap_domain]
|
185
185
|
end
|
186
186
|
|
187
|
-
# boolean - Is strategy enabled?
|
187
|
+
# boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
188
188
|
def enabled
|
189
189
|
@attributes[:enabled]
|
190
190
|
end
|
@@ -19,11 +19,46 @@ module Files
|
|
19
19
|
@attributes[:date]
|
20
20
|
end
|
21
21
|
|
22
|
-
#
|
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 -
|
12
|
+
# int64 - Usage snapshot ID
|
13
13
|
def id
|
14
14
|
@attributes[:id]
|
15
15
|
end
|
16
16
|
|
17
|
-
# 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 -
|
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 -
|
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 -
|
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
|
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 -
|
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 -
|
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).
|
data/lib/files.com.rb
CHANGED
@@ -94,7 +94,6 @@ require "files.com/models/site"
|
|
94
94
|
require "files.com/models/sso_strategy"
|
95
95
|
require "files.com/models/status"
|
96
96
|
require "files.com/models/style"
|
97
|
-
require "files.com/models/sync_job"
|
98
97
|
require "files.com/models/usage_daily_snapshot"
|
99
98
|
require "files.com/models/usage_snapshot"
|
100
99
|
require "files.com/models/user"
|
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.
|
4
|
+
version: 1.0.239
|
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-
|
11
|
+
date: 2022-02-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|
@@ -154,7 +154,6 @@ files:
|
|
154
154
|
- docs/sso_strategy.md
|
155
155
|
- docs/status.md
|
156
156
|
- docs/style.md
|
157
|
-
- docs/sync_job.md
|
158
157
|
- docs/usage_daily_snapshot.md
|
159
158
|
- docs/usage_snapshot.md
|
160
159
|
- docs/user.md
|
@@ -236,7 +235,6 @@ files:
|
|
236
235
|
- lib/files.com/models/sso_strategy.rb
|
237
236
|
- lib/files.com/models/status.rb
|
238
237
|
- lib/files.com/models/style.rb
|
239
|
-
- lib/files.com/models/sync_job.rb
|
240
238
|
- lib/files.com/models/usage_daily_snapshot.rb
|
241
239
|
- lib/files.com/models/usage_snapshot.rb
|
242
240
|
- lib/files.com/models/user.rb
|
data/docs/sync_job.md
DELETED
@@ -1,37 +0,0 @@
|
|
1
|
-
# SyncJob
|
2
|
-
|
3
|
-
## Example SyncJob Object
|
4
|
-
|
5
|
-
```
|
6
|
-
{
|
7
|
-
"queued_at": "2000-01-01T01:00:00Z",
|
8
|
-
"updated_at": "2000-01-01T01:00:00Z",
|
9
|
-
"status": "",
|
10
|
-
"regional_worker_status": "",
|
11
|
-
"uuid": "",
|
12
|
-
"folder_behavior_id": 1
|
13
|
-
}
|
14
|
-
```
|
15
|
-
|
16
|
-
* `queued_at` (date-time): Job enqueued at
|
17
|
-
* `updated_at` (date-time): Job updated at
|
18
|
-
* `status` (string): Status of the job
|
19
|
-
* `regional_worker_status` (string): Most recent reported status of sync worker
|
20
|
-
* `uuid` (string):
|
21
|
-
* `folder_behavior_id` (int64):
|
22
|
-
|
23
|
-
|
24
|
-
---
|
25
|
-
|
26
|
-
## List Sync Jobs
|
27
|
-
|
28
|
-
```
|
29
|
-
Files::SyncJob.list(
|
30
|
-
per_page: 1
|
31
|
-
)
|
32
|
-
```
|
33
|
-
|
34
|
-
### Parameters
|
35
|
-
|
36
|
-
* `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.
|
37
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
@@ -1,58 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module Files
|
4
|
-
class SyncJob
|
5
|
-
attr_reader :options, :attributes
|
6
|
-
|
7
|
-
def initialize(attributes = {}, options = {})
|
8
|
-
@attributes = attributes || {}
|
9
|
-
@options = options || {}
|
10
|
-
end
|
11
|
-
|
12
|
-
# date-time - Job enqueued at
|
13
|
-
def queued_at
|
14
|
-
@attributes[:queued_at]
|
15
|
-
end
|
16
|
-
|
17
|
-
# date-time - Job updated at
|
18
|
-
def updated_at
|
19
|
-
@attributes[:updated_at]
|
20
|
-
end
|
21
|
-
|
22
|
-
# string - Status of the job
|
23
|
-
def status
|
24
|
-
@attributes[:status]
|
25
|
-
end
|
26
|
-
|
27
|
-
# string - Most recent reported status of sync worker
|
28
|
-
def regional_worker_status
|
29
|
-
@attributes[:regional_worker_status]
|
30
|
-
end
|
31
|
-
|
32
|
-
# string -
|
33
|
-
def uuid
|
34
|
-
@attributes[:uuid]
|
35
|
-
end
|
36
|
-
|
37
|
-
# int64 -
|
38
|
-
def folder_behavior_id
|
39
|
-
@attributes[:folder_behavior_id]
|
40
|
-
end
|
41
|
-
|
42
|
-
# Parameters:
|
43
|
-
# 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.
|
44
|
-
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
-
def self.list(params = {}, options = {})
|
46
|
-
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
47
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
48
|
-
|
49
|
-
List.new(SyncJob, params) do
|
50
|
-
Api.send_request("/sync_jobs", :get, params, options)
|
51
|
-
end
|
52
|
-
end
|
53
|
-
|
54
|
-
def self.all(params = {}, options = {})
|
55
|
-
list(params, options)
|
56
|
-
end
|
57
|
-
end
|
58
|
-
end
|