files.com 1.0.123 → 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 (63) 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 +51 -16
  7. data/docs/bandwidth_snapshot.md +5 -1
  8. data/docs/behavior.md +2 -2
  9. data/docs/bundle.md +40 -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/request.md +2 -2
  33. data/docs/settings_change.md +1 -1
  34. data/docs/site.md +91 -7
  35. data/docs/sso_strategy.md +1 -1
  36. data/docs/status.md +7 -0
  37. data/docs/style.md +1 -1
  38. data/docs/usage_daily_snapshot.md +1 -1
  39. data/docs/user.md +8 -8
  40. data/lib/files.com.rb +5 -0
  41. data/lib/files.com/models/api_key.rb +1 -1
  42. data/lib/files.com/models/automation.rb +60 -31
  43. data/lib/files.com/models/bandwidth_snapshot.rb +11 -1
  44. data/lib/files.com/models/behavior.rb +2 -2
  45. data/lib/files.com/models/bundle.rb +29 -1
  46. data/lib/files.com/models/bundle_download.rb +7 -2
  47. data/lib/files.com/models/bundle_recipient.rb +14 -0
  48. data/lib/files.com/models/bundle_registration.rb +47 -0
  49. data/lib/files.com/models/external_event.rb +1 -1
  50. data/lib/files.com/models/file_action.rb +14 -4
  51. data/lib/files.com/models/form_field.rb +52 -0
  52. data/lib/files.com/models/form_field_set.rb +171 -0
  53. data/lib/files.com/models/group.rb +1 -1
  54. data/lib/files.com/models/history.rb +1 -1
  55. data/lib/files.com/models/inbox_registration.rb +42 -0
  56. data/lib/files.com/models/inbox_upload.rb +46 -0
  57. data/lib/files.com/models/notification.rb +1 -1
  58. data/lib/files.com/models/permission.rb +1 -1
  59. data/lib/files.com/models/request.rb +2 -2
  60. data/lib/files.com/models/settings_change.rb +1 -1
  61. data/lib/files.com/models/usage_daily_snapshot.rb +1 -1
  62. data/lib/files.com/models/user.rb +7 -7
  63. metadata +12 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b327cdd5fe83088b3b598f87178627b0fb7d721e257575bdd0b9d5f783c51495
4
- data.tar.gz: 23e6a12ef8f91043bf4c769f1b8d970839c50461efb99bd5562a6f6989bc7b63
3
+ metadata.gz: d3e1278f84e7c16dba288784cf89e9a52b4dbb2d864c8dccce564ea413aad735
4
+ data.tar.gz: 06d50e38f5728b443c19f104f63545b5ee414fe85805dbe09f77628c82b0881b
5
5
  SHA512:
6
- metadata.gz: 7c0bbcd80eed68a5c8f534b02b40f38e926305cbb8d9302fe9213c96463d0b89eae331474d6cac3a004d531b3c09fb58ea19c1e2ab6e174cd76cd526d2aaf4f9
7
- data.tar.gz: feebcff93f3bc88a96824f75238600007936d8750614862d272e6d45d97892645e8637fbe381730df2173f9a806cd06859675ce1620978313e521e101f22560b
6
+ metadata.gz: 96ceaa8549312e55ff63dba0d16d0498ab99833505279684d3e7ec36cadb3d9866dcc5d34e23af4029c87336bef658fd2468e2116f0bf975eb61654eeb90eb7c
7
+ data.tar.gz: d24ed0fb7d3cddd8d71ed270649294e4b2b543f8b6f4f8a3fb062538ed27463e2c361534d47d958b97b314721ba202d7f8d41cf3989ae04cb07a3f2c314337a9
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.123
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": "",
@@ -6,37 +6,54 @@
6
6
  {
7
7
  "id": 1,
8
8
  "automation": "create_folder",
9
+ "trigger": "realtime",
10
+ "interval": "week",
11
+ "next_process_on": "2020-01-01",
12
+ "schedule": {
13
+ "days_of_week": [
14
+ 0,
15
+ 2,
16
+ 4
17
+ ],
18
+ "times_of_day": [
19
+ "6:30",
20
+ "14:30"
21
+ ],
22
+ "time_zone": "Eastern Time (US & Canada)"
23
+ },
9
24
  "source": "",
10
25
  "destination": "",
11
26
  "destination_replace_from": "",
12
27
  "destination_replace_to": "",
13
- "interval": "week",
14
- "next_process_on": "2020-01-01",
15
28
  "path": "",
16
- "realtime": true,
17
29
  "user_id": 1,
18
30
  "user_ids": [
19
-
31
+ 1,
32
+ 2
20
33
  ],
21
34
  "group_ids": [
22
-
23
- ]
35
+ 1,
36
+ 2
37
+ ],
38
+ "webhook_url": "https://app.files.com/api/webhooks/abc123"
24
39
  }
25
40
  ```
26
41
 
27
42
  * `id` (int64): Automation ID
28
43
  * `automation` (string): Automation type
44
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
45
+ * `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
46
+ * `next_process_on` (string): If trigger is `daily`, date this automation will next run.
47
+ * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
29
48
  * `source` (string): Source Path
30
49
  * `destination` (string): Destination Path
31
50
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
32
51
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
33
- * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
34
- * `next_process_on` (string): Date this automation will next run.
35
52
  * `path` (string): Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
36
- * `realtime` (boolean): Does this automation run in real time? This is a read-only property based on automation type.
37
53
  * `user_id` (int64): User ID of the Automation's creator.
38
54
  * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
39
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.
40
57
 
41
58
 
42
59
  ---
@@ -54,7 +71,7 @@ Files::Automation.list(
54
71
 
55
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.
56
73
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
57
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `automation`.
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`.
58
75
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
59
76
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
60
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`.
@@ -86,13 +103,17 @@ Files::Automation.create(
86
103
  automation: "create_folder",
87
104
  source: "source",
88
105
  destination: "destination",
89
- interval: "year"
106
+ interval: "year",
107
+ user_ids: [1,2],
108
+ group_ids: [1,2],
109
+ schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
110
+ trigger: "realtime"
90
111
  )
91
112
  ```
92
113
 
93
114
  ### Parameters
94
115
 
95
- * `automation` (string): Required - Type of automation. One of: `create_folder`, `request_file`, `request_move`
116
+ * `automation` (string): Required - Automation type
96
117
  * `source` (string): Source Path
97
118
  * `destination` (string): Destination Path
98
119
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -101,6 +122,8 @@ Files::Automation.create(
101
122
  * `path` (string): Path on which this Automation runs. Supports globs.
102
123
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
103
124
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
125
+ * `schedule` (object): Custom schedule for running this automation.
126
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
104
127
 
105
128
 
106
129
  ---
@@ -112,14 +135,18 @@ Files::Automation.update(id,
112
135
  automation: "create_folder",
113
136
  source: "source",
114
137
  destination: "destination",
115
- interval: "year"
138
+ interval: "year",
139
+ user_ids: [1,2],
140
+ group_ids: [1,2],
141
+ schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
142
+ trigger: "realtime"
116
143
  )
117
144
  ```
118
145
 
119
146
  ### Parameters
120
147
 
121
148
  * `id` (int64): Required - Automation ID.
122
- * `automation` (string): Required - Type of automation. One of: `create_folder`, `request_file`, `request_move`
149
+ * `automation` (string): Required - Automation type
123
150
  * `source` (string): Source Path
124
151
  * `destination` (string): Destination Path
125
152
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -128,6 +155,8 @@ Files::Automation.update(id,
128
155
  * `path` (string): Path on which this Automation runs. Supports globs.
129
156
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
130
157
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
158
+ * `schedule` (object): Custom schedule for running this automation.
159
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
131
160
 
132
161
 
133
162
  ---
@@ -154,14 +183,18 @@ automation.update(
154
183
  automation: "create_folder",
155
184
  source: "source",
156
185
  destination: "destination",
157
- interval: "year"
186
+ interval: "year",
187
+ user_ids: [1,2],
188
+ group_ids: [1,2],
189
+ schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
190
+ trigger: "realtime"
158
191
  )
159
192
  ```
160
193
 
161
194
  ### Parameters
162
195
 
163
196
  * `id` (int64): Required - Automation ID.
164
- * `automation` (string): Required - Type of automation. One of: `create_folder`, `request_file`, `request_move`
197
+ * `automation` (string): Required - Automation type
165
198
  * `source` (string): Source Path
166
199
  * `destination` (string): Destination Path
167
200
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -170,6 +203,8 @@ automation.update(
170
203
  * `path` (string): Path on which this Automation runs. Supports globs.
171
204
  * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
172
205
  * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
206
+ * `schedule` (object): Custom schedule for running this automation.
207
+ * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
173
208
 
174
209
 
175
210
  ---
@@ -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
@@ -149,7 +179,9 @@ Files::Bundle.share(id,
149
179
 
150
180
  ```
151
181
  Files::Bundle.update(id,
182
+ paths: ["file.txt"],
152
183
  password: "Password",
184
+ form_field_set_id: 1,
153
185
  clickwrap_id: 1,
154
186
  code: "abc123",
155
187
  description: "The public description of the bundle.",
@@ -165,7 +197,9 @@ Files::Bundle.update(id,
165
197
  ### Parameters
166
198
 
167
199
  * `id` (int64): Required - Bundle ID.
200
+ * `paths` (array(string)): A list of paths to include in this bundle.
168
201
  * `password` (string): Password for this bundle.
202
+ * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
169
203
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
170
204
  * `code` (string): Bundle code. This code forms the end part of the Public URL.
171
205
  * `description` (string): Public description
@@ -220,7 +254,9 @@ bundle.share(
220
254
  bundle = Files::Bundle.list_for(path).first
221
255
 
222
256
  bundle.update(
257
+ paths: ["file.txt"],
223
258
  password: "Password",
259
+ form_field_set_id: 1,
224
260
  clickwrap_id: 1,
225
261
  code: "abc123",
226
262
  description: "The public description of the bundle.",
@@ -236,7 +272,9 @@ bundle.update(
236
272
  ### Parameters
237
273
 
238
274
  * `id` (int64): Required - Bundle ID.
275
+ * `paths` (array(string)): A list of paths to include in this bundle.
239
276
  * `password` (string): Password for this bundle.
277
+ * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
240
278
  * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
241
279
  * `code` (string): Bundle code. This code forms the end part of the Public URL.
242
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