files.com 1.0.104 → 1.0.105
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/api_key.md +18 -2
- data/docs/as2_key.md +1 -0
- data/docs/bundle_download.md +1 -0
- data/docs/bundle_recipient.md +1 -0
- data/docs/clickwrap.md +1 -0
- data/docs/dns_record.md +1 -0
- data/docs/external_event.md +43 -0
- data/docs/file_comment.md +1 -0
- data/docs/folder.md +1 -1
- data/docs/group_user.md +1 -0
- data/docs/history_export.md +20 -20
- data/docs/history_export_result.md +0 -1
- data/docs/invoice.md +1 -0
- data/docs/ip_address.md +2 -0
- data/docs/lock.md +1 -0
- data/docs/message.md +1 -0
- data/docs/message_comment.md +1 -0
- data/docs/message_comment_reaction.md +1 -0
- data/docs/message_reaction.md +1 -0
- data/docs/payment.md +1 -0
- data/docs/project.md +1 -0
- data/docs/public_key.md +1 -0
- data/docs/remote_server.md +1 -0
- data/docs/session.md +10 -2
- data/docs/site.md +18 -2
- data/docs/sso_strategy.md +1 -0
- data/docs/usage_snapshot.md +1 -0
- data/docs/user_cipher_use.md +1 -0
- data/docs/user_request.md +1 -0
- data/lib/files.com.rb +1 -0
- data/lib/files.com/models/api_key.rb +12 -0
- data/lib/files.com/models/as2_key.rb +4 -3
- data/lib/files.com/models/bundle_download.rb +4 -3
- data/lib/files.com/models/bundle_recipient.rb +4 -3
- data/lib/files.com/models/clickwrap.rb +4 -3
- data/lib/files.com/models/dns_record.rb +4 -3
- data/lib/files.com/models/external_event.rb +66 -0
- data/lib/files.com/models/file_comment.rb +4 -3
- data/lib/files.com/models/folder.rb +2 -2
- data/lib/files.com/models/group_user.rb +4 -3
- data/lib/files.com/models/history_export.rb +15 -15
- data/lib/files.com/models/history_export_result.rb +0 -2
- data/lib/files.com/models/invoice.rb +4 -3
- data/lib/files.com/models/ip_address.rb +8 -6
- data/lib/files.com/models/lock.rb +4 -3
- data/lib/files.com/models/message.rb +4 -3
- data/lib/files.com/models/message_comment.rb +4 -3
- data/lib/files.com/models/message_comment_reaction.rb +4 -3
- data/lib/files.com/models/message_reaction.rb +4 -3
- data/lib/files.com/models/payment.rb +4 -3
- data/lib/files.com/models/project.rb +4 -3
- data/lib/files.com/models/public_key.rb +4 -3
- data/lib/files.com/models/remote_server.rb +4 -3
- data/lib/files.com/models/session.rb +6 -0
- data/lib/files.com/models/site.rb +12 -0
- data/lib/files.com/models/sso_strategy.rb +4 -3
- data/lib/files.com/models/usage_snapshot.rb +4 -3
- data/lib/files.com/models/user_cipher_use.rb +4 -3
- data/lib/files.com/models/user_request.rb +4 -3
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8cd77bb2f9cb48b58dcda25c2604f5456b55111db664dc3fb7bca8babe8074da
|
|
4
|
+
data.tar.gz: 5adda7542727b131b64f313edc01608cd3b44d3461c0ec2dec1f007e1d4d8c35
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6468ef426a11a2decd80f733c8552a7e47d736ed3606116199282044441db62cf62abb22e3df058723b74a896832b585a072f427807a55a7d68bd0ca33d320db
|
|
7
|
+
data.tar.gz: 4b0bc1dbb25ce5dc5b1182209bbe4cacd3cd6ffa5279ee885b6846a76a1821d54ee9a95fb11dfc5ed42df39bb3b5a67c59a9a134f3f7da3d0fe9e99276005a1d
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.105
|
data/docs/api_key.md
CHANGED
|
@@ -64,9 +64,17 @@ Files::ApiKey.list(
|
|
|
64
64
|
## Show information about current API key. (Requires current API connection to be using an API key.)
|
|
65
65
|
|
|
66
66
|
```
|
|
67
|
-
Files::ApiKey.find_current
|
|
67
|
+
Files::ApiKey.find_current(
|
|
68
|
+
format: "",
|
|
69
|
+
api_key: ""
|
|
70
|
+
)
|
|
68
71
|
```
|
|
69
72
|
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
* `format` (string):
|
|
76
|
+
* `api_key` (object):
|
|
77
|
+
|
|
70
78
|
|
|
71
79
|
---
|
|
72
80
|
|
|
@@ -148,9 +156,17 @@ Files::ApiKey.update(id,
|
|
|
148
156
|
## Delete current API key. (Requires current API connection to be using an API key.)
|
|
149
157
|
|
|
150
158
|
```
|
|
151
|
-
Files::ApiKey.delete_current
|
|
159
|
+
Files::ApiKey.delete_current(
|
|
160
|
+
format: "",
|
|
161
|
+
api_key: ""
|
|
162
|
+
)
|
|
152
163
|
```
|
|
153
164
|
|
|
165
|
+
### Parameters
|
|
166
|
+
|
|
167
|
+
* `format` (string):
|
|
168
|
+
* `api_key` (object):
|
|
169
|
+
|
|
154
170
|
|
|
155
171
|
---
|
|
156
172
|
|
data/docs/as2_key.md
CHANGED
|
@@ -37,6 +37,7 @@ Files::As2Key.list(
|
|
|
37
37
|
* `page` (int64): Current page number.
|
|
38
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
39
39
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
40
|
+
* `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.
|
|
40
41
|
|
|
41
42
|
|
|
42
43
|
---
|
data/docs/bundle_download.md
CHANGED
|
@@ -32,4 +32,5 @@ Files::BundleDownload.list(
|
|
|
32
32
|
* `page` (int64): Current page number.
|
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
34
34
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
35
|
+
* `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.
|
|
35
36
|
* `bundle_registration_id` (int64): Required - BundleRegistration ID
|
data/docs/bundle_recipient.md
CHANGED
|
@@ -38,4 +38,5 @@ Files::BundleRecipient.list(
|
|
|
38
38
|
* `page` (int64): Current page number.
|
|
39
39
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
40
40
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
41
|
+
* `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.
|
|
41
42
|
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
data/docs/clickwrap.md
CHANGED
|
@@ -36,6 +36,7 @@ Files::Clickwrap.list(
|
|
|
36
36
|
* `page` (int64): Current page number.
|
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
38
38
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
39
|
+
* `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.
|
|
39
40
|
|
|
40
41
|
|
|
41
42
|
---
|
data/docs/dns_record.md
CHANGED
|
@@ -33,3 +33,4 @@ Files::DnsRecord.list(
|
|
|
33
33
|
* `page` (int64): Current page number.
|
|
34
34
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
35
35
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
36
|
+
* `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.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# ExternalEvent
|
|
2
|
+
|
|
3
|
+
## Example ExternalEvent Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"event_type": "",
|
|
8
|
+
"status": "",
|
|
9
|
+
"body": "",
|
|
10
|
+
"created_at": "2000-01-01T01:00:00Z"
|
|
11
|
+
}
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
* `event_type` (string): Type of event being recorded. Valid values: `remote_server_sync`, `lockout`, `ldap_login`, `saml_login`
|
|
15
|
+
* `status` (string): Status of event. Valid values: `error`
|
|
16
|
+
* `body` (string): Event body
|
|
17
|
+
* `created_at` (date-time): External event create date/time
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## List External Events
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
Files::ExternalEvent.list(
|
|
26
|
+
page: 1,
|
|
27
|
+
per_page: 1
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Parameters
|
|
32
|
+
|
|
33
|
+
* `page` (int64): Current page number.
|
|
34
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
35
|
+
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
36
|
+
* `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.
|
|
37
|
+
* `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 `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
|
|
38
|
+
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
|
39
|
+
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
|
40
|
+
* `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`, `event_type`, `remote_server_type` or `status`.
|
|
41
|
+
* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
|
42
|
+
* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
|
|
43
|
+
* `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`, `event_type`, `remote_server_type` or `status`.
|
data/docs/file_comment.md
CHANGED
|
@@ -34,6 +34,7 @@ Files::FileComment.list_for(path,
|
|
|
34
34
|
* `page` (int64): Current page number.
|
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
36
36
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
37
|
+
* `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.
|
|
37
38
|
* `path` (string): Required - Path to operate on.
|
|
38
39
|
|
|
39
40
|
|
data/docs/folder.md
CHANGED
|
@@ -67,8 +67,8 @@ Files::Folder.list_for(path,
|
|
|
67
67
|
* `page` (int64): Current page number.
|
|
68
68
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
69
69
|
* `action` (string): Action to take. Can be `count`, `count_nrs` (non recursive), `size`, `permissions`, or blank.
|
|
70
|
-
* `path` (string): Required - Path to operate on.
|
|
71
70
|
* `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 header.
|
|
71
|
+
* `path` (string): Required - Path to operate on.
|
|
72
72
|
* `filter` (string): If specified, will to filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
|
|
73
73
|
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
74
74
|
* `search` (string): If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
|
data/docs/group_user.md
CHANGED
|
@@ -41,6 +41,7 @@ Files::GroupUser.list(
|
|
|
41
41
|
* `page` (int64): Current page number.
|
|
42
42
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
43
43
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
44
|
+
* `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.
|
|
44
45
|
* `group_id` (int64): Group ID. If provided, will return group_users of this group.
|
|
45
46
|
|
|
46
47
|
|
data/docs/history_export.md
CHANGED
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
"status": "ready",
|
|
11
11
|
"query_action": "read",
|
|
12
12
|
"query_interface": "ftp",
|
|
13
|
-
"query_user_id": 1,
|
|
14
|
-
"query_file_id": 1,
|
|
15
|
-
"query_parent_id": 1,
|
|
13
|
+
"query_user_id": "1",
|
|
14
|
+
"query_file_id": "1",
|
|
15
|
+
"query_parent_id": "1",
|
|
16
16
|
"query_path": "MyFile.txt",
|
|
17
17
|
"query_folder": "Folder",
|
|
18
18
|
"query_src": "SrcFolder",
|
|
@@ -20,10 +20,10 @@
|
|
|
20
20
|
"query_ip": "127.0.0.1",
|
|
21
21
|
"query_username": "jerry",
|
|
22
22
|
"query_failure_type": "bad_password",
|
|
23
|
-
"query_target_id": 1,
|
|
23
|
+
"query_target_id": "1",
|
|
24
24
|
"query_target_name": "full",
|
|
25
25
|
"query_target_permission": "full",
|
|
26
|
-
"query_target_user_id": 1,
|
|
26
|
+
"query_target_user_id": "1",
|
|
27
27
|
"query_target_username": "jerry",
|
|
28
28
|
"query_target_platform": "windows",
|
|
29
29
|
"query_target_permission_set": "desktop_app",
|
|
@@ -37,9 +37,9 @@
|
|
|
37
37
|
* `status` (string): Status of export. Will be: `building` or `ready`
|
|
38
38
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
|
39
39
|
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
|
|
40
|
-
* `query_user_id` (
|
|
41
|
-
* `query_file_id` (
|
|
42
|
-
* `query_parent_id` (
|
|
40
|
+
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
|
41
|
+
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
|
42
|
+
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
|
43
43
|
* `query_path` (string): Return results that are file actions related to this path.
|
|
44
44
|
* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
|
|
45
45
|
* `query_src` (string): Return results that are file moves originating from this path.
|
|
@@ -47,10 +47,10 @@
|
|
|
47
47
|
* `query_ip` (string): Filter results by this IP address.
|
|
48
48
|
* `query_username` (string): Filter results by this username.
|
|
49
49
|
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
|
|
50
|
-
* `query_target_id` (
|
|
50
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
|
51
51
|
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
|
52
52
|
* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
|
53
|
-
* `query_target_user_id` (
|
|
53
|
+
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
|
54
54
|
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
|
55
55
|
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
|
56
56
|
* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|
|
@@ -82,9 +82,9 @@ Files::HistoryExport.create(
|
|
|
82
82
|
end_at: "2000-01-01T01:00:00Z",
|
|
83
83
|
query_action: "read",
|
|
84
84
|
query_interface: "ftp",
|
|
85
|
-
query_user_id: 1,
|
|
86
|
-
query_file_id: 1,
|
|
87
|
-
query_parent_id: 1,
|
|
85
|
+
query_user_id: "1",
|
|
86
|
+
query_file_id: "1",
|
|
87
|
+
query_parent_id: "1",
|
|
88
88
|
query_path: "MyFile.txt",
|
|
89
89
|
query_folder: "Folder",
|
|
90
90
|
query_src: "SrcFolder",
|
|
@@ -92,10 +92,10 @@ Files::HistoryExport.create(
|
|
|
92
92
|
query_ip: "127.0.0.1",
|
|
93
93
|
query_username: "jerry",
|
|
94
94
|
query_failure_type: "bad_password",
|
|
95
|
-
query_target_id: 1,
|
|
95
|
+
query_target_id: "1",
|
|
96
96
|
query_target_name: "full",
|
|
97
97
|
query_target_permission: "full",
|
|
98
|
-
query_target_user_id: 1,
|
|
98
|
+
query_target_user_id: "1",
|
|
99
99
|
query_target_username: "jerry",
|
|
100
100
|
query_target_platform: "windows",
|
|
101
101
|
query_target_permission_set: "desktop_app"
|
|
@@ -109,9 +109,9 @@ Files::HistoryExport.create(
|
|
|
109
109
|
* `end_at` (string): End date/time of export range.
|
|
110
110
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
|
111
111
|
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
|
|
112
|
-
* `query_user_id` (
|
|
113
|
-
* `query_file_id` (
|
|
114
|
-
* `query_parent_id` (
|
|
112
|
+
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
|
113
|
+
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
|
114
|
+
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
|
115
115
|
* `query_path` (string): Return results that are file actions related to this path.
|
|
116
116
|
* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
|
|
117
117
|
* `query_src` (string): Return results that are file moves originating from this path.
|
|
@@ -119,10 +119,10 @@ Files::HistoryExport.create(
|
|
|
119
119
|
* `query_ip` (string): Filter results by this IP address.
|
|
120
120
|
* `query_username` (string): Filter results by this username.
|
|
121
121
|
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
|
|
122
|
-
* `query_target_id` (
|
|
122
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
|
123
123
|
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
|
124
124
|
* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
|
125
|
-
* `query_target_user_id` (
|
|
125
|
+
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
|
126
126
|
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
|
127
127
|
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
|
128
128
|
* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|
|
@@ -76,5 +76,4 @@ Files::HistoryExportResult.list(
|
|
|
76
76
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
77
77
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
78
78
|
* `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.
|
|
79
|
-
* `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 `created_at`.
|
|
80
79
|
* `history_export_id` (int64): Required - ID of the associated history export.
|
data/docs/invoice.md
CHANGED
|
@@ -57,6 +57,7 @@ Files::Invoice.list(
|
|
|
57
57
|
* `page` (int64): Current page number.
|
|
58
58
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
59
59
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
60
|
+
* `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
61
|
|
|
61
62
|
|
|
62
63
|
---
|
data/docs/ip_address.md
CHANGED
|
@@ -35,6 +35,7 @@ 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
|
+
* `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.
|
|
38
39
|
|
|
39
40
|
|
|
40
41
|
---
|
|
@@ -53,3 +54,4 @@ Files::IpAddress.get_reserved(
|
|
|
53
54
|
* `page` (int64): Current page number.
|
|
54
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
55
56
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
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.
|
data/docs/lock.md
CHANGED
|
@@ -44,6 +44,7 @@ Files::Lock.list_for(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
|
+
* `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
48
|
* `path` (string): Required - Path to operate on.
|
|
48
49
|
* `include_children` (boolean): Include locks from children objects?
|
|
49
50
|
|
data/docs/message.md
CHANGED
|
@@ -40,6 +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
|
+
* `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
44
|
* `project_id` (int64): Required - Project for which to return messages.
|
|
44
45
|
|
|
45
46
|
|
data/docs/message_comment.md
CHANGED
|
@@ -37,6 +37,7 @@ Files::MessageComment.list(
|
|
|
37
37
|
* `page` (int64): Current page number.
|
|
38
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
39
39
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
40
|
+
* `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.
|
|
40
41
|
* `message_id` (int64): Required - Message comment to return comments for.
|
|
41
42
|
|
|
42
43
|
|
|
@@ -33,6 +33,7 @@ Files::MessageCommentReaction.list(
|
|
|
33
33
|
* `page` (int64): Current page number.
|
|
34
34
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
35
35
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
36
|
+
* `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.
|
|
36
37
|
* `message_comment_id` (int64): Required - Message comment to return reactions for.
|
|
37
38
|
|
|
38
39
|
|
data/docs/message_reaction.md
CHANGED
|
@@ -33,6 +33,7 @@ Files::MessageReaction.list(
|
|
|
33
33
|
* `page` (int64): Current page number.
|
|
34
34
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
35
35
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
36
|
+
* `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.
|
|
36
37
|
* `message_id` (int64): Required - Message to return reactions for.
|
|
37
38
|
|
|
38
39
|
|
data/docs/payment.md
CHANGED
|
@@ -57,6 +57,7 @@ Files::Payment.list(
|
|
|
57
57
|
* `page` (int64): Current page number.
|
|
58
58
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
59
59
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
60
|
+
* `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
61
|
|
|
61
62
|
|
|
62
63
|
---
|
data/docs/project.md
CHANGED
|
@@ -29,6 +29,7 @@ Files::Project.list(
|
|
|
29
29
|
* `page` (int64): Current page number.
|
|
30
30
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
31
31
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
32
|
+
* `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.
|
|
32
33
|
|
|
33
34
|
|
|
34
35
|
---
|
data/docs/public_key.md
CHANGED
|
@@ -37,6 +37,7 @@ Files::PublicKey.list(
|
|
|
37
37
|
* `page` (int64): Current page number.
|
|
38
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
39
39
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
40
|
+
* `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.
|
|
40
41
|
|
|
41
42
|
|
|
42
43
|
---
|
data/docs/remote_server.md
CHANGED
|
@@ -93,6 +93,7 @@ Files::RemoteServer.list(
|
|
|
93
93
|
* `page` (int64): Current page number.
|
|
94
94
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
95
95
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
96
|
+
* `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.
|
|
96
97
|
|
|
97
98
|
|
|
98
99
|
---
|
data/docs/session.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"login_token_domain": "https://mysite.files.com",
|
|
11
11
|
"max_dir_listing_size": 1,
|
|
12
12
|
"multiple_regions": true,
|
|
13
|
-
"read_only":
|
|
13
|
+
"read_only": true,
|
|
14
14
|
"root_path": "",
|
|
15
15
|
"site_id": 1,
|
|
16
16
|
"ssl_required": true,
|
|
@@ -74,5 +74,13 @@ Files::Session.create(
|
|
|
74
74
|
## Delete user session (log out)
|
|
75
75
|
|
|
76
76
|
```
|
|
77
|
-
Files::Session.delete
|
|
77
|
+
Files::Session.delete(
|
|
78
|
+
format: "",
|
|
79
|
+
session: ""
|
|
80
|
+
)
|
|
78
81
|
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
* `format` (string):
|
|
86
|
+
* `session` (object):
|
data/docs/site.md
CHANGED
|
@@ -234,18 +234,34 @@
|
|
|
234
234
|
## Show site settings
|
|
235
235
|
|
|
236
236
|
```
|
|
237
|
-
Files::Site.get
|
|
237
|
+
Files::Site.get(
|
|
238
|
+
format: "",
|
|
239
|
+
site: ""
|
|
240
|
+
)
|
|
238
241
|
```
|
|
239
242
|
|
|
243
|
+
### Parameters
|
|
244
|
+
|
|
245
|
+
* `format` (string):
|
|
246
|
+
* `site` (object):
|
|
247
|
+
|
|
240
248
|
|
|
241
249
|
---
|
|
242
250
|
|
|
243
251
|
## Get the most recent usage snapshot (usage data for billing purposes) for a Site
|
|
244
252
|
|
|
245
253
|
```
|
|
246
|
-
Files::Site.get_usage
|
|
254
|
+
Files::Site.get_usage(
|
|
255
|
+
format: "",
|
|
256
|
+
site: ""
|
|
257
|
+
)
|
|
247
258
|
```
|
|
248
259
|
|
|
260
|
+
### Parameters
|
|
261
|
+
|
|
262
|
+
* `format` (string):
|
|
263
|
+
* `site` (object):
|
|
264
|
+
|
|
249
265
|
|
|
250
266
|
---
|
|
251
267
|
|
data/docs/sso_strategy.md
CHANGED
|
@@ -99,6 +99,7 @@ Files::SsoStrategy.list(
|
|
|
99
99
|
* `page` (int64): Current page number.
|
|
100
100
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
101
101
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
102
|
+
* `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.
|
|
102
103
|
|
|
103
104
|
|
|
104
105
|
---
|
data/docs/usage_snapshot.md
CHANGED
|
@@ -51,3 +51,4 @@ Files::UsageSnapshot.list(
|
|
|
51
51
|
* `page` (int64): Current page number.
|
|
52
52
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
53
53
|
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
|
54
|
+
* `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.
|