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
@@ -108,7 +108,7 @@ module Files
108
108
  # Parameters:
109
109
  # 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.
110
110
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
111
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `active`, `site_id` or `name`.
111
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name`.
112
112
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
113
113
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
114
114
  # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name`.
@@ -175,7 +175,7 @@ module Files
175
175
  # display - string - Display format. Leave blank or set to `full` or `parent`.
176
176
  # 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.
177
177
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
178
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `path`, `created_at`, `folder` or `user_id`.
178
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `path`, `folder`, `user_id` or `created_at`.
179
179
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
180
180
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
181
181
  # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class InboxRegistration
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # string - Registration cookie code
13
+ def code
14
+ @attributes[:code]
15
+ end
16
+
17
+ # string - Registrant name
18
+ def name
19
+ @attributes[:name]
20
+ end
21
+
22
+ # string - Registrant company name
23
+ def company
24
+ @attributes[:company]
25
+ end
26
+
27
+ # string - Registrant email address
28
+ def email
29
+ @attributes[:email]
30
+ end
31
+
32
+ # int64 - Id of associated form field set
33
+ def form_field_set_id
34
+ @attributes[:form_field_set_id]
35
+ end
36
+
37
+ # string - Data for form field set with form field ids as keys and user data as values
38
+ def form_field_data
39
+ @attributes[:form_field_data]
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class InboxUpload
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ def inbox_registration
13
+ @attributes[:inbox_registration]
14
+ end
15
+
16
+ # string - Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
17
+ def path
18
+ @attributes[:path]
19
+ end
20
+
21
+ # date-time - Upload date/time
22
+ def created_at
23
+ @attributes[:created_at]
24
+ end
25
+
26
+ # Parameters:
27
+ # 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.
28
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
29
+ # inbox_registration_id - int64 - InboxRegistration ID
30
+ # inbox_id - int64 - Inbox ID
31
+ def self.list(params = {}, options = {})
32
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
33
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
34
+ raise InvalidParameterError.new("Bad parameter: inbox_registration_id must be an Integer") if params.dig(:inbox_registration_id) and !params.dig(:inbox_registration_id).is_a?(Integer)
35
+ raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
36
+
37
+ List.new(InboxUpload, params) do
38
+ Api.send_request("/inbox_uploads", :get, params, options)
39
+ end
40
+ end
41
+
42
+ def self.all(params = {}, options = {})
43
+ list(params, options)
44
+ end
45
+ end
46
+ end
@@ -169,7 +169,7 @@ module Files
169
169
  # user_id - int64 - DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
170
170
  # 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.
171
171
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
172
- # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `path`, `user_id` or `group_id`.
172
+ # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `path`, `user_id` or `group_id`.
173
173
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
174
174
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
175
175
  # filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
@@ -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 `deleted_at`, `group_id`, `path`, `user_id` or `permission`.
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 `group_id`, `path`, `user_id` or `permission`.
111
111
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
112
112
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
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 `group_id`, `user_id` or `path`.
@@ -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`, `folder_id` or `destination`.
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 `destination`.
111
111
  # mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
112
112
  # path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
113
113
  def self.list(params = {}, options = {})
@@ -128,7 +128,7 @@ module Files
128
128
  # Parameters:
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 `site_id`, `folder_id` or `destination`.
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 `destination`.
132
132
  # mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
133
133
  # path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
134
134
  def self.get_folder(path, params = {}, options = {})
@@ -27,7 +27,7 @@ module Files
27
27
  # Parameters:
28
28
  # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
29
29
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
30
- # 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`.
30
+ # 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`.
31
31
  # 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`.
32
32
  # 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`.
33
33
  # 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`.
@@ -32,7 +32,7 @@ module Files
32
32
  # Parameters:
33
33
  # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
34
34
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
- # 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`.
35
+ # 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`.
36
36
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
37
37
  # 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`.
38
38
  # 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`.
@@ -646,13 +646,13 @@ module Files
646
646
  # Parameters:
647
647
  # 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.
648
648
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
649
- # 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`.
650
- # 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`.
651
- # 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`.
652
- # 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`.
653
- # 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`.
654
- # 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`.
655
- # 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`.
649
+ # 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`.
650
+ # 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`.
651
+ # 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`.
652
+ # 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`.
653
+ # 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`.
654
+ # 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`.
655
+ # 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`.
656
656
  # ids - string - comma-separated list of User IDs
657
657
  # q[username] - string - List users matching username.
658
658
  # q[email] - string - List users matching email.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.123
4
+ version: 1.0.128
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-11-12 00:00:00.000000000 Z
11
+ date: 2021-01-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -97,6 +97,7 @@ files:
97
97
  - docs/bundle.md
98
98
  - docs/bundle_download.md
99
99
  - docs/bundle_recipient.md
100
+ - docs/bundle_registration.md
100
101
  - docs/clickwrap.md
101
102
  - docs/dns_record.md
102
103
  - docs/errors.md
@@ -108,12 +109,16 @@ files:
108
109
  - docs/file_upload_part.md
109
110
  - docs/file_utils.md
110
111
  - docs/folder.md
112
+ - docs/form_field.md
113
+ - docs/form_field_set.md
111
114
  - docs/group.md
112
115
  - docs/group_user.md
113
116
  - docs/history.md
114
117
  - docs/history_export.md
115
118
  - docs/history_export_result.md
116
119
  - docs/image.md
120
+ - docs/inbox_registration.md
121
+ - docs/inbox_upload.md
117
122
  - docs/invoice.md
118
123
  - docs/invoice_line_item.md
119
124
  - docs/ip_address.md
@@ -161,6 +166,7 @@ files:
161
166
  - lib/files.com/models/bundle.rb
162
167
  - lib/files.com/models/bundle_download.rb
163
168
  - lib/files.com/models/bundle_recipient.rb
169
+ - lib/files.com/models/bundle_registration.rb
164
170
  - lib/files.com/models/clickwrap.rb
165
171
  - lib/files.com/models/dir.rb
166
172
  - lib/files.com/models/dns_record.rb
@@ -173,12 +179,16 @@ files:
173
179
  - lib/files.com/models/file_upload_part.rb
174
180
  - lib/files.com/models/file_utils.rb
175
181
  - lib/files.com/models/folder.rb
182
+ - lib/files.com/models/form_field.rb
183
+ - lib/files.com/models/form_field_set.rb
176
184
  - lib/files.com/models/group.rb
177
185
  - lib/files.com/models/group_user.rb
178
186
  - lib/files.com/models/history.rb
179
187
  - lib/files.com/models/history_export.rb
180
188
  - lib/files.com/models/history_export_result.rb
181
189
  - lib/files.com/models/image.rb
190
+ - lib/files.com/models/inbox_registration.rb
191
+ - lib/files.com/models/inbox_upload.rb
182
192
  - lib/files.com/models/invoice.rb
183
193
  - lib/files.com/models/invoice_line_item.rb
184
194
  - lib/files.com/models/ip_address.rb