files.com 1.0.127 → 1.0.128

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/account_line_item.md +18 -2
  4. data/docs/api_key.md +1 -1
  5. data/docs/app.md +3 -1
  6. data/docs/automation.md +14 -4
  7. data/docs/bandwidth_snapshot.md +5 -1
  8. data/docs/behavior.md +2 -2
  9. data/docs/bundle.md +36 -2
  10. data/docs/bundle_download.md +5 -1
  11. data/docs/bundle_recipient.md +7 -0
  12. data/docs/bundle_registration.md +23 -0
  13. data/docs/external_event.md +1 -1
  14. data/docs/file.md +7 -1
  15. data/docs/file_action.md +13 -0
  16. data/docs/file_comment.md +4 -1
  17. data/docs/folder.md +7 -1
  18. data/docs/form_field.md +29 -0
  19. data/docs/form_field_set.md +154 -0
  20. data/docs/group.md +13 -7
  21. data/docs/group_user.md +1 -1
  22. data/docs/history.md +1 -1
  23. data/docs/inbox_registration.md +21 -0
  24. data/docs/inbox_upload.md +35 -0
  25. data/docs/invoice.md +18 -2
  26. data/docs/ip_address.md +1 -1
  27. data/docs/message.md +10 -1
  28. data/docs/message_comment.md +4 -1
  29. data/docs/notification.md +1 -1
  30. data/docs/payment.md +18 -2
  31. data/docs/permission.md +1 -1
  32. data/docs/remote_server.md +0 -55
  33. data/docs/request.md +2 -2
  34. data/docs/settings_change.md +1 -1
  35. data/docs/site.md +91 -7
  36. data/docs/sso_strategy.md +1 -1
  37. data/docs/status.md +7 -0
  38. data/docs/style.md +1 -1
  39. data/docs/usage_daily_snapshot.md +1 -1
  40. data/docs/user.md +8 -8
  41. data/lib/files.com.rb +5 -0
  42. data/lib/files.com/models/api_key.rb +1 -1
  43. data/lib/files.com/models/automation.rb +10 -1
  44. data/lib/files.com/models/bandwidth_snapshot.rb +11 -1
  45. data/lib/files.com/models/behavior.rb +2 -2
  46. data/lib/files.com/models/bundle.rb +25 -1
  47. data/lib/files.com/models/bundle_download.rb +7 -2
  48. data/lib/files.com/models/bundle_recipient.rb +14 -0
  49. data/lib/files.com/models/bundle_registration.rb +47 -0
  50. data/lib/files.com/models/external_event.rb +1 -1
  51. data/lib/files.com/models/file_action.rb +14 -4
  52. data/lib/files.com/models/form_field.rb +52 -0
  53. data/lib/files.com/models/form_field_set.rb +171 -0
  54. data/lib/files.com/models/group.rb +1 -1
  55. data/lib/files.com/models/history.rb +1 -1
  56. data/lib/files.com/models/inbox_registration.rb +42 -0
  57. data/lib/files.com/models/inbox_upload.rb +46 -0
  58. data/lib/files.com/models/notification.rb +1 -1
  59. data/lib/files.com/models/permission.rb +1 -1
  60. data/lib/files.com/models/remote_server.rb +0 -82
  61. data/lib/files.com/models/request.rb +2 -2
  62. data/lib/files.com/models/settings_change.rb +1 -1
  63. data/lib/files.com/models/usage_daily_snapshot.rb +1 -1
  64. data/lib/files.com/models/user.rb +7 -7
  65. metadata +12 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 15dbc7abb6293b77a82d25bf3f994067c822ef00bee620936112530f03d621b2
4
- data.tar.gz: 91ed6680ef400cfc4b9cd835b2683ea3491c46bddf8d0344c132f712d461f96a
3
+ metadata.gz: d3e1278f84e7c16dba288784cf89e9a52b4dbb2d864c8dccce564ea413aad735
4
+ data.tar.gz: 06d50e38f5728b443c19f104f63545b5ee414fe85805dbe09f77628c82b0881b
5
5
  SHA512:
6
- metadata.gz: 34da33211bf14a73e5e4e7d8cf4cd61881cd84270285c6396fa2822e1c5dbf3ad3438393affc2bff59a6664a5638e924d46a794033849cae4b8ca3c7bc986638
7
- data.tar.gz: 1d69ae3c02058e92fb3deed3ab1f44fde463d80afaba73b6e59411f1bef18e441f7811ecc9025fa1cb21a4709e148b073526f083d6824bc71dfe532cc412db04
6
+ metadata.gz: 96ceaa8549312e55ff63dba0d16d0498ab99833505279684d3e7ec36cadb3d9866dcc5d34e23af4029c87336bef658fd2468e2116f0bf975eb61654eeb90eb7c
7
+ data.tar.gz: d24ed0fb7d3cddd8d71ed270649294e4b2b543f8b6f4f8a3fb062538ed27463e2c361534d47d958b97b314721ba202d7f8d41cf3989ae04cb07a3f2c314337a9
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.127
1
+ 1.0.128
@@ -11,11 +11,27 @@
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
-
14
+ {
15
+ "amount": 1.0,
16
+ "created_at": "2000-01-01T01:00:00Z",
17
+ "description": "Service from 2019-01-01 through 2019-12-31",
18
+ "type": "invoice",
19
+ "service_end_at": "2000-01-01T01:00:00Z",
20
+ "service_start_at": "2000-01-01T01:00:00Z",
21
+ "updated_at": "2000-01-01T01:00:00Z",
22
+ "plan": "Enterprise",
23
+ "site": "My site"
24
+ }
15
25
  ],
16
26
  "method": "paypal",
17
27
  "payment_line_items": [
18
-
28
+ {
29
+ "amount": 1.0,
30
+ "created_at": "2000-01-01T01:00:00Z",
31
+ "invoice_id": 1,
32
+ "payment_id": 1,
33
+ "updated_at": "2000-01-01T01:00:00Z"
34
+ }
19
35
  ],
20
36
  "payment_reversed_at": "2000-01-01T01:00:00Z",
21
37
  "payment_type": "",
@@ -47,7 +47,7 @@ Files::ApiKey.list(
47
47
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
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
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `deleted_at` and `expires_at`.
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 specifiied field is equal to the supplied value. Valid fields are `expires_at`.
52
52
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
53
53
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `expires_at`.
@@ -9,7 +9,9 @@
9
9
  "documentation_links": "Important Info => http://files.test/learn-more",
10
10
  "icon_url": "",
11
11
  "logo_url": "",
12
- "screenshot_list_urls": "",
12
+ "screenshot_list_urls": [
13
+ ""
14
+ ],
13
15
  "logo_thumbnail_url": "",
14
16
  "sso_strategy_type": "",
15
17
  "remote_server_type": "",
@@ -28,11 +28,14 @@
28
28
  "path": "",
29
29
  "user_id": 1,
30
30
  "user_ids": [
31
-
31
+ 1,
32
+ 2
32
33
  ],
33
34
  "group_ids": [
34
-
35
- ]
35
+ 1,
36
+ 2
37
+ ],
38
+ "webhook_url": "https://app.files.com/api/webhooks/abc123"
36
39
  }
37
40
  ```
38
41
 
@@ -50,6 +53,7 @@
50
53
  * `user_id` (int64): User ID of the Automation's creator.
51
54
  * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
52
55
  * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
56
+ * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
53
57
 
54
58
 
55
59
  ---
@@ -67,7 +71,7 @@ Files::Automation.list(
67
71
 
68
72
  * `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.
69
73
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
70
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `automation`.
74
+ * `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`.
71
75
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
72
76
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
73
77
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `automation`.
@@ -100,6 +104,8 @@ Files::Automation.create(
100
104
  source: "source",
101
105
  destination: "destination",
102
106
  interval: "year",
107
+ user_ids: [1,2],
108
+ group_ids: [1,2],
103
109
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
104
110
  trigger: "realtime"
105
111
  )
@@ -130,6 +136,8 @@ Files::Automation.update(id,
130
136
  source: "source",
131
137
  destination: "destination",
132
138
  interval: "year",
139
+ user_ids: [1,2],
140
+ group_ids: [1,2],
133
141
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
134
142
  trigger: "realtime"
135
143
  )
@@ -176,6 +184,8 @@ automation.update(
176
184
  source: "source",
177
185
  destination: "destination",
178
186
  interval: "year",
187
+ user_ids: [1,2],
188
+ group_ids: [1,2],
179
189
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
180
190
  trigger: "realtime"
181
191
  )
@@ -7,6 +7,8 @@
7
7
  "id": 1,
8
8
  "bytes_received": 1.0,
9
9
  "bytes_sent": 1.0,
10
+ "sync_bytes_received": 1.0,
11
+ "sync_bytes_sent": 1.0,
10
12
  "requests_get": 1.0,
11
13
  "requests_put": 1.0,
12
14
  "requests_other": 1.0,
@@ -19,6 +21,8 @@
19
21
  * `id` (int64): Site bandwidth ID
20
22
  * `bytes_received` (double): Site bandwidth report bytes received
21
23
  * `bytes_sent` (double): Site bandwidth report bytes sent
24
+ * `sync_bytes_received` (double): Site sync bandwidth report bytes received
25
+ * `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
22
26
  * `requests_get` (double): Site bandwidth report get requests
23
27
  * `requests_put` (double): Site bandwidth report put requests
24
28
  * `requests_other` (double): Site bandwidth report other requests
@@ -41,7 +45,7 @@ Files::BandwidthSnapshot.list(
41
45
 
42
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.
43
47
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
44
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `logged_at`.
48
+ * `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`.
45
49
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
46
50
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
47
51
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.
@@ -37,7 +37,7 @@ Files::Behavior.list(
37
37
 
38
38
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
39
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
40
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `behavior`.
40
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
41
41
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
42
42
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
43
43
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -75,7 +75,7 @@ Files::Behavior.list_for(path,
75
75
 
76
76
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
77
77
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
78
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `behavior`.
78
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `behavior`.
79
79
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
80
80
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
81
81
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -11,6 +11,32 @@
11
11
  "require_registration": true,
12
12
  "require_share_recipient": true,
13
13
  "clickwrap_body": "[Legal text]",
14
+ "form_field_set": {
15
+ "id": 1,
16
+ "title": "Sample Form Title",
17
+ "form_layout": [
18
+ 1,
19
+ 2,
20
+ 3,
21
+ 4
22
+ ],
23
+ "form_fields": [
24
+ {
25
+ "id": 1,
26
+ "label": "Sample Label",
27
+ "required": true,
28
+ "help_text": "Help Text",
29
+ "field_type": "text",
30
+ "options_for_select": [
31
+ "red",
32
+ "green",
33
+ "blue"
34
+ ],
35
+ "default_option": "red",
36
+ "form_field_set_id": 1
37
+ }
38
+ ]
39
+ },
14
40
  "id": 1,
15
41
  "created_at": "2000-01-01T01:00:00Z",
16
42
  "expires_at": "2000-01-01T01:00:00Z",
@@ -22,7 +48,7 @@
22
48
  "inbox_id": 1,
23
49
  "has_inbox": true,
24
50
  "paths": [
25
-
51
+ "file.txt"
26
52
  ]
27
53
  }
28
54
  ```
@@ -34,6 +60,7 @@
34
60
  * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
35
61
  * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
36
62
  * `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
63
+ * `form_field_set`: Custom Form to use
37
64
  * `id` (int64): Bundle ID
38
65
  * `created_at` (date-time): Bundle created at date/time
39
66
  * `expires_at` (date-time): Bundle expiration date/time
@@ -46,6 +73,7 @@
46
73
  * `has_inbox` (boolean): Does this bundle have an associated inbox?
47
74
  * `paths` (array): A list of paths in this bundle
48
75
  * `password` (string): Password for this bundle.
76
+ * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
49
77
 
50
78
 
51
79
  ---
@@ -64,7 +92,7 @@ Files::Bundle.list(
64
92
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
65
93
  * `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.
66
94
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
67
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `created_at` or `code`.
95
+ * `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`.
68
96
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
69
97
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
70
98
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
@@ -95,6 +123,7 @@ Files::Bundle.create(
95
123
  user_id: 1,
96
124
  paths: ["file.txt"],
97
125
  password: "Password",
126
+ form_field_set_id: 1,
98
127
  expires_at: "2000-01-01T01:00:00Z",
99
128
  max_uses: 1,
100
129
  description: "The public description of the bundle.",
@@ -112,6 +141,7 @@ Files::Bundle.create(
112
141
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
113
142
  * `paths` (array(string)): Required - A list of paths to include in this bundle.
114
143
  * `password` (string): Password for this bundle.
144
+ * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
115
145
  * `expires_at` (string): Bundle expiration date/time
116
146
  * `max_uses` (int64): Maximum number of times bundle can be accessed
117
147
  * `description` (string): Public description
@@ -151,6 +181,7 @@ Files::Bundle.share(id,
151
181
  Files::Bundle.update(id,
152
182
  paths: ["file.txt"],
153
183
  password: "Password",
184
+ form_field_set_id: 1,
154
185
  clickwrap_id: 1,
155
186
  code: "abc123",
156
187
  description: "The public description of the bundle.",
@@ -168,6 +199,7 @@ Files::Bundle.update(id,
168
199
  * `id` (int64): Required - Bundle ID.
169
200
  * `paths` (array(string)): A list of paths to include in this bundle.
170
201
  * `password` (string): Password for this bundle.
202
+ * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
171
203
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
172
204
  * `code` (string): Bundle code. This code forms the end part of the Public URL.
173
205
  * `description` (string): Public description
@@ -224,6 +256,7 @@ bundle = Files::Bundle.list_for(path).first
224
256
  bundle.update(
225
257
  paths: ["file.txt"],
226
258
  password: "Password",
259
+ form_field_set_id: 1,
227
260
  clickwrap_id: 1,
228
261
  code: "abc123",
229
262
  description: "The public description of the bundle.",
@@ -241,6 +274,7 @@ bundle.update(
241
274
  * `id` (int64): Required - Bundle ID.
242
275
  * `paths` (array(string)): A list of paths to include in this bundle.
243
276
  * `password` (string): Password for this bundle.
277
+ * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
244
278
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
245
279
  * `code` (string): Bundle code. This code forms the end part of the Public URL.
246
280
  * `description` (string): Public description
@@ -4,12 +4,14 @@
4
4
 
5
5
  ```
6
6
  {
7
+ "bundle_registration": "",
7
8
  "download_method": "file",
8
9
  "path": "a/b/test.txt",
9
10
  "created_at": "2020-01-01 00:00:00"
10
11
  }
11
12
  ```
12
13
 
14
+ * `bundle_registration`:
13
15
  * `download_method` (string): Download method (file or full_zip)
14
16
  * `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
15
17
  * `created_at` (date-time): Download date/time
@@ -22,6 +24,7 @@
22
24
  ```
23
25
  Files::BundleDownload.list(
24
26
  per_page: 1,
27
+ bundle_id: 1,
25
28
  bundle_registration_id: 1
26
29
  )
27
30
  ```
@@ -30,4 +33,5 @@ Files::BundleDownload.list(
30
33
 
31
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.
32
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
33
- * `bundle_registration_id` (int64): Required - BundleRegistration ID
36
+ * `bundle_id` (int64): Bundle ID
37
+ * `bundle_registration_id` (int64): BundleRegistration ID
@@ -36,4 +36,11 @@ Files::BundleRecipient.list(
36
36
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
37
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.
38
38
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
+ * `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`.
40
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
41
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
42
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
43
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
44
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
45
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
39
46
  * `bundle_id` (int64): Required - List recipients for the bundle with this ID.
@@ -0,0 +1,23 @@
1
+ # BundleRegistration
2
+
3
+ ## Example BundleRegistration Object
4
+
5
+ ```
6
+ {
7
+ "code": "abc123",
8
+ "name": "account",
9
+ "company": "Action Verb",
10
+ "email": "john.doe@files.com",
11
+ "inbox_code": "abc123",
12
+ "form_field_set_id": 1,
13
+ "form_field_data": ""
14
+ }
15
+ ```
16
+
17
+ * `code` (string): Registration cookie code
18
+ * `name` (string): Registrant name
19
+ * `company` (string): Registrant company name
20
+ * `email` (string): Registrant email address
21
+ * `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
22
+ * `form_field_set_id` (int64): Id of associated form field set
23
+ * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
@@ -31,7 +31,7 @@ Files::ExternalEvent.list(
31
31
 
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
- * `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`.
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`, `event_type`, `created_at` or `status`.
35
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`.
36
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`.
37
37
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
@@ -22,7 +22,13 @@ may places where a Ruby File object can be used.
22
22
  "download_uri": "https://mysite.files.com/...",
23
23
  "priority_color": "red",
24
24
  "preview_id": 1,
25
- "preview": ""
25
+ "preview": {
26
+ "id": 1,
27
+ "status": "complete",
28
+ "download_uri": "https://mysite.files.com/...",
29
+ "type": "complete",
30
+ "size": 1024
31
+ }
26
32
  }
27
33
  ```
28
34
 
@@ -1,3 +1,16 @@
1
+ # FileAction
2
+
3
+ ## Example FileAction Object
4
+
5
+ ```
6
+ {
7
+ "status": "enqueued",
8
+ "file_migration_id": "123"
9
+ }
10
+ ```
11
+
12
+ * `status` (string): Status of file operation. Possible values: completed, enqueued.
13
+ * `file_migration_id` (int64): If status is enqueued, this is the id of the FileMigration to check for status updates.
1
14
 
2
15
 
3
16
  ---
@@ -7,7 +7,10 @@
7
7
  "id": 1,
8
8
  "body": "What a great file!",
9
9
  "reactions": [
10
-
10
+ {
11
+ "id": 1,
12
+ "emoji": "👍"
13
+ }
11
14
  ]
12
15
  }
13
16
  ```
@@ -24,7 +24,13 @@ Files::Dir is an alias of Files::Folder
24
24
  "download_uri": "https://mysite.files.com/...",
25
25
  "priority_color": "red",
26
26
  "preview_id": 1,
27
- "preview": ""
27
+ "preview": {
28
+ "id": 1,
29
+ "status": "complete",
30
+ "download_uri": "https://mysite.files.com/...",
31
+ "type": "complete",
32
+ "size": 1024
33
+ }
28
34
  }
29
35
  ```
30
36
 
@@ -0,0 +1,29 @@
1
+ # FormField
2
+
3
+ ## Example FormField Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "label": "Sample Label",
9
+ "required": true,
10
+ "help_text": "Help Text",
11
+ "field_type": "text",
12
+ "options_for_select": [
13
+ "red",
14
+ "green",
15
+ "blue"
16
+ ],
17
+ "default_option": "red",
18
+ "form_field_set_id": 1
19
+ }
20
+ ```
21
+
22
+ * `id` (int64): Form field id
23
+ * `label` (string): Label to be displayed
24
+ * `required` (boolean): Is this a required field?
25
+ * `help_text` (string): Help text to be displayed
26
+ * `field_type` (string): Type of Field
27
+ * `options_for_select` (string): Options to display for radio and dropdown
28
+ * `default_option` (string): Default option for radio and dropdown
29
+ * `form_field_set_id` (int64): Form field set id