files.com 1.0.127 → 1.0.128

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -38,7 +38,7 @@ Files::Request.list(
38
38
 
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
- * `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`, `folder_id` or `destination`.
41
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `destination`.
42
42
  * `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
43
43
  * `path` (string): Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
44
44
 
@@ -58,7 +58,7 @@ Files::Request.get_folder(path,
58
58
 
59
59
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
60
60
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
61
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `folder_id` or `destination`.
61
+ * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `destination`.
62
62
  * `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
63
63
  * `path` (string): Required - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
64
64
 
@@ -29,7 +29,7 @@ Files::SettingsChange.list(
29
29
 
30
30
  * `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
31
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
32
- * `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`, `api_key_id`, `created_at` or `user_id`.
32
+ * `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
33
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
34
34
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
35
35
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
@@ -39,10 +39,22 @@
39
39
  "non_sso_users_allowed": true,
40
40
  "folder_permissions_groups_only": true,
41
41
  "hipaa": true,
42
- "icon128": "",
43
- "icon16": "",
44
- "icon32": "",
45
- "icon48": "",
42
+ "icon128": {
43
+ "name": "My logo",
44
+ "uri": "https://mysite.files.com/.../my_image.png"
45
+ },
46
+ "icon16": {
47
+ "name": "My logo",
48
+ "uri": "https://mysite.files.com/.../my_image.png"
49
+ },
50
+ "icon32": {
51
+ "name": "My logo",
52
+ "uri": "https://mysite.files.com/.../my_image.png"
53
+ },
54
+ "icon48": {
55
+ "name": "My logo",
56
+ "uri": "https://mysite.files.com/.../my_image.png"
57
+ },
46
58
  "immutable_files_set_at": "2000-01-01T01:00:00Z",
47
59
  "include_password_in_welcome_email": true,
48
60
  "language": "en",
@@ -63,7 +75,10 @@
63
75
  "ldap_username": "[ldap username]",
64
76
  "ldap_username_field": "sAMAccountName",
65
77
  "login_help_text": "Login page help text.",
66
- "logo": "",
78
+ "logo": {
79
+ "name": "My logo",
80
+ "uri": "https://mysite.files.com/.../my_image.png"
81
+ },
67
82
  "max_prior_passwords": 1,
68
83
  "next_billing_amount": 1.0,
69
84
  "next_billing_date": "Apr 20",
@@ -84,7 +99,26 @@
84
99
  "require_2fa": true,
85
100
  "require_2fa_stop_time": "2000-01-01T01:00:00Z",
86
101
  "require_2fa_user_type": "`site_admins`",
87
- "session": "",
102
+ "session": {
103
+ "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
104
+ "language": "en",
105
+ "login_token": "@tok-randomcode",
106
+ "login_token_domain": "https://mysite.files.com",
107
+ "max_dir_listing_size": false,
108
+ "multiple_regions": true,
109
+ "read_only": true,
110
+ "root_path": "",
111
+ "site_id": 1,
112
+ "ssl_required": true,
113
+ "tls_disabled": false,
114
+ "two_factor_setup_needed": false,
115
+ "allowed_2fa_method_sms": true,
116
+ "allowed_2fa_method_totp": true,
117
+ "allowed_2fa_method_u2f": true,
118
+ "allowed_2fa_method_yubi": true,
119
+ "use_provided_modified_at": true,
120
+ "windows_mode_ftp": false
121
+ },
88
122
  "session_pinned_by_ip": true,
89
123
  "sftp_user_root_enabled": true,
90
124
  "sharing_enabled": true,
@@ -105,7 +139,57 @@
105
139
  "trial_until": "2000-01-01T01:00:00Z",
106
140
  "updated_at": "2000-01-01T01:00:00Z",
107
141
  "use_provided_modified_at": true,
108
- "user": "",
142
+ "user": {
143
+ "id": 1,
144
+ "username": "user",
145
+ "admin_group_ids": [
146
+ 1
147
+ ],
148
+ "allowed_ips": "127.0.0.1",
149
+ "attachments_permission": true,
150
+ "api_keys_count": 1,
151
+ "authenticate_until": "2000-01-01T01:00:00Z",
152
+ "authentication_method": "password",
153
+ "avatar_url": "",
154
+ "billing_permission": false,
155
+ "bypass_site_allowed_ips": false,
156
+ "bypass_inactive_disable": false,
157
+ "created_at": "2000-01-01T01:00:00Z",
158
+ "dav_permission": true,
159
+ "disabled": true,
160
+ "email": "john.doe@files.com",
161
+ "ftp_permission": true,
162
+ "group_ids": "",
163
+ "header_text": "User-specific message.",
164
+ "language": "en",
165
+ "last_login_at": "2000-01-01T01:00:00Z",
166
+ "last_protocol_cipher": "",
167
+ "lockout_expires": "2000-01-01T01:00:00Z",
168
+ "name": "John Doe",
169
+ "company": "ACME Corp.",
170
+ "notes": "Internal notes on this user.",
171
+ "notification_daily_send_time": 18,
172
+ "office_integration_enabled": true,
173
+ "password_set_at": "2000-01-01T01:00:00Z",
174
+ "password_validity_days": 1,
175
+ "public_keys_count": 1,
176
+ "receive_admin_alerts": true,
177
+ "require_2fa": "always_require",
178
+ "active_2fa": true,
179
+ "require_password_change": true,
180
+ "restapi_permission": true,
181
+ "self_managed": true,
182
+ "sftp_permission": true,
183
+ "site_admin": true,
184
+ "skip_welcome_screen": true,
185
+ "ssl_required": "always_require",
186
+ "sso_strategy_id": 1,
187
+ "subscribe_to_newsletter": true,
188
+ "externally_managed": true,
189
+ "time_zone": "Pacific Time (US & Canada)",
190
+ "type_of_2fa": "",
191
+ "user_root": ""
192
+ },
109
193
  "user_lockout": true,
110
194
  "user_lockout_lock_period": 1,
111
195
  "user_lockout_tries": 1,
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "protocol": [
8
-
8
+ "okta"
9
9
  ],
10
10
  "provider": "okta",
11
11
  "label": "My Corporate SSO Provider",
@@ -9,7 +9,14 @@
9
9
  "status": "",
10
10
  "data": "",
11
11
  "errors": [
12
+ {
13
+ "fields": [
12
14
 
15
+ ],
16
+ "messages": [
17
+
18
+ ]
19
+ }
13
20
  ]
14
21
  }
15
22
  ```
@@ -6,7 +6,7 @@
6
6
  {
7
7
  "id": 1,
8
8
  "path": "",
9
- "logo": "",
9
+ "logo": "https://mysite.files.com/...",
10
10
  "thumbnail": ""
11
11
  }
12
12
  ```
@@ -33,7 +33,7 @@ Files::UsageDailySnapshot.list(
33
33
 
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
- * `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`, `date` or `usage_snapshot_id`.
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 `date` and `usage_snapshot_id`.
37
37
  * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
38
38
  * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
39
39
  * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
@@ -7,7 +7,7 @@
7
7
  "id": 1,
8
8
  "username": "user",
9
9
  "admin_group_ids": [
10
-
10
+ 1
11
11
  ],
12
12
  "allowed_ips": "127.0.0.1",
13
13
  "attachments_permission": true,
@@ -128,13 +128,13 @@ Files::User.list(
128
128
 
129
129
  * `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.
130
130
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
131
- * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `active`, `master_admin`, `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `notes`, `site_admin`, `receive_admin_alerts`, `allowed_ips`, `password_validity_days`, `ssl_required` or `not_site_admin`.
132
- * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
133
- * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
134
- * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
135
- * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
136
- * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
137
- * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
131
+ * `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 `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
132
+ * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
133
+ * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
134
+ * `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
135
+ * `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
136
+ * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
137
+ * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
138
138
  * `ids` (string): comma-separated list of User IDs
139
139
  * `q[username]` (string): List users matching username.
140
140
  * `q[email]` (string): List users matching email.
@@ -39,6 +39,7 @@ require "files.com/models/behavior"
39
39
  require "files.com/models/bundle"
40
40
  require "files.com/models/bundle_download"
41
41
  require "files.com/models/bundle_recipient"
42
+ require "files.com/models/bundle_registration"
42
43
  require "files.com/models/clickwrap"
43
44
  require "files.com/models/dns_record"
44
45
  require "files.com/models/errors"
@@ -49,12 +50,16 @@ require "files.com/models/file_comment"
49
50
  require "files.com/models/file_comment_reaction"
50
51
  require "files.com/models/file_upload_part"
51
52
  require "files.com/models/folder"
53
+ require "files.com/models/form_field"
54
+ require "files.com/models/form_field_set"
52
55
  require "files.com/models/group"
53
56
  require "files.com/models/group_user"
54
57
  require "files.com/models/history"
55
58
  require "files.com/models/history_export"
56
59
  require "files.com/models/history_export_result"
57
60
  require "files.com/models/image"
61
+ require "files.com/models/inbox_registration"
62
+ require "files.com/models/inbox_upload"
58
63
  require "files.com/models/invoice"
59
64
  require "files.com/models/invoice_line_item"
60
65
  require "files.com/models/ip_address"
@@ -148,7 +148,7 @@ module Files
148
148
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
149
149
  # 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.
150
150
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
151
- # 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`.
151
+ # 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`.
152
152
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
153
153
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
154
154
  # 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`.
@@ -135,6 +135,15 @@ module Files
135
135
  @attributes[:group_ids] = value
136
136
  end
137
137
 
138
+ # string - If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
139
+ def webhook_url
140
+ @attributes[:webhook_url]
141
+ end
142
+
143
+ def webhook_url=(value)
144
+ @attributes[:webhook_url] = value
145
+ end
146
+
138
147
  # Parameters:
139
148
  # automation (required) - string - Automation type
140
149
  # source - string - Source Path
@@ -194,7 +203,7 @@ module Files
194
203
  # Parameters:
195
204
  # 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.
196
205
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
197
- # 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`.
206
+ # 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`.
198
207
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
199
208
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
200
209
  # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `automation`.
@@ -24,6 +24,16 @@ module Files
24
24
  @attributes[:bytes_sent]
25
25
  end
26
26
 
27
+ # double - Site sync bandwidth report bytes received
28
+ def sync_bytes_received
29
+ @attributes[:sync_bytes_received]
30
+ end
31
+
32
+ # double - Site sync bandwidth report bytes sent
33
+ def sync_bytes_sent
34
+ @attributes[:sync_bytes_sent]
35
+ end
36
+
27
37
  # double - Site bandwidth report get requests
28
38
  def requests_get
29
39
  @attributes[:requests_get]
@@ -57,7 +67,7 @@ module Files
57
67
  # Parameters:
58
68
  # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
59
69
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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 `site_id` and `logged_at`.
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 `logged_at`.
61
71
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
62
72
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
63
73
  # 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`.
@@ -107,7 +107,7 @@ module Files
107
107
  # Parameters:
108
108
  # 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.
109
109
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
110
- # 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`.
110
+ # 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`.
111
111
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
112
112
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
113
113
  # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -155,7 +155,7 @@ module Files
155
155
  # Parameters:
156
156
  # 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.
157
157
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
158
- # 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`.
158
+ # 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`.
159
159
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
160
160
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
161
161
  # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
@@ -72,6 +72,15 @@ module Files
72
72
  @attributes[:clickwrap_body] = value
73
73
  end
74
74
 
75
+ # Custom Form to use
76
+ def form_field_set
77
+ @attributes[:form_field_set]
78
+ end
79
+
80
+ def form_field_set=(value)
81
+ @attributes[:form_field_set] = value
82
+ end
83
+
75
84
  # int64 - Bundle ID
76
85
  def id
77
86
  @attributes[:id]
@@ -176,6 +185,15 @@ module Files
176
185
  @attributes[:password] = value
177
186
  end
178
187
 
188
+ # int64 - Id of Form Field Set to use with this bundle
189
+ def form_field_set_id
190
+ @attributes[:form_field_set_id]
191
+ end
192
+
193
+ def form_field_set_id=(value)
194
+ @attributes[:form_field_set_id] = value
195
+ end
196
+
179
197
  # Send email(s) with a link to bundle
180
198
  #
181
199
  # Parameters:
@@ -199,6 +217,7 @@ module Files
199
217
  # Parameters:
200
218
  # paths - array(string) - A list of paths to include in this bundle.
201
219
  # password - string - Password for this bundle.
220
+ # form_field_set_id - int64 - Id of Form Field Set to use with this bundle
202
221
  # clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
203
222
  # code - string - Bundle code. This code forms the end part of the Public URL.
204
223
  # description - string - Public description
@@ -215,6 +234,7 @@ module Files
215
234
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
216
235
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
217
236
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
237
+ raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params.dig(:form_field_set_id) and !params.dig(:form_field_set_id).is_a?(Integer)
218
238
  raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
219
239
  raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
220
240
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
@@ -254,7 +274,7 @@ module Files
254
274
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
255
275
  # 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.
256
276
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
257
- # 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`.
277
+ # 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`.
258
278
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
259
279
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
260
280
  # 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`.
@@ -302,6 +322,7 @@ module Files
302
322
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
303
323
  # paths (required) - array(string) - A list of paths to include in this bundle.
304
324
  # password - string - Password for this bundle.
325
+ # form_field_set_id - int64 - Id of Form Field Set to use with this bundle
305
326
  # expires_at - string - Bundle expiration date/time
306
327
  # max_uses - int64 - Maximum number of times bundle can be accessed
307
328
  # description - string - Public description
@@ -315,6 +336,7 @@ module Files
315
336
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
316
337
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
317
338
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
339
+ raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params.dig(:form_field_set_id) and !params.dig(:form_field_set_id).is_a?(Integer)
318
340
  raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
319
341
  raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
320
342
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
@@ -351,6 +373,7 @@ module Files
351
373
  # Parameters:
352
374
  # paths - array(string) - A list of paths to include in this bundle.
353
375
  # password - string - Password for this bundle.
376
+ # form_field_set_id - int64 - Id of Form Field Set to use with this bundle
354
377
  # clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
355
378
  # code - string - Bundle code. This code forms the end part of the Public URL.
356
379
  # description - string - Public description
@@ -366,6 +389,7 @@ module Files
366
389
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
367
390
  raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
368
391
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
392
+ raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params.dig(:form_field_set_id) and !params.dig(:form_field_set_id).is_a?(Integer)
369
393
  raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
370
394
  raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
371
395
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
@@ -9,6 +9,10 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
+ def bundle_registration
13
+ @attributes[:bundle_registration]
14
+ end
15
+
12
16
  # string - Download method (file or full_zip)
13
17
  def download_method
14
18
  @attributes[:download_method]
@@ -27,12 +31,13 @@ module Files
27
31
  # Parameters:
28
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.
29
33
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
30
- # bundle_registration_id (required) - int64 - BundleRegistration ID
34
+ # bundle_id - int64 - Bundle ID
35
+ # bundle_registration_id - int64 - BundleRegistration ID
31
36
  def self.list(params = {}, options = {})
32
37
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
33
38
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
39
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
34
40
  raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params.dig(:bundle_registration_id) and !params.dig(:bundle_registration_id).is_a?(Integer)
35
- raise MissingParameterError.new("Parameter missing: bundle_registration_id") unless params.dig(:bundle_registration_id)
36
41
 
37
42
  List.new(BundleDownload, params) do
38
43
  Api.send_request("/bundle_downloads", :get, params, options)
@@ -38,11 +38,25 @@ module Files
38
38
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
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
+ # 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`.
42
+ # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
43
+ # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
44
+ # 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`.
45
+ # filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
46
+ # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
47
+ # 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`.
41
48
  # bundle_id (required) - int64 - List recipients for the bundle with this ID.
42
49
  def self.list(params = {}, options = {})
43
50
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
44
51
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
45
52
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
53
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
54
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
55
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
56
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
57
+ raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
58
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
59
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
46
60
  raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
47
61
  raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
48
62