files.com 1.1.768 → 1.1.770

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 (138) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +47 -7
  4. data/_VERSION +1 -1
  5. data/docs/file.md +37 -0
  6. data/lib/files.com/api.rb +9 -4
  7. data/lib/files.com/api_client.rb +181 -55
  8. data/lib/files.com/list.rb +98 -66
  9. data/lib/files.com/models/action_log.rb +7 -2
  10. data/lib/files.com/models/action_notification_export.rb +13 -3
  11. data/lib/files.com/models/action_notification_export_result.rb +7 -2
  12. data/lib/files.com/models/ai_assistant_personality.rb +34 -8
  13. data/lib/files.com/models/ai_task.rb +39 -8
  14. data/lib/files.com/models/api_key.rb +49 -10
  15. data/lib/files.com/models/api_request_log.rb +7 -2
  16. data/lib/files.com/models/app.rb +7 -2
  17. data/lib/files.com/models/as2_incoming_message.rb +7 -2
  18. data/lib/files.com/models/as2_outgoing_message.rb +7 -2
  19. data/lib/files.com/models/as2_partner.rb +34 -8
  20. data/lib/files.com/models/as2_station.rb +34 -8
  21. data/lib/files.com/models/automation.rb +50 -10
  22. data/lib/files.com/models/automation_log.rb +7 -2
  23. data/lib/files.com/models/automation_run.rb +31 -6
  24. data/lib/files.com/models/bandwidth_snapshot.rb +7 -2
  25. data/lib/files.com/models/behavior.rb +46 -10
  26. data/lib/files.com/models/bundle.rb +39 -8
  27. data/lib/files.com/models/bundle_action.rb +7 -2
  28. data/lib/files.com/models/bundle_download.rb +7 -2
  29. data/lib/files.com/models/bundle_notification.rb +34 -8
  30. data/lib/files.com/models/bundle_recipient.rb +14 -4
  31. data/lib/files.com/models/bundle_registration.rb +7 -2
  32. data/lib/files.com/models/chat_session.rb +13 -3
  33. data/lib/files.com/models/child_site_management_policy.rb +34 -8
  34. data/lib/files.com/models/clickwrap.rb +34 -8
  35. data/lib/files.com/models/custom_domain.rb +40 -9
  36. data/lib/files.com/models/desktop_configuration_profile.rb +34 -8
  37. data/lib/files.com/models/dns_record.rb +7 -2
  38. data/lib/files.com/models/email_incoming_message.rb +7 -2
  39. data/lib/files.com/models/email_log.rb +7 -2
  40. data/lib/files.com/models/event_channel.rb +34 -8
  41. data/lib/files.com/models/event_delivery_attempt.rb +13 -3
  42. data/lib/files.com/models/event_record.rb +13 -3
  43. data/lib/files.com/models/event_subscription.rb +34 -8
  44. data/lib/files.com/models/event_target.rb +34 -8
  45. data/lib/files.com/models/exavault_api_request_log.rb +7 -2
  46. data/lib/files.com/models/expectation.rb +40 -9
  47. data/lib/files.com/models/expectation_evaluation.rb +13 -3
  48. data/lib/files.com/models/expectation_incident.rb +31 -6
  49. data/lib/files.com/models/external_event.rb +20 -5
  50. data/lib/files.com/models/file.rb +93 -15
  51. data/lib/files.com/models/file_comment.rb +28 -7
  52. data/lib/files.com/models/file_comment_reaction.rb +11 -2
  53. data/lib/files.com/models/file_migration.rb +6 -1
  54. data/lib/files.com/models/file_migration_log.rb +7 -2
  55. data/lib/files.com/models/folder.rb +13 -3
  56. data/lib/files.com/models/form_field_set.rb +34 -8
  57. data/lib/files.com/models/ftp_action_log.rb +7 -2
  58. data/lib/files.com/models/gpg_key.rb +34 -8
  59. data/lib/files.com/models/group.rb +34 -8
  60. data/lib/files.com/models/group_user.rb +29 -7
  61. data/lib/files.com/models/history.rb +35 -10
  62. data/lib/files.com/models/history_export.rb +13 -3
  63. data/lib/files.com/models/history_export_result.rb +7 -2
  64. data/lib/files.com/models/holiday_calendar.rb +34 -8
  65. data/lib/files.com/models/holiday_region.rb +7 -2
  66. data/lib/files.com/models/inbound_s3_log.rb +7 -2
  67. data/lib/files.com/models/inbox_recipient.rb +14 -4
  68. data/lib/files.com/models/inbox_registration.rb +7 -2
  69. data/lib/files.com/models/inbox_upload.rb +7 -2
  70. data/lib/files.com/models/integration_centric_profile.rb +34 -8
  71. data/lib/files.com/models/invoice.rb +13 -3
  72. data/lib/files.com/models/ip_address.rb +28 -8
  73. data/lib/files.com/models/key_lifecycle_rule.rb +34 -8
  74. data/lib/files.com/models/lock.rb +18 -3
  75. data/lib/files.com/models/metadata_category.rb +41 -10
  76. data/lib/files.com/models/notification.rb +34 -8
  77. data/lib/files.com/models/outbound_connection_log.rb +7 -2
  78. data/lib/files.com/models/partner.rb +34 -8
  79. data/lib/files.com/models/partner_channel.rb +34 -8
  80. data/lib/files.com/models/partner_channel_template.rb +34 -8
  81. data/lib/files.com/models/partner_site.rb +4 -0
  82. data/lib/files.com/models/partner_site_request.rb +33 -4
  83. data/lib/files.com/models/payment.rb +13 -3
  84. data/lib/files.com/models/pending_work_event.rb +13 -3
  85. data/lib/files.com/models/permission.rb +18 -4
  86. data/lib/files.com/models/public_hosting_request_log.rb +7 -2
  87. data/lib/files.com/models/public_key.rb +34 -8
  88. data/lib/files.com/models/remote_bandwidth_snapshot.rb +7 -2
  89. data/lib/files.com/models/remote_mount_backend.rb +39 -8
  90. data/lib/files.com/models/remote_server.rb +52 -11
  91. data/lib/files.com/models/remote_server_credential.rb +34 -8
  92. data/lib/files.com/models/request.rb +25 -6
  93. data/lib/files.com/models/restore.rb +14 -4
  94. data/lib/files.com/models/schedule.rb +34 -8
  95. data/lib/files.com/models/scheduled_export.rb +34 -8
  96. data/lib/files.com/models/scim_log.rb +13 -3
  97. data/lib/files.com/models/secret.rb +34 -8
  98. data/lib/files.com/models/session.rb +11 -2
  99. data/lib/files.com/models/settings_change.rb +7 -2
  100. data/lib/files.com/models/sftp_action_log.rb +7 -2
  101. data/lib/files.com/models/sftp_host_key.rb +34 -8
  102. data/lib/files.com/models/share_group.rb +34 -8
  103. data/lib/files.com/models/siem_http_destination.rb +39 -8
  104. data/lib/files.com/models/siem_http_destination_event.rb +13 -3
  105. data/lib/files.com/models/site.rb +16 -3
  106. data/lib/files.com/models/site_subdomain_redirect.rb +17 -3
  107. data/lib/files.com/models/snapshot.rb +39 -8
  108. data/lib/files.com/models/sso_event.rb +13 -3
  109. data/lib/files.com/models/sso_strategy.rb +18 -3
  110. data/lib/files.com/models/style.rb +20 -5
  111. data/lib/files.com/models/sync.rb +44 -8
  112. data/lib/files.com/models/sync_log.rb +7 -2
  113. data/lib/files.com/models/sync_run.rb +13 -3
  114. data/lib/files.com/models/usage_daily_snapshot.rb +7 -2
  115. data/lib/files.com/models/usage_snapshot.rb +7 -2
  116. data/lib/files.com/models/user.rb +50 -8
  117. data/lib/files.com/models/user_additional_email_recipient.rb +34 -8
  118. data/lib/files.com/models/user_cipher_use.rb +7 -2
  119. data/lib/files.com/models/user_lifecycle_rule.rb +34 -8
  120. data/lib/files.com/models/user_request.rb +24 -5
  121. data/lib/files.com/models/user_security_event.rb +13 -3
  122. data/lib/files.com/models/user_sftp_client_use.rb +7 -2
  123. data/lib/files.com/models/web_dav_action_log.rb +7 -2
  124. data/lib/files.com/models/webhook_test.rb +7 -2
  125. data/lib/files.com/models/workspace.rb +34 -8
  126. data/lib/files.com/response.rb +24 -0
  127. data/lib/files.com/sizable_io.rb +65 -4
  128. data/lib/files.com/version.rb +1 -1
  129. data/lib/files.com.rb +23 -1
  130. data/spec/language_spec.rb +20 -10
  131. data/spec/lib/api_client_spec.rb +173 -18
  132. data/spec/list_spec.rb +203 -187
  133. data/spec/models/file_transfer_spec.rb +346 -0
  134. data/spec/models/persistence_spec.rb +167 -0
  135. data/spec/spec_helper.rb +122 -6
  136. data/spec/support/stubbed_api.rb +14 -0
  137. data/spec/support/transfer_server.rb +60 -0
  138. metadata +6 -2
@@ -146,9 +146,9 @@ module Files
146
146
  raise NotImplementedError.new("The Permission object doesn't support updates.")
147
147
  else
148
148
  new_obj = Permission.create(@attributes, @options)
149
+ @attributes = new_obj.attributes
149
150
  end
150
151
 
151
- @attributes = new_obj.attributes
152
152
  true
153
153
  end
154
154
 
@@ -163,6 +163,11 @@ module Files
163
163
  # group_id - string
164
164
  # partner_id - string
165
165
  # user_id - string
166
+ #
167
+ # params:: Hash of API operation parameter values.
168
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
169
+ #
170
+ # Returns a Files::List of Files::Permission objects.
166
171
  def self.list(params = {}, options = {})
167
172
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
168
173
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -174,8 +179,8 @@ module Files
174
179
  raise InvalidParameterError.new("Bad parameter: partner_id must be an String") if params[:partner_id] and !params[:partner_id].is_a?(String)
175
180
  raise InvalidParameterError.new("Bad parameter: user_id must be an String") if params[:user_id] and !params[:user_id].is_a?(String)
176
181
 
177
- List.new(Permission, params) do
178
- Api.send_request("/permissions", :get, params, options)
182
+ List.new(Permission, params) do |page_params, &check_page|
183
+ Api.send_request("/permissions", :get, page_params, options, &check_page)
179
184
  end
180
185
  end
181
186
 
@@ -194,6 +199,11 @@ module Files
194
199
  # username - string - User username. Provide `username` or `user_id`
195
200
  # group_name - string - Group name. Provide `group_name` or `group_id`
196
201
  # site_id - int64 - Site ID. If not provided, will default to current site. Used when creating a permission for a child site.
202
+ #
203
+ # params:: Hash of API operation parameter values.
204
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
205
+ #
206
+ # Returns a Files::Permission.
197
207
  def self.create(params = {}, options = {})
198
208
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
199
209
  raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
@@ -206,10 +216,14 @@ module Files
206
216
  raise InvalidParameterError.new("Bad parameter: site_id must be an Integer") if params[:site_id] and !params[:site_id].is_a?(Integer)
207
217
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]
208
218
 
209
- response, options = Api.send_request("/permissions", :post, params, options)
219
+ response, options = Api.send_request("/permissions", :post, params, options) { |reply| reply.require_object("Permission") }
210
220
  Permission.new(response.data, options)
211
221
  end
212
222
 
223
+ # params:: Hash of API operation parameter values.
224
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
225
+ #
226
+ # Returns nil.
213
227
  def self.delete(id, params = {}, options = {})
214
228
  params ||= {}
215
229
  params[:id] = id
@@ -73,6 +73,11 @@ module Files
73
73
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
74
74
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
75
75
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ path ]`, `[ remote_ip ]`, `[ success ]`, `[ created_at ]`, `[ path, remote_ip ]`, `[ path, success ]`, `[ path, created_at ]`, `[ remote_ip, success ]`, `[ remote_ip, created_at ]`, `[ success, created_at ]`, `[ path, remote_ip, success ]`, `[ path, remote_ip, created_at ]`, `[ path, success, created_at ]`, `[ remote_ip, success, created_at ]` or `[ path, remote_ip, success, created_at ]`.
76
+ #
77
+ # params:: Hash of API operation parameter values.
78
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
79
+ #
80
+ # Returns a Files::List of Files::PublicHostingRequestLog objects.
76
81
  def self.list(params = {}, options = {})
77
82
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
78
83
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -83,8 +88,8 @@ module Files
83
88
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
84
89
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
85
90
 
86
- List.new(PublicHostingRequestLog, params) do
87
- Api.send_request("/public_hosting_request_logs", :get, params, options)
91
+ List.new(PublicHostingRequestLog, params) do |page_params, &check_page|
92
+ Api.send_request("/public_hosting_request_logs", :get, page_params, options, &check_page)
88
93
  end
89
94
  end
90
95
 
@@ -187,7 +187,9 @@ module Files
187
187
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
188
188
  raise MissingParameterError.new("Parameter missing: title") unless params[:title]
189
189
 
190
- Api.send_request("/public_keys/#{@attributes[:id]}", :patch, params, @options)
190
+ response, options = Api.send_request("/public_keys/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("PublicKey") }
191
+ @attributes = response.data
192
+ [ response, options ]
191
193
  end
192
194
 
193
195
  def delete(params = {})
@@ -207,12 +209,12 @@ module Files
207
209
 
208
210
  def save
209
211
  if @attributes[:id]
210
- new_obj = update(@attributes)
212
+ update(@attributes)
211
213
  else
212
214
  new_obj = PublicKey.create(@attributes, @options)
215
+ @attributes = new_obj.attributes
213
216
  end
214
217
 
215
- @attributes = new_obj.attributes
216
218
  true
217
219
  end
218
220
 
@@ -226,6 +228,11 @@ module Files
226
228
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
227
229
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
228
230
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
231
+ #
232
+ # params:: Hash of API operation parameter values.
233
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
234
+ #
235
+ # Returns a Files::List of Files::PublicKey objects.
229
236
  def self.list(params = {}, options = {})
230
237
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
231
238
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -237,8 +244,8 @@ module Files
237
244
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
238
245
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
239
246
 
240
- List.new(PublicKey, params) do
241
- Api.send_request("/public_keys", :get, params, options)
247
+ List.new(PublicKey, params) do |page_params, &check_page|
248
+ Api.send_request("/public_keys", :get, page_params, options, &check_page)
242
249
  end
243
250
  end
244
251
 
@@ -248,13 +255,18 @@ module Files
248
255
 
249
256
  # Parameters:
250
257
  # id (required) - int64 - Public Key ID.
258
+ #
259
+ # params:: Hash of API operation parameter values.
260
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
261
+ #
262
+ # Returns a Files::PublicKey.
251
263
  def self.find(id, params = {}, options = {})
252
264
  params ||= {}
253
265
  params[:id] = id
254
266
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
255
267
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
256
268
 
257
- response, options = Api.send_request("/public_keys/#{params[:id]}", :get, params, options)
269
+ response, options = Api.send_request("/public_keys/#{params[:id]}", :get, params, options) { |reply| reply.require_object("PublicKey") }
258
270
  PublicKey.new(response.data, options)
259
271
  end
260
272
 
@@ -270,6 +282,11 @@ module Files
270
282
  # generate_private_key_password - string - Password for the private key. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
271
283
  # generate_algorithm - string - Type of key to generate. One of rsa, dsa, ecdsa, ed25519. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
272
284
  # generate_length - int64 - Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
285
+ #
286
+ # params:: Hash of API operation parameter values.
287
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
288
+ #
289
+ # Returns a Files::PublicKey.
273
290
  def self.create(params = {}, options = {})
274
291
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
275
292
  raise InvalidParameterError.new("Bad parameter: title must be an String") if params[:title] and !params[:title].is_a?(String)
@@ -279,12 +296,17 @@ module Files
279
296
  raise InvalidParameterError.new("Bad parameter: generate_length must be an Integer") if params[:generate_length] and !params[:generate_length].is_a?(Integer)
280
297
  raise MissingParameterError.new("Parameter missing: title") unless params[:title]
281
298
 
282
- response, options = Api.send_request("/public_keys", :post, params, options)
299
+ response, options = Api.send_request("/public_keys", :post, params, options) { |reply| reply.require_object("PublicKey") }
283
300
  PublicKey.new(response.data, options)
284
301
  end
285
302
 
286
303
  # Parameters:
287
304
  # title (required) - string - Internal reference for key.
305
+ #
306
+ # params:: Hash of API operation parameter values.
307
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
308
+ #
309
+ # Returns a Files::PublicKey.
288
310
  def self.update(id, params = {}, options = {})
289
311
  params ||= {}
290
312
  params[:id] = id
@@ -293,10 +315,14 @@ module Files
293
315
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
294
316
  raise MissingParameterError.new("Parameter missing: title") unless params[:title]
295
317
 
296
- response, options = Api.send_request("/public_keys/#{params[:id]}", :patch, params, options)
318
+ response, options = Api.send_request("/public_keys/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("PublicKey") }
297
319
  PublicKey.new(response.data, options)
298
320
  end
299
321
 
322
+ # params:: Hash of API operation parameter values.
323
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
324
+ #
325
+ # Returns nil.
300
326
  def self.delete(id, params = {}, options = {})
301
327
  params ||= {}
302
328
  params[:id] = id
@@ -43,6 +43,11 @@ module Files
43
43
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
44
44
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
45
45
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
46
+ #
47
+ # params:: Hash of API operation parameter values.
48
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
49
+ #
50
+ # Returns a Files::List of Files::RemoteBandwidthSnapshot objects.
46
51
  def self.list(params = {}, options = {})
47
52
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
48
53
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -53,8 +58,8 @@ module Files
53
58
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
54
59
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
55
60
 
56
- List.new(RemoteBandwidthSnapshot, params) do
57
- Api.send_request("/remote_bandwidth_snapshots", :get, params, options)
61
+ List.new(RemoteBandwidthSnapshot, params) do |page_params, &check_page|
62
+ Api.send_request("/remote_bandwidth_snapshots", :get, page_params, options, &check_page)
58
63
  end
59
64
  end
60
65
 
@@ -209,7 +209,9 @@ module Files
209
209
  raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params[:remote_server_id] and !params[:remote_server_id].is_a?(Integer)
210
210
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
211
211
 
212
- Api.send_request("/remote_mount_backends/#{@attributes[:id]}", :patch, params, @options)
212
+ response, options = Api.send_request("/remote_mount_backends/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("RemoteMountBackend") }
213
+ @attributes = response.data
214
+ [ response, options ]
213
215
  end
214
216
 
215
217
  def delete(params = {})
@@ -229,12 +231,12 @@ module Files
229
231
 
230
232
  def save
231
233
  if @attributes[:id]
232
- new_obj = update(@attributes)
234
+ update(@attributes)
233
235
  else
234
236
  new_obj = RemoteMountBackend.create(@attributes, @options)
237
+ @attributes = new_obj.attributes
235
238
  end
236
239
 
237
- @attributes = new_obj.attributes
238
240
  true
239
241
  end
240
242
 
@@ -242,13 +244,18 @@ module Files
242
244
  # cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
243
245
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
244
246
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `remote_server_mount_id`.
247
+ #
248
+ # params:: Hash of API operation parameter values.
249
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
250
+ #
251
+ # Returns a Files::List of Files::RemoteMountBackend objects.
245
252
  def self.list(params = {}, options = {})
246
253
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
247
254
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
248
255
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
249
256
 
250
- List.new(RemoteMountBackend, params) do
251
- Api.send_request("/remote_mount_backends", :get, params, options)
257
+ List.new(RemoteMountBackend, params) do |page_params, &check_page|
258
+ Api.send_request("/remote_mount_backends", :get, page_params, options, &check_page)
252
259
  end
253
260
  end
254
261
 
@@ -258,13 +265,18 @@ module Files
258
265
 
259
266
  # Parameters:
260
267
  # id (required) - int64 - Remote Mount Backend ID.
268
+ #
269
+ # params:: Hash of API operation parameter values.
270
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
271
+ #
272
+ # Returns a Files::RemoteMountBackend.
261
273
  def self.find(id, params = {}, options = {})
262
274
  params ||= {}
263
275
  params[:id] = id
264
276
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
265
277
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
266
278
 
267
- response, options = Api.send_request("/remote_mount_backends/#{params[:id]}", :get, params, options)
279
+ response, options = Api.send_request("/remote_mount_backends/#{params[:id]}", :get, params, options) { |reply| reply.require_object("RemoteMountBackend") }
268
280
  RemoteMountBackend.new(response.data, options)
269
281
  end
270
282
 
@@ -286,6 +298,11 @@ module Files
286
298
  # canary_file_path (required) - string - Path to the canary file used for health checks.
287
299
  # remote_server_mount_id (required) - int64 - The mount ID of the Remote Server Mount that this backend is associated with.
288
300
  # remote_server_id (required) - int64 - The remote server that this backend is associated with.
301
+ #
302
+ # params:: Hash of API operation parameter values.
303
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
304
+ #
305
+ # Returns a Files::RemoteMountBackend.
289
306
  def self.create(params = {}, options = {})
290
307
  raise InvalidParameterError.new("Bad parameter: fall must be an Integer") if params[:fall] and !params[:fall].is_a?(Integer)
291
308
  raise InvalidParameterError.new("Bad parameter: health_check_type must be an String") if params[:health_check_type] and !params[:health_check_type].is_a?(String)
@@ -302,11 +319,16 @@ module Files
302
319
  raise MissingParameterError.new("Parameter missing: remote_server_mount_id") unless params[:remote_server_mount_id]
303
320
  raise MissingParameterError.new("Parameter missing: remote_server_id") unless params[:remote_server_id]
304
321
 
305
- response, options = Api.send_request("/remote_mount_backends", :post, params, options)
322
+ response, options = Api.send_request("/remote_mount_backends", :post, params, options) { |reply| reply.require_object("RemoteMountBackend") }
306
323
  RemoteMountBackend.new(response.data, options)
307
324
  end
308
325
 
309
326
  # Reset backend status to healthy
327
+ #
328
+ # params:: Hash of API operation parameter values.
329
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
330
+ #
331
+ # Returns nil.
310
332
  def self.reset_status(id, params = {}, options = {})
311
333
  params ||= {}
312
334
  params[:id] = id
@@ -330,6 +352,11 @@ module Files
330
352
  # rise - int64 - Number of consecutive successes before considering the backend healthy.
331
353
  # canary_file_path - string - Path to the canary file used for health checks.
332
354
  # remote_server_id - int64 - The remote server that this backend is associated with.
355
+ #
356
+ # params:: Hash of API operation parameter values.
357
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
358
+ #
359
+ # Returns a Files::RemoteMountBackend.
333
360
  def self.update(id, params = {}, options = {})
334
361
  params ||= {}
335
362
  params[:id] = id
@@ -346,10 +373,14 @@ module Files
346
373
  raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params[:remote_server_id] and !params[:remote_server_id].is_a?(Integer)
347
374
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
348
375
 
349
- response, options = Api.send_request("/remote_mount_backends/#{params[:id]}", :patch, params, options)
376
+ response, options = Api.send_request("/remote_mount_backends/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("RemoteMountBackend") }
350
377
  RemoteMountBackend.new(response.data, options)
351
378
  end
352
379
 
380
+ # params:: Hash of API operation parameter values.
381
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
382
+ #
383
+ # Returns nil.
353
384
  def self.delete(id, params = {}, options = {})
354
385
  params ||= {}
355
386
  params[:id] = id
@@ -1116,7 +1116,9 @@ module Files
1116
1116
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
1117
1117
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1118
1118
 
1119
- Api.send_request("/remote_servers/#{@attributes[:id]}", :patch, params, @options)
1119
+ response, options = Api.send_request("/remote_servers/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("RemoteServer") }
1120
+ @attributes = response.data
1121
+ [ response, options ]
1120
1122
  end
1121
1123
 
1122
1124
  def delete(params = {})
@@ -1136,12 +1138,12 @@ module Files
1136
1138
 
1137
1139
  def save
1138
1140
  if @attributes[:id]
1139
- new_obj = update(@attributes)
1141
+ update(@attributes)
1140
1142
  else
1141
1143
  new_obj = RemoteServer.create(@attributes, @options)
1144
+ @attributes = new_obj.attributes
1142
1145
  end
1143
1146
 
1144
- @attributes = new_obj.attributes
1145
1147
  true
1146
1148
  end
1147
1149
 
@@ -1152,6 +1154,11 @@ module Files
1152
1154
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
1153
1155
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `workspace_id`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ workspace_id, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]`, `[ linode_bucket, name ]`, `[ workspace_id, server_type ]` or `[ workspace_id, server_type, name ]`.
1154
1156
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
1157
+ #
1158
+ # params:: Hash of API operation parameter values.
1159
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1160
+ #
1161
+ # Returns a Files::List of Files::RemoteServer objects.
1155
1162
  def self.list(params = {}, options = {})
1156
1163
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
1157
1164
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
@@ -1160,8 +1167,8 @@ module Files
1160
1167
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
1161
1168
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
1162
1169
 
1163
- List.new(RemoteServer, params) do
1164
- Api.send_request("/remote_servers", :get, params, options)
1170
+ List.new(RemoteServer, params) do |page_params, &check_page|
1171
+ Api.send_request("/remote_servers", :get, page_params, options, &check_page)
1165
1172
  end
1166
1173
  end
1167
1174
 
@@ -1171,13 +1178,18 @@ module Files
1171
1178
 
1172
1179
  # Parameters:
1173
1180
  # id (required) - int64 - Remote Server ID.
1181
+ #
1182
+ # params:: Hash of API operation parameter values.
1183
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1184
+ #
1185
+ # Returns a Files::RemoteServer.
1174
1186
  def self.find(id, params = {}, options = {})
1175
1187
  params ||= {}
1176
1188
  params[:id] = id
1177
1189
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
1178
1190
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1179
1191
 
1180
- response, options = Api.send_request("/remote_servers/#{params[:id]}", :get, params, options)
1192
+ response, options = Api.send_request("/remote_servers/#{params[:id]}", :get, params, options) { |reply| reply.require_object("RemoteServer") }
1181
1193
  RemoteServer.new(response.data, options)
1182
1194
  end
1183
1195
 
@@ -1186,25 +1198,35 @@ module Files
1186
1198
  end
1187
1199
 
1188
1200
  # List Files.com Agent nodes
1201
+ #
1202
+ # params:: Hash of API operation parameter values.
1203
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1204
+ #
1205
+ # Returns a Files::AgentNode.
1189
1206
  def self.agent_nodes(id, params = {}, options = {})
1190
1207
  params ||= {}
1191
1208
  params[:id] = id
1192
1209
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
1193
1210
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1194
1211
 
1195
- response, options = Api.send_request("/remote_servers/#{params[:id]}/agent_nodes", :get, params, options)
1212
+ response, options = Api.send_request("/remote_servers/#{params[:id]}/agent_nodes", :get, params, options) { |reply| reply.require_object("AgentNode") }
1196
1213
  AgentNode.new(response.data, options)
1197
1214
  end
1198
1215
 
1199
1216
  # Parameters:
1200
1217
  # id (required) - int64 - Remote Server ID.
1218
+ #
1219
+ # params:: Hash of API operation parameter values.
1220
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1221
+ #
1222
+ # Returns a Files::RemoteServerConfigurationFile.
1201
1223
  def self.find_configuration_file(id, params = {}, options = {})
1202
1224
  params ||= {}
1203
1225
  params[:id] = id
1204
1226
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
1205
1227
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1206
1228
 
1207
- response, options = Api.send_request("/remote_servers/#{params[:id]}/configuration_file", :get, params, options)
1229
+ response, options = Api.send_request("/remote_servers/#{params[:id]}/configuration_file", :get, params, options) { |reply| reply.require_object("RemoteServerConfigurationFile") }
1208
1230
  RemoteServerConfigurationFile.new(response.data, options)
1209
1231
  end
1210
1232
 
@@ -1294,6 +1316,11 @@ module Files
1294
1316
  # wasabi_bucket - string - Wasabi: Bucket name
1295
1317
  # wasabi_region - string - Wasabi: Region
1296
1318
  # workspace_id - int64 - Workspace ID (0 for default workspace)
1319
+ #
1320
+ # params:: Hash of API operation parameter values.
1321
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1322
+ #
1323
+ # Returns a Files::RemoteServer.
1297
1324
  def self.create(params = {}, options = {})
1298
1325
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
1299
1326
  raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
@@ -1374,18 +1401,23 @@ module Files
1374
1401
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
1375
1402
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
1376
1403
 
1377
- response, options = Api.send_request("/remote_servers", :post, params, options)
1404
+ response, options = Api.send_request("/remote_servers", :post, params, options) { |reply| reply.require_object("RemoteServer") }
1378
1405
  RemoteServer.new(response.data, options)
1379
1406
  end
1380
1407
 
1381
1408
  # Push update to Files Agent
1409
+ #
1410
+ # params:: Hash of API operation parameter values.
1411
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1412
+ #
1413
+ # Returns a Files::AgentPushUpdate.
1382
1414
  def self.agent_push_update(id, params = {}, options = {})
1383
1415
  params ||= {}
1384
1416
  params[:id] = id
1385
1417
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
1386
1418
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1387
1419
 
1388
- response, options = Api.send_request("/remote_servers/#{params[:id]}/agent_push_update", :post, params, options)
1420
+ response, options = Api.send_request("/remote_servers/#{params[:id]}/agent_push_update", :post, params, options) { |reply| reply.require_object("AgentPushUpdate") }
1389
1421
  AgentPushUpdate.new(response.data, options)
1390
1422
  end
1391
1423
 
@@ -1473,6 +1505,11 @@ module Files
1473
1505
  # wasabi_access_key - string - Wasabi: Access Key.
1474
1506
  # wasabi_bucket - string - Wasabi: Bucket name
1475
1507
  # wasabi_region - string - Wasabi: Region
1508
+ #
1509
+ # params:: Hash of API operation parameter values.
1510
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1511
+ #
1512
+ # Returns a Files::RemoteServer.
1476
1513
  def self.update(id, params = {}, options = {})
1477
1514
  params ||= {}
1478
1515
  params[:id] = id
@@ -1555,10 +1592,14 @@ module Files
1555
1592
  raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
1556
1593
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
1557
1594
 
1558
- response, options = Api.send_request("/remote_servers/#{params[:id]}", :patch, params, options)
1595
+ response, options = Api.send_request("/remote_servers/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("RemoteServer") }
1559
1596
  RemoteServer.new(response.data, options)
1560
1597
  end
1561
1598
 
1599
+ # params:: Hash of API operation parameter values.
1600
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
1601
+ #
1602
+ # Returns nil.
1562
1603
  def self.delete(id, params = {}, options = {})
1563
1604
  params ||= {}
1564
1605
  params[:id] = id
@@ -436,7 +436,9 @@ module Files
436
436
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
437
437
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
438
438
 
439
- Api.send_request("/remote_server_credentials/#{@attributes[:id]}", :patch, params, @options)
439
+ response, options = Api.send_request("/remote_server_credentials/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("RemoteServerCredential") }
440
+ @attributes = response.data
441
+ [ response, options ]
440
442
  end
441
443
 
442
444
  def delete(params = {})
@@ -456,12 +458,12 @@ module Files
456
458
 
457
459
  def save
458
460
  if @attributes[:id]
459
- new_obj = update(@attributes)
461
+ update(@attributes)
460
462
  else
461
463
  new_obj = RemoteServerCredential.create(@attributes, @options)
464
+ @attributes = new_obj.attributes
462
465
  end
463
466
 
464
- @attributes = new_obj.attributes
465
467
  true
466
468
  end
467
469
 
@@ -471,6 +473,11 @@ module Files
471
473
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
472
474
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id` and `name`. Valid field combinations are `[ workspace_id, name ]`.
473
475
  # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
476
+ #
477
+ # params:: Hash of API operation parameter values.
478
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
479
+ #
480
+ # Returns a Files::List of Files::RemoteServerCredential objects.
474
481
  def self.list(params = {}, options = {})
475
482
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
476
483
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -478,8 +485,8 @@ module Files
478
485
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
479
486
  raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
480
487
 
481
- List.new(RemoteServerCredential, params) do
482
- Api.send_request("/remote_server_credentials", :get, params, options)
488
+ List.new(RemoteServerCredential, params) do |page_params, &check_page|
489
+ Api.send_request("/remote_server_credentials", :get, page_params, options, &check_page)
483
490
  end
484
491
  end
485
492
 
@@ -489,13 +496,18 @@ module Files
489
496
 
490
497
  # Parameters:
491
498
  # id (required) - int64 - Remote Server Credential ID.
499
+ #
500
+ # params:: Hash of API operation parameter values.
501
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
502
+ #
503
+ # Returns a Files::RemoteServerCredential.
492
504
  def self.find(id, params = {}, options = {})
493
505
  params ||= {}
494
506
  params[:id] = id
495
507
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
496
508
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
497
509
 
498
- response, options = Api.send_request("/remote_server_credentials/#{params[:id]}", :get, params, options)
510
+ response, options = Api.send_request("/remote_server_credentials/#{params[:id]}", :get, params, options) { |reply| reply.require_object("RemoteServerCredential") }
499
511
  RemoteServerCredential.new(response.data, options)
500
512
  end
501
513
 
@@ -540,6 +552,11 @@ module Files
540
552
  # wasabi_secret_key - string - Wasabi: Secret Key
541
553
  # workspace_id - int64 - Workspace ID (0 for default workspace)
542
554
  # copy_values_from_credential_id - int64 - ID of Remote Server Credential to copy omitted values from.
555
+ #
556
+ # params:: Hash of API operation parameter values.
557
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
558
+ #
559
+ # Returns a Files::RemoteServerCredential.
543
560
  def self.create(params = {}, options = {})
544
561
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
545
562
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
@@ -578,7 +595,7 @@ module Files
578
595
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
579
596
  raise InvalidParameterError.new("Bad parameter: copy_values_from_credential_id must be an Integer") if params[:copy_values_from_credential_id] and !params[:copy_values_from_credential_id].is_a?(Integer)
580
597
 
581
- response, options = Api.send_request("/remote_server_credentials", :post, params, options)
598
+ response, options = Api.send_request("/remote_server_credentials", :post, params, options) { |reply| reply.require_object("RemoteServerCredential") }
582
599
  RemoteServerCredential.new(response.data, options)
583
600
  end
584
601
 
@@ -617,6 +634,11 @@ module Files
617
634
  # sharepoint_client_certificate - string - SharePoint: PEM-encoded certificate and unencrypted private key for app-only authentication.
618
635
  # sharepoint_client_secret - string - SharePoint: Microsoft Entra application client secret for app-only authentication.
619
636
  # wasabi_secret_key - string - Wasabi: Secret Key
637
+ #
638
+ # params:: Hash of API operation parameter values.
639
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
640
+ #
641
+ # Returns a Files::RemoteServerCredential.
620
642
  def self.update(id, params = {}, options = {})
621
643
  params ||= {}
622
644
  params[:id] = id
@@ -657,10 +679,14 @@ module Files
657
679
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
658
680
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
659
681
 
660
- response, options = Api.send_request("/remote_server_credentials/#{params[:id]}", :patch, params, options)
682
+ response, options = Api.send_request("/remote_server_credentials/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("RemoteServerCredential") }
661
683
  RemoteServerCredential.new(response.data, options)
662
684
  end
663
685
 
686
+ # params:: Hash of API operation parameter values.
687
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
688
+ #
689
+ # Returns nil.
664
690
  def self.delete(id, params = {}, options = {})
665
691
  params ||= {}
666
692
  params[:id] = id