files.com 1.0.226 → 1.0.230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_notification_export_result.md +1 -1
- data/docs/api_key.md +1 -1
- data/docs/app.md +1 -1
- data/docs/as2_key.md +1 -1
- data/docs/automation.md +1 -1
- data/docs/automation_run.md +1 -1
- data/docs/bandwidth_snapshot.md +1 -1
- data/docs/behavior.md +9 -4
- data/docs/bundle.md +19 -3
- data/docs/bundle_download.md +1 -1
- data/docs/bundle_recipient.md +1 -1
- data/docs/bundle_registration.md +1 -1
- data/docs/clickwrap.md +1 -1
- data/docs/dns_record.md +1 -1
- data/docs/external_event.md +1 -1
- data/docs/file_comment.md +1 -1
- data/docs/folder.md +1 -1
- data/docs/form_field_set.md +1 -1
- data/docs/group.md +1 -1
- data/docs/group_user.md +1 -1
- data/docs/history.md +5 -5
- data/docs/history_export_result.md +1 -1
- data/docs/inbox_recipient.md +1 -1
- data/docs/inbox_registration.md +1 -1
- data/docs/inbox_upload.md +1 -1
- data/docs/invoice.md +1 -1
- data/docs/ip_address.md +2 -2
- data/docs/lock.md +1 -1
- data/docs/message.md +1 -1
- data/docs/message_comment.md +1 -1
- data/docs/message_comment_reaction.md +1 -1
- data/docs/message_reaction.md +1 -1
- data/docs/notification.md +1 -1
- data/docs/payment.md +1 -1
- data/docs/permission.md +1 -1
- data/docs/priority.md +1 -1
- data/docs/project.md +1 -1
- data/docs/public_key.md +1 -1
- data/docs/remote_server.md +1 -1
- data/docs/request.md +2 -2
- data/docs/settings_change.md +5 -1
- data/docs/sso_strategy.md +1 -1
- data/docs/sync_job.md +1 -1
- data/docs/usage_daily_snapshot.md +1 -1
- data/docs/usage_snapshot.md +1 -1
- data/docs/user.md +1 -1
- data/docs/user_cipher_use.md +1 -1
- data/docs/user_request.md +1 -1
- data/lib/files.com/models/action_notification_export_result.rb +1 -1
- data/lib/files.com/models/api_key.rb +1 -1
- data/lib/files.com/models/app.rb +1 -1
- data/lib/files.com/models/as2_key.rb +1 -1
- data/lib/files.com/models/automation.rb +1 -1
- data/lib/files.com/models/automation_run.rb +1 -1
- data/lib/files.com/models/bandwidth_snapshot.rb +1 -1
- data/lib/files.com/models/behavior.rb +15 -3
- data/lib/files.com/models/bundle.rb +42 -1
- data/lib/files.com/models/bundle_download.rb +1 -1
- data/lib/files.com/models/bundle_recipient.rb +1 -1
- data/lib/files.com/models/bundle_registration.rb +1 -1
- data/lib/files.com/models/clickwrap.rb +1 -1
- data/lib/files.com/models/dns_record.rb +1 -1
- data/lib/files.com/models/external_event.rb +1 -1
- data/lib/files.com/models/file_comment.rb +1 -1
- data/lib/files.com/models/folder.rb +1 -1
- data/lib/files.com/models/form_field_set.rb +1 -1
- data/lib/files.com/models/group.rb +1 -1
- data/lib/files.com/models/group_user.rb +1 -1
- data/lib/files.com/models/history.rb +5 -5
- data/lib/files.com/models/history_export_result.rb +1 -1
- data/lib/files.com/models/inbox_recipient.rb +1 -1
- data/lib/files.com/models/inbox_registration.rb +1 -1
- data/lib/files.com/models/inbox_upload.rb +1 -1
- data/lib/files.com/models/invoice.rb +1 -1
- data/lib/files.com/models/ip_address.rb +2 -2
- data/lib/files.com/models/lock.rb +1 -1
- data/lib/files.com/models/message.rb +1 -1
- data/lib/files.com/models/message_comment.rb +1 -1
- data/lib/files.com/models/message_comment_reaction.rb +1 -1
- data/lib/files.com/models/message_reaction.rb +1 -1
- data/lib/files.com/models/notification.rb +1 -1
- data/lib/files.com/models/payment.rb +1 -1
- data/lib/files.com/models/permission.rb +1 -1
- data/lib/files.com/models/priority.rb +1 -1
- data/lib/files.com/models/project.rb +1 -1
- data/lib/files.com/models/public_key.rb +1 -1
- data/lib/files.com/models/remote_server.rb +1 -1
- data/lib/files.com/models/request.rb +2 -2
- data/lib/files.com/models/settings_change.rb +6 -1
- data/lib/files.com/models/sso_strategy.rb +1 -1
- data/lib/files.com/models/sync_job.rb +1 -1
- data/lib/files.com/models/usage_daily_snapshot.rb +1 -1
- data/lib/files.com/models/usage_snapshot.rb +1 -1
- data/lib/files.com/models/user.rb +1 -1
- data/lib/files.com/models/user_cipher_use.rb +1 -1
- data/lib/files.com/models/user_request.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 577e4466fc3ee443e1ce074d02d4b90410988ac10d81caaa26d6b672044851f7
|
4
|
+
data.tar.gz: cd569b5acfc84da810f69f740b62b2627a701c6fcdc82ad16935fa70538d9127
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d875c3598cd26514e8470ded6f8564c4c2695526c35c774133553e98dd31a6b3e1c18288e5026ea2562247640737ba4443dd72ede5104437171affbc9ba9dac7
|
7
|
+
data.tar.gz: 8523816b4031deff6216148b2b83f91454d6d8debd8720dcefd965a116ad6123e7f174f52dd8cba6bf5cbb95b6206d38d9b0992bdfc246233c78703db33f5a93
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.230
|
@@ -44,6 +44,6 @@ Files::ActionNotificationExportResult.list(
|
|
44
44
|
### Parameters
|
45
45
|
|
46
46
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
47
|
-
* `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.
|
47
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
48
48
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
49
49
|
* `action_notification_export_id` (int64): Required - ID of the associated action notification export.
|
data/docs/api_key.md
CHANGED
@@ -45,7 +45,7 @@ Files::ApiKey.list(
|
|
45
45
|
### Parameters
|
46
46
|
|
47
47
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
49
49
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
50
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 `expires_at`.
|
51
51
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
|
data/docs/app.md
CHANGED
@@ -55,7 +55,7 @@ Files::App.list(
|
|
55
55
|
|
56
56
|
### Parameters
|
57
57
|
|
58
|
-
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
58
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
59
59
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
60
60
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
|
61
61
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
|
data/docs/as2_key.md
CHANGED
@@ -33,7 +33,7 @@ Files::As2Key.list(
|
|
33
33
|
### Parameters
|
34
34
|
|
35
35
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
38
|
|
39
39
|
|
data/docs/automation.md
CHANGED
@@ -80,7 +80,7 @@ Files::Automation.list(
|
|
80
80
|
|
81
81
|
### Parameters
|
82
82
|
|
83
|
-
* `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.
|
83
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
84
84
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
85
|
* `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 `automation`.
|
86
86
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
data/docs/automation_run.md
CHANGED
@@ -36,7 +36,7 @@ Files::AutomationRun.list(
|
|
36
36
|
### Parameters
|
37
37
|
|
38
38
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
39
|
-
* `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
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
40
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
41
41
|
* `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` and `status`.
|
42
42
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
data/docs/bandwidth_snapshot.md
CHANGED
@@ -43,7 +43,7 @@ Files::BandwidthSnapshot.list(
|
|
43
43
|
|
44
44
|
### Parameters
|
45
45
|
|
46
|
-
* `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.
|
46
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
47
47
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
48
48
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `logged_at`.
|
49
49
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
data/docs/behavior.md
CHANGED
@@ -24,6 +24,7 @@
|
|
24
24
|
* `description` (string): Description for this behavior.
|
25
25
|
* `value` (object): Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
|
26
26
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
27
|
+
* `attachment_delete` (boolean): If true, will delete the file stored in attachment
|
27
28
|
|
28
29
|
|
29
30
|
---
|
@@ -39,7 +40,7 @@ Files::Behavior.list(
|
|
39
40
|
|
40
41
|
### Parameters
|
41
42
|
|
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.
|
43
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
43
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
44
45
|
* `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 `behavior`.
|
45
46
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
@@ -77,7 +78,7 @@ Files::Behavior.list_for(path,
|
|
77
78
|
|
78
79
|
### Parameters
|
79
80
|
|
80
|
-
* `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
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
81
82
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
82
83
|
* `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 `behavior`.
|
83
84
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
@@ -145,7 +146,8 @@ Files::Behavior.webhook_test(
|
|
145
146
|
```
|
146
147
|
Files::Behavior.update(id,
|
147
148
|
value: "{\"method\": \"GET\"}",
|
148
|
-
behavior: "webhook"
|
149
|
+
behavior: "webhook",
|
150
|
+
attachment_delete: true
|
149
151
|
)
|
150
152
|
```
|
151
153
|
|
@@ -158,6 +160,7 @@ Files::Behavior.update(id,
|
|
158
160
|
* `description` (string): Description for this behavior.
|
159
161
|
* `behavior` (string): Behavior type.
|
160
162
|
* `path` (string): Folder behaviors path.
|
163
|
+
* `attachment_delete` (boolean): If true, will delete the file stored in attachment
|
161
164
|
|
162
165
|
|
163
166
|
---
|
@@ -182,7 +185,8 @@ behavior = Files::Behavior.list.first
|
|
182
185
|
|
183
186
|
behavior.update(
|
184
187
|
value: "{\"method\": \"GET\"}",
|
185
|
-
behavior: "webhook"
|
188
|
+
behavior: "webhook",
|
189
|
+
attachment_delete: true
|
186
190
|
)
|
187
191
|
```
|
188
192
|
|
@@ -195,6 +199,7 @@ behavior.update(
|
|
195
199
|
* `description` (string): Description for this behavior.
|
196
200
|
* `behavior` (string): Behavior type.
|
197
201
|
* `path` (string): Folder behaviors path.
|
202
|
+
* `attachment_delete` (boolean): If true, will delete the file stored in attachment
|
198
203
|
|
199
204
|
|
200
205
|
---
|
data/docs/bundle.md
CHANGED
@@ -48,6 +48,11 @@
|
|
48
48
|
"username": "user",
|
49
49
|
"clickwrap_id": 1,
|
50
50
|
"inbox_id": 1,
|
51
|
+
"watermark_attachment": {
|
52
|
+
"name": "My logo",
|
53
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
54
|
+
},
|
55
|
+
"watermark_value": "",
|
51
56
|
"has_inbox": true,
|
52
57
|
"paths": [
|
53
58
|
"file.txt"
|
@@ -73,10 +78,14 @@
|
|
73
78
|
* `username` (string): Bundle creator username
|
74
79
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
75
80
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
81
|
+
* `watermark_attachment`: Preview watermark image applied to all bundle items.
|
82
|
+
* `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
76
83
|
* `has_inbox` (boolean): Does this bundle have an associated inbox?
|
77
84
|
* `paths` (array): A list of paths in this bundle
|
78
85
|
* `password` (string): Password for this bundle.
|
79
86
|
* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
|
87
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
88
|
+
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
80
89
|
|
81
90
|
|
82
91
|
---
|
@@ -93,7 +102,7 @@ Files::Bundle.list(
|
|
93
102
|
### Parameters
|
94
103
|
|
95
104
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
96
|
-
* `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.
|
105
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
97
106
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
98
107
|
* `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` and `code`.
|
99
108
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
@@ -156,6 +165,7 @@ Files::Bundle.create(
|
|
156
165
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
157
166
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
158
167
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
168
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
159
169
|
|
160
170
|
|
161
171
|
---
|
@@ -196,7 +206,8 @@ Files::Bundle.update(id,
|
|
196
206
|
note: "The internal note on the bundle.",
|
197
207
|
preview_only: true,
|
198
208
|
require_registration: true,
|
199
|
-
require_share_recipient: true
|
209
|
+
require_share_recipient: true,
|
210
|
+
watermark_attachment_delete: true
|
200
211
|
)
|
201
212
|
```
|
202
213
|
|
@@ -216,6 +227,8 @@ Files::Bundle.update(id,
|
|
216
227
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
217
228
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
218
229
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
230
|
+
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
231
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
219
232
|
|
220
233
|
|
221
234
|
---
|
@@ -273,7 +286,8 @@ bundle.update(
|
|
273
286
|
note: "The internal note on the bundle.",
|
274
287
|
preview_only: true,
|
275
288
|
require_registration: true,
|
276
|
-
require_share_recipient: true
|
289
|
+
require_share_recipient: true,
|
290
|
+
watermark_attachment_delete: true
|
277
291
|
)
|
278
292
|
```
|
279
293
|
|
@@ -293,6 +307,8 @@ bundle.update(
|
|
293
307
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
294
308
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
295
309
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
310
|
+
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
311
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
296
312
|
|
297
313
|
|
298
314
|
---
|
data/docs/bundle_download.md
CHANGED
@@ -31,7 +31,7 @@ Files::BundleDownload.list(
|
|
31
31
|
|
32
32
|
### Parameters
|
33
33
|
|
34
|
-
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
34
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
36
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
|
37
37
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
data/docs/bundle_recipient.md
CHANGED
@@ -37,7 +37,7 @@ Files::BundleRecipient.list(
|
|
37
37
|
### Parameters
|
38
38
|
|
39
39
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
41
41
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
42
|
* `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 `has_registrations`.
|
43
43
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
data/docs/bundle_registration.md
CHANGED
@@ -48,6 +48,6 @@ Files::BundleRegistration.list(
|
|
48
48
|
### Parameters
|
49
49
|
|
50
50
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
51
|
-
* `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.
|
51
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
52
52
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
53
53
|
* `bundle_id` (int64): ID of the associated Bundle
|
data/docs/clickwrap.md
CHANGED
@@ -33,7 +33,7 @@ Files::Clickwrap.list(
|
|
33
33
|
|
34
34
|
### Parameters
|
35
35
|
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
38
|
|
39
39
|
|
data/docs/dns_record.md
CHANGED
@@ -29,5 +29,5 @@ Files::DnsRecord.list(
|
|
29
29
|
|
30
30
|
### Parameters
|
31
31
|
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
data/docs/external_event.md
CHANGED
@@ -43,7 +43,7 @@ Files::ExternalEvent.list(
|
|
43
43
|
|
44
44
|
### Parameters
|
45
45
|
|
46
|
-
* `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.
|
46
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
47
47
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
48
48
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
|
49
49
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
|
data/docs/file_comment.md
CHANGED
@@ -31,7 +31,7 @@ Files::FileComment.list_for(path,
|
|
31
31
|
|
32
32
|
### Parameters
|
33
33
|
|
34
|
-
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
34
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
36
|
* `path` (string): Required - Path to operate on.
|
37
37
|
|
data/docs/folder.md
CHANGED
@@ -67,7 +67,7 @@ Files::Folder.list_for(path,
|
|
67
67
|
|
68
68
|
### Parameters
|
69
69
|
|
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.
|
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-Next header or the X-Files-Cursor-Prev header.
|
71
71
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
72
72
|
* `path` (string): Required - Path to operate on.
|
73
73
|
* `filter` (string): If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
|
data/docs/form_field_set.md
CHANGED
@@ -56,7 +56,7 @@ Files::FormFieldSet.list(
|
|
56
56
|
### Parameters
|
57
57
|
|
58
58
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
59
|
-
* `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
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
60
60
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
61
61
|
|
62
62
|
|
data/docs/group.md
CHANGED
@@ -39,7 +39,7 @@ Files::Group.list(
|
|
39
39
|
|
40
40
|
### Parameters
|
41
41
|
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
43
43
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
44
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 `name`.
|
45
45
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
data/docs/group_user.md
CHANGED
@@ -37,7 +37,7 @@ Files::GroupUser.list(
|
|
37
37
|
### Parameters
|
38
38
|
|
39
39
|
* `user_id` (int64): User ID. If provided, will return group_users of this user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
41
41
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
42
|
* `group_id` (int64): Group ID. If provided, will return group_users of this group.
|
43
43
|
|
data/docs/history.md
CHANGED
@@ -53,7 +53,7 @@ Files::History.list_for_file(path,
|
|
53
53
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
54
54
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
55
55
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
57
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
58
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`.
|
59
59
|
* `path` (string): Required - Path to operate on.
|
@@ -75,7 +75,7 @@ Files::History.list_for_folder(path,
|
|
75
75
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
76
76
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
77
77
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
79
79
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
80
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`.
|
81
81
|
* `path` (string): Required - Path to operate on.
|
@@ -97,7 +97,7 @@ Files::History.list_for_user(user_id,
|
|
97
97
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
98
98
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
99
99
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
101
101
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
102
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`.
|
103
103
|
* `user_id` (int64): Required - User ID.
|
@@ -119,7 +119,7 @@ Files::History.list_logins(
|
|
119
119
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
120
120
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
121
121
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
123
123
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
124
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`.
|
125
125
|
|
@@ -140,7 +140,7 @@ Files::History.list(
|
|
140
140
|
* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
|
141
141
|
* `end_at` (string): Leave blank or set to a date/time to filter later entries.
|
142
142
|
* `display` (string): Display format. Leave blank or set to `full` or `parent`.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
144
144
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
145
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 `path`, `folder`, `user_id` or `created_at`.
|
146
146
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
@@ -70,6 +70,6 @@ Files::HistoryExportResult.list(
|
|
70
70
|
### Parameters
|
71
71
|
|
72
72
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
73
|
-
* `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.
|
73
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
74
74
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
75
75
|
* `history_export_id` (int64): Required - ID of the associated history export.
|
data/docs/inbox_recipient.md
CHANGED
@@ -37,7 +37,7 @@ Files::InboxRecipient.list(
|
|
37
37
|
### Parameters
|
38
38
|
|
39
39
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
41
41
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
42
|
* `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 `has_registrations`.
|
43
43
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
data/docs/inbox_registration.md
CHANGED
@@ -42,6 +42,6 @@ Files::InboxRegistration.list(
|
|
42
42
|
|
43
43
|
### Parameters
|
44
44
|
|
45
|
-
* `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.
|
45
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
46
46
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
47
47
|
* `folder_behavior_id` (int64): ID of the associated Inbox.
|
data/docs/inbox_upload.md
CHANGED
@@ -29,7 +29,7 @@ Files::InboxUpload.list(
|
|
29
29
|
|
30
30
|
### Parameters
|
31
31
|
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
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 `created_at`.
|
35
35
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
data/docs/invoice.md
CHANGED
@@ -65,7 +65,7 @@ Files::Invoice.list(
|
|
65
65
|
|
66
66
|
### Parameters
|
67
67
|
|
68
|
-
* `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.
|
68
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
69
69
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
|
71
71
|
|
data/docs/ip_address.md
CHANGED
@@ -31,7 +31,7 @@ Files::IpAddress.list(
|
|
31
31
|
|
32
32
|
### Parameters
|
33
33
|
|
34
|
-
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
34
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
35
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
36
|
|
37
37
|
|
@@ -47,5 +47,5 @@ Files::IpAddress.get_reserved(
|
|
47
47
|
|
48
48
|
### Parameters
|
49
49
|
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
51
51
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
data/docs/lock.md
CHANGED
@@ -46,7 +46,7 @@ Files::Lock.list_for(path,
|
|
46
46
|
|
47
47
|
### Parameters
|
48
48
|
|
49
|
-
* `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.
|
49
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
50
50
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
51
51
|
* `path` (string): Required - Path to operate on.
|
52
52
|
* `include_children` (boolean): Include locks from children objects?
|
data/docs/message.md
CHANGED
@@ -41,7 +41,7 @@ Files::Message.list(
|
|
41
41
|
### Parameters
|
42
42
|
|
43
43
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
44
|
-
* `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
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
45
45
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
46
46
|
* `project_id` (int64): Required - Project for which to return messages.
|
47
47
|
|
data/docs/message_comment.md
CHANGED
@@ -34,7 +34,7 @@ Files::MessageComment.list(
|
|
34
34
|
### Parameters
|
35
35
|
|
36
36
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
38
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
39
39
|
* `message_id` (int64): Required - Message comment to return comments for.
|
40
40
|
|
@@ -29,7 +29,7 @@ Files::MessageCommentReaction.list(
|
|
29
29
|
### Parameters
|
30
30
|
|
31
31
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
34
|
* `message_comment_id` (int64): Required - Message comment to return reactions for.
|
35
35
|
|
data/docs/message_reaction.md
CHANGED
@@ -29,7 +29,7 @@ Files::MessageReaction.list(
|
|
29
29
|
### Parameters
|
30
30
|
|
31
31
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
33
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
34
|
* `message_id` (int64): Required - Message to return reactions for.
|
35
35
|
|
data/docs/notification.md
CHANGED
@@ -51,7 +51,7 @@ Files::Notification.list(
|
|
51
51
|
### Parameters
|
52
52
|
|
53
53
|
* `user_id` (int64): DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
|
54
|
-
* `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.
|
54
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
55
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
56
56
|
* `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 `path`, `user_id` or `group_id`.
|
57
57
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
data/docs/payment.md
CHANGED
@@ -65,7 +65,7 @@ Files::Payment.list(
|
|
65
65
|
|
66
66
|
### Parameters
|
67
67
|
|
68
|
-
* `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.
|
68
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
69
69
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
|
71
71
|
|
data/docs/permission.md
CHANGED
@@ -40,7 +40,7 @@ Files::Permission.list(
|
|
40
40
|
|
41
41
|
### Parameters
|
42
42
|
|
43
|
-
* `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.
|
43
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
44
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
45
|
* `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 `group_id`, `path`, `user_id` or `permission`.
|
46
46
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
data/docs/priority.md
CHANGED
@@ -25,6 +25,6 @@ Files::Priority.list(path,
|
|
25
25
|
|
26
26
|
### Parameters
|
27
27
|
|
28
|
-
* `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.
|
28
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
29
29
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
30
30
|
* `path` (string): Required - The path to query for priorities
|
data/docs/project.md
CHANGED
@@ -25,7 +25,7 @@ Files::Project.list(
|
|
25
25
|
|
26
26
|
### Parameters
|
27
27
|
|
28
|
-
* `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.
|
28
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
29
29
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
30
30
|
|
31
31
|
|
data/docs/public_key.md
CHANGED
@@ -33,7 +33,7 @@ Files::PublicKey.list(
|
|
33
33
|
### Parameters
|
34
34
|
|
35
35
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
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.
|
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 either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
38
|
|
39
39
|
|
data/docs/remote_server.md
CHANGED
@@ -100,7 +100,7 @@ Files::RemoteServer.list(
|
|
100
100
|
|
101
101
|
### Parameters
|
102
102
|
|
103
|
-
* `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.
|
103
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
104
104
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
105
105
|
|
106
106
|
|
data/docs/request.md
CHANGED
@@ -36,7 +36,7 @@ Files::Request.list(
|
|
36
36
|
|
37
37
|
### Parameters
|
38
38
|
|
39
|
-
* `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
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
40
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
41
41
|
* `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 `destination`.
|
42
42
|
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
@@ -56,7 +56,7 @@ Files::Request.get_folder(path,
|
|
56
56
|
|
57
57
|
### Parameters
|
58
58
|
|
59
|
-
* `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
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
60
60
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
61
61
|
* `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 `destination`.
|
62
62
|
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|