files.com 1.0.238 → 1.0.242

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 702a974ca2b9858e24c5906f60f5c4ffeac5968bdbc9bae74cc4cea3cf9b265a
4
- data.tar.gz: b267aeae588b6b132d8824691624a53160f80a49231b632f217a0ac01f4c6621
3
+ metadata.gz: f81993b4991a882495c913dfd5c0796baf56c7ce76d096eecb419019b63f3355
4
+ data.tar.gz: 69ee9f77623b066290da7637d8808a8073fd25355d373c111b9e18e4d78efd89
5
5
  SHA512:
6
- metadata.gz: bcbd8b164d5ea6992cd87aeb84cc8c66643b7e6bf2ec59278905087639f83e16b37c176ecdd6477558ac0465296769c7d064af0d7a99567039484ab02369b7e1
7
- data.tar.gz: ef1b9b6f097f5a4a9f0a5c90b5196afc65c499c24bf37ece5d21bffe50f404f7b5515e75f4570aa8a7ae31394f05d0b933727798dc969c651421fe08eb4fed34
6
+ metadata.gz: d60b367ca44d880798f8a1e66fc61dd587a1b23a8a2b9a5136875e1fd35744b6d3d8984b7c7ff14542711b6ae33613e9af5b90c2cd83537fda9758a1994fd839
7
+ data.tar.gz: baecae6c0025df413e990a3a7b97550fdaf1f9cb67f01bb9f5926ac14c3c4083ed7bc70c29b15b376d0116967e70f4de6a1ca09d7db0ade5f3b0092b2896ee8d
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.238
1
+ 1.0.242
@@ -12,9 +12,7 @@
12
12
  "requests_get": 1.0,
13
13
  "requests_put": 1.0,
14
14
  "requests_other": 1.0,
15
- "logged_at": "2000-01-01T01:00:00Z",
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "updated_at": "2000-01-01T01:00:00Z"
15
+ "logged_at": "2000-01-01T01:00:00Z"
18
16
  }
19
17
  ```
20
18
 
@@ -27,8 +25,6 @@
27
25
  * `requests_put` (double): Site bandwidth report put requests
28
26
  * `requests_other` (double): Site bandwidth report other requests
29
27
  * `logged_at` (date-time): Time the site bandwidth report was logged
30
- * `created_at` (date-time): Site bandwidth report created at date/time
31
- * `updated_at` (date-time): The last time this site bandwidth report was updated
32
28
 
33
29
 
34
30
  ---
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
@@ -0,0 +1,42 @@
1
+ # RemoteBandwidthSnapshot
2
+
3
+ ## Example RemoteBandwidthSnapshot Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "sync_bytes_received": 1.0,
9
+ "sync_bytes_sent": 1.0,
10
+ "logged_at": "2000-01-01T01:00:00Z",
11
+ "remote_server_id": 1
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): Site bandwidth ID
16
+ * `sync_bytes_received` (double): Site sync bandwidth report bytes received
17
+ * `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
18
+ * `logged_at` (date-time): Time the site bandwidth report was logged
19
+ * `remote_server_id` (int64): ID of related Remote Server
20
+
21
+
22
+ ---
23
+
24
+ ## List Remote Bandwidth Snapshots
25
+
26
+ ```
27
+ Files::RemoteBandwidthSnapshot.list(
28
+ per_page: 1
29
+ )
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ * `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.
35
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
37
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
38
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
39
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
40
+ * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
41
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
42
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
@@ -4,19 +4,21 @@
4
4
 
5
5
  ```
6
6
  {
7
- "change_details": "{ domain: [\"olddomain.com', \"newdomain.com\"] }",
8
7
  "changes": [
9
8
  ""
10
9
  ],
11
10
  "created_at": "2000-01-01T01:00:00Z",
12
- "user_id": 1
11
+ "user_id": 1,
12
+ "user_is_files_support": true,
13
+ "username": "some_user"
13
14
  }
14
15
  ```
15
16
 
16
- * `change_details` (object): Specifics on what changed.
17
17
  * `changes` (string): Markdown-formatted change messages.
18
18
  * `created_at` (date-time): The time this change was made
19
19
  * `user_id` (int64): The user id responsible for this change
20
+ * `user_is_files_support` (boolean): true if this change was performed by Files.com support.
21
+ * `username` (string): The username of the user responsible for this change
20
22
 
21
23
 
22
24
  ---
data/docs/site.md CHANGED
@@ -207,7 +207,7 @@
207
207
  "subscribe_to_newsletter": true,
208
208
  "externally_managed": true,
209
209
  "time_zone": "Pacific Time (US & Canada)",
210
- "type_of_2fa": "",
210
+ "type_of_2fa": "yubi",
211
211
  "user_root": ""
212
212
  },
213
213
  "user_lockout": true,
data/docs/user.md CHANGED
@@ -52,7 +52,7 @@
52
52
  "subscribe_to_newsletter": true,
53
53
  "externally_managed": true,
54
54
  "time_zone": "Pacific Time (US & Canada)",
55
- "type_of_2fa": "",
55
+ "type_of_2fa": "yubi",
56
56
  "user_root": ""
57
57
  }
58
58
  ```
@@ -54,16 +54,6 @@ module Files
54
54
  @attributes[:logged_at]
55
55
  end
56
56
 
57
- # date-time - Site bandwidth report created at date/time
58
- def created_at
59
- @attributes[:created_at]
60
- end
61
-
62
- # date-time - The last time this site bandwidth report was updated
63
- def updated_at
64
- @attributes[:updated_at]
65
- end
66
-
67
57
  # Parameters:
68
58
  # 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.
69
59
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
@@ -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
@@ -0,0 +1,67 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class RemoteBandwidthSnapshot
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - Site bandwidth ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # double - Site sync bandwidth report bytes received
18
+ def sync_bytes_received
19
+ @attributes[:sync_bytes_received]
20
+ end
21
+
22
+ # double - Site sync bandwidth report bytes sent
23
+ def sync_bytes_sent
24
+ @attributes[:sync_bytes_sent]
25
+ end
26
+
27
+ # date-time - Time the site bandwidth report was logged
28
+ def logged_at
29
+ @attributes[:logged_at]
30
+ end
31
+
32
+ # int64 - ID of related Remote Server
33
+ def remote_server_id
34
+ @attributes[:remote_server_id]
35
+ end
36
+
37
+ # Parameters:
38
+ # 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.
39
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
40
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
41
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
42
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
43
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
44
+ # filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
45
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
46
+ # filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
47
+ def self.list(params = {}, options = {})
48
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
49
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
50
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
51
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
52
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
53
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
54
+ raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
55
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
56
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
57
+
58
+ List.new(RemoteBandwidthSnapshot, params) do
59
+ Api.send_request("/remote_bandwidth_snapshots", :get, params, options)
60
+ end
61
+ end
62
+
63
+ def self.all(params = {}, options = {})
64
+ list(params, options)
65
+ end
66
+ end
67
+ end
@@ -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 +24,16 @@ module Files
29
24
  @attributes[:user_id]
30
25
  end
31
26
 
27
+ # boolean - true if this change was performed by Files.com support.
28
+ def user_is_files_support
29
+ @attributes[:user_is_files_support]
30
+ end
31
+
32
+ # string - The username of the user responsible for this change
33
+ def username
34
+ @attributes[:username]
35
+ end
36
+
32
37
  # Parameters:
33
38
  # 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.
34
39
  # 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
@@ -86,6 +86,7 @@ require "files.com/models/priority"
86
86
  require "files.com/models/project"
87
87
  require "files.com/models/public_ip_address"
88
88
  require "files.com/models/public_key"
89
+ require "files.com/models/remote_bandwidth_snapshot"
89
90
  require "files.com/models/remote_server"
90
91
  require "files.com/models/request"
91
92
  require "files.com/models/session"
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.238
4
+ version: 1.0.242
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-02-01 00:00:00.000000000 Z
11
+ date: 2022-02-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -146,6 +146,7 @@ files:
146
146
  - docs/project.md
147
147
  - docs/public_ip_address.md
148
148
  - docs/public_key.md
149
+ - docs/remote_bandwidth_snapshot.md
149
150
  - docs/remote_server.md
150
151
  - docs/request.md
151
152
  - docs/session.md
@@ -227,6 +228,7 @@ files:
227
228
  - lib/files.com/models/project.rb
228
229
  - lib/files.com/models/public_ip_address.rb
229
230
  - lib/files.com/models/public_key.rb
231
+ - lib/files.com/models/remote_bandwidth_snapshot.rb
230
232
  - lib/files.com/models/remote_server.rb
231
233
  - lib/files.com/models/request.rb
232
234
  - lib/files.com/models/session.rb