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
@@ -103,6 +103,11 @@ module Files
103
103
  # 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 `[ operation ]`, `[ status ]`, `[ src_remote_server_id ]`, `[ dest_remote_server_id ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, src_remote_server_id ]`, `[ operation, dest_remote_server_id ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, src_remote_server_id ]`, `[ status, dest_remote_server_id ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ src_remote_server_id, dest_remote_server_id ]`, `[ src_remote_server_id, path ]`, `[ src_remote_server_id, client_ip ]`, `[ src_remote_server_id, created_at ]`, `[ dest_remote_server_id, path ]`, `[ dest_remote_server_id, client_ip ]`, `[ dest_remote_server_id, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, src_remote_server_id ]`, `[ operation, status, dest_remote_server_id ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id ]`, `[ operation, src_remote_server_id, path ]`, `[ operation, src_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, created_at ]`, `[ operation, dest_remote_server_id, path ]`, `[ operation, dest_remote_server_id, client_ip ]`, `[ operation, dest_remote_server_id, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id ]`, `[ status, src_remote_server_id, path ]`, `[ status, src_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, created_at ]`, `[ status, dest_remote_server_id, path ]`, `[ status, dest_remote_server_id, client_ip ]`, `[ status, dest_remote_server_id, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, created_at ]`, `[ src_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, path, created_at ]`, `[ src_remote_server_id, client_ip, created_at ]`, `[ dest_remote_server_id, path, client_ip ]`, `[ dest_remote_server_id, path, created_at ]`, `[ dest_remote_server_id, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ operation, status, src_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, created_at ]`, `[ operation, status, dest_remote_server_id, path ]`, `[ operation, status, dest_remote_server_id, client_ip ]`, `[ operation, status, dest_remote_server_id, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ operation, src_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, path, created_at ]`, `[ operation, src_remote_server_id, client_ip, created_at ]`, `[ operation, dest_remote_server_id, path, client_ip ]`, `[ operation, dest_remote_server_id, path, created_at ]`, `[ operation, dest_remote_server_id, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ status, src_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, path, created_at ]`, `[ status, src_remote_server_id, client_ip, created_at ]`, `[ status, dest_remote_server_id, path, client_ip ]`, `[ status, dest_remote_server_id, path, created_at ]`, `[ status, dest_remote_server_id, client_ip, created_at ]`, `[ status, path, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ src_remote_server_id, path, client_ip, created_at ]`, `[ dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ operation, status, src_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, path, created_at ]`, `[ operation, status, src_remote_server_id, client_ip, created_at ]`, `[ operation, status, dest_remote_server_id, path, client_ip ]`, `[ operation, status, dest_remote_server_id, path, created_at ]`, `[ operation, status, dest_remote_server_id, client_ip, created_at ]`, `[ operation, status, path, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ operation, src_remote_server_id, path, client_ip, created_at ]`, `[ operation, dest_remote_server_id, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ status, src_remote_server_id, path, client_ip, created_at ]`, `[ status, dest_remote_server_id, path, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]` or `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`.
104
104
  # 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 `[ operation ]`, `[ status ]`, `[ src_remote_server_id ]`, `[ dest_remote_server_id ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, src_remote_server_id ]`, `[ operation, dest_remote_server_id ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, src_remote_server_id ]`, `[ status, dest_remote_server_id ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ src_remote_server_id, dest_remote_server_id ]`, `[ src_remote_server_id, path ]`, `[ src_remote_server_id, client_ip ]`, `[ src_remote_server_id, created_at ]`, `[ dest_remote_server_id, path ]`, `[ dest_remote_server_id, client_ip ]`, `[ dest_remote_server_id, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, src_remote_server_id ]`, `[ operation, status, dest_remote_server_id ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id ]`, `[ operation, src_remote_server_id, path ]`, `[ operation, src_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, created_at ]`, `[ operation, dest_remote_server_id, path ]`, `[ operation, dest_remote_server_id, client_ip ]`, `[ operation, dest_remote_server_id, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id ]`, `[ status, src_remote_server_id, path ]`, `[ status, src_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, created_at ]`, `[ status, dest_remote_server_id, path ]`, `[ status, dest_remote_server_id, client_ip ]`, `[ status, dest_remote_server_id, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, created_at ]`, `[ src_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, path, created_at ]`, `[ src_remote_server_id, client_ip, created_at ]`, `[ dest_remote_server_id, path, client_ip ]`, `[ dest_remote_server_id, path, created_at ]`, `[ dest_remote_server_id, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ operation, status, src_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, created_at ]`, `[ operation, status, dest_remote_server_id, path ]`, `[ operation, status, dest_remote_server_id, client_ip ]`, `[ operation, status, dest_remote_server_id, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ operation, src_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, path, created_at ]`, `[ operation, src_remote_server_id, client_ip, created_at ]`, `[ operation, dest_remote_server_id, path, client_ip ]`, `[ operation, dest_remote_server_id, path, created_at ]`, `[ operation, dest_remote_server_id, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ status, src_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, path, created_at ]`, `[ status, src_remote_server_id, client_ip, created_at ]`, `[ status, dest_remote_server_id, path, client_ip ]`, `[ status, dest_remote_server_id, path, created_at ]`, `[ status, dest_remote_server_id, client_ip, created_at ]`, `[ status, path, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ src_remote_server_id, path, client_ip, created_at ]`, `[ dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ operation, status, src_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, path, created_at ]`, `[ operation, status, src_remote_server_id, client_ip, created_at ]`, `[ operation, status, dest_remote_server_id, path, client_ip ]`, `[ operation, status, dest_remote_server_id, path, created_at ]`, `[ operation, status, dest_remote_server_id, client_ip, created_at ]`, `[ operation, status, path, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ operation, src_remote_server_id, path, client_ip, created_at ]`, `[ operation, dest_remote_server_id, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ status, src_remote_server_id, path, client_ip, created_at ]`, `[ status, dest_remote_server_id, path, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]` or `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`.
105
105
  # 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 `[ operation ]`, `[ status ]`, `[ src_remote_server_id ]`, `[ dest_remote_server_id ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, src_remote_server_id ]`, `[ operation, dest_remote_server_id ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, src_remote_server_id ]`, `[ status, dest_remote_server_id ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ src_remote_server_id, dest_remote_server_id ]`, `[ src_remote_server_id, path ]`, `[ src_remote_server_id, client_ip ]`, `[ src_remote_server_id, created_at ]`, `[ dest_remote_server_id, path ]`, `[ dest_remote_server_id, client_ip ]`, `[ dest_remote_server_id, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, src_remote_server_id ]`, `[ operation, status, dest_remote_server_id ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id ]`, `[ operation, src_remote_server_id, path ]`, `[ operation, src_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, created_at ]`, `[ operation, dest_remote_server_id, path ]`, `[ operation, dest_remote_server_id, client_ip ]`, `[ operation, dest_remote_server_id, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id ]`, `[ status, src_remote_server_id, path ]`, `[ status, src_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, created_at ]`, `[ status, dest_remote_server_id, path ]`, `[ status, dest_remote_server_id, client_ip ]`, `[ status, dest_remote_server_id, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, created_at ]`, `[ src_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, path, created_at ]`, `[ src_remote_server_id, client_ip, created_at ]`, `[ dest_remote_server_id, path, client_ip ]`, `[ dest_remote_server_id, path, created_at ]`, `[ dest_remote_server_id, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ operation, status, src_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, created_at ]`, `[ operation, status, dest_remote_server_id, path ]`, `[ operation, status, dest_remote_server_id, client_ip ]`, `[ operation, status, dest_remote_server_id, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ operation, src_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, path, created_at ]`, `[ operation, src_remote_server_id, client_ip, created_at ]`, `[ operation, dest_remote_server_id, path, client_ip ]`, `[ operation, dest_remote_server_id, path, created_at ]`, `[ operation, dest_remote_server_id, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ status, src_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, path, created_at ]`, `[ status, src_remote_server_id, client_ip, created_at ]`, `[ status, dest_remote_server_id, path, client_ip ]`, `[ status, dest_remote_server_id, path, created_at ]`, `[ status, dest_remote_server_id, client_ip, created_at ]`, `[ status, path, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ src_remote_server_id, path, client_ip, created_at ]`, `[ dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, created_at ]`, `[ operation, status, src_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, path, created_at ]`, `[ operation, status, src_remote_server_id, client_ip, created_at ]`, `[ operation, status, dest_remote_server_id, path, client_ip ]`, `[ operation, status, dest_remote_server_id, path, created_at ]`, `[ operation, status, dest_remote_server_id, client_ip, created_at ]`, `[ operation, status, path, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ operation, src_remote_server_id, path, client_ip, created_at ]`, `[ operation, dest_remote_server_id, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ status, src_remote_server_id, path, client_ip, created_at ]`, `[ status, dest_remote_server_id, path, client_ip, created_at ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, created_at ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip, created_at ]`, `[ operation, status, src_remote_server_id, path, client_ip, created_at ]`, `[ operation, status, dest_remote_server_id, path, client_ip, created_at ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]` or `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip, created_at ]`.
106
+ #
107
+ # params:: Hash of API operation parameter values.
108
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
109
+ #
110
+ # Returns a Files::List of Files::OutboundConnectionLog objects.
106
111
  def self.list(params = {}, options = {})
107
112
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
108
113
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -113,8 +118,8 @@ module Files
113
118
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
114
119
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
115
120
 
116
- List.new(OutboundConnectionLog, params) do
117
- Api.send_request("/outbound_connection_logs", :get, params, options)
121
+ List.new(OutboundConnectionLog, params) do |page_params, &check_page|
122
+ Api.send_request("/outbound_connection_logs", :get, page_params, options, &check_page)
118
123
  end
119
124
  end
120
125
 
@@ -232,7 +232,9 @@ module Files
232
232
  raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
233
233
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
234
234
 
235
- Api.send_request("/partners/#{@attributes[:id]}", :patch, params, @options)
235
+ response, options = Api.send_request("/partners/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("Partner") }
236
+ @attributes = response.data
237
+ [ response, options ]
236
238
  end
237
239
 
238
240
  def delete(params = {})
@@ -252,12 +254,12 @@ module Files
252
254
 
253
255
  def save
254
256
  if @attributes[:id]
255
- new_obj = update(@attributes)
257
+ update(@attributes)
256
258
  else
257
259
  new_obj = Partner.create(@attributes, @options)
260
+ @attributes = new_obj.attributes
258
261
  end
259
262
 
260
- @attributes = new_obj.attributes
261
263
  true
262
264
  end
263
265
 
@@ -266,14 +268,19 @@ module Files
266
268
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
267
269
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
268
270
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
271
+ #
272
+ # params:: Hash of API operation parameter values.
273
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
274
+ #
275
+ # Returns a Files::List of Files::Partner objects.
269
276
  def self.list(params = {}, options = {})
270
277
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
271
278
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
272
279
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
273
280
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
274
281
 
275
- List.new(Partner, params) do
276
- Api.send_request("/partners", :get, params, options)
282
+ List.new(Partner, params) do |page_params, &check_page|
283
+ Api.send_request("/partners", :get, page_params, options, &check_page)
277
284
  end
278
285
  end
279
286
 
@@ -283,13 +290,18 @@ module Files
283
290
 
284
291
  # Parameters:
285
292
  # id (required) - int64 - Partner ID.
293
+ #
294
+ # params:: Hash of API operation parameter values.
295
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
296
+ #
297
+ # Returns a Files::Partner.
286
298
  def self.find(id, params = {}, options = {})
287
299
  params ||= {}
288
300
  params[:id] = id
289
301
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
290
302
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
291
303
 
292
- response, options = Api.send_request("/partners/#{params[:id]}", :get, params, options)
304
+ response, options = Api.send_request("/partners/#{params[:id]}", :get, params, options) { |reply| reply.require_object("Partner") }
293
305
  Partner.new(response.data, options)
294
306
  end
295
307
 
@@ -314,6 +326,11 @@ module Files
314
326
  # name (required) - string - The name of the Partner.
315
327
  # root_folder (required) - string - The root folder path for this Partner.
316
328
  # workspace_id - int64 - ID of the Workspace associated with this Partner.
329
+ #
330
+ # params:: Hash of API operation parameter values.
331
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
332
+ #
333
+ # Returns a Files::Partner.
317
334
  def self.create(params = {}, options = {})
318
335
  raise InvalidParameterError.new("Bad parameter: ai_assistant_personality_id must be an Integer") if params[:ai_assistant_personality_id] and !params[:ai_assistant_personality_id].is_a?(Integer)
319
336
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
@@ -328,7 +345,7 @@ module Files
328
345
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]
329
346
  raise MissingParameterError.new("Parameter missing: root_folder") unless params[:root_folder]
330
347
 
331
- response, options = Api.send_request("/partners", :post, params, options)
348
+ response, options = Api.send_request("/partners", :post, params, options) { |reply| reply.require_object("Partner") }
332
349
  Partner.new(response.data, options)
333
350
  end
334
351
 
@@ -349,6 +366,11 @@ module Files
349
366
  # name - string - The name of the Partner.
350
367
  # partnership_role - string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
351
368
  # root_folder - string - The root folder path for this Partner.
369
+ #
370
+ # params:: Hash of API operation parameter values.
371
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
372
+ #
373
+ # Returns a Files::Partner.
352
374
  def self.update(id, params = {}, options = {})
353
375
  params ||= {}
354
376
  params[:id] = id
@@ -365,10 +387,14 @@ module Files
365
387
  raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
366
388
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
367
389
 
368
- response, options = Api.send_request("/partners/#{params[:id]}", :patch, params, options)
390
+ response, options = Api.send_request("/partners/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("Partner") }
369
391
  Partner.new(response.data, options)
370
392
  end
371
393
 
394
+ # params:: Hash of API operation parameter values.
395
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
396
+ #
397
+ # Returns nil.
372
398
  def self.delete(id, params = {}, options = {})
373
399
  params ||= {}
374
400
  params[:id] = id
@@ -196,7 +196,9 @@ module Files
196
196
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
197
197
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
198
198
 
199
- Api.send_request("/partner_channels/#{@attributes[:id]}", :patch, params, @options)
199
+ response, options = Api.send_request("/partner_channels/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("PartnerChannel") }
200
+ @attributes = response.data
201
+ [ response, options ]
200
202
  end
201
203
 
202
204
  def delete(params = {})
@@ -216,12 +218,12 @@ module Files
216
218
 
217
219
  def save
218
220
  if @attributes[:id]
219
- new_obj = update(@attributes)
221
+ update(@attributes)
220
222
  else
221
223
  new_obj = PartnerChannel.create(@attributes, @options)
224
+ @attributes = new_obj.attributes
222
225
  end
223
226
 
224
- @attributes = new_obj.attributes
225
227
  true
226
228
  end
227
229
 
@@ -230,14 +232,19 @@ module Files
230
232
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
231
233
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `path` or `partner_id`.
232
234
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `partner_id` and `workspace_id`. Valid field combinations are `[ workspace_id, partner_id ]`.
235
+ #
236
+ # params:: Hash of API operation parameter values.
237
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
238
+ #
239
+ # Returns a Files::List of Files::PartnerChannel objects.
233
240
  def self.list(params = {}, options = {})
234
241
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
235
242
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
236
243
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
237
244
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
238
245
 
239
- List.new(PartnerChannel, params) do
240
- Api.send_request("/partner_channels", :get, params, options)
246
+ List.new(PartnerChannel, params) do |page_params, &check_page|
247
+ Api.send_request("/partner_channels", :get, page_params, options, &check_page)
241
248
  end
242
249
  end
243
250
 
@@ -247,13 +254,18 @@ module Files
247
254
 
248
255
  # Parameters:
249
256
  # id (required) - int64 - Partner Channel ID.
257
+ #
258
+ # params:: Hash of API operation parameter values.
259
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
260
+ #
261
+ # Returns a Files::PartnerChannel.
250
262
  def self.find(id, params = {}, options = {})
251
263
  params ||= {}
252
264
  params[:id] = id
253
265
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
254
266
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
255
267
 
256
- response, options = Api.send_request("/partner_channels/#{params[:id]}", :get, params, options)
268
+ response, options = Api.send_request("/partner_channels/#{params[:id]}", :get, params, options) { |reply| reply.require_object("PartnerChannel") }
257
269
  PartnerChannel.new(response.data, options)
258
270
  end
259
271
 
@@ -273,6 +285,11 @@ module Files
273
285
  # partner_id (required) - int64 - ID of the Partner this Channel belongs to.
274
286
  # path (required) - string - Channel path relative to the Partner root folder.
275
287
  # workspace_id - int64 - ID of the Workspace associated with this Partner Channel.
288
+ #
289
+ # params:: Hash of API operation parameter values.
290
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
291
+ #
292
+ # Returns a Files::PartnerChannel.
276
293
  def self.create(params = {}, options = {})
277
294
  raise InvalidParameterError.new("Bad parameter: direction must be an String") if params[:direction] and !params[:direction].is_a?(String)
278
295
  raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
@@ -287,7 +304,7 @@ module Files
287
304
  raise MissingParameterError.new("Parameter missing: partner_id") unless params[:partner_id]
288
305
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]
289
306
 
290
- response, options = Api.send_request("/partner_channels", :post, params, options)
307
+ response, options = Api.send_request("/partner_channels", :post, params, options) { |reply| reply.require_object("PartnerChannel") }
291
308
  PartnerChannel.new(response.data, options)
292
309
  end
293
310
 
@@ -301,6 +318,11 @@ module Files
301
318
  # to_partner_managed_folder_paths - array(string) - Managed folder paths inside the to-Partner folder.
302
319
  # to_partner_route_path - string - Optional route path for files delivered to the Partner.
303
320
  # path - string - Channel path relative to the Partner root folder.
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 a Files::PartnerChannel.
304
326
  def self.update(id, params = {}, options = {})
305
327
  params ||= {}
306
328
  params[:id] = id
@@ -315,10 +337,14 @@ module Files
315
337
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
316
338
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
317
339
 
318
- response, options = Api.send_request("/partner_channels/#{params[:id]}", :patch, params, options)
340
+ response, options = Api.send_request("/partner_channels/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("PartnerChannel") }
319
341
  PartnerChannel.new(response.data, options)
320
342
  end
321
343
 
344
+ # params:: Hash of API operation parameter values.
345
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
346
+ #
347
+ # Returns nil.
322
348
  def self.delete(id, params = {}, options = {})
323
349
  params ||= {}
324
350
  params[:id] = id
@@ -162,7 +162,9 @@ module Files
162
162
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
163
163
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
164
164
 
165
- Api.send_request("/partner_channel_templates/#{@attributes[:id]}", :patch, params, @options)
165
+ response, options = Api.send_request("/partner_channel_templates/#{@attributes[:id]}", :patch, params, @options) { |reply| reply.require_object("PartnerChannelTemplate") }
166
+ @attributes = response.data
167
+ [ response, options ]
166
168
  end
167
169
 
168
170
  def delete(params = {})
@@ -182,12 +184,12 @@ module Files
182
184
 
183
185
  def save
184
186
  if @attributes[:id]
185
- new_obj = update(@attributes)
187
+ update(@attributes)
186
188
  else
187
189
  new_obj = PartnerChannelTemplate.create(@attributes, @options)
190
+ @attributes = new_obj.attributes
188
191
  end
189
192
 
190
- @attributes = new_obj.attributes
191
193
  true
192
194
  end
193
195
 
@@ -196,14 +198,19 @@ module Files
196
198
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
197
199
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
198
200
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
201
+ #
202
+ # params:: Hash of API operation parameter values.
203
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
204
+ #
205
+ # Returns a Files::List of Files::PartnerChannelTemplate objects.
199
206
  def self.list(params = {}, options = {})
200
207
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
201
208
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
202
209
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
203
210
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
204
211
 
205
- List.new(PartnerChannelTemplate, params) do
206
- Api.send_request("/partner_channel_templates", :get, params, options)
212
+ List.new(PartnerChannelTemplate, params) do |page_params, &check_page|
213
+ Api.send_request("/partner_channel_templates", :get, page_params, options, &check_page)
207
214
  end
208
215
  end
209
216
 
@@ -213,13 +220,18 @@ module Files
213
220
 
214
221
  # Parameters:
215
222
  # id (required) - int64 - Partner Channel Template ID.
223
+ #
224
+ # params:: Hash of API operation parameter values.
225
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
226
+ #
227
+ # Returns a Files::PartnerChannelTemplate.
216
228
  def self.find(id, params = {}, options = {})
217
229
  params ||= {}
218
230
  params[:id] = id
219
231
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
220
232
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
221
233
 
222
- response, options = Api.send_request("/partner_channel_templates/#{params[:id]}", :get, params, options)
234
+ response, options = Api.send_request("/partner_channel_templates/#{params[:id]}", :get, params, options) { |reply| reply.require_object("PartnerChannelTemplate") }
223
235
  PartnerChannelTemplate.new(response.data, options)
224
236
  end
225
237
 
@@ -239,6 +251,11 @@ module Files
239
251
  # name (required) - string - The name of the Partner Channel Template.
240
252
  # path (required) - string - Channel path relative to the Partner root folder.
241
253
  # workspace_id - int64 - ID of the Workspace associated with this Partner Channel Template.
254
+ #
255
+ # params:: Hash of API operation parameter values.
256
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
257
+ #
258
+ # Returns a Files::PartnerChannelTemplate.
242
259
  def self.create(params = {}, options = {})
243
260
  raise InvalidParameterError.new("Bad parameter: direction must be an String") if params[:direction] and !params[:direction].is_a?(String)
244
261
  raise InvalidParameterError.new("Bad parameter: from_partner_folder_name must be an String") if params[:from_partner_folder_name] and !params[:from_partner_folder_name].is_a?(String)
@@ -253,7 +270,7 @@ module Files
253
270
  raise MissingParameterError.new("Parameter missing: name") unless params[:name]
254
271
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]
255
272
 
256
- response, options = Api.send_request("/partner_channel_templates", :post, params, options)
273
+ response, options = Api.send_request("/partner_channel_templates", :post, params, options) { |reply| reply.require_object("PartnerChannelTemplate") }
257
274
  PartnerChannelTemplate.new(response.data, options)
258
275
  end
259
276
 
@@ -268,6 +285,11 @@ module Files
268
285
  # to_partner_route_path_pattern - string - Optional route path pattern for files delivered to the Partner. Supports {{partner_name}}.
269
286
  # name - string - The name of the Partner Channel Template.
270
287
  # path - string - Channel path relative to the Partner root folder.
288
+ #
289
+ # params:: Hash of API operation parameter values.
290
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
291
+ #
292
+ # Returns a Files::PartnerChannelTemplate.
271
293
  def self.update(id, params = {}, options = {})
272
294
  params ||= {}
273
295
  params[:id] = id
@@ -283,10 +305,14 @@ module Files
283
305
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
284
306
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
285
307
 
286
- response, options = Api.send_request("/partner_channel_templates/#{params[:id]}", :patch, params, options)
308
+ response, options = Api.send_request("/partner_channel_templates/#{params[:id]}", :patch, params, options) { |reply| reply.require_object("PartnerChannelTemplate") }
287
309
  PartnerChannelTemplate.new(response.data, options)
288
310
  end
289
311
 
312
+ # params:: Hash of API operation parameter values.
313
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
314
+ #
315
+ # Returns nil.
290
316
  def self.delete(id, params = {}, options = {})
291
317
  params ||= {}
292
318
  params[:id] = id
@@ -24,6 +24,10 @@ module Files
24
24
  nil
25
25
  end
26
26
 
27
+ # params:: Hash of API operation parameter values.
28
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
29
+ #
30
+ # Returns nil.
27
31
  def self.delete(id, params = {}, options = {})
28
32
  params ||= {}
29
33
  params[:id] = id
@@ -93,9 +93,9 @@ module Files
93
93
  raise NotImplementedError.new("The PartnerSiteRequest object doesn't support updates.")
94
94
  else
95
95
  new_obj = PartnerSiteRequest.create(@attributes, @options)
96
+ @attributes = new_obj.attributes
96
97
  end
97
98
 
98
- @attributes = new_obj.attributes
99
99
  true
100
100
  end
101
101
 
@@ -104,14 +104,19 @@ module Files
104
104
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
105
105
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `host_partner_id`.
106
106
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `host_partner_id`.
107
+ #
108
+ # params:: Hash of API operation parameter values.
109
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
110
+ #
111
+ # Returns a Files::List of Files::PartnerSiteRequest objects.
107
112
  def self.list(params = {}, options = {})
108
113
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
109
114
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
110
115
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
111
116
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
112
117
 
113
- List.new(PartnerSiteRequest, params) do
114
- Api.send_request("/partner_site_requests", :get, params, options)
118
+ List.new(PartnerSiteRequest, params) do |page_params, &check_page|
119
+ Api.send_request("/partner_site_requests", :get, page_params, options, &check_page)
115
120
  end
116
121
  end
117
122
 
@@ -121,6 +126,11 @@ module Files
121
126
 
122
127
  # Parameters:
123
128
  # pairing_key (required) - string - Pairing key for the partner site request
129
+ #
130
+ # params:: Hash of API operation parameter values.
131
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
132
+ #
133
+ # Returns nil.
124
134
  def self.find_by_pairing_key(params = {}, options = {})
125
135
  raise InvalidParameterError.new("Bad parameter: pairing_key must be an String") if params[:pairing_key] and !params[:pairing_key].is_a?(String)
126
136
  raise MissingParameterError.new("Parameter missing: pairing_key") unless params[:pairing_key]
@@ -132,18 +142,28 @@ module Files
132
142
  # Parameters:
133
143
  # host_partner_id (required) - int64 - Host Partner ID to link with
134
144
  # guest_site_url (required) - string - Guest Site URL to link to
145
+ #
146
+ # params:: Hash of API operation parameter values.
147
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
148
+ #
149
+ # Returns a Files::PartnerSiteRequest.
135
150
  def self.create(params = {}, options = {})
136
151
  raise InvalidParameterError.new("Bad parameter: host_partner_id must be an Integer") if params[:host_partner_id] and !params[:host_partner_id].is_a?(Integer)
137
152
  raise InvalidParameterError.new("Bad parameter: guest_site_url must be an String") if params[:guest_site_url] and !params[:guest_site_url].is_a?(String)
138
153
  raise MissingParameterError.new("Parameter missing: host_partner_id") unless params[:host_partner_id]
139
154
  raise MissingParameterError.new("Parameter missing: guest_site_url") unless params[:guest_site_url]
140
155
 
141
- response, options = Api.send_request("/partner_site_requests", :post, params, options)
156
+ response, options = Api.send_request("/partner_site_requests", :post, params, options) { |reply| reply.require_object("PartnerSiteRequest") }
142
157
  PartnerSiteRequest.new(response.data, options)
143
158
  end
144
159
 
145
160
  # Parameters:
146
161
  # pairing_key (required) - string - Pairing key for the partner site request
162
+ #
163
+ # params:: Hash of API operation parameter values.
164
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
165
+ #
166
+ # Returns nil.
147
167
  def self.reject(params = {}, options = {})
148
168
  raise InvalidParameterError.new("Bad parameter: pairing_key must be an String") if params[:pairing_key] and !params[:pairing_key].is_a?(String)
149
169
  raise MissingParameterError.new("Parameter missing: pairing_key") unless params[:pairing_key]
@@ -155,6 +175,11 @@ module Files
155
175
  # Parameters:
156
176
  # pairing_key (required) - string - Pairing key for the partner site request
157
177
  # partner_id - int64 - ID of an existing Partner on this site, with the host role, that represents the requesting organization. The connection binds to that Partner and makes it host_and_guest. When omitted, a guest Partner named after the host site is created.
178
+ #
179
+ # params:: Hash of API operation parameter values.
180
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
181
+ #
182
+ # Returns nil.
158
183
  def self.approve(params = {}, options = {})
159
184
  raise InvalidParameterError.new("Bad parameter: pairing_key must be an String") if params[:pairing_key] and !params[:pairing_key].is_a?(String)
160
185
  raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
@@ -164,6 +189,10 @@ module Files
164
189
  nil
165
190
  end
166
191
 
192
+ # params:: Hash of API operation parameter values.
193
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
194
+ #
195
+ # Returns nil.
167
196
  def self.delete(id, params = {}, options = {})
168
197
  params ||= {}
169
198
  params[:id] = id
@@ -85,12 +85,17 @@ module Files
85
85
  # Parameters:
86
86
  # 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.
87
87
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
88
+ #
89
+ # params:: Hash of API operation parameter values.
90
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
91
+ #
92
+ # Returns a Files::List of Files::AccountLineItem objects.
88
93
  def self.list(params = {}, options = {})
89
94
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
90
95
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
91
96
 
92
- List.new(AccountLineItem, params) do
93
- Api.send_request("/payments", :get, params, options)
97
+ List.new(AccountLineItem, params) do |page_params, &check_page|
98
+ Api.send_request("/payments", :get, page_params, options, &check_page)
94
99
  end
95
100
  end
96
101
 
@@ -100,13 +105,18 @@ module Files
100
105
 
101
106
  # Parameters:
102
107
  # id (required) - int64 - Payment ID.
108
+ #
109
+ # params:: Hash of API operation parameter values.
110
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
111
+ #
112
+ # Returns a Files::AccountLineItem.
103
113
  def self.find(id, params = {}, options = {})
104
114
  params ||= {}
105
115
  params[:id] = id
106
116
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
107
117
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
108
118
 
109
- response, options = Api.send_request("/payments/#{params[:id]}", :get, params, options)
119
+ response, options = Api.send_request("/payments/#{params[:id]}", :get, params, options) { |reply| reply.require_object("AccountLineItem") }
110
120
  AccountLineItem.new(response.data, options)
111
121
  end
112
122
 
@@ -58,6 +58,11 @@ module Files
58
58
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
59
59
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
60
60
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
61
+ #
62
+ # params:: Hash of API operation parameter values.
63
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
64
+ #
65
+ # Returns a Files::List of Files::PendingWorkEvent objects.
61
66
  def self.list(params = {}, options = {})
62
67
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
63
68
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -68,8 +73,8 @@ module Files
68
73
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
69
74
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
70
75
 
71
- List.new(PendingWorkEvent, params) do
72
- Api.send_request("/pending_work_events", :get, params, options)
76
+ List.new(PendingWorkEvent, params) do |page_params, &check_page|
77
+ Api.send_request("/pending_work_events", :get, page_params, options, &check_page)
73
78
  end
74
79
  end
75
80
 
@@ -79,13 +84,18 @@ module Files
79
84
 
80
85
  # Parameters:
81
86
  # id (required) - int64 - Pending Work Event ID.
87
+ #
88
+ # params:: Hash of API operation parameter values.
89
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
90
+ #
91
+ # Returns a Files::PendingWorkEvent.
82
92
  def self.find(id, params = {}, options = {})
83
93
  params ||= {}
84
94
  params[:id] = id
85
95
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
86
96
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
87
97
 
88
- response, options = Api.send_request("/pending_work_events/#{params[:id]}", :get, params, options)
98
+ response, options = Api.send_request("/pending_work_events/#{params[:id]}", :get, params, options) { |reply| reply.require_object("PendingWorkEvent") }
89
99
  PendingWorkEvent.new(response.data, options)
90
100
  end
91
101