files.com 1.0.121 → 1.0.122

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 (83) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/api_key.md +1 -4
  4. data/docs/app.md +1 -4
  5. data/docs/as2_key.md +1 -4
  6. data/docs/automation.md +1 -4
  7. data/docs/bandwidth_snapshot.md +1 -4
  8. data/docs/behavior.md +2 -8
  9. data/docs/bundle.md +7 -6
  10. data/docs/bundle_download.md +1 -4
  11. data/docs/bundle_recipient.md +1 -4
  12. data/docs/clickwrap.md +3 -5
  13. data/docs/dns_record.md +1 -4
  14. data/docs/external_event.md +1 -4
  15. data/docs/file_comment.md +1 -4
  16. data/docs/folder.md +1 -4
  17. data/docs/group.md +1 -4
  18. data/docs/group_user.md +1 -4
  19. data/docs/history.md +10 -30
  20. data/docs/history_export.md +5 -0
  21. data/docs/history_export_result.md +1 -5
  22. data/docs/invoice.md +1 -4
  23. data/docs/ip_address.md +2 -8
  24. data/docs/lock.md +1 -4
  25. data/docs/message.md +1 -4
  26. data/docs/message_comment.md +1 -4
  27. data/docs/message_comment_reaction.md +1 -4
  28. data/docs/message_reaction.md +1 -4
  29. data/docs/notification.md +1 -4
  30. data/docs/payment.md +1 -4
  31. data/docs/permission.md +1 -4
  32. data/docs/project.md +1 -4
  33. data/docs/public_key.md +1 -4
  34. data/docs/remote_server.md +1 -4
  35. data/docs/request.md +2 -8
  36. data/docs/settings_change.md +1 -4
  37. data/docs/sso_strategy.md +5 -4
  38. data/docs/usage_daily_snapshot.md +1 -4
  39. data/docs/usage_snapshot.md +1 -4
  40. data/docs/user.md +1 -4
  41. data/docs/user_cipher_use.md +1 -4
  42. data/docs/user_request.md +1 -4
  43. data/lib/files.com/models/api_key.rb +2 -6
  44. data/lib/files.com/models/app.rb +2 -6
  45. data/lib/files.com/models/as2_key.rb +2 -6
  46. data/lib/files.com/models/automation.rb +2 -6
  47. data/lib/files.com/models/bandwidth_snapshot.rb +2 -6
  48. data/lib/files.com/models/behavior.rb +4 -12
  49. data/lib/files.com/models/bundle.rb +6 -6
  50. data/lib/files.com/models/bundle_download.rb +2 -6
  51. data/lib/files.com/models/bundle_recipient.rb +2 -6
  52. data/lib/files.com/models/clickwrap.rb +11 -15
  53. data/lib/files.com/models/dns_record.rb +2 -6
  54. data/lib/files.com/models/external_event.rb +2 -6
  55. data/lib/files.com/models/file_comment.rb +2 -6
  56. data/lib/files.com/models/folder.rb +2 -6
  57. data/lib/files.com/models/group.rb +2 -6
  58. data/lib/files.com/models/group_user.rb +2 -6
  59. data/lib/files.com/models/history.rb +10 -30
  60. data/lib/files.com/models/history_export.rb +20 -0
  61. data/lib/files.com/models/history_export_result.rb +2 -6
  62. data/lib/files.com/models/invoice.rb +2 -6
  63. data/lib/files.com/models/ip_address.rb +4 -12
  64. data/lib/files.com/models/lock.rb +2 -6
  65. data/lib/files.com/models/message.rb +2 -6
  66. data/lib/files.com/models/message_comment.rb +2 -6
  67. data/lib/files.com/models/message_comment_reaction.rb +2 -6
  68. data/lib/files.com/models/message_reaction.rb +2 -6
  69. data/lib/files.com/models/notification.rb +2 -6
  70. data/lib/files.com/models/payment.rb +2 -6
  71. data/lib/files.com/models/permission.rb +2 -6
  72. data/lib/files.com/models/project.rb +2 -6
  73. data/lib/files.com/models/public_key.rb +2 -6
  74. data/lib/files.com/models/remote_server.rb +2 -6
  75. data/lib/files.com/models/request.rb +4 -12
  76. data/lib/files.com/models/settings_change.rb +2 -6
  77. data/lib/files.com/models/sso_strategy.rb +12 -6
  78. data/lib/files.com/models/usage_daily_snapshot.rb +2 -6
  79. data/lib/files.com/models/usage_snapshot.rb +2 -6
  80. data/lib/files.com/models/user.rb +2 -6
  81. data/lib/files.com/models/user_cipher_use.rb +2 -6
  82. data/lib/files.com/models/user_request.rb +2 -6
  83. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: afbaa52d35acc90caddf03f3591030a31497eafabc834d7a7e80a118b75b275c
4
- data.tar.gz: 0d09ba83f3191475ad3b6f4f3e4832a99cecf378e7a8290b9ae86462f858dde5
3
+ metadata.gz: 41f87247229342528ec82a228c26f4728f6c072a893a17099c5dcf25c76740e6
4
+ data.tar.gz: 44d9b38138b7e885134b744630ed510aa1a6a1464e9e686d3c8ef646eca17a96
5
5
  SHA512:
6
- metadata.gz: 2c8b2f614e56ec6d051a88ae44cf77fb7e62ccdee5f326364b9994ee2d8c3bb85d85a8ec0765cca2df3498eaea286874bfed4594289e628f1d891c09c7174e9a
7
- data.tar.gz: c81352b474842a5b48e0e30ea708c67b506b42bfc4b9c26923728927459256fec710867588788f04431a1e60f6c5c5cec80f329fab1f78cec846876365800ba8
6
+ metadata.gz: 29c90fb532df767daa42f194025626fd5494d9d60d190723a2a09e771bcd0c32efc334176d6dc8c1aba11f5a1c02ef4d952b6ec5fbb0b5bfcd62abd0ec31e07a
7
+ data.tar.gz: b3ce9294dcedf97211571ec0dfe8049ca6f927957aec16526a581dadc7be94b94640a58a634c064291ffd89f21831df882fa0fb813905a6341ac154f5e0bc83d
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.121
1
+ 1.0.122
data/docs/api_key.md CHANGED
@@ -38,7 +38,6 @@
38
38
  ```
39
39
  Files::ApiKey.list(
40
40
  user_id: 1,
41
- page: 1,
42
41
  per_page: 1
43
42
  )
44
43
  ```
@@ -46,10 +45,8 @@ Files::ApiKey.list(
46
45
  ### Parameters
47
46
 
48
47
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
49
- * `page` (int64): Current page number.
48
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
50
49
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
50
  * `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
51
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
55
52
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
data/docs/app.md CHANGED
@@ -41,17 +41,14 @@
41
41
 
42
42
  ```
43
43
  Files::App.list(
44
- page: 1,
45
44
  per_page: 1
46
45
  )
47
46
  ```
48
47
 
49
48
  ### Parameters
50
49
 
51
- * `page` (int64): Current page number.
50
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
52
51
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
55
52
  * `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`.
56
53
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
57
54
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.
data/docs/as2_key.md CHANGED
@@ -26,7 +26,6 @@
26
26
  ```
27
27
  Files::As2Key.list(
28
28
  user_id: 1,
29
- page: 1,
30
29
  per_page: 1
31
30
  )
32
31
  ```
@@ -34,10 +33,8 @@ Files::As2Key.list(
34
33
  ### Parameters
35
34
 
36
35
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
37
- * `page` (int64): Current page number.
36
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
38
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
41
38
 
42
39
 
43
40
  ---
data/docs/automation.md CHANGED
@@ -45,7 +45,6 @@
45
45
 
46
46
  ```
47
47
  Files::Automation.list(
48
- page: 1,
49
48
  per_page: 1,
50
49
  automation: "create_folder"
51
50
  )
@@ -53,10 +52,8 @@ Files::Automation.list(
53
52
 
54
53
  ### Parameters
55
54
 
56
- * `page` (int64): Current page number.
55
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
57
56
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
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
57
  * `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
58
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
62
59
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
data/docs/bandwidth_snapshot.md CHANGED
@@ -33,17 +33,14 @@
33
33
 
34
34
  ```
35
35
  Files::BandwidthSnapshot.list(
36
- page: 1,
37
36
  per_page: 1
38
37
  )
39
38
  ```
40
39
 
41
40
  ### Parameters
42
41
 
43
- * `page` (int64): Current page number.
42
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
44
43
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
44
  * `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
45
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
49
46
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
data/docs/behavior.md CHANGED
@@ -28,7 +28,6 @@
28
28
 
29
29
  ```
30
30
  Files::Behavior.list(
31
- page: 1,
32
31
  per_page: 1,
33
32
  behavior: "webhook"
34
33
  )
@@ -36,10 +35,8 @@ Files::Behavior.list(
36
35
 
37
36
  ### Parameters
38
37
 
39
- * `page` (int64): Current page number.
38
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
40
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
40
  * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `behavior`.
44
41
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
45
42
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
@@ -69,7 +66,6 @@ Files::Behavior.find(id)
69
66
 
70
67
  ```
71
68
  Files::Behavior.list_for(path,
72
- page: 1,
73
69
  per_page: 1,
74
70
  behavior: "webhook"
75
71
  )
@@ -77,10 +73,8 @@ Files::Behavior.list_for(path,
77
73
 
78
74
  ### Parameters
79
75
 
80
- * `page` (int64): Current page number.
76
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
81
77
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
78
  * `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
79
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
86
80
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
data/docs/bundle.md CHANGED
@@ -55,7 +55,6 @@
55
55
  ```
56
56
  Files::Bundle.list(
57
57
  user_id: 1,
58
- page: 1,
59
58
  per_page: 1
60
59
  )
61
60
  ```
@@ -63,10 +62,8 @@ Files::Bundle.list(
63
62
  ### Parameters
64
63
 
65
64
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
66
- * `page` (int64): Current page number.
65
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
67
66
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
68
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
69
- * `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.
70
67
  * `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`.
71
68
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
72
69
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
@@ -133,7 +130,8 @@ Files::Bundle.create(
133
130
  ```
134
131
  Files::Bundle.share(id,
135
132
  to: ["johndoe@gmail.com"],
136
- note: "Just a note."
133
+ note: "Just a note.",
134
+ recipients: [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}]
137
135
  )
138
136
  ```
139
137
 
@@ -142,6 +140,7 @@ Files::Bundle.share(id,
142
140
  * `id` (int64): Required - Bundle ID.
143
141
  * `to` (array(string)): Required - A list of email addresses to share this bundle with.
144
142
  * `note` (string): Note to include in email.
143
+ * `recipients` (array(object)): A list of recipients to share this bundle with.
145
144
 
146
145
 
147
146
  ---
@@ -200,7 +199,8 @@ bundle = Files::Bundle.list_for(path).first
200
199
 
201
200
  bundle.share(
202
201
  to: ["johndoe@gmail.com"],
203
- note: "Just a note."
202
+ note: "Just a note.",
203
+ recipients: [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}]
204
204
  )
205
205
  ```
206
206
 
@@ -209,6 +209,7 @@ bundle.share(
209
209
  * `id` (int64): Required - Bundle ID.
210
210
  * `to` (array(string)): Required - A list of email addresses to share this bundle with.
211
211
  * `note` (string): Note to include in email.
212
+ * `recipients` (array(object)): A list of recipients to share this bundle with.
212
213
 
213
214
 
214
215
  ---
data/docs/bundle_download.md CHANGED
@@ -21,7 +21,6 @@
21
21
 
22
22
  ```
23
23
  Files::BundleDownload.list(
24
- page: 1,
25
24
  per_page: 1,
26
25
  bundle_registration_id: 1
27
26
  )
@@ -29,8 +28,6 @@ Files::BundleDownload.list(
29
28
 
30
29
  ### Parameters
31
30
 
32
- * `page` (int64): Current page number.
31
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
33
32
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
36
33
  * `bundle_registration_id` (int64): Required - BundleRegistration ID
data/docs/bundle_recipient.md CHANGED
@@ -26,7 +26,6 @@
26
26
  ```
27
27
  Files::BundleRecipient.list(
28
28
  user_id: 1,
29
- page: 1,
30
29
  per_page: 1,
31
30
  bundle_id: 1
32
31
  )
@@ -35,8 +34,6 @@ Files::BundleRecipient.list(
35
34
  ### Parameters
36
35
 
37
36
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
38
- * `page` (int64): Current page number.
37
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
39
38
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
42
39
  * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
data/docs/clickwrap.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
+ "id": 1,
7
8
  "name": "Example Site NDA for Files.com Use",
8
9
  "body": "[Legal body text]",
9
10
  "use_with_users": "",
@@ -12,12 +13,12 @@
12
13
  }
13
14
  ```
14
15
 
16
+ * `id` (int64): Clickwrap ID
15
17
  * `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
16
18
  * `body` (string): Body text of Clickwrap (supports Markdown formatting).
17
19
  * `use_with_users` (string): Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
18
20
  * `use_with_bundles` (string): Use this Clickwrap for Bundles?
19
21
  * `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
20
- * `id` (int64): Clickwrap ID.
21
22
 
22
23
 
23
24
  ---
@@ -26,17 +27,14 @@
26
27
 
27
28
  ```
28
29
  Files::Clickwrap.list(
29
- page: 1,
30
30
  per_page: 1
31
31
  )
32
32
  ```
33
33
 
34
34
  ### Parameters
35
35
 
36
- * `page` (int64): Current page number.
36
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
37
37
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
40
38
 
41
39
 
42
40
  ---
data/docs/dns_record.md CHANGED
@@ -23,14 +23,11 @@
23
23
 
24
24
  ```
25
25
  Files::DnsRecord.list(
26
- page: 1,
27
26
  per_page: 1
28
27
  )
29
28
  ```
30
29
 
31
30
  ### Parameters
32
31
 
33
- * `page` (int64): Current page number.
32
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
34
33
  * `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.
data/docs/external_event.md CHANGED
@@ -23,17 +23,14 @@
23
23
 
24
24
  ```
25
25
  Files::ExternalEvent.list(
26
- page: 1,
27
26
  per_page: 1
28
27
  )
29
28
  ```
30
29
 
31
30
  ### Parameters
32
31
 
33
- * `page` (int64): Current page number.
32
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
34
33
  * `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
34
  * `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
35
  * `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
36
  * `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`.
data/docs/file_comment.md CHANGED
@@ -24,17 +24,14 @@
24
24
 
25
25
  ```
26
26
  Files::FileComment.list_for(path,
27
- page: 1,
28
27
  per_page: 1
29
28
  )
30
29
  ```
31
30
 
32
31
  ### Parameters
33
32
 
34
- * `page` (int64): Current page number.
33
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
35
34
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
38
35
  * `path` (string): Required - Path to operate on.
39
36
 
40
37
 
data/docs/folder.md CHANGED
@@ -52,7 +52,6 @@ Files::Dir is an alias of Files::Folder
52
52
 
53
53
  ```
54
54
  Files::Folder.list_for(path,
55
- page: 1,
56
55
  per_page: 1,
57
56
  search_all: true,
58
57
  with_previews: true,
@@ -62,10 +61,8 @@ Files::Folder.list_for(path,
62
61
 
63
62
  ### Parameters
64
63
 
65
- * `page` (int64): Current page number.
66
- * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
67
- * `action` (string): Action to take. Can be `count`, `size`, `permissions`, or blank.
68
64
  * `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.
65
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
69
66
  * `path` (string): Required - Path to operate on.
70
67
  * `filter` (string): If specified, will to filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
71
68
  * `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
data/docs/group.md CHANGED
@@ -33,17 +33,14 @@
33
33
 
34
34
  ```
35
35
  Files::Group.list(
36
- page: 1,
37
36
  per_page: 1
38
37
  )
39
38
  ```
40
39
 
41
40
  ### Parameters
42
41
 
43
- * `page` (int64): Current page number.
42
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
44
43
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
44
  * `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`, `site_id` or `name`.
48
45
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
49
46
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
data/docs/group_user.md CHANGED
@@ -29,7 +29,6 @@
29
29
  ```
30
30
  Files::GroupUser.list(
31
31
  user_id: 1,
32
- page: 1,
33
32
  per_page: 1,
34
33
  group_id: 1
35
34
  )
@@ -38,10 +37,8 @@ Files::GroupUser.list(
38
37
  ### Parameters
39
38
 
40
39
  * `user_id` (int64): User ID. If provided, will return group_users of this user.
41
- * `page` (int64): Current page number.
40
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
42
41
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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.
45
42
  * `group_id` (int64): Group ID. If provided, will return group_users of this group.
46
43
 
47
44
 
data/docs/history.md CHANGED
@@ -44,9 +44,7 @@
44
44
  ```
45
45
  Files::History.list_for_file(path,
46
46
  display: "Actual text of the action here.",
47
- page: 1,
48
- per_page: 1,
49
- action: "create"
47
+ per_page: 1
50
48
  )
51
49
  ```
52
50
 
@@ -55,10 +53,8 @@ Files::History.list_for_file(path,
55
53
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
56
54
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
57
55
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
58
- * `page` (int64): Current page number.
56
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
59
57
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
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 `user_id` and `created_at`.
63
59
  * `path` (string): Required - Path to operate on.
64
60
 
@@ -70,9 +66,7 @@ Files::History.list_for_file(path,
70
66
  ```
71
67
  Files::History.list_for_folder(path,
72
68
  display: "Actual text of the action here.",
73
- page: 1,
74
- per_page: 1,
75
- action: "create"
69
+ per_page: 1
76
70
  )
77
71
  ```
78
72
 
@@ -81,10 +75,8 @@ Files::History.list_for_folder(path,
81
75
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
82
76
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
83
77
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
84
- * `page` (int64): Current page number.
78
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
85
79
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
80
  * `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`.
89
81
  * `path` (string): Required - Path to operate on.
90
82
 
@@ -96,9 +88,7 @@ Files::History.list_for_folder(path,
96
88
  ```
97
89
  Files::History.list_for_user(user_id,
98
90
  display: "Actual text of the action here.",
99
- page: 1,
100
- per_page: 1,
101
- action: "create"
91
+ per_page: 1
102
92
  )
103
93
  ```
104
94
 
@@ -107,10 +97,8 @@ Files::History.list_for_user(user_id,
107
97
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
108
98
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
109
99
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
110
- * `page` (int64): Current page number.
100
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
111
101
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
102
  * `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`.
115
103
  * `user_id` (int64): Required - User ID.
116
104
 
@@ -122,9 +110,7 @@ Files::History.list_for_user(user_id,
122
110
  ```
123
111
  Files::History.list_logins(
124
112
  display: "Actual text of the action here.",
125
- page: 1,
126
- per_page: 1,
127
- action: "create"
113
+ per_page: 1
128
114
  )
129
115
  ```
130
116
 
@@ -133,10 +119,8 @@ Files::History.list_logins(
133
119
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
134
120
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
135
121
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
136
- * `page` (int64): Current page number.
122
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
137
123
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
124
  * `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`.
141
125
 
142
126
 
@@ -147,9 +131,7 @@ Files::History.list_logins(
147
131
  ```
148
132
  Files::History.list(
149
133
  display: "Actual text of the action here.",
150
- page: 1,
151
- per_page: 1,
152
- action: "create"
134
+ per_page: 1
153
135
  )
154
136
  ```
155
137
 
@@ -158,10 +140,8 @@ Files::History.list(
158
140
  * `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
159
141
  * `end_at` (string): Leave blank or set to a date/time to filter later entries.
160
142
  * `display` (string): Display format. Leave blank or set to `full` or `parent`.
161
- * `page` (int64): Current page number.
143
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
162
144
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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
145
  * `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
146
  * `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
147
  * `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`.