files.com 1.1.769 → 1.1.771

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 (122) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/remote_server.md +8 -0
  4. data/lib/files.com/models/action_log.rb +5 -0
  5. data/lib/files.com/models/action_notification_export.rb +10 -0
  6. data/lib/files.com/models/action_notification_export_result.rb +5 -0
  7. data/lib/files.com/models/ai_assistant_personality.rb +24 -0
  8. data/lib/files.com/models/ai_task.rb +29 -0
  9. data/lib/files.com/models/api_key.rb +37 -0
  10. data/lib/files.com/models/api_request_log.rb +5 -0
  11. data/lib/files.com/models/app.rb +5 -0
  12. data/lib/files.com/models/as2_incoming_message.rb +5 -0
  13. data/lib/files.com/models/as2_outgoing_message.rb +5 -0
  14. data/lib/files.com/models/as2_partner.rb +24 -0
  15. data/lib/files.com/models/as2_station.rb +24 -0
  16. data/lib/files.com/models/automation.rb +38 -0
  17. data/lib/files.com/models/automation_log.rb +5 -0
  18. data/lib/files.com/models/automation_run.rb +25 -0
  19. data/lib/files.com/models/bandwidth_snapshot.rb +5 -0
  20. data/lib/files.com/models/behavior.rb +34 -0
  21. data/lib/files.com/models/bundle.rb +29 -0
  22. data/lib/files.com/models/bundle_action.rb +5 -0
  23. data/lib/files.com/models/bundle_download.rb +5 -0
  24. data/lib/files.com/models/bundle_notification.rb +24 -0
  25. data/lib/files.com/models/bundle_recipient.rb +10 -0
  26. data/lib/files.com/models/bundle_registration.rb +5 -0
  27. data/lib/files.com/models/chat_session.rb +10 -0
  28. data/lib/files.com/models/child_site_management_policy.rb +24 -0
  29. data/lib/files.com/models/clickwrap.rb +24 -0
  30. data/lib/files.com/models/custom_domain.rb +29 -0
  31. data/lib/files.com/models/desktop_configuration_profile.rb +24 -0
  32. data/lib/files.com/models/dns_record.rb +5 -0
  33. data/lib/files.com/models/email_incoming_message.rb +5 -0
  34. data/lib/files.com/models/email_log.rb +5 -0
  35. data/lib/files.com/models/event_channel.rb +24 -0
  36. data/lib/files.com/models/event_delivery_attempt.rb +10 -0
  37. data/lib/files.com/models/event_record.rb +10 -0
  38. data/lib/files.com/models/event_subscription.rb +24 -0
  39. data/lib/files.com/models/event_target.rb +24 -0
  40. data/lib/files.com/models/exavault_api_request_log.rb +5 -0
  41. data/lib/files.com/models/expectation.rb +29 -0
  42. data/lib/files.com/models/expectation_evaluation.rb +10 -0
  43. data/lib/files.com/models/expectation_incident.rb +25 -0
  44. data/lib/files.com/models/external_event.rb +15 -0
  45. data/lib/files.com/models/file.rb +70 -0
  46. data/lib/files.com/models/file_comment.rb +19 -0
  47. data/lib/files.com/models/file_comment_reaction.rb +9 -0
  48. data/lib/files.com/models/file_migration.rb +5 -0
  49. data/lib/files.com/models/file_migration_log.rb +5 -0
  50. data/lib/files.com/models/folder.rb +10 -0
  51. data/lib/files.com/models/form_field_set.rb +24 -0
  52. data/lib/files.com/models/ftp_action_log.rb +5 -0
  53. data/lib/files.com/models/gpg_key.rb +24 -0
  54. data/lib/files.com/models/group.rb +24 -0
  55. data/lib/files.com/models/group_user.rb +20 -0
  56. data/lib/files.com/models/history.rb +25 -0
  57. data/lib/files.com/models/history_export.rb +10 -0
  58. data/lib/files.com/models/history_export_result.rb +5 -0
  59. data/lib/files.com/models/holiday_calendar.rb +24 -0
  60. data/lib/files.com/models/holiday_region.rb +5 -0
  61. data/lib/files.com/models/inbound_s3_log.rb +5 -0
  62. data/lib/files.com/models/inbox_recipient.rb +10 -0
  63. data/lib/files.com/models/inbox_registration.rb +5 -0
  64. data/lib/files.com/models/inbox_upload.rb +5 -0
  65. data/lib/files.com/models/integration_centric_profile.rb +24 -0
  66. data/lib/files.com/models/invoice.rb +10 -0
  67. data/lib/files.com/models/ip_address.rb +20 -0
  68. data/lib/files.com/models/key_lifecycle_rule.rb +24 -0
  69. data/lib/files.com/models/lock.rb +15 -0
  70. data/lib/files.com/models/metadata_category.rb +29 -0
  71. data/lib/files.com/models/notification.rb +24 -0
  72. data/lib/files.com/models/outbound_connection_log.rb +5 -0
  73. data/lib/files.com/models/partner.rb +24 -0
  74. data/lib/files.com/models/partner_channel.rb +24 -0
  75. data/lib/files.com/models/partner_channel_template.rb +24 -0
  76. data/lib/files.com/models/partner_site.rb +4 -0
  77. data/lib/files.com/models/partner_site_request.rb +29 -0
  78. data/lib/files.com/models/payment.rb +10 -0
  79. data/lib/files.com/models/pending_work_event.rb +10 -0
  80. data/lib/files.com/models/permission.rb +14 -0
  81. data/lib/files.com/models/public_hosting_request_log.rb +5 -0
  82. data/lib/files.com/models/public_key.rb +24 -0
  83. data/lib/files.com/models/remote_bandwidth_snapshot.rb +5 -0
  84. data/lib/files.com/models/remote_mount_backend.rb +29 -0
  85. data/lib/files.com/models/remote_server.rb +54 -0
  86. data/lib/files.com/models/remote_server_credential.rb +24 -0
  87. data/lib/files.com/models/request.rb +19 -0
  88. data/lib/files.com/models/restore.rb +10 -0
  89. data/lib/files.com/models/schedule.rb +24 -0
  90. data/lib/files.com/models/scheduled_export.rb +24 -0
  91. data/lib/files.com/models/scim_log.rb +10 -0
  92. data/lib/files.com/models/secret.rb +24 -0
  93. data/lib/files.com/models/session.rb +9 -0
  94. data/lib/files.com/models/settings_change.rb +5 -0
  95. data/lib/files.com/models/sftp_action_log.rb +5 -0
  96. data/lib/files.com/models/sftp_host_key.rb +24 -0
  97. data/lib/files.com/models/share_group.rb +24 -0
  98. data/lib/files.com/models/siem_http_destination.rb +29 -0
  99. data/lib/files.com/models/siem_http_destination_event.rb +10 -0
  100. data/lib/files.com/models/site.rb +13 -0
  101. data/lib/files.com/models/site_subdomain_redirect.rb +14 -0
  102. data/lib/files.com/models/snapshot.rb +29 -0
  103. data/lib/files.com/models/sso_event.rb +10 -0
  104. data/lib/files.com/models/sso_strategy.rb +15 -0
  105. data/lib/files.com/models/style.rb +14 -0
  106. data/lib/files.com/models/sync.rb +34 -0
  107. data/lib/files.com/models/sync_log.rb +5 -0
  108. data/lib/files.com/models/sync_run.rb +10 -0
  109. data/lib/files.com/models/usage_daily_snapshot.rb +5 -0
  110. data/lib/files.com/models/usage_snapshot.rb +5 -0
  111. data/lib/files.com/models/user.rb +40 -0
  112. data/lib/files.com/models/user_additional_email_recipient.rb +24 -0
  113. data/lib/files.com/models/user_cipher_use.rb +5 -0
  114. data/lib/files.com/models/user_lifecycle_rule.rb +24 -0
  115. data/lib/files.com/models/user_request.rb +19 -0
  116. data/lib/files.com/models/user_security_event.rb +10 -0
  117. data/lib/files.com/models/user_sftp_client_use.rb +5 -0
  118. data/lib/files.com/models/web_dav_action_log.rb +5 -0
  119. data/lib/files.com/models/webhook_test.rb +5 -0
  120. data/lib/files.com/models/workspace.rb +24 -0
  121. data/lib/files.com/version.rb +1 -1
  122. metadata +2 -2
@@ -92,6 +92,11 @@ module Files
92
92
  # 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.
93
93
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
94
94
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
95
+ #
96
+ # params:: Hash of API operation parameter values.
97
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
98
+ #
99
+ # Returns a Files::List of Files::HolidayCalendar objects.
95
100
  def self.list(params = {}, options = {})
96
101
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
97
102
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -108,6 +113,11 @@ module Files
108
113
 
109
114
  # Parameters:
110
115
  # id (required) - int64 - Holiday Calendar ID.
116
+ #
117
+ # params:: Hash of API operation parameter values.
118
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
119
+ #
120
+ # Returns a Files::HolidayCalendar.
111
121
  def self.find(id, params = {}, options = {})
112
122
  params ||= {}
113
123
  params[:id] = id
@@ -125,6 +135,11 @@ module Files
125
135
  # Parameters:
126
136
  # definition (required) - object - Holiday rules for the calendar.
127
137
  # name (required) - string - Holiday Calendar name.
138
+ #
139
+ # params:: Hash of API operation parameter values.
140
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
141
+ #
142
+ # Returns a Files::HolidayCalendar.
128
143
  def self.create(params = {}, options = {})
129
144
  raise InvalidParameterError.new("Bad parameter: definition must be an Hash") if params[:definition] and !params[:definition].is_a?(Hash)
130
145
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
@@ -138,6 +153,11 @@ module Files
138
153
  # Parameters:
139
154
  # definition - object - Holiday rules for the calendar.
140
155
  # name - string - Holiday Calendar name.
156
+ #
157
+ # params:: Hash of API operation parameter values.
158
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
159
+ #
160
+ # Returns a Files::HolidayCalendar.
141
161
  def self.update(id, params = {}, options = {})
142
162
  params ||= {}
143
163
  params[:id] = id
@@ -150,6 +170,10 @@ module Files
150
170
  HolidayCalendar.new(response.data, options)
151
171
  end
152
172
 
173
+ # params:: Hash of API operation parameter values.
174
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
175
+ #
176
+ # Returns nil.
153
177
  def self.delete(id, params = {}, options = {})
154
178
  params ||= {}
155
179
  params[:id] = id
@@ -22,6 +22,11 @@ module Files
22
22
  # Parameters:
23
23
  # 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.
24
24
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
25
+ #
26
+ # params:: Hash of API operation parameter values.
27
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
28
+ #
29
+ # Returns a Files::List of Files::HolidayRegion objects.
25
30
  def self.get_supported(params = {}, options = {})
26
31
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
27
32
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -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 `operation`, `status`, `path` or `client_ip`. Valid field combinations are `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, 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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, 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 `[ operation ]`, `[ status ]`, `[ path ]`, `[ client_ip ]`, `[ created_at ]`, `[ operation, status ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ operation, created_at ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ status, created_at ]`, `[ path, client_ip ]`, `[ path, created_at ]`, `[ client_ip, created_at ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, status, created_at ]`, `[ operation, path, client_ip ]`, `[ operation, path, created_at ]`, `[ operation, client_ip, created_at ]`, `[ status, path, client_ip ]`, `[ status, path, created_at ]`, `[ status, client_ip, created_at ]`, `[ path, client_ip, created_at ]`, `[ operation, status, path, client_ip ]`, `[ operation, status, path, created_at ]`, `[ operation, status, client_ip, created_at ]`, `[ operation, path, client_ip, created_at ]` or `[ status, path, client_ip, 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::InboundS3Log 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)
@@ -89,6 +89,11 @@ module Files
89
89
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
90
90
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
91
91
  # inbox_id (required) - int64 - List recipients for the inbox with this ID.
92
+ #
93
+ # params:: Hash of API operation parameter values.
94
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
95
+ #
96
+ # Returns a Files::List of Files::InboxRecipient objects.
92
97
  def self.list(params = {}, options = {})
93
98
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
94
99
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -113,6 +118,11 @@ module Files
113
118
  # company - string - Company of recipient.
114
119
  # note - string - Note to include in email.
115
120
  # share_after_create - boolean - Set to true to share the link with the recipient upon creation.
121
+ #
122
+ # params:: Hash of API operation parameter values.
123
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
124
+ #
125
+ # Returns a Files::InboxRecipient.
116
126
  def self.create(params = {}, options = {})
117
127
  raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
118
128
  raise InvalidParameterError.new("Bad parameter: recipient must be an String") if params[:recipient] and !params[:recipient].is_a?(String)
@@ -73,6 +73,11 @@ module Files
73
73
  # 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.
74
74
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
75
75
  # folder_behavior_id - int64 - ID of the associated Inbox. This is required if the user is not a site admin.
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::InboxRegistration 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)
@@ -33,6 +33,11 @@ module Files
33
33
  # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
34
34
  # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
35
35
  # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
36
+ #
37
+ # params:: Hash of API operation parameter values.
38
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
39
+ #
40
+ # Returns a Files::List of Files::InboxUpload objects.
36
41
  def self.list(params = {}, options = {})
37
42
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
38
43
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -105,6 +105,11 @@ module Files
105
105
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
106
106
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
107
107
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_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::List of Files::IntegrationCentricProfile objects.
108
113
  def self.list(params = {}, options = {})
109
114
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
110
115
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -122,6 +127,11 @@ module Files
122
127
 
123
128
  # Parameters:
124
129
  # id (required) - int64 - Integration Centric Profile ID.
130
+ #
131
+ # params:: Hash of API operation parameter values.
132
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
133
+ #
134
+ # Returns a Files::IntegrationCentricProfile.
125
135
  def self.find(id, params = {}, options = {})
126
136
  params ||= {}
127
137
  params[:id] = id
@@ -141,6 +151,11 @@ module Files
141
151
  # expected_remote_servers (required) - array(object) - Remote Server integrations the user is expected to add and connect. Each entry requires `server_type` and may include a display `name`.
142
152
  # workspace_id - int64 - Workspace ID
143
153
  # use_for_all_users - boolean - Whether this profile applies to all users in the Workspace by default
154
+ #
155
+ # params:: Hash of API operation parameter values.
156
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
157
+ #
158
+ # Returns a Files::IntegrationCentricProfile.
144
159
  def self.create(params = {}, options = {})
145
160
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
146
161
  raise InvalidParameterError.new("Bad parameter: expected_remote_servers must be an Array") if params[:expected_remote_servers] and !params[:expected_remote_servers].is_a?(Array)
@@ -157,6 +172,11 @@ module Files
157
172
  # workspace_id - int64 - Workspace ID
158
173
  # expected_remote_servers - array(object) - Remote Server integrations the user is expected to add and connect. Each entry requires `server_type` and may include a display `name`.
159
174
  # use_for_all_users - boolean - Whether this profile applies to all users in the Workspace by default
175
+ #
176
+ # params:: Hash of API operation parameter values.
177
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
178
+ #
179
+ # Returns a Files::IntegrationCentricProfile.
160
180
  def self.update(id, params = {}, options = {})
161
181
  params ||= {}
162
182
  params[:id] = id
@@ -170,6 +190,10 @@ module Files
170
190
  IntegrationCentricProfile.new(response.data, options)
171
191
  end
172
192
 
193
+ # params:: Hash of API operation parameter values.
194
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
195
+ #
196
+ # Returns nil.
173
197
  def self.delete(id, params = {}, options = {})
174
198
  params ||= {}
175
199
  params[:id] = id
@@ -85,6 +85,11 @@ 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)
@@ -100,6 +105,11 @@ module Files
100
105
 
101
106
  # Parameters:
102
107
  # id (required) - int64 - Invoice 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
@@ -32,6 +32,11 @@ module Files
32
32
  # Parameters:
33
33
  # 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.
34
34
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
35
+ #
36
+ # params:: Hash of API operation parameter values.
37
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
38
+ #
39
+ # Returns a Files::List of Files::IpAddress objects.
35
40
  def self.list(params = {}, options = {})
36
41
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
37
42
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -48,6 +53,11 @@ module Files
48
53
  # Parameters:
49
54
  # 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.
50
55
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
56
+ #
57
+ # params:: Hash of API operation parameter values.
58
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
59
+ #
60
+ # Returns a Files::List of Files::PublicIpAddress objects.
51
61
  def self.get_smartfile_reserved(params = {}, options = {})
52
62
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
53
63
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -60,6 +70,11 @@ module Files
60
70
  # Parameters:
61
71
  # 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.
62
72
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
73
+ #
74
+ # params:: Hash of API operation parameter values.
75
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
76
+ #
77
+ # Returns a Files::List of Files::PublicIpAddress objects.
63
78
  def self.get_exavault_reserved(params = {}, options = {})
64
79
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
65
80
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -72,6 +87,11 @@ module Files
72
87
  # Parameters:
73
88
  # 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.
74
89
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
90
+ #
91
+ # params:: Hash of API operation parameter values.
92
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
93
+ #
94
+ # Returns a Files::List of Files::PublicIpAddress objects.
75
95
  def self.get_reserved(params = {}, options = {})
76
96
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
77
97
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -127,6 +127,11 @@ module Files
127
127
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
128
128
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `key_type`.
129
129
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type` and `workspace_id`. Valid field combinations are `[ workspace_id, key_type ]`.
130
+ #
131
+ # params:: Hash of API operation parameter values.
132
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
133
+ #
134
+ # Returns a Files::List of Files::KeyLifecycleRule objects.
130
135
  def self.list(params = {}, options = {})
131
136
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
132
137
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -144,6 +149,11 @@ module Files
144
149
 
145
150
  # Parameters:
146
151
  # id (required) - int64 - Key Lifecycle Rule ID.
152
+ #
153
+ # params:: Hash of API operation parameter values.
154
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
155
+ #
156
+ # Returns a Files::KeyLifecycleRule.
147
157
  def self.find(id, params = {}, options = {})
148
158
  params ||= {}
149
159
  params[:id] = id
@@ -165,6 +175,11 @@ module Files
165
175
  # inactivity_days - int64 - Number of days of inactivity before the rule applies.
166
176
  # name - string - Key Lifecycle Rule name
167
177
  # workspace_id - int64 - Workspace ID. `0` means the default workspace.
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 a Files::KeyLifecycleRule.
168
183
  def self.create(params = {}, options = {})
169
184
  raise InvalidParameterError.new("Bad parameter: expiration_days must be an Integer") if params[:expiration_days] and !params[:expiration_days].is_a?(Integer)
170
185
  raise InvalidParameterError.new("Bad parameter: key_type must be an String") if params[:key_type] and !params[:key_type].is_a?(String)
@@ -183,6 +198,11 @@ module Files
183
198
  # inactivity_days - int64 - Number of days of inactivity before the rule applies.
184
199
  # name - string - Key Lifecycle Rule name
185
200
  # workspace_id - int64 - Workspace ID. `0` means the default workspace.
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::KeyLifecycleRule.
186
206
  def self.update(id, params = {}, options = {})
187
207
  params ||= {}
188
208
  params[:id] = id
@@ -198,6 +218,10 @@ module Files
198
218
  KeyLifecycleRule.new(response.data, options)
199
219
  end
200
220
 
221
+ # params:: Hash of API operation parameter values.
222
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
223
+ #
224
+ # Returns nil.
201
225
  def self.delete(id, params = {}, options = {})
202
226
  params ||= {}
203
227
  params[:id] = id
@@ -156,6 +156,11 @@ module Files
156
156
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
157
157
  # path (required) - string - Path to operate on.
158
158
  # include_children - boolean - Include locks from children objects?
159
+ #
160
+ # params:: Hash of API operation parameter values.
161
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
162
+ #
163
+ # Returns a Files::List of Files::Lock objects.
159
164
  def self.list_for(path, params = {}, options = {})
160
165
  params ||= {}
161
166
  params[:path] = path
@@ -178,6 +183,11 @@ module Files
178
183
  # recursive - boolean - Does lock apply to subfolders?
179
184
  # owner - string - Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
180
185
  # timeout - int64 - Lock timeout in seconds
186
+ #
187
+ # params:: Hash of API operation parameter values.
188
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
189
+ #
190
+ # Returns a Files::Lock.
181
191
  def self.create(path, params = {}, options = {})
182
192
  params ||= {}
183
193
  params[:path] = path
@@ -194,6 +204,11 @@ module Files
194
204
 
195
205
  # Parameters:
196
206
  # token (required) - string - Lock token
207
+ #
208
+ # params:: Hash of API operation parameter values.
209
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
210
+ #
211
+ # Returns nil.
197
212
  def self.delete(path, params = {}, options = {})
198
213
  params ||= {}
199
214
  params[:path] = path
@@ -92,6 +92,11 @@ module Files
92
92
  # 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.
93
93
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
94
94
  # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
95
+ #
96
+ # params:: Hash of API operation parameter values.
97
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
98
+ #
99
+ # Returns a Files::List of Files::MetadataCategory objects.
95
100
  def self.list(params = {}, options = {})
96
101
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
97
102
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -108,6 +113,11 @@ module Files
108
113
 
109
114
  # Parameters:
110
115
  # id (required) - int64 - Metadata Category ID.
116
+ #
117
+ # params:: Hash of API operation parameter values.
118
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
119
+ #
120
+ # Returns a Files::MetadataCategory.
111
121
  def self.find(id, params = {}, options = {})
112
122
  params ||= {}
113
123
  params[:id] = id
@@ -126,6 +136,11 @@ module Files
126
136
  # 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.
127
137
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
128
138
  # path (required) - string - Path to operate on.
139
+ #
140
+ # params:: Hash of API operation parameter values.
141
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
142
+ #
143
+ # Returns a Files::List of Files::MetadataCategory objects.
129
144
  def self.list_for(path, params = {}, options = {})
130
145
  params ||= {}
131
146
  params[:path] = path
@@ -142,6 +157,11 @@ module Files
142
157
  # Parameters:
143
158
  # name (required) - string - Name of the metadata category.
144
159
  # default_columns - array(string) - Metadata keys that should appear as columns in the UI by default.
160
+ #
161
+ # params:: Hash of API operation parameter values.
162
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
163
+ #
164
+ # Returns a Files::MetadataCategory.
145
165
  def self.create(params = {}, options = {})
146
166
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
147
167
  raise InvalidParameterError.new("Bad parameter: default_columns must be an Array") if params[:default_columns] and !params[:default_columns].is_a?(Array)
@@ -154,6 +174,11 @@ module Files
154
174
  # Parameters:
155
175
  # name - string - Name of the metadata category.
156
176
  # default_columns - array(string) - Metadata keys that should appear as columns in the UI by default.
177
+ #
178
+ # params:: Hash of API operation parameter values.
179
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
180
+ #
181
+ # Returns a Files::MetadataCategory.
157
182
  def self.update(id, params = {}, options = {})
158
183
  params ||= {}
159
184
  params[:id] = id
@@ -166,6 +191,10 @@ module Files
166
191
  MetadataCategory.new(response.data, options)
167
192
  end
168
193
 
194
+ # params:: Hash of API operation parameter values.
195
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
196
+ #
197
+ # Returns nil.
169
198
  def self.delete(id, params = {}, options = {})
170
199
  params ||= {}
171
200
  params[:id] = id
@@ -313,6 +313,11 @@ module Files
313
313
  # path - string - Show notifications for this Path.
314
314
  # include_ancestors - boolean - If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
315
315
  # group_id - string
316
+ #
317
+ # params:: Hash of API operation parameter values.
318
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
319
+ #
320
+ # Returns a Files::List of Files::Notification objects.
316
321
  def self.list(params = {}, options = {})
317
322
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
318
323
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -333,6 +338,11 @@ module Files
333
338
 
334
339
  # Parameters:
335
340
  # id (required) - int64 - Notification ID.
341
+ #
342
+ # params:: Hash of API operation parameter values.
343
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
344
+ #
345
+ # Returns a Files::Notification.
336
346
  def self.find(id, params = {}, options = {})
337
347
  params ||= {}
338
348
  params[:id] = id
@@ -368,6 +378,11 @@ module Files
368
378
  # group_ids - string - Group IDs when the notification requires multiple groups. If sent as a string, it should be comma-delimited.
369
379
  # path - string - Path
370
380
  # username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.
381
+ #
382
+ # params:: Hash of API operation parameter values.
383
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
384
+ #
385
+ # Returns a Files::Notification.
371
386
  def self.create(params = {}, options = {})
372
387
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
373
388
  raise InvalidParameterError.new("Bad parameter: send_interval must be an String") if params[:send_interval] and !params[:send_interval].is_a?(String)
@@ -402,6 +417,11 @@ module Files
402
417
  # triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
403
418
  # trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
404
419
  # workspace_id - int64 - Workspace ID. `0` means the default workspace.
420
+ #
421
+ # params:: Hash of API operation parameter values.
422
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
423
+ #
424
+ # Returns a Files::Notification.
405
425
  def self.update(id, params = {}, options = {})
406
426
  params ||= {}
407
427
  params[:id] = id
@@ -419,6 +439,10 @@ module Files
419
439
  Notification.new(response.data, options)
420
440
  end
421
441
 
442
+ # params:: Hash of API operation parameter values.
443
+ # options:: Hash of optional request configuration passed to Files::Api.send_request.
444
+ #
445
+ # Returns nil.
422
446
  def self.delete(id, params = {}, options = {})
423
447
  params ||= {}
424
448
  params[:id] = id
@@ -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)
@@ -268,6 +268,11 @@ module Files
268
268
  # per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
269
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`.
270
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.
271
276
  def self.list(params = {}, options = {})
272
277
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
273
278
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -285,6 +290,11 @@ module Files
285
290
 
286
291
  # Parameters:
287
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.
288
298
  def self.find(id, params = {}, options = {})
289
299
  params ||= {}
290
300
  params[:id] = id
@@ -316,6 +326,11 @@ module Files
316
326
  # name (required) - string - The name of the Partner.
317
327
  # root_folder (required) - string - The root folder path for this Partner.
318
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.
319
334
  def self.create(params = {}, options = {})
320
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)
321
336
  raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
@@ -351,6 +366,11 @@ module Files
351
366
  # name - string - The name of the Partner.
352
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`.
353
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.
354
374
  def self.update(id, params = {}, options = {})
355
375
  params ||= {}
356
376
  params[:id] = id
@@ -371,6 +391,10 @@ module Files
371
391
  Partner.new(response.data, options)
372
392
  end
373
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.
374
398
  def self.delete(id, params = {}, options = {})
375
399
  params ||= {}
376
400
  params[:id] = id