files.com 1.0.85 → 1.0.90

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/SECURITY.md +24 -0
  3. data/_VERSION +1 -1
  4. data/docs/api_key.md +13 -1
  5. data/docs/app.md +12 -0
  6. data/docs/automation.md +9 -1
  7. data/docs/behavior.md +30 -14
  8. data/docs/bundle.md +8 -0
  9. data/docs/file.md +0 -4
  10. data/docs/group.md +8 -0
  11. data/docs/history.md +16 -0
  12. data/docs/ip_address.md +18 -0
  13. data/docs/message.md +11 -11
  14. data/docs/notification.md +10 -2
  15. data/docs/permission.md +11 -3
  16. data/docs/public_ip_address.md +13 -0
  17. data/docs/request.md +6 -25
  18. data/docs/session.md +2 -2
  19. data/docs/site.md +4 -0
  20. data/docs/style.md +1 -1
  21. data/docs/usage_daily_snapshot.md +8 -0
  22. data/docs/user.md +16 -2
  23. data/lib/files.com.rb +1 -0
  24. data/lib/files.com/models/api_key.rb +30 -4
  25. data/lib/files.com/models/app.rb +28 -3
  26. data/lib/files.com/models/automation.rb +19 -4
  27. data/lib/files.com/models/behavior.rb +53 -23
  28. data/lib/files.com/models/bundle.rb +19 -4
  29. data/lib/files.com/models/file.rb +7 -11
  30. data/lib/files.com/models/file_action.rb +6 -6
  31. data/lib/files.com/models/file_comment.rb +1 -1
  32. data/lib/files.com/models/folder.rb +2 -2
  33. data/lib/files.com/models/group.rb +18 -3
  34. data/lib/files.com/models/history.rb +43 -16
  35. data/lib/files.com/models/ip_address.rb +15 -0
  36. data/lib/files.com/models/lock.rb +4 -4
  37. data/lib/files.com/models/message.rb +5 -5
  38. data/lib/files.com/models/notification.rb +20 -5
  39. data/lib/files.com/models/permission.rb +21 -6
  40. data/lib/files.com/models/public_ip_address.rb +22 -0
  41. data/lib/files.com/models/request.rb +15 -28
  42. data/lib/files.com/models/session.rb +1 -1
  43. data/lib/files.com/models/site.rb +6 -0
  44. data/lib/files.com/models/style.rb +8 -8
  45. data/lib/files.com/models/usage_daily_snapshot.rb +18 -3
  46. data/lib/files.com/models/user.rb +30 -5
  47. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4f256669e61998c0d04e226d0f790790fe0727fff5a0a4ff5d91711e91b207dc
4
- data.tar.gz: 13c775f7f838a326c807878ea590e4ebb326177b557ef7ab4934a8e3888e2f0d
3
+ metadata.gz: ebf4d4605addae148b16bbe121b65c0e49c1d15c6ea46a2b1f056a0bfd3cd8d2
4
+ data.tar.gz: a8880dab867bbbc0ebb640cc39cf3aa2e7898efa9ac81fd39bcf30a060d898bf
5
5
  SHA512:
6
- metadata.gz: dc7836b465ba29c3161ef92d853994f4fe186623c58bb3fa9f46e126dcbb6f34aa189a90b21d80c49cb3b8610af3e64a84dde4a017743df29357849bee536222
7
- data.tar.gz: 7c09856639a412cfe9e24aad75fdf3bfdca104d7f7077126f3c4c4f9b7b192251a0fd648e11c38e720f45afc78a45bf958a38fe09c33198435c25625c2e8cdc6
6
+ metadata.gz: f1bf9ea0d78910f4c41926f971113527b199392dfa2739ac1f389f87b5947023906b7a622e9e2961b503c3b95b833435806892d74bab5a023634badd850e6acb
7
+ data.tar.gz: e6b8a6b3b6e012c9b9d01f70d5835f39622dc3cf9656701f29c54c774af987a7f0605d540aa1c5f20115ecef1cfa65f7f47bbb8e59eb4e67c3d9a32219dee824
@@ -0,0 +1,24 @@
1
+ # Security Policy
2
+
3
+ Thank you for your interest in Files.com security. We recognize that your data is very personal and sensitive and we work hard to keep it protected.
4
+
5
+
6
+ ## Supported Versions
7
+
8
+ Only the latest version will be supported with security updates.
9
+
10
+
11
+ ## Reporting a Vulnerability
12
+
13
+ Here at Files.com, we celebrate security and we encourage independent security researchers to help us keep our products secure.
14
+
15
+ We offer a Security Bug Bounty Program to create an incentive and reward structure so that researchers are able to devote resources to working on Files.com.
16
+
17
+ We offer our Bug Bounty Program on HackerOne at https://hackerone.com/files
18
+
19
+ We prefer to receive reports of vulnerabilities there.
20
+
21
+ If you do not wish to use HackerOne, alternate submission instructions are available at:
22
+ https://www.files.com/legal/security-bounty/
23
+
24
+ Thank you for helping keep the Files.com community secure!
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.85
1
+ 1.0.90
@@ -11,6 +11,7 @@
11
11
  "key": "[key]",
12
12
  "last_use_at": "2000-01-01T01:00:00Z",
13
13
  "name": "My Main API Key",
14
+ "path": "shared/docs",
14
15
  "permission_set": "full",
15
16
  "platform": "win32",
16
17
  "user_id": 1
@@ -24,6 +25,7 @@
24
25
  * `key` (string): API Key actual key string
25
26
  * `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
26
27
  * `name` (string): Internal name for the API Key. For your use.
28
+ * `path` (string): Folder path restriction for this api key. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
27
29
  * `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
28
30
  * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
29
31
  * `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
@@ -47,6 +49,14 @@ Files::ApiKey.list(
47
49
  * `page` (int64): Current page number.
48
50
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
49
51
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
52
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
53
+ * `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 `deleted_at` and `expires_at`.
54
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
55
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
56
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `expires_at`.
57
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
58
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `expires_at`.
59
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `expires_at`.
50
60
 
51
61
 
52
62
  ---
@@ -80,7 +90,8 @@ Files::ApiKey.create(
80
90
  user_id: 1,
81
91
  name: "My Main API Key",
82
92
  expires_at: "2000-01-01T01:00:00Z",
83
- permission_set: "full"
93
+ permission_set: "full",
94
+ path: "shared/docs"
84
95
  )
85
96
  ```
86
97
 
@@ -90,6 +101,7 @@ Files::ApiKey.create(
90
101
  * `name` (string): Internal name for the API Key. For your use.
91
102
  * `expires_at` (string): API Key expiration date
92
103
  * `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
104
+ * `path` (string): Folder path restriction for this api key.
93
105
 
94
106
 
95
107
  ---
@@ -7,6 +7,8 @@
7
7
  "name": "",
8
8
  "extended_description": "",
9
9
  "documentation_links": "Important Info => http://files.test/learn-more",
10
+ "logo_url": "",
11
+ "logo_thumbnail_url": "",
10
12
  "sso_strategy_type": "",
11
13
  "remote_server_type": "",
12
14
  "folder_behavior_type": "",
@@ -19,6 +21,8 @@
19
21
  * `name` (string): Name of the App
20
22
  * `extended_description` (string): Long form description of the App
21
23
  * `documentation_links` (string): Collection of named links to documentation
24
+ * `logo_url` (string): Full size logo for the App
25
+ * `logo_thumbnail_url` (string): Logo thumbnail for the App
22
26
  * `sso_strategy_type` (string): Associated SSO Strategy type, if any
23
27
  * `remote_server_type` (string): Associated Remote Server type, if any
24
28
  * `folder_behavior_type` (string): Associated Folder Behavior type, if any
@@ -43,3 +47,11 @@ Files::App.list(
43
47
  * `page` (int64): Current page number.
44
48
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
49
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
50
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
51
+ * `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 `name` and `app_type`.
52
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
53
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.
54
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`.
55
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
56
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `name` and `app_type`.
57
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
@@ -56,7 +56,15 @@ Files::Automation.list(
56
56
  * `page` (int64): Current page number.
57
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
58
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
59
- * `automation` (string): Type of automation to filter by.
59
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
60
+ * `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 `site_id` and `automation`.
61
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
62
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
63
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `automation`.
64
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
65
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `automation`.
66
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `automation`.
67
+ * `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
60
68
 
61
69
 
62
70
  ---
@@ -39,9 +39,30 @@ Files::Behavior.list(
39
39
  * `page` (int64): Current page number.
40
40
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
41
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
42
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
43
+ * `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 `site_id` and `behavior`.
44
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
45
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
46
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
47
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
48
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `behavior`.
49
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `behavior`.
42
50
  * `behavior` (string): If set, only shows folder behaviors matching this behavior type.
43
51
 
44
52
 
53
+ ---
54
+
55
+ ## Show Behavior
56
+
57
+ ```
58
+ Files::Behavior.find(id)
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ * `id` (int64): Required - Behavior ID.
64
+
65
+
45
66
  ---
46
67
 
47
68
  ## List Behaviors by path
@@ -59,22 +80,17 @@ Files::Behavior.list_for(path,
59
80
  * `page` (int64): Current page number.
60
81
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
82
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
83
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
84
+ * `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 `site_id` and `behavior`.
85
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
86
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
87
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
88
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
89
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `behavior`.
90
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `behavior`.
62
91
  * `path` (string): Required - Path to operate on.
63
92
  * `recursive` (string): Show behaviors above this path?
64
- * `behavior` (string): If set only shows folder behaviors matching this behavior type.
65
-
66
-
67
- ---
68
-
69
- ## Show Behavior
70
-
71
- ```
72
- Files::Behavior.find(id)
73
- ```
74
-
75
- ### Parameters
76
-
77
- * `id` (int64): Required - Behavior ID.
93
+ * `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
78
94
 
79
95
 
80
96
  ---
@@ -62,6 +62,14 @@ Files::Bundle.list(
62
62
  * `page` (int64): Current page number.
63
63
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
64
64
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
65
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
66
+ * `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 `site_id`, `created_at` or `code`.
67
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
68
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
69
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
70
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
71
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
72
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
65
73
 
66
74
 
67
75
  ---
@@ -61,7 +61,6 @@ may places where a Ruby File object can be used.
61
61
 
62
62
  ```
63
63
  Files::File.download(path,
64
- id: 1,
65
64
  with_previews: true,
66
65
  with_priority_color: true
67
66
  )
@@ -71,7 +70,6 @@ Files::File.download(path,
71
70
 
72
71
  * `path` (string): Required - Path to operate on.
73
72
  * `action` (string): Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
74
- * `id` (int64): If provided, lookup the file by id instead of path.
75
73
  * `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
76
74
  * `with_previews` (boolean): Include file preview information?
77
75
  * `with_priority_color` (boolean): Include file priority color information?
@@ -154,7 +152,6 @@ Files::File.delete(path,
154
152
  file = Files::File.list_for(path).first
155
153
 
156
154
  file.download(
157
- id: 1,
158
155
  with_previews: true,
159
156
  with_priority_color: true
160
157
  )
@@ -164,7 +161,6 @@ file.download(
164
161
 
165
162
  * `path` (string): Required - Path to operate on.
166
163
  * `action` (string): Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
167
- * `id` (int64): If provided, lookup the file by id instead of path.
168
164
  * `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
169
165
  * `with_previews` (boolean): Include file preview information?
170
166
  * `with_priority_color` (boolean): Include file priority color information?
@@ -43,6 +43,14 @@ Files::Group.list(
43
43
  * `page` (int64): Current page number.
44
44
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
45
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
46
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
47
+ * `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 `active`, `deleted_at`, `site_id` or `name`.
48
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
49
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
50
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name`.
51
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
52
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `name`.
53
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name`.
46
54
  * `ids` (string): Comma-separated list of group ids to include in results.
47
55
 
48
56
 
@@ -58,6 +58,8 @@ Files::History.list_for_file(path,
58
58
  * `page` (int64): Current page number.
59
59
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
60
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
61
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
62
+ * `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 `user_id` and `created_at`.
61
63
  * `path` (string): Required - Path to operate on.
62
64
 
63
65
 
@@ -82,6 +84,8 @@ Files::History.list_for_folder(path,
82
84
  * `page` (int64): Current page number.
83
85
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
84
86
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
87
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
88
+ * `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 `user_id` and `created_at`.
85
89
  * `path` (string): Required - Path to operate on.
86
90
 
87
91
 
@@ -106,6 +110,8 @@ Files::History.list_for_user(user_id,
106
110
  * `page` (int64): Current page number.
107
111
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
108
112
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
113
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
114
+ * `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 `user_id` and `created_at`.
109
115
  * `user_id` (int64): Required - User ID.
110
116
 
111
117
 
@@ -130,6 +136,8 @@ Files::History.list_logins(
130
136
  * `page` (int64): Current page number.
131
137
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
132
138
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
139
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
140
+ * `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 `user_id` and `created_at`.
133
141
 
134
142
 
135
143
  ---
@@ -153,3 +161,11 @@ Files::History.list(
153
161
  * `page` (int64): Current page number.
154
162
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
155
163
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
164
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
165
+ * `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 `site_id`, `path`, `created_at`, `folder` or `user_id`.
166
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
167
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
168
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
169
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
170
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
171
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
@@ -35,3 +35,21 @@ Files::IpAddress.list(
35
35
  * `page` (int64): Current page number.
36
36
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
37
37
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
38
+
39
+
40
+ ---
41
+
42
+ ## List all possible public IP addresses
43
+
44
+ ```
45
+ Files::IpAddress.get_reserved(
46
+ page: 1,
47
+ per_page: 1
48
+ )
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `page` (int64): Current page number.
54
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
+ * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
@@ -18,7 +18,7 @@
18
18
  * `body` (string): Message body.
19
19
  * `comments` (array): Comments.
20
20
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
21
- * `project_id` (int64): Project to attach the message to.
21
+ * `project_id` (int64): Project to which the message should be attached.
22
22
 
23
23
 
24
24
  ---
@@ -40,7 +40,7 @@ Files::Message.list(
40
40
  * `page` (int64): Current page number.
41
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
42
42
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
43
- * `project_id` (int64): Required - Project to return messages for.
43
+ * `project_id` (int64): Required - Project for which to return messages.
44
44
 
45
45
 
46
46
  ---
@@ -64,15 +64,15 @@ Files::Message.find(id)
64
64
  Files::Message.create(
65
65
  user_id: 1,
66
66
  project_id: 1,
67
- subject: "subject",
68
- body: "body"
67
+ subject: "Files.com Account Upgrade",
68
+ body: "We should upgrade our Files.com account!"
69
69
  )
70
70
  ```
71
71
 
72
72
  ### Parameters
73
73
 
74
74
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
75
- * `project_id` (int64): Required - Project to attach the message to.
75
+ * `project_id` (int64): Required - Project to which the message should be attached.
76
76
  * `subject` (string): Required - Message subject.
77
77
  * `body` (string): Required - Message body.
78
78
 
@@ -84,15 +84,15 @@ Files::Message.create(
84
84
  ```
85
85
  Files::Message.update(id,
86
86
  project_id: 1,
87
- subject: "subject",
88
- body: "body"
87
+ subject: "Files.com Account Upgrade",
88
+ body: "We should upgrade our Files.com account!"
89
89
  )
90
90
  ```
91
91
 
92
92
  ### Parameters
93
93
 
94
94
  * `id` (int64): Required - Message ID.
95
- * `project_id` (int64): Required - Project to attach the message to.
95
+ * `project_id` (int64): Required - Project to which the message should be attached.
96
96
  * `subject` (string): Required - Message subject.
97
97
  * `body` (string): Required - Message body.
98
98
 
@@ -119,15 +119,15 @@ message = Files::Message.list_for(path).first
119
119
 
120
120
  message.update(
121
121
  project_id: 1,
122
- subject: "subject",
123
- body: "body"
122
+ subject: "Files.com Account Upgrade",
123
+ body: "We should upgrade our Files.com account!"
124
124
  )
125
125
  ```
126
126
 
127
127
  ### Parameters
128
128
 
129
129
  * `id` (int64): Required - Message ID.
130
- * `project_id` (int64): Required - Project to attach the message to.
130
+ * `project_id` (int64): Required - Project to which the message should be attached.
131
131
  * `subject` (string): Required - Message subject.
132
132
  * `body` (string): Required - Message body.
133
133
 
@@ -50,11 +50,19 @@ Files::Notification.list(
50
50
 
51
51
  ### Parameters
52
52
 
53
- * `user_id` (int64): Show notifications for this User ID.
53
+ * `user_id` (int64): DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
54
54
  * `page` (int64): Current page number.
55
55
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
56
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
57
- * `group_id` (int64): Show notifications for this Group ID.
57
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
58
+ * `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 `site_id`, `path`, `user_id` or `group_id`.
59
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
60
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
61
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
62
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
63
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
64
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
65
+ * `group_id` (int64): DEPRECATED: Show notifications for this Group ID. Use `filter[group_id]` instead.
58
66
  * `path` (string): Show notifications for this Path.
59
67
  * `include_ancestors` (boolean): If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
60
68
 
@@ -44,9 +44,17 @@ Files::Permission.list(path,
44
44
  * `page` (int64): Current page number.
45
45
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
46
  * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
47
- * `path` (string): Permission path. If provided, will scope permissions to this path.
48
- * `group_id` (string): Group ID. If provided, will scope permissions to this group.
49
- * `user_id` (string): User ID. If provided, will scope permissions to this user.
47
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
48
+ * `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 `deleted_at`, `group_id`, `path`, `user_id` or `permission`.
49
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
50
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
51
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
52
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
53
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
54
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
55
+ * `path` (string): DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
56
+ * `group_id` (string): DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
57
+ * `user_id` (string): DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
50
58
  * `include_groups` (boolean): If searching by user or group, also include user's permissions that are inherited from its groups?
51
59
 
52
60