files.com 1.0.121 → 1.0.126

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 (81) 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 +38 -16
  7. data/docs/bandwidth_snapshot.md +1 -4
  8. data/docs/behavior.md +2 -8
  9. data/docs/bundle.md +11 -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_result.md +1 -5
  21. data/docs/invoice.md +1 -4
  22. data/docs/ip_address.md +2 -8
  23. data/docs/lock.md +1 -4
  24. data/docs/message.md +1 -4
  25. data/docs/message_comment.md +1 -4
  26. data/docs/message_comment_reaction.md +1 -4
  27. data/docs/message_reaction.md +1 -4
  28. data/docs/notification.md +1 -4
  29. data/docs/payment.md +1 -4
  30. data/docs/permission.md +1 -4
  31. data/docs/project.md +1 -4
  32. data/docs/public_key.md +1 -4
  33. data/docs/remote_server.md +56 -4
  34. data/docs/request.md +2 -8
  35. data/docs/settings_change.md +1 -4
  36. data/docs/sso_strategy.md +5 -4
  37. data/docs/usage_daily_snapshot.md +1 -4
  38. data/docs/usage_snapshot.md +1 -4
  39. data/docs/user.md +1 -4
  40. data/docs/user_cipher_use.md +1 -4
  41. data/docs/user_request.md +1 -4
  42. data/lib/files.com/models/api_key.rb +2 -6
  43. data/lib/files.com/models/app.rb +2 -6
  44. data/lib/files.com/models/as2_key.rb +2 -6
  45. data/lib/files.com/models/automation.rb +52 -36
  46. data/lib/files.com/models/bandwidth_snapshot.rb +2 -6
  47. data/lib/files.com/models/behavior.rb +4 -12
  48. data/lib/files.com/models/bundle.rb +10 -6
  49. data/lib/files.com/models/bundle_download.rb +2 -6
  50. data/lib/files.com/models/bundle_recipient.rb +2 -6
  51. data/lib/files.com/models/clickwrap.rb +11 -15
  52. data/lib/files.com/models/dns_record.rb +2 -6
  53. data/lib/files.com/models/external_event.rb +2 -6
  54. data/lib/files.com/models/file_comment.rb +2 -6
  55. data/lib/files.com/models/folder.rb +2 -6
  56. data/lib/files.com/models/group.rb +2 -6
  57. data/lib/files.com/models/group_user.rb +2 -6
  58. data/lib/files.com/models/history.rb +10 -30
  59. data/lib/files.com/models/history_export_result.rb +2 -6
  60. data/lib/files.com/models/invoice.rb +2 -6
  61. data/lib/files.com/models/ip_address.rb +4 -12
  62. data/lib/files.com/models/lock.rb +2 -6
  63. data/lib/files.com/models/message.rb +2 -6
  64. data/lib/files.com/models/message_comment.rb +2 -6
  65. data/lib/files.com/models/message_comment_reaction.rb +2 -6
  66. data/lib/files.com/models/message_reaction.rb +2 -6
  67. data/lib/files.com/models/notification.rb +2 -6
  68. data/lib/files.com/models/payment.rb +2 -6
  69. data/lib/files.com/models/permission.rb +2 -6
  70. data/lib/files.com/models/project.rb +2 -6
  71. data/lib/files.com/models/public_key.rb +2 -6
  72. data/lib/files.com/models/remote_server.rb +84 -6
  73. data/lib/files.com/models/request.rb +4 -12
  74. data/lib/files.com/models/settings_change.rb +2 -6
  75. data/lib/files.com/models/sso_strategy.rb +12 -6
  76. data/lib/files.com/models/usage_daily_snapshot.rb +2 -6
  77. data/lib/files.com/models/usage_snapshot.rb +2 -6
  78. data/lib/files.com/models/user.rb +2 -6
  79. data/lib/files.com/models/user_cipher_use.rb +2 -6
  80. data/lib/files.com/models/user_request.rb +2 -6
  81. metadata +2 -2
@@ -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
 
@@ -195,6 +197,7 @@ module Files
195
197
  end
196
198
 
197
199
  # Parameters:
200
+ # paths - array(string) - A list of paths to include in this bundle.
198
201
  # password - string - Password for this bundle.
199
202
  # clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
200
203
  # code - string - Bundle code. This code forms the end part of the Public URL.
@@ -210,6 +213,7 @@ module Files
210
213
  params[:id] = @attributes[:id]
211
214
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
212
215
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
216
+ raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
213
217
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
214
218
  raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
215
219
  raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
@@ -248,10 +252,8 @@ module Files
248
252
 
249
253
  # Parameters:
250
254
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
251
- # page - int64 - Current page number.
255
+ # 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
256
  # 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
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`.
256
258
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
257
259
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
@@ -261,10 +263,8 @@ module Files
261
263
  # 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
264
  def self.list(params = {}, options = {})
263
265
  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
266
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
267
+ 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
268
  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
269
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
270
270
  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 +333,14 @@ module Files
333
333
  # Parameters:
334
334
  # to (required) - array(string) - A list of email addresses to share this bundle with.
335
335
  # note - string - Note to include in email.
336
+ # recipients - array(object) - A list of recipients to share this bundle with.
336
337
  def self.share(id, params = {}, options = {})
337
338
  params ||= {}
338
339
  params[:id] = id
339
340
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
340
341
  raise InvalidParameterError.new("Bad parameter: to must be an Array") if params.dig(:to) and !params.dig(:to).is_a?(Array)
341
342
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
343
+ raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array)
342
344
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
343
345
  raise MissingParameterError.new("Parameter missing: to") unless params.dig(:to)
344
346
 
@@ -347,6 +349,7 @@ module Files
347
349
  end
348
350
 
349
351
  # Parameters:
352
+ # paths - array(string) - A list of paths to include in this bundle.
350
353
  # password - string - Password for this bundle.
351
354
  # clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
352
355
  # code - string - Bundle code. This code forms the end part of the Public URL.
@@ -361,6 +364,7 @@ module Files
361
364
  params ||= {}
362
365
  params[:id] = id
363
366
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
367
+ raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
364
368
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
365
369
  raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
366
370
  raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
@@ -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)
@@ -106,10 +106,8 @@ module Files
106
106
  end
107
107
 
108
108
  # Parameters:
109
- # page - int64 - Current page number.
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
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
112
- # 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.
113
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`.
114
112
  # filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
115
113
  # filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
@@ -119,10 +117,8 @@ module Files
119
117
  # filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name`.
120
118
  # ids - string - Comma-separated list of group ids to include in results.
121
119
  def self.list(params = {}, options = {})
122
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
123
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
124
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
125
120
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
121
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
126
122
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
127
123
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
128
124
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
@@ -108,17 +108,13 @@ module Files
108
108
 
109
109
  # Parameters:
110
110
  # user_id - int64 - User ID. If provided, will return group_users of this user.
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
  # group_id - int64 - Group ID. If provided, will return group_users of this group.
116
114
  def self.list(params = {}, options = {})
117
115
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
118
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
119
- 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
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
121
116
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
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)
122
118
  raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
123
119
 
124
120
  List.new(GroupUser, params) do
@@ -78,10 +78,8 @@ module Files
78
78
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
79
79
  # end_at - string - Leave blank or set to a date/time to filter later entries.
80
80
  # display - string - Display format. Leave blank or set to `full` or `parent`.
81
- # page - int64 - Current page number.
81
+ # 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.
82
82
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
83
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
84
- # 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.
85
83
  # 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 `user_id` and `created_at`.
86
84
  # path (required) - string - Path to operate on.
87
85
  def self.list_for_file(path, params = {}, options = {})
@@ -90,10 +88,8 @@ module Files
90
88
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
91
89
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
92
90
  raise InvalidParameterError.new("Bad parameter: display must be an String") if params.dig(:display) and !params.dig(:display).is_a?(String)
93
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
94
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
95
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
96
91
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
92
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
97
93
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
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)
@@ -107,10 +103,8 @@ module Files
107
103
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
108
104
  # end_at - string - Leave blank or set to a date/time to filter later entries.
109
105
  # display - string - Display format. Leave blank or set to `full` or `parent`.
110
- # page - int64 - Current page number.
106
+ # 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.
111
107
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
112
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
113
- # 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.
114
108
  # 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 `user_id` and `created_at`.
115
109
  # path (required) - string - Path to operate on.
116
110
  def self.list_for_folder(path, params = {}, options = {})
@@ -119,10 +113,8 @@ module Files
119
113
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
120
114
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
121
115
  raise InvalidParameterError.new("Bad parameter: display must be an String") if params.dig(:display) and !params.dig(:display).is_a?(String)
122
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
123
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
124
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
125
116
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
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)
126
118
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
127
119
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
128
120
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
@@ -136,10 +128,8 @@ module Files
136
128
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
137
129
  # end_at - string - Leave blank or set to a date/time to filter later entries.
138
130
  # display - string - Display format. Leave blank or set to `full` or `parent`.
139
- # page - int64 - Current page number.
131
+ # 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.
140
132
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
141
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
142
- # 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.
143
133
  # 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 `user_id` and `created_at`.
144
134
  # user_id (required) - int64 - User ID.
145
135
  def self.list_for_user(user_id, params = {}, options = {})
@@ -148,10 +138,8 @@ module Files
148
138
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
149
139
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
150
140
  raise InvalidParameterError.new("Bad parameter: display must be an String") if params.dig(:display) and !params.dig(:display).is_a?(String)
151
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
152
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
153
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
154
141
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
142
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
155
143
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
156
144
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
157
145
  raise MissingParameterError.new("Parameter missing: user_id") unless params.dig(:user_id)
@@ -165,19 +153,15 @@ module Files
165
153
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
166
154
  # end_at - string - Leave blank or set to a date/time to filter later entries.
167
155
  # display - string - Display format. Leave blank or set to `full` or `parent`.
168
- # 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.
169
157
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
170
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
171
- # 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.
172
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 `user_id` and `created_at`.
173
159
  def self.list_logins(params = {}, options = {})
174
160
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
175
161
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
176
162
  raise InvalidParameterError.new("Bad parameter: display must be an String") if params.dig(:display) and !params.dig(:display).is_a?(String)
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
163
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
164
+ 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
165
  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
166
 
183
167
  List.new(Action, params) do
@@ -189,10 +173,8 @@ module Files
189
173
  # start_at - string - Leave blank or set to a date/time to filter earlier entries.
190
174
  # end_at - string - Leave blank or set to a date/time to filter later entries.
191
175
  # display - string - Display format. Leave blank or set to `full` or `parent`.
192
- # page - int64 - Current page number.
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.
193
177
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
194
- # action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
195
- # 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.
196
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`.
197
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`.
198
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`.
@@ -204,10 +186,8 @@ module Files
204
186
  raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
205
187
  raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
206
188
  raise InvalidParameterError.new("Bad parameter: display must be an String") if params.dig(:display) and !params.dig(:display).is_a?(String)
207
- raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
208
- raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
209
- raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
210
189
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
190
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
211
191
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
212
192
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
213
193
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)