files.com 1.0.121 → 1.0.126
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/api_key.md +1 -4
- data/docs/app.md +1 -4
- data/docs/as2_key.md +1 -4
- data/docs/automation.md +38 -16
- data/docs/bandwidth_snapshot.md +1 -4
- data/docs/behavior.md +2 -8
- data/docs/bundle.md +11 -6
- data/docs/bundle_download.md +1 -4
- data/docs/bundle_recipient.md +1 -4
- data/docs/clickwrap.md +3 -5
- data/docs/dns_record.md +1 -4
- data/docs/external_event.md +1 -4
- data/docs/file_comment.md +1 -4
- data/docs/folder.md +1 -4
- data/docs/group.md +1 -4
- data/docs/group_user.md +1 -4
- data/docs/history.md +10 -30
- data/docs/history_export_result.md +1 -5
- data/docs/invoice.md +1 -4
- data/docs/ip_address.md +2 -8
- data/docs/lock.md +1 -4
- data/docs/message.md +1 -4
- data/docs/message_comment.md +1 -4
- data/docs/message_comment_reaction.md +1 -4
- data/docs/message_reaction.md +1 -4
- data/docs/notification.md +1 -4
- data/docs/payment.md +1 -4
- data/docs/permission.md +1 -4
- data/docs/project.md +1 -4
- data/docs/public_key.md +1 -4
- data/docs/remote_server.md +56 -4
- data/docs/request.md +2 -8
- data/docs/settings_change.md +1 -4
- data/docs/sso_strategy.md +5 -4
- data/docs/usage_daily_snapshot.md +1 -4
- data/docs/usage_snapshot.md +1 -4
- data/docs/user.md +1 -4
- data/docs/user_cipher_use.md +1 -4
- data/docs/user_request.md +1 -4
- data/lib/files.com/models/api_key.rb +2 -6
- data/lib/files.com/models/app.rb +2 -6
- data/lib/files.com/models/as2_key.rb +2 -6
- data/lib/files.com/models/automation.rb +52 -36
- data/lib/files.com/models/bandwidth_snapshot.rb +2 -6
- data/lib/files.com/models/behavior.rb +4 -12
- data/lib/files.com/models/bundle.rb +10 -6
- data/lib/files.com/models/bundle_download.rb +2 -6
- data/lib/files.com/models/bundle_recipient.rb +2 -6
- data/lib/files.com/models/clickwrap.rb +11 -15
- data/lib/files.com/models/dns_record.rb +2 -6
- data/lib/files.com/models/external_event.rb +2 -6
- data/lib/files.com/models/file_comment.rb +2 -6
- data/lib/files.com/models/folder.rb +2 -6
- data/lib/files.com/models/group.rb +2 -6
- data/lib/files.com/models/group_user.rb +2 -6
- data/lib/files.com/models/history.rb +10 -30
- data/lib/files.com/models/history_export_result.rb +2 -6
- data/lib/files.com/models/invoice.rb +2 -6
- data/lib/files.com/models/ip_address.rb +4 -12
- data/lib/files.com/models/lock.rb +2 -6
- data/lib/files.com/models/message.rb +2 -6
- data/lib/files.com/models/message_comment.rb +2 -6
- data/lib/files.com/models/message_comment_reaction.rb +2 -6
- data/lib/files.com/models/message_reaction.rb +2 -6
- data/lib/files.com/models/notification.rb +2 -6
- data/lib/files.com/models/payment.rb +2 -6
- data/lib/files.com/models/permission.rb +2 -6
- data/lib/files.com/models/project.rb +2 -6
- data/lib/files.com/models/public_key.rb +2 -6
- data/lib/files.com/models/remote_server.rb +84 -6
- data/lib/files.com/models/request.rb +4 -12
- data/lib/files.com/models/settings_change.rb +2 -6
- data/lib/files.com/models/sso_strategy.rb +12 -6
- data/lib/files.com/models/usage_daily_snapshot.rb +2 -6
- data/lib/files.com/models/usage_snapshot.rb +2 -6
- data/lib/files.com/models/user.rb +2 -6
- data/lib/files.com/models/user_cipher_use.rb +2 -6
- data/lib/files.com/models/user_request.rb +2 -6
- metadata +2 -2
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
|
-
* `
|
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
|
-
* `
|
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
|
-
* `
|
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
|
-
* `
|
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
|
-
|
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
|
-
* `
|
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
|
-
|
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
|
-
* `
|
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
|
-
|
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
|
-
* `
|
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
|
-
|
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
|
-
* `
|
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
|
-
|
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
|
-
* `
|
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`.
|
@@ -62,9 +62,7 @@
|
|
62
62
|
```
|
63
63
|
Files::HistoryExportResult.list(
|
64
64
|
user_id: 1,
|
65
|
-
page: 1,
|
66
65
|
per_page: 1,
|
67
|
-
action: "read",
|
68
66
|
history_export_id: 1
|
69
67
|
)
|
70
68
|
```
|
@@ -72,8 +70,6 @@ Files::HistoryExportResult.list(
|
|
72
70
|
### Parameters
|
73
71
|
|
74
72
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
75
|
-
* `
|
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.
|
76
74
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
77
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
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
75
|
* `history_export_id` (int64): Required - ID of the associated history export.
|
data/docs/invoice.md
CHANGED
@@ -47,17 +47,14 @@
|
|
47
47
|
|
48
48
|
```
|
49
49
|
Files::Invoice.list(
|
50
|
-
page: 1,
|
51
50
|
per_page: 1
|
52
51
|
)
|
53
52
|
```
|
54
53
|
|
55
54
|
### Parameters
|
56
55
|
|
57
|
-
* `
|
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.
|
58
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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.
|
61
58
|
|
62
59
|
|
63
60
|
---
|
data/docs/ip_address.md
CHANGED
@@ -25,17 +25,14 @@
|
|
25
25
|
|
26
26
|
```
|
27
27
|
Files::IpAddress.list(
|
28
|
-
page: 1,
|
29
28
|
per_page: 1
|
30
29
|
)
|
31
30
|
```
|
32
31
|
|
33
32
|
### Parameters
|
34
33
|
|
35
|
-
* `
|
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.
|
36
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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.
|
39
36
|
|
40
37
|
|
41
38
|
---
|
@@ -44,14 +41,11 @@ Files::IpAddress.list(
|
|
44
41
|
|
45
42
|
```
|
46
43
|
Files::IpAddress.get_reserved(
|
47
|
-
page: 1,
|
48
44
|
per_page: 1
|
49
45
|
)
|
50
46
|
```
|
51
47
|
|
52
48
|
### Parameters
|
53
49
|
|
54
|
-
* `
|
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.
|
55
51
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
56
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
57
|
-
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
data/docs/lock.md
CHANGED
@@ -33,7 +33,6 @@
|
|
33
33
|
|
34
34
|
```
|
35
35
|
Files::Lock.list_for(path,
|
36
|
-
page: 1,
|
37
36
|
per_page: 1,
|
38
37
|
include_children: true
|
39
38
|
)
|
@@ -41,10 +40,8 @@ Files::Lock.list_for(path,
|
|
41
40
|
|
42
41
|
### Parameters
|
43
42
|
|
44
|
-
* `
|
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.
|
45
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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.
|
48
45
|
* `path` (string): Required - Path to operate on.
|
49
46
|
* `include_children` (boolean): Include locks from children objects?
|
50
47
|
|
data/docs/message.md
CHANGED
@@ -28,7 +28,6 @@
|
|
28
28
|
```
|
29
29
|
Files::Message.list(
|
30
30
|
user_id: 1,
|
31
|
-
page: 1,
|
32
31
|
per_page: 1,
|
33
32
|
project_id: 1
|
34
33
|
)
|
@@ -37,10 +36,8 @@ Files::Message.list(
|
|
37
36
|
### Parameters
|
38
37
|
|
39
38
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
40
|
-
* `
|
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.
|
41
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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.
|
44
41
|
* `project_id` (int64): Required - Project for which to return messages.
|
45
42
|
|
46
43
|
|
data/docs/message_comment.md
CHANGED
@@ -25,7 +25,6 @@
|
|
25
25
|
```
|
26
26
|
Files::MessageComment.list(
|
27
27
|
user_id: 1,
|
28
|
-
page: 1,
|
29
28
|
per_page: 1,
|
30
29
|
message_id: 1
|
31
30
|
)
|
@@ -34,10 +33,8 @@ Files::MessageComment.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
|
-
* `
|
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
|
* `message_id` (int64): Required - Message comment to return comments for.
|
42
39
|
|
43
40
|
|
@@ -21,7 +21,6 @@
|
|
21
21
|
```
|
22
22
|
Files::MessageCommentReaction.list(
|
23
23
|
user_id: 1,
|
24
|
-
page: 1,
|
25
24
|
per_page: 1,
|
26
25
|
message_comment_id: 1
|
27
26
|
)
|
@@ -30,10 +29,8 @@ Files::MessageCommentReaction.list(
|
|
30
29
|
### Parameters
|
31
30
|
|
32
31
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
33
|
-
* `
|
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
|
* `message_comment_id` (int64): Required - Message comment to return reactions for.
|
38
35
|
|
39
36
|
|
data/docs/message_reaction.md
CHANGED
@@ -21,7 +21,6 @@
|
|
21
21
|
```
|
22
22
|
Files::MessageReaction.list(
|
23
23
|
user_id: 1,
|
24
|
-
page: 1,
|
25
24
|
per_page: 1,
|
26
25
|
message_id: 1
|
27
26
|
)
|
@@ -30,10 +29,8 @@ Files::MessageReaction.list(
|
|
30
29
|
### Parameters
|
31
30
|
|
32
31
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
33
|
-
* `
|
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
|
* `message_id` (int64): Required - Message to return reactions for.
|
38
35
|
|
39
36
|
|
data/docs/notification.md
CHANGED
@@ -42,7 +42,6 @@
|
|
42
42
|
```
|
43
43
|
Files::Notification.list(
|
44
44
|
user_id: 1,
|
45
|
-
page: 1,
|
46
45
|
per_page: 1,
|
47
46
|
group_id: 1,
|
48
47
|
include_ancestors: true
|
@@ -52,10 +51,8 @@ Files::Notification.list(
|
|
52
51
|
### Parameters
|
53
52
|
|
54
53
|
* `user_id` (int64): DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
|
55
|
-
* `
|
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.
|
56
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
57
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
58
|
-
* `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.
|
59
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 `site_id`, `path`, `user_id` or `group_id`.
|
60
57
|
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
61
58
|
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
data/docs/payment.md
CHANGED
@@ -47,17 +47,14 @@
|
|
47
47
|
|
48
48
|
```
|
49
49
|
Files::Payment.list(
|
50
|
-
page: 1,
|
51
50
|
per_page: 1
|
52
51
|
)
|
53
52
|
```
|
54
53
|
|
55
54
|
### Parameters
|
56
55
|
|
57
|
-
* `
|
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.
|
58
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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.
|
61
58
|
|
62
59
|
|
63
60
|
---
|
data/docs/permission.md
CHANGED
@@ -31,7 +31,6 @@
|
|
31
31
|
|
32
32
|
```
|
33
33
|
Files::Permission.list(
|
34
|
-
page: 1,
|
35
34
|
per_page: 1,
|
36
35
|
group_id: 1,
|
37
36
|
user_id: 1,
|
@@ -41,10 +40,8 @@ Files::Permission.list(
|
|
41
40
|
|
42
41
|
### Parameters
|
43
42
|
|
44
|
-
* `
|
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.
|
45
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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.
|
48
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 `deleted_at`, `group_id`, `path`, `user_id` or `permission`.
|
49
46
|
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
50
47
|
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
data/docs/project.md
CHANGED
@@ -19,17 +19,14 @@
|
|
19
19
|
|
20
20
|
```
|
21
21
|
Files::Project.list(
|
22
|
-
page: 1,
|
23
22
|
per_page: 1
|
24
23
|
)
|
25
24
|
```
|
26
25
|
|
27
26
|
### Parameters
|
28
27
|
|
29
|
-
* `
|
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.
|
30
29
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
31
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
32
|
-
* `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
33
30
|
|
34
31
|
|
35
32
|
---
|