files.com 1.0.103 → 1.0.108

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.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/api_key.md +18 -2
  4. data/docs/app.md +2 -0
  5. data/docs/as2_key.md +1 -0
  6. data/docs/bandwidth_snapshot.md +8 -0
  7. data/docs/bundle_download.md +1 -0
  8. data/docs/bundle_recipient.md +1 -0
  9. data/docs/clickwrap.md +1 -0
  10. data/docs/dns_record.md +1 -0
  11. data/docs/external_event.md +43 -0
  12. data/docs/file.md +2 -4
  13. data/docs/file_comment.md +1 -0
  14. data/docs/file_part_upload.md +12 -10
  15. data/docs/folder.md +2 -4
  16. data/docs/group_user.md +1 -0
  17. data/docs/history_export.md +20 -20
  18. data/docs/history_export_result.md +0 -1
  19. data/docs/invoice.md +1 -0
  20. data/docs/ip_address.md +2 -0
  21. data/docs/lock.md +1 -0
  22. data/docs/message.md +1 -0
  23. data/docs/message_comment.md +1 -0
  24. data/docs/message_comment_reaction.md +1 -0
  25. data/docs/message_reaction.md +1 -0
  26. data/docs/payment.md +1 -0
  27. data/docs/project.md +1 -0
  28. data/docs/public_key.md +1 -0
  29. data/docs/remote_server.md +1 -0
  30. data/docs/session.md +10 -2
  31. data/docs/site.md +18 -2
  32. data/docs/sso_strategy.md +3 -0
  33. data/docs/usage_snapshot.md +1 -0
  34. data/docs/user_cipher_use.md +1 -0
  35. data/docs/user_request.md +1 -0
  36. data/lib/files.com.rb +1 -0
  37. data/lib/files.com/api_client.rb +7 -2
  38. data/lib/files.com/models/api_key.rb +12 -0
  39. data/lib/files.com/models/app.rb +5 -0
  40. data/lib/files.com/models/as2_key.rb +4 -3
  41. data/lib/files.com/models/bandwidth_snapshot.rb +18 -3
  42. data/lib/files.com/models/bundle_download.rb +4 -3
  43. data/lib/files.com/models/bundle_recipient.rb +4 -3
  44. data/lib/files.com/models/clickwrap.rb +4 -3
  45. data/lib/files.com/models/dns_record.rb +4 -3
  46. data/lib/files.com/models/external_event.rb +66 -0
  47. data/lib/files.com/models/file.rb +6 -15
  48. data/lib/files.com/models/file_comment.rb +4 -3
  49. data/lib/files.com/models/file_part_upload.rb +10 -5
  50. data/lib/files.com/models/folder.rb +3 -12
  51. data/lib/files.com/models/group_user.rb +4 -3
  52. data/lib/files.com/models/history_export.rb +15 -15
  53. data/lib/files.com/models/history_export_result.rb +0 -2
  54. data/lib/files.com/models/invoice.rb +4 -3
  55. data/lib/files.com/models/ip_address.rb +8 -6
  56. data/lib/files.com/models/lock.rb +4 -3
  57. data/lib/files.com/models/message.rb +4 -3
  58. data/lib/files.com/models/message_comment.rb +4 -3
  59. data/lib/files.com/models/message_comment_reaction.rb +4 -3
  60. data/lib/files.com/models/message_reaction.rb +4 -3
  61. data/lib/files.com/models/payment.rb +4 -3
  62. data/lib/files.com/models/project.rb +4 -3
  63. data/lib/files.com/models/public_key.rb +4 -3
  64. data/lib/files.com/models/remote_server.rb +4 -3
  65. data/lib/files.com/models/session.rb +6 -0
  66. data/lib/files.com/models/site.rb +12 -0
  67. data/lib/files.com/models/sso_strategy.rb +9 -3
  68. data/lib/files.com/models/usage_snapshot.rb +4 -3
  69. data/lib/files.com/models/user_cipher_use.rb +4 -3
  70. data/lib/files.com/models/user_request.rb +4 -3
  71. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7f919d05ae57ba64da53d365f1113ae7201112f868d1efc2b589441aef6ab641
4
- data.tar.gz: c8ba72453ec961faac523f28353a2a740502c7e68204e5e36a53012bdb671520
3
+ metadata.gz: 25f50a7b22a0ce6961bef338ac56f24f8965eef17734dbac75dbfceaa17bcb26
4
+ data.tar.gz: ee58bb0d063261711d08934ca91bb9ec7f87b50bd9205c4b5fb048faa9802847
5
5
  SHA512:
6
- metadata.gz: 4caf847e2199a84755cf407af3baaaed160378d7c2b0024a0b0f1b87610c835cc16f015be5b700dc08cd55a1bd72b0c548116ba8bcb485b0cb4b8fa76bd6db43
7
- data.tar.gz: dc807e6052c1b8dacbbea536de7bff4ac1f2e4dc6768e6dc5f40cdf90f1e034b3d56c90ff983e3a0a06228f8bc3201d55e573f49b04d2381474b81f480e6f177
6
+ metadata.gz: 38a7bb9709b3946bdcf12601f385f66a7ab566c08749533263bc3d32f665d4420ba57090279ed46f2fb4fd32bf2303a92573ecb80cfd781cb5a03c947227ba14
7
+ data.tar.gz: f66986f45017abe32cabc84e7103d29dc0e1329c1152d14d131e64edafa10069dd02da91d789404d31bdd7e9de8436878e995a927fde8a34f1951640264e981d
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.103
1
+ 1.0.108
@@ -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
 
@@ -9,6 +9,7 @@
9
9
  "documentation_links": "Important Info => http://files.test/learn-more",
10
10
  "icon_url": "",
11
11
  "logo_url": "",
12
+ "screenshot_list_urls": "",
12
13
  "logo_thumbnail_url": "",
13
14
  "sso_strategy_type": "",
14
15
  "remote_server_type": "",
@@ -24,6 +25,7 @@
24
25
  * `documentation_links` (string): Collection of named links to documentation
25
26
  * `icon_url` (string): App icon
26
27
  * `logo_url` (string): Full size logo for the App
28
+ * `screenshot_list_urls` (string): Screenshots of the App
27
29
  * `logo_thumbnail_url` (string): Logo thumbnail for the App
28
30
  * `sso_strategy_type` (string): Associated SSO Strategy type, if any
29
31
  * `remote_server_type` (string): Associated Remote Server type, if any
@@ -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
  ---
@@ -43,3 +43,11 @@ Files::BandwidthSnapshot.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 `site_id` and `logged_at`.
48
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
49
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
50
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.
51
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
52
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `logged_at`.
53
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `logged_at`.
@@ -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
@@ -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.
@@ -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
  ---
@@ -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`.
@@ -7,7 +7,6 @@ may places where a Ruby File object can be used.
7
7
 
8
8
  ```
9
9
  {
10
- "id": 1,
11
10
  "path": "path/file.txt",
12
11
  "display_name": "file.txt",
13
12
  "type": "file",
@@ -27,7 +26,6 @@ may places where a Ruby File object can be used.
27
26
  }
28
27
  ```
29
28
 
30
- * `id` (int64): File/Folder ID
31
29
  * `path` (string): File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
32
30
  * `display_name` (string): File/Folder display name
33
31
  * `type` (string): Type: `directory` or `file`.
@@ -141,7 +139,7 @@ Files::File.delete(path,
141
139
  ### Parameters
142
140
 
143
141
  * `path` (string): Required - Path to operate on.
144
- * `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders. For legacy reasons, this parameter may also be provided as the HTTP header `Depth: Infinity`
142
+ * `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders.
145
143
 
146
144
 
147
145
  ---
@@ -201,4 +199,4 @@ file.delete(
201
199
  ### Parameters
202
200
 
203
201
  * `path` (string): Required - Path to operate on.
204
- * `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders. For legacy reasons, this parameter may also be provided as the HTTP header `Depth: Infinity`
202
+ * `recursive` (boolean): If true, will recursively delete folers. Otherwise, will error on non-empty folders.
@@ -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
 
@@ -7,14 +7,15 @@
7
7
  "send": "",
8
8
  "action": "upload/direct",
9
9
  "ask_about_overwrites": true,
10
- "available_parts": "",
10
+ "available_parts": 1,
11
11
  "expires": "",
12
12
  "headers": "",
13
13
  "http_method": "POST",
14
- "next_partsize": "",
15
- "parameters": "",
16
- "part_number": "",
17
- "partsize": "",
14
+ "next_partsize": 1,
15
+ "parallel_parts": true,
16
+ "parameters": "{}",
17
+ "part_number": 1,
18
+ "partsize": 1,
18
19
  "path": "",
19
20
  "ref": "upload-1",
20
21
  "upload_uri": ""
@@ -24,14 +25,15 @@
24
25
  * `send` (object): Content-Type and File to send
25
26
  * `action` (string): Type of upload
26
27
  * `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation
27
- * `available_parts` (string): Currently unused
28
+ * `available_parts` (int64): Currently unused
28
29
  * `expires` (string): Currently unused
29
30
  * `headers` (object): Additional upload headers
30
31
  * `http_method` (string): Upload method, usually POST
31
- * `next_partsize` (string): Currently unused
32
- * `parameters` (string): Additional upload parameters
33
- * `part_number` (string): Currently unused
34
- * `partsize` (string): Currently unused
32
+ * `next_partsize` (int64): Currently unused
33
+ * `parallel_parts` (boolean): If true, parts may be uploaded in parallel
34
+ * `parameters` (object): Additional upload parameters
35
+ * `part_number` (int64): Currently unused
36
+ * `partsize` (int64): Currently unused
35
37
  * `path` (string): Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
36
38
  * `ref` (string): Reference name for this upload part
37
39
  * `upload_uri` (string): URI to upload this part to
@@ -9,7 +9,6 @@ Files::Dir is an alias of Files::Folder
9
9
 
10
10
  ```
11
11
  {
12
- "id": 1,
13
12
  "path": "path/file.txt",
14
13
  "display_name": "file.txt",
15
14
  "type": "file",
@@ -29,7 +28,6 @@ Files::Dir is an alias of Files::Folder
29
28
  }
30
29
  ```
31
30
 
32
- * `id` (int64): File/Folder ID
33
31
  * `path` (string): File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
34
32
  * `display_name` (string): File/Folder display name
35
33
  * `type` (string): Type: `directory` or `file`.
@@ -66,9 +64,9 @@ Files::Folder.list_for(path,
66
64
 
67
65
  * `page` (int64): Current page number.
68
66
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
67
+ * `action` (string): Action to take. Can be `count`, `size`, `permissions`, or blank.
71
68
  * `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.
69
+ * `path` (string): Required - Path to operate on.
72
70
  * `filter` (string): If specified, will to filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
73
71
  * `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
74
72
  * `search` (string): If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
@@ -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
 
@@ -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` (int64): Return results that are actions performed by the user indiciated by this User ID
41
- * `query_file_id` (int64): Return results that are file actions related to the file indicated by this File ID
42
- * `query_parent_id` (int64): Return results that are file actions inside the parent folder specified by this folder 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` (int64): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this 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` (int64): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this 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` (int64): Return results that are actions performed by the user indiciated by this User ID
113
- * `query_file_id` (int64): Return results that are file actions related to the file indicated by this File ID
114
- * `query_parent_id` (int64): Return results that are file actions inside the parent folder specified by this folder 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` (int64): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this 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` (int64): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this 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.
@@ -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
  ---
@@ -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.
@@ -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
 
@@ -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
 
@@ -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