files.com 1.0.224 → 1.0.228
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 +6 -6
- data/docs/app.md +7 -7
- data/docs/automation.md +6 -6
- data/docs/automation_run.md +6 -6
- data/docs/bandwidth_snapshot.md +6 -6
- data/docs/behavior.md +19 -14
- data/docs/bundle.md +24 -8
- data/docs/bundle_download.md +6 -6
- data/docs/bundle_recipient.md +6 -6
- data/docs/bundle_registration.md +1 -1
- data/docs/external_event.md +6 -6
- data/docs/file.md +1 -2
- data/docs/folder.md +1 -2
- data/docs/group.md +6 -6
- data/docs/history.md +6 -6
- data/docs/inbox_recipient.md +6 -6
- data/docs/inbox_registration.md +1 -1
- data/docs/inbox_upload.md +6 -6
- data/docs/notification.md +6 -6
- data/docs/permission.md +6 -6
- data/docs/preview.md +1 -3
- data/docs/settings_change.md +10 -6
- data/docs/usage_daily_snapshot.md +6 -6
- data/docs/user.md +6 -6
- data/lib/files.com/models/api_key.rb +6 -6
- data/lib/files.com/models/app.rb +7 -7
- data/lib/files.com/models/automation.rb +6 -6
- data/lib/files.com/models/automation_run.rb +6 -6
- data/lib/files.com/models/bandwidth_snapshot.rb +6 -6
- data/lib/files.com/models/behavior.rb +25 -13
- data/lib/files.com/models/bundle.rb +47 -6
- data/lib/files.com/models/bundle_download.rb +6 -6
- data/lib/files.com/models/bundle_recipient.rb +6 -6
- data/lib/files.com/models/bundle_registration.rb +1 -1
- data/lib/files.com/models/external_event.rb +6 -6
- data/lib/files.com/models/group.rb +6 -6
- data/lib/files.com/models/history.rb +6 -6
- data/lib/files.com/models/inbox_recipient.rb +6 -6
- data/lib/files.com/models/inbox_registration.rb +1 -1
- data/lib/files.com/models/inbox_upload.rb +6 -6
- data/lib/files.com/models/notification.rb +6 -6
- data/lib/files.com/models/permission.rb +6 -6
- data/lib/files.com/models/preview.rb +0 -5
- data/lib/files.com/models/settings_change.rb +11 -6
- data/lib/files.com/models/usage_daily_snapshot.rb +6 -6
- data/lib/files.com/models/user.rb +6 -6
- 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: f69db0db605f1e4f0d82720a9768276ec402d16e81d6c577c7585fe8f91dd069
|
4
|
+
data.tar.gz: 7f92c64559527e74ba064be293e84691a61855d315b4ec16273c9326d6d75996
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 855bb1f45ddd1a7c7aaa9a380b6615fa88e1d42489f5080d95ed643a1fa6ebf6757d939772bc7a1a89a2bbbda724b4d627893854bdd6317bffd8740c765667c2
|
7
|
+
data.tar.gz: 8aee5b650cd672fd7c8183b4206b1c0484d6022025bf3acd8d2f1f55dcc84b51d6e1384f3f8c67498f15291109efdacde559cba83aa902faa873afee3369abe1
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.228
|
data/docs/api_key.md
CHANGED
@@ -48,12 +48,12 @@ Files::ApiKey.list(
|
|
48
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
52
|
-
* `filter_gt` (object): If set, return records where the
|
53
|
-
* `filter_gteq` (object): If set, return records where the
|
54
|
-
* `filter_like` (object): If set, return records where the
|
55
|
-
* `filter_lt` (object): If set, return records where the
|
56
|
-
* `filter_lteq` (object): If set, return records where the
|
51
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
|
52
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
|
53
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `expires_at`.
|
54
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
|
55
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
|
56
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `expires_at`.
|
57
57
|
|
58
58
|
|
59
59
|
---
|
data/docs/app.md
CHANGED
@@ -28,7 +28,7 @@
|
|
28
28
|
* `name` (string): Name of the App
|
29
29
|
* `extended_description` (string): Long form description of the App
|
30
30
|
* `short_description` (string): Short description of the App
|
31
|
-
* `documentation_links` (
|
31
|
+
* `documentation_links` (object): Collection of named links to documentation
|
32
32
|
* `icon_url` (string): App icon
|
33
33
|
* `logo_url` (string): Full size logo for the App
|
34
34
|
* `screenshot_list_urls` (string): Screenshots of the App
|
@@ -58,9 +58,9 @@ Files::App.list(
|
|
58
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
62
|
-
* `filter_gt` (object): If set, return records where the
|
63
|
-
* `filter_gteq` (object): If set, return records where the
|
64
|
-
* `filter_like` (object): If set, return records where the
|
65
|
-
* `filter_lt` (object): If set, return records where the
|
66
|
-
* `filter_lteq` (object): If set, return records where the
|
61
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
|
62
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`.
|
63
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`.
|
64
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
|
65
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`.
|
66
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
|
data/docs/automation.md
CHANGED
@@ -83,12 +83,12 @@ Files::Automation.list(
|
|
83
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
87
|
-
* `filter_gt` (object): If set, return records where the
|
88
|
-
* `filter_gteq` (object): If set, return records where the
|
89
|
-
* `filter_like` (object): If set, return records where the
|
90
|
-
* `filter_lt` (object): If set, return records where the
|
91
|
-
* `filter_lteq` (object): If set, return records where the
|
86
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
87
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`.
|
88
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`.
|
89
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
90
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `automation`.
|
91
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`.
|
92
92
|
* `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
|
93
93
|
|
94
94
|
|
data/docs/automation_run.md
CHANGED
@@ -39,12 +39,12 @@ Files::AutomationRun.list(
|
|
39
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
43
|
-
* `filter_gt` (object): If set, return records where the
|
44
|
-
* `filter_gteq` (object): If set, return records where the
|
45
|
-
* `filter_like` (object): If set, return records where the
|
46
|
-
* `filter_lt` (object): If set, return records where the
|
47
|
-
* `filter_lteq` (object): If set, return records where the
|
42
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
43
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
|
44
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
|
45
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
46
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
|
47
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
|
48
48
|
* `automation_id` (int64): Required - ID of the associated Automation.
|
49
49
|
|
50
50
|
|
data/docs/bandwidth_snapshot.md
CHANGED
@@ -46,9 +46,9 @@ Files::BandwidthSnapshot.list(
|
|
46
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
50
|
-
* `filter_gt` (object): If set, return records where the
|
51
|
-
* `filter_gteq` (object): If set, return records where the
|
52
|
-
* `filter_like` (object): If set, return records where the
|
53
|
-
* `filter_lt` (object): If set, return records where the
|
54
|
-
* `filter_lteq` (object): If set, return records where the
|
49
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
50
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
51
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
|
52
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
53
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
54
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or 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
|
---
|
@@ -42,12 +43,12 @@ Files::Behavior.list(
|
|
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
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
|
-
* `filter` (object): If set, return records where the
|
46
|
-
* `filter_gt` (object): If set, return records where the
|
47
|
-
* `filter_gteq` (object): If set, return records where the
|
48
|
-
* `filter_like` (object): If set, return records where the
|
49
|
-
* `filter_lt` (object): If set, return records where the
|
50
|
-
* `filter_lteq` (object): If set, return records where the
|
46
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
47
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
|
48
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
|
49
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
50
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
|
51
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
|
51
52
|
* `behavior` (string): If set, only shows folder behaviors matching this behavior type.
|
52
53
|
|
53
54
|
|
@@ -80,12 +81,12 @@ Files::Behavior.list_for(path,
|
|
80
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 the X-Files-Cursor-Next 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
|
-
* `filter` (object): If set, return records where the
|
84
|
-
* `filter_gt` (object): If set, return records where the
|
85
|
-
* `filter_gteq` (object): If set, return records where the
|
86
|
-
* `filter_like` (object): If set, return records where the
|
87
|
-
* `filter_lt` (object): If set, return records where the
|
88
|
-
* `filter_lteq` (object): If set, return records where the
|
84
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
85
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `behavior`.
|
86
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
|
87
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
88
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
|
89
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
|
89
90
|
* `path` (string): Required - Path to operate on.
|
90
91
|
* `recursive` (string): Show behaviors above this path?
|
91
92
|
* `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
|
@@ -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
|
---
|
@@ -96,12 +105,12 @@ Files::Bundle.list(
|
|
96
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 the X-Files-Cursor-Next 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
|
-
* `filter` (object): If set, return records where the
|
100
|
-
* `filter_gt` (object): If set, return records where the
|
101
|
-
* `filter_gteq` (object): If set, return records where the
|
102
|
-
* `filter_like` (object): If set, return records where the
|
103
|
-
* `filter_lt` (object): If set, return records where the
|
104
|
-
* `filter_lteq` (object): If set, return records where the
|
108
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
109
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
110
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
|
111
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
112
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
113
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
|
105
114
|
|
106
115
|
|
107
116
|
---
|
@@ -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
@@ -34,11 +34,11 @@ Files::BundleDownload.list(
|
|
34
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
38
|
-
* `filter_gt` (object): If set, return records where the
|
39
|
-
* `filter_gteq` (object): If set, return records where the
|
40
|
-
* `filter_like` (object): If set, return records where the
|
41
|
-
* `filter_lt` (object): If set, return records where the
|
42
|
-
* `filter_lteq` (object): If set, return records where the
|
37
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
38
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
39
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
|
40
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
41
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
42
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
|
43
43
|
* `bundle_id` (int64): Bundle ID
|
44
44
|
* `bundle_registration_id` (int64): BundleRegistration ID
|
data/docs/bundle_recipient.md
CHANGED
@@ -40,12 +40,12 @@ Files::BundleRecipient.list(
|
|
40
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
44
|
-
* `filter_gt` (object): If set, return records where the
|
45
|
-
* `filter_gteq` (object): If set, return records where the
|
46
|
-
* `filter_like` (object): If set, return records where the
|
47
|
-
* `filter_lt` (object): If set, return records where the
|
48
|
-
* `filter_lteq` (object): If set, return records where the
|
43
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
44
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
|
45
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
|
46
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
47
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
|
48
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
|
49
49
|
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
50
50
|
|
51
51
|
|
data/docs/bundle_registration.md
CHANGED
@@ -27,7 +27,7 @@
|
|
27
27
|
* `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
|
28
28
|
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
|
29
29
|
* `form_field_set_id` (int64): Id of associated form field set
|
30
|
-
* `form_field_data` (
|
30
|
+
* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
|
31
31
|
* `bundle_code` (string): Bundle URL code
|
32
32
|
* `bundle_id` (int64): Id of associated bundle
|
33
33
|
* `bundle_recipient_id` (int64): Id of associated bundle recipient
|
data/docs/external_event.md
CHANGED
@@ -46,12 +46,12 @@ Files::ExternalEvent.list(
|
|
46
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
50
|
-
* `filter_gt` (object): If set, return records where the
|
51
|
-
* `filter_gteq` (object): If set, return records where the
|
52
|
-
* `filter_like` (object): If set, return records where the
|
53
|
-
* `filter_lt` (object): If set, return records where the
|
54
|
-
* `filter_lteq` (object): If set, return records where the
|
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`.
|
50
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
|
51
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
|
52
|
+
* `filter_like` (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`.
|
53
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
|
54
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
|
55
55
|
|
56
56
|
|
57
57
|
---
|
data/docs/file.md
CHANGED
data/docs/folder.md
CHANGED
data/docs/group.md
CHANGED
@@ -42,12 +42,12 @@ Files::Group.list(
|
|
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
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
|
-
* `filter` (object): If set, return records where the
|
46
|
-
* `filter_gt` (object): If set, return records where the
|
47
|
-
* `filter_gteq` (object): If set, return records where the
|
48
|
-
* `filter_like` (object): If set, return records where the
|
49
|
-
* `filter_lt` (object): If set, return records where the
|
50
|
-
* `filter_lteq` (object): If set, return records where the
|
45
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
46
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
|
47
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
|
48
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
49
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name`.
|
50
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name`.
|
51
51
|
* `ids` (string): Comma-separated list of group ids to include in results.
|
52
52
|
|
53
53
|
|
data/docs/history.md
CHANGED
@@ -143,9 +143,9 @@ Files::History.list(
|
|
143
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
147
|
-
* `filter_gt` (object): If set, return records where the
|
148
|
-
* `filter_gteq` (object): If set, return records where the
|
149
|
-
* `filter_like` (object): If set, return records where the
|
150
|
-
* `filter_lt` (object): If set, return records where the
|
151
|
-
* `filter_lteq` (object): If set, return records where the
|
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`.
|
147
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
148
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
149
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
150
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
151
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
data/docs/inbox_recipient.md
CHANGED
@@ -40,12 +40,12 @@ Files::InboxRecipient.list(
|
|
40
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
44
|
-
* `filter_gt` (object): If set, return records where the
|
45
|
-
* `filter_gteq` (object): If set, return records where the
|
46
|
-
* `filter_like` (object): If set, return records where the
|
47
|
-
* `filter_lt` (object): If set, return records where the
|
48
|
-
* `filter_lteq` (object): If set, return records where the
|
43
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
44
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
|
45
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
|
46
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
47
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
|
48
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
|
49
49
|
* `inbox_id` (int64): Required - List recipients for the inbox with this ID.
|
50
50
|
|
51
51
|
|
data/docs/inbox_registration.md
CHANGED
@@ -23,7 +23,7 @@
|
|
23
23
|
* `email` (string): Registrant email address
|
24
24
|
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
|
25
25
|
* `form_field_set_id` (int64): Id of associated form field set
|
26
|
-
* `form_field_data` (
|
26
|
+
* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
|
27
27
|
* `inbox_id` (int64): Id of associated inbox
|
28
28
|
* `inbox_recipient_id` (int64): Id of associated inbox recipient
|
29
29
|
* `inbox_title` (string): Title of associated inbox
|
data/docs/inbox_upload.md
CHANGED
@@ -32,11 +32,11 @@ Files::InboxUpload.list(
|
|
32
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
36
|
-
* `filter_gt` (object): If set, return records where the
|
37
|
-
* `filter_gteq` (object): If set, return records where the
|
38
|
-
* `filter_like` (object): If set, return records where the
|
39
|
-
* `filter_lt` (object): If set, return records where the
|
40
|
-
* `filter_lteq` (object): If set, return records where the
|
35
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
36
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
37
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
|
38
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
39
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
40
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
|
41
41
|
* `inbox_registration_id` (int64): InboxRegistration ID
|
42
42
|
* `inbox_id` (int64): Inbox ID
|
data/docs/notification.md
CHANGED
@@ -54,12 +54,12 @@ Files::Notification.list(
|
|
54
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
58
|
-
* `filter_gt` (object): If set, return records where the
|
59
|
-
* `filter_gteq` (object): If set, return records where the
|
60
|
-
* `filter_like` (object): If set, return records where the
|
61
|
-
* `filter_lt` (object): If set, return records where the
|
62
|
-
* `filter_lteq` (object): If set, return records where the
|
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`.
|
58
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
59
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
60
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
61
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
62
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
63
63
|
* `group_id` (int64): DEPRECATED: Show notifications for this Group ID. Use `filter[group_id]` instead.
|
64
64
|
* `path` (string): Show notifications for this Path.
|
65
65
|
* `include_ancestors` (boolean): If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
|
data/docs/permission.md
CHANGED
@@ -43,12 +43,12 @@ Files::Permission.list(
|
|
43
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.
|
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
|
-
* `filter` (object): If set, return records where the
|
47
|
-
* `filter_gt` (object): If set, return records where the
|
48
|
-
* `filter_gteq` (object): If set, return records where the
|
49
|
-
* `filter_like` (object): If set, return records where the
|
50
|
-
* `filter_lt` (object): If set, return records where the
|
51
|
-
* `filter_lteq` (object): If set, return records where the
|
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`.
|
47
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
48
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
49
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
50
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
51
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
|
52
52
|
* `path` (string): DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
|
53
53
|
* `group_id` (string): DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
|
54
54
|
* `user_id` (string): DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
|
data/docs/preview.md
CHANGED
@@ -8,8 +8,7 @@
|
|
8
8
|
"status": "complete",
|
9
9
|
"download_uri": "https://mysite.files.com/...",
|
10
10
|
"type": "complete",
|
11
|
-
"size": 1024
|
12
|
-
"status_message": ""
|
11
|
+
"size": 1024
|
13
12
|
}
|
14
13
|
```
|
15
14
|
|
@@ -18,4 +17,3 @@
|
|
18
17
|
* `download_uri` (string): Link to download preview
|
19
18
|
* `type` (string): Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
|
20
19
|
* `size` (int64): Preview size
|
21
|
-
* `status_message` (string): Preview status message. Addtional context from the preview generation process about the status
|
data/docs/settings_change.md
CHANGED
@@ -5,12 +5,16 @@
|
|
5
5
|
```
|
6
6
|
{
|
7
7
|
"change_details": "{ domain: [\"olddomain.com', \"newdomain.com\"] }",
|
8
|
+
"changes": [
|
9
|
+
""
|
10
|
+
],
|
8
11
|
"created_at": "2000-01-01T01:00:00Z",
|
9
12
|
"user_id": 1
|
10
13
|
}
|
11
14
|
```
|
12
15
|
|
13
16
|
* `change_details` (object): Specifics on what changed.
|
17
|
+
* `changes` (string): Markdown-formatted change messages.
|
14
18
|
* `created_at` (date-time): The time this change was made
|
15
19
|
* `user_id` (int64): The user id responsible for this change
|
16
20
|
|
@@ -30,9 +34,9 @@ Files::SettingsChange.list(
|
|
30
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.
|
31
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
32
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 `api_key_id`, `created_at` or `user_id`.
|
33
|
-
* `filter` (object): If set, return records where the
|
34
|
-
* `filter_gt` (object): If set, return records where the
|
35
|
-
* `filter_gteq` (object): If set, return records where the
|
36
|
-
* `filter_like` (object): If set, return records where the
|
37
|
-
* `filter_lt` (object): If set, return records where the
|
38
|
-
* `filter_lteq` (object): If set, return records where the
|
37
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
38
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
|
39
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
40
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
41
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
|
42
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|