files.com 1.0.121 → 1.0.122

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 (83) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/api_key.md +1 -4
  4. data/docs/app.md +1 -4
  5. data/docs/as2_key.md +1 -4
  6. data/docs/automation.md +1 -4
  7. data/docs/bandwidth_snapshot.md +1 -4
  8. data/docs/behavior.md +2 -8
  9. data/docs/bundle.md +7 -6
  10. data/docs/bundle_download.md +1 -4
  11. data/docs/bundle_recipient.md +1 -4
  12. data/docs/clickwrap.md +3 -5
  13. data/docs/dns_record.md +1 -4
  14. data/docs/external_event.md +1 -4
  15. data/docs/file_comment.md +1 -4
  16. data/docs/folder.md +1 -4
  17. data/docs/group.md +1 -4
  18. data/docs/group_user.md +1 -4
  19. data/docs/history.md +10 -30
  20. data/docs/history_export.md +5 -0
  21. data/docs/history_export_result.md +1 -5
  22. data/docs/invoice.md +1 -4
  23. data/docs/ip_address.md +2 -8
  24. data/docs/lock.md +1 -4
  25. data/docs/message.md +1 -4
  26. data/docs/message_comment.md +1 -4
  27. data/docs/message_comment_reaction.md +1 -4
  28. data/docs/message_reaction.md +1 -4
  29. data/docs/notification.md +1 -4
  30. data/docs/payment.md +1 -4
  31. data/docs/permission.md +1 -4
  32. data/docs/project.md +1 -4
  33. data/docs/public_key.md +1 -4
  34. data/docs/remote_server.md +1 -4
  35. data/docs/request.md +2 -8
  36. data/docs/settings_change.md +1 -4
  37. data/docs/sso_strategy.md +5 -4
  38. data/docs/usage_daily_snapshot.md +1 -4
  39. data/docs/usage_snapshot.md +1 -4
  40. data/docs/user.md +1 -4
  41. data/docs/user_cipher_use.md +1 -4
  42. data/docs/user_request.md +1 -4
  43. data/lib/files.com/models/api_key.rb +2 -6
  44. data/lib/files.com/models/app.rb +2 -6
  45. data/lib/files.com/models/as2_key.rb +2 -6
  46. data/lib/files.com/models/automation.rb +2 -6
  47. data/lib/files.com/models/bandwidth_snapshot.rb +2 -6
  48. data/lib/files.com/models/behavior.rb +4 -12
  49. data/lib/files.com/models/bundle.rb +6 -6
  50. data/lib/files.com/models/bundle_download.rb +2 -6
  51. data/lib/files.com/models/bundle_recipient.rb +2 -6
  52. data/lib/files.com/models/clickwrap.rb +11 -15
  53. data/lib/files.com/models/dns_record.rb +2 -6
  54. data/lib/files.com/models/external_event.rb +2 -6
  55. data/lib/files.com/models/file_comment.rb +2 -6
  56. data/lib/files.com/models/folder.rb +2 -6
  57. data/lib/files.com/models/group.rb +2 -6
  58. data/lib/files.com/models/group_user.rb +2 -6
  59. data/lib/files.com/models/history.rb +10 -30
  60. data/lib/files.com/models/history_export.rb +20 -0
  61. data/lib/files.com/models/history_export_result.rb +2 -6
  62. data/lib/files.com/models/invoice.rb +2 -6
  63. data/lib/files.com/models/ip_address.rb +4 -12
  64. data/lib/files.com/models/lock.rb +2 -6
  65. data/lib/files.com/models/message.rb +2 -6
  66. data/lib/files.com/models/message_comment.rb +2 -6
  67. data/lib/files.com/models/message_comment_reaction.rb +2 -6
  68. data/lib/files.com/models/message_reaction.rb +2 -6
  69. data/lib/files.com/models/notification.rb +2 -6
  70. data/lib/files.com/models/payment.rb +2 -6
  71. data/lib/files.com/models/permission.rb +2 -6
  72. data/lib/files.com/models/project.rb +2 -6
  73. data/lib/files.com/models/public_key.rb +2 -6
  74. data/lib/files.com/models/remote_server.rb +2 -6
  75. data/lib/files.com/models/request.rb +4 -12
  76. data/lib/files.com/models/settings_change.rb +2 -6
  77. data/lib/files.com/models/sso_strategy.rb +12 -6
  78. data/lib/files.com/models/usage_daily_snapshot.rb +2 -6
  79. data/lib/files.com/models/usage_snapshot.rb +2 -6
  80. data/lib/files.com/models/user.rb +2 -6
  81. data/lib/files.com/models/user_cipher_use.rb +2 -6
  82. data/lib/files.com/models/user_request.rb +2 -6
  83. metadata +2 -2
@@ -120,17 +120,14 @@
120
120
 
121
121
  ```
122
122
  Files::User.list(
123
- page: 1,
124
123
  per_page: 1
125
124
  )
126
125
  ```
127
126
 
128
127
  ### Parameters
129
128
 
130
- * `page` (int64): Current page number.
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.
131
130
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
132
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
133
- * `cursor` (string): Send cursor 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.
134
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`.
135
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`.
136
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`.
@@ -28,7 +28,6 @@
28
28
  ```
29
29
  Files::UserCipherUse.list(
30
30
  user_id: 1,
31
- page: 1,
32
31
  per_page: 1
33
32
  )
34
33
  ```
@@ -36,7 +35,5 @@ Files::UserCipherUse.list(
36
35
  ### Parameters
37
36
 
38
37
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
39
- * `page` (int64): Current page number.
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.
40
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
42
- * `cursor` (string): Send cursor 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.
@@ -23,17 +23,14 @@
23
23
 
24
24
  ```
25
25
  Files::UserRequest.list(
26
- page: 1,
27
26
  per_page: 1
28
27
  )
29
28
  ```
30
29
 
31
30
  ### Parameters
32
31
 
33
- * `page` (int64): Current page number.
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.
34
33
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
- * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36
- * `cursor` (string): Send cursor 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.
37
34
 
38
35
 
39
36
  ---
@@ -146,10 +146,8 @@ module Files
146
146
 
147
147
  # Parameters:
148
148
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
149
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
152
- # cursor - string - Send cursor 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.
153
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`.
154
152
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
155
153
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
@@ -159,10 +157,8 @@ module Files
159
157
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `expires_at`.
160
158
  def self.list(params = {}, options = {})
161
159
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
162
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
163
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
164
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
165
160
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
161
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
166
162
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
167
163
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
168
164
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -75,10 +75,8 @@ module Files
75
75
  end
76
76
 
77
77
  # Parameters:
78
- # page - int64 - Current page number.
78
+ # 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.
79
79
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
80
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
81
- # cursor - string - Send cursor 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.
82
80
  # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
83
81
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
84
82
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.
@@ -87,10 +85,8 @@ module Files
87
85
  # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `name` and `app_type`.
88
86
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
89
87
  def self.list(params = {}, options = {})
90
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
91
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
92
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
93
88
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
89
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
94
90
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
95
91
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
96
92
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -98,16 +98,12 @@ module Files
98
98
 
99
99
  # Parameters:
100
100
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
101
- # page - int64 - Current page number.
101
+ # 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.
102
102
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
103
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
104
- # cursor - string - Send cursor 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.
105
103
  def self.list(params = {}, options = {})
106
104
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
107
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
108
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
109
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
110
105
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
106
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
111
107
 
112
108
  List.new(As2Key, params) do
113
109
  Api.send_request("/as2_keys", :get, params, options)
@@ -180,10 +180,8 @@ module Files
180
180
  end
181
181
 
182
182
  # Parameters:
183
- # page - int64 - Current page number.
183
+ # 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.
184
184
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
185
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
186
- # cursor - string - Send cursor 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.
187
185
  # 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`.
188
186
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
189
187
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
@@ -193,10 +191,8 @@ module Files
193
191
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `automation`.
194
192
  # automation - string - DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
195
193
  def self.list(params = {}, options = {})
196
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
197
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
198
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
199
194
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
195
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
200
196
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
201
197
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
202
198
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -55,10 +55,8 @@ module Files
55
55
  end
56
56
 
57
57
  # Parameters:
58
- # page - int64 - Current page number.
58
+ # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
59
59
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
61
- # cursor - string - Send cursor 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.
62
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`.
63
61
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
64
62
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
@@ -67,10 +65,8 @@ module Files
67
65
  # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `logged_at`.
68
66
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `logged_at`.
69
67
  def self.list(params = {}, options = {})
70
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
71
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
72
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
73
68
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
69
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
74
70
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
75
71
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
76
72
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -105,10 +105,8 @@ module Files
105
105
  end
106
106
 
107
107
  # Parameters:
108
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
111
- # cursor - string - Send cursor 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.
112
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`.
113
111
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
114
112
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
@@ -118,10 +116,8 @@ module Files
118
116
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `behavior`.
119
117
  # behavior - string - If set, only shows folder behaviors matching this behavior type.
120
118
  def self.list(params = {}, options = {})
121
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
122
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
123
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
124
119
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
120
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
125
121
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
126
122
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
127
123
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -157,10 +153,8 @@ module Files
157
153
  end
158
154
 
159
155
  # Parameters:
160
- # page - int64 - Current page number.
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.
161
157
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
162
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
163
- # cursor - string - Send cursor 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.
164
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`.
165
159
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
166
160
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
@@ -174,10 +168,8 @@ module Files
174
168
  def self.list_for(path, params = {}, options = {})
175
169
  params ||= {}
176
170
  params[:path] = path
177
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
178
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
179
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
180
171
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
172
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
181
173
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
182
174
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
183
175
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -181,6 +181,7 @@ module Files
181
181
  # Parameters:
182
182
  # to (required) - array(string) - A list of email addresses to share this bundle with.
183
183
  # note - string - Note to include in email.
184
+ # recipients - array(object) - A list of recipients to share this bundle with.
184
185
  def share(params = {})
185
186
  params ||= {}
186
187
  params[:id] = @attributes[:id]
@@ -188,6 +189,7 @@ module Files
188
189
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
189
190
  raise InvalidParameterError.new("Bad parameter: to must be an Array") if params.dig(:to) and !params.dig(:to).is_a?(Array)
190
191
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
192
+ raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
191
193
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
192
194
  raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
193
195
 
@@ -248,10 +250,8 @@ module Files
248
250
 
249
251
  # Parameters:
250
252
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
251
- # page - int64 - Current page number.
253
+ # 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.
252
254
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
253
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
254
- # cursor - string - Send cursor 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.
255
255
  # 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`.
256
256
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
257
257
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
@@ -261,10 +261,8 @@ module Files
261
261
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
262
262
  def self.list(params = {}, options = {})
263
263
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
264
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
265
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
266
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
267
264
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
265
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
268
266
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
269
267
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
270
268
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -333,12 +331,14 @@ module Files
333
331
  # Parameters:
334
332
  # to (required) - array(string) - A list of email addresses to share this bundle with.
335
333
  # note - string - Note to include in email.
334
+ # recipients - array(object) - A list of recipients to share this bundle with.
336
335
  def self.share(id, params = {}, options = {})
337
336
  params ||= {}
338
337
  params[:id] = id
339
338
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
340
339
  raise InvalidParameterError.new("Bad parameter: to must be an Array") if params.dig(:to) and !params.dig(:to).is_a?(Array)
341
340
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
341
+ raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
342
342
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
343
343
  raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
344
344
 
@@ -25,16 +25,12 @@ module Files
25
25
  end
26
26
 
27
27
  # Parameters:
28
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
31
- # cursor - string - Send cursor 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
30
  # bundle_registration_id (required) - int64 - BundleRegistration ID
33
31
  def self.list(params = {}, options = {})
34
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
35
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
36
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
37
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)
38
34
  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)
39
35
  raise MissingParameterError.new("Parameter missing: bundle_registration_id") unless params.dig(:bundle_registration_id)
40
36
 
@@ -36,17 +36,13 @@ module Files
36
36
 
37
37
  # Parameters:
38
38
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
39
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
42
- # cursor - string - Send cursor 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
41
  # bundle_id (required) - int64 - List recipients for the bundle with this ID.
44
42
  def self.list(params = {}, options = {})
45
43
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
46
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
47
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
48
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
49
44
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
45
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
50
46
  raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
51
47
  raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
52
48
 
@@ -9,6 +9,15 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
+ # int64 - Clickwrap ID
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ def id=(value)
18
+ @attributes[:id] = value
19
+ end
20
+
12
21
  # string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
13
22
  def name
14
23
  @attributes[:name]
@@ -54,15 +63,6 @@ module Files
54
63
  @attributes[:use_with_inboxes] = value
55
64
  end
56
65
 
57
- # int64 - Clickwrap ID.
58
- def id
59
- @attributes[:id]
60
- end
61
-
62
- def id=(value)
63
- @attributes[:id] = value
64
- end
65
-
66
66
  # Parameters:
67
67
  # name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
68
68
  # body - string - Body text of Clickwrap (supports Markdown formatting).
@@ -108,15 +108,11 @@ module Files
108
108
  end
109
109
 
110
110
  # Parameters:
111
- # page - int64 - Current page number.
111
+ # 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.
112
112
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
113
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
114
- # cursor - string - Send cursor 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.
115
113
  def self.list(params = {}, options = {})
116
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
117
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
118
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
119
114
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
115
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
120
116
 
121
117
  List.new(Clickwrap, params) do
122
118
  Api.send_request("/clickwraps", :get, params, options)
@@ -30,15 +30,11 @@ module Files
30
30
  end
31
31
 
32
32
  # Parameters:
33
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36
- # cursor - string - Send cursor 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.
37
35
  def self.list(params = {}, options = {})
38
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
39
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
40
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
41
36
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
37
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
42
38
 
43
39
  List.new(DnsRecord, params) do
44
40
  Api.send_request("/dns_records", :get, params, options)
@@ -30,10 +30,8 @@ module Files
30
30
  end
31
31
 
32
32
  # Parameters:
33
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
36
- # cursor - string - Send cursor 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.
37
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 `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
38
36
  # 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`.
39
37
  # 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`.
@@ -42,10 +40,8 @@ module Files
42
40
  # filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
43
41
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
44
42
  def self.list(params = {}, options = {})
45
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
46
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
47
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
48
43
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
44
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
49
45
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
50
46
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
51
47
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -83,18 +83,14 @@ module Files
83
83
  end
84
84
 
85
85
  # Parameters:
86
- # page - int64 - Current page number.
86
+ # 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.
87
87
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
88
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
89
- # cursor - string - Send cursor 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.
90
88
  # path (required) - string - Path to operate on.
91
89
  def self.list_for(path, params = {}, options = {})
92
90
  params ||= {}
93
91
  params[:path] = path
94
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
95
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
96
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
97
92
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
93
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
98
94
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
99
95
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
100
96
 
@@ -300,10 +300,8 @@ module Files
300
300
  end
301
301
 
302
302
  # Parameters:
303
- # page - int64 - Current page number.
304
- # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
305
- # action - string - Action to take. Can be `count`, `size`, `permissions`, or blank.
306
303
  # cursor - string - Send cursor 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 header.
304
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
307
305
  # path (required) - string - Path to operate on.
308
306
  # filter - string - If specified, will to filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
309
307
  # preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
@@ -314,10 +312,8 @@ module Files
314
312
  def self.list_for(path, params = {}, options = {})
315
313
  params ||= {}
316
314
  params[:path] = path
317
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
318
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
319
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
320
315
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
316
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
321
317
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
322
318
  raise InvalidParameterError.new("Bad parameter: filter must be an String") if params.dig(:filter) and !params.dig(:filter).is_a?(String)
323
319
  raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params.dig(:preview_size) and !params.dig(:preview_size).is_a?(String)