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.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/remote_server.md +8 -0
- data/lib/files.com/models/action_log.rb +5 -0
- data/lib/files.com/models/action_notification_export.rb +10 -0
- data/lib/files.com/models/action_notification_export_result.rb +5 -0
- data/lib/files.com/models/ai_assistant_personality.rb +24 -0
- data/lib/files.com/models/ai_task.rb +29 -0
- data/lib/files.com/models/api_key.rb +37 -0
- data/lib/files.com/models/api_request_log.rb +5 -0
- data/lib/files.com/models/app.rb +5 -0
- data/lib/files.com/models/as2_incoming_message.rb +5 -0
- data/lib/files.com/models/as2_outgoing_message.rb +5 -0
- data/lib/files.com/models/as2_partner.rb +24 -0
- data/lib/files.com/models/as2_station.rb +24 -0
- data/lib/files.com/models/automation.rb +38 -0
- data/lib/files.com/models/automation_log.rb +5 -0
- data/lib/files.com/models/automation_run.rb +25 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +5 -0
- data/lib/files.com/models/behavior.rb +34 -0
- data/lib/files.com/models/bundle.rb +29 -0
- data/lib/files.com/models/bundle_action.rb +5 -0
- data/lib/files.com/models/bundle_download.rb +5 -0
- data/lib/files.com/models/bundle_notification.rb +24 -0
- data/lib/files.com/models/bundle_recipient.rb +10 -0
- data/lib/files.com/models/bundle_registration.rb +5 -0
- data/lib/files.com/models/chat_session.rb +10 -0
- data/lib/files.com/models/child_site_management_policy.rb +24 -0
- data/lib/files.com/models/clickwrap.rb +24 -0
- data/lib/files.com/models/custom_domain.rb +29 -0
- data/lib/files.com/models/desktop_configuration_profile.rb +24 -0
- data/lib/files.com/models/dns_record.rb +5 -0
- data/lib/files.com/models/email_incoming_message.rb +5 -0
- data/lib/files.com/models/email_log.rb +5 -0
- data/lib/files.com/models/event_channel.rb +24 -0
- data/lib/files.com/models/event_delivery_attempt.rb +10 -0
- data/lib/files.com/models/event_record.rb +10 -0
- data/lib/files.com/models/event_subscription.rb +24 -0
- data/lib/files.com/models/event_target.rb +24 -0
- data/lib/files.com/models/exavault_api_request_log.rb +5 -0
- data/lib/files.com/models/expectation.rb +29 -0
- data/lib/files.com/models/expectation_evaluation.rb +10 -0
- data/lib/files.com/models/expectation_incident.rb +25 -0
- data/lib/files.com/models/external_event.rb +15 -0
- data/lib/files.com/models/file.rb +70 -0
- data/lib/files.com/models/file_comment.rb +19 -0
- data/lib/files.com/models/file_comment_reaction.rb +9 -0
- data/lib/files.com/models/file_migration.rb +5 -0
- data/lib/files.com/models/file_migration_log.rb +5 -0
- data/lib/files.com/models/folder.rb +10 -0
- data/lib/files.com/models/form_field_set.rb +24 -0
- data/lib/files.com/models/ftp_action_log.rb +5 -0
- data/lib/files.com/models/gpg_key.rb +24 -0
- data/lib/files.com/models/group.rb +24 -0
- data/lib/files.com/models/group_user.rb +20 -0
- data/lib/files.com/models/history.rb +25 -0
- data/lib/files.com/models/history_export.rb +10 -0
- data/lib/files.com/models/history_export_result.rb +5 -0
- data/lib/files.com/models/holiday_calendar.rb +24 -0
- data/lib/files.com/models/holiday_region.rb +5 -0
- data/lib/files.com/models/inbound_s3_log.rb +5 -0
- data/lib/files.com/models/inbox_recipient.rb +10 -0
- data/lib/files.com/models/inbox_registration.rb +5 -0
- data/lib/files.com/models/inbox_upload.rb +5 -0
- data/lib/files.com/models/integration_centric_profile.rb +24 -0
- data/lib/files.com/models/invoice.rb +10 -0
- data/lib/files.com/models/ip_address.rb +20 -0
- data/lib/files.com/models/key_lifecycle_rule.rb +24 -0
- data/lib/files.com/models/lock.rb +15 -0
- data/lib/files.com/models/metadata_category.rb +29 -0
- data/lib/files.com/models/notification.rb +24 -0
- data/lib/files.com/models/outbound_connection_log.rb +5 -0
- data/lib/files.com/models/partner.rb +24 -0
- data/lib/files.com/models/partner_channel.rb +24 -0
- data/lib/files.com/models/partner_channel_template.rb +24 -0
- data/lib/files.com/models/partner_site.rb +4 -0
- data/lib/files.com/models/partner_site_request.rb +29 -0
- data/lib/files.com/models/payment.rb +10 -0
- data/lib/files.com/models/pending_work_event.rb +10 -0
- data/lib/files.com/models/permission.rb +14 -0
- data/lib/files.com/models/public_hosting_request_log.rb +5 -0
- data/lib/files.com/models/public_key.rb +24 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +5 -0
- data/lib/files.com/models/remote_mount_backend.rb +29 -0
- data/lib/files.com/models/remote_server.rb +54 -0
- data/lib/files.com/models/remote_server_credential.rb +24 -0
- data/lib/files.com/models/request.rb +19 -0
- data/lib/files.com/models/restore.rb +10 -0
- data/lib/files.com/models/schedule.rb +24 -0
- data/lib/files.com/models/scheduled_export.rb +24 -0
- data/lib/files.com/models/scim_log.rb +10 -0
- data/lib/files.com/models/secret.rb +24 -0
- data/lib/files.com/models/session.rb +9 -0
- data/lib/files.com/models/settings_change.rb +5 -0
- data/lib/files.com/models/sftp_action_log.rb +5 -0
- data/lib/files.com/models/sftp_host_key.rb +24 -0
- data/lib/files.com/models/share_group.rb +24 -0
- data/lib/files.com/models/siem_http_destination.rb +29 -0
- data/lib/files.com/models/siem_http_destination_event.rb +10 -0
- data/lib/files.com/models/site.rb +13 -0
- data/lib/files.com/models/site_subdomain_redirect.rb +14 -0
- data/lib/files.com/models/snapshot.rb +29 -0
- data/lib/files.com/models/sso_event.rb +10 -0
- data/lib/files.com/models/sso_strategy.rb +15 -0
- data/lib/files.com/models/style.rb +14 -0
- data/lib/files.com/models/sync.rb +34 -0
- data/lib/files.com/models/sync_log.rb +5 -0
- data/lib/files.com/models/sync_run.rb +10 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +5 -0
- data/lib/files.com/models/usage_snapshot.rb +5 -0
- data/lib/files.com/models/user.rb +40 -0
- data/lib/files.com/models/user_additional_email_recipient.rb +24 -0
- data/lib/files.com/models/user_cipher_use.rb +5 -0
- data/lib/files.com/models/user_lifecycle_rule.rb +24 -0
- data/lib/files.com/models/user_request.rb +19 -0
- data/lib/files.com/models/user_security_event.rb +10 -0
- data/lib/files.com/models/user_sftp_client_use.rb +5 -0
- data/lib/files.com/models/web_dav_action_log.rb +5 -0
- data/lib/files.com/models/webhook_test.rb +5 -0
- data/lib/files.com/models/workspace.rb +24 -0
- data/lib/files.com/version.rb +1 -1
- metadata +2 -2
|
@@ -158,6 +158,11 @@ module Files
|
|
|
158
158
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
|
|
159
159
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
|
|
160
160
|
# automation_id (required) - int64 - ID of the associated Automation.
|
|
161
|
+
#
|
|
162
|
+
# params:: Hash of API operation parameter values.
|
|
163
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
164
|
+
#
|
|
165
|
+
# Returns a Files::List of Files::AutomationRun objects.
|
|
161
166
|
def self.list(params = {}, options = {})
|
|
162
167
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
163
168
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -178,6 +183,11 @@ module Files
|
|
|
178
183
|
|
|
179
184
|
# Parameters:
|
|
180
185
|
# id (required) - int64 - Automation Run ID.
|
|
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::AutomationRun.
|
|
181
191
|
def self.find(id, params = {}, options = {})
|
|
182
192
|
params ||= {}
|
|
183
193
|
params[:id] = id
|
|
@@ -195,6 +205,11 @@ module Files
|
|
|
195
205
|
# Parameters:
|
|
196
206
|
# id (required) - int64 - Automation Run ID.
|
|
197
207
|
# node_id (required) - string - Node ID from the pinned Automation definition.
|
|
208
|
+
#
|
|
209
|
+
# params:: Hash of API operation parameter values.
|
|
210
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
211
|
+
#
|
|
212
|
+
# Returns a Files::AutomationExecutionNode.
|
|
198
213
|
def self.find_node(id, params = {}, options = {})
|
|
199
214
|
params ||= {}
|
|
200
215
|
params[:id] = id
|
|
@@ -208,6 +223,11 @@ module Files
|
|
|
208
223
|
end
|
|
209
224
|
|
|
210
225
|
# Cancel Automation Run
|
|
226
|
+
#
|
|
227
|
+
# params:: Hash of API operation parameter values.
|
|
228
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
229
|
+
#
|
|
230
|
+
# Returns a Files::AutomationRun.
|
|
211
231
|
def self.cancel(id, params = {}, options = {})
|
|
212
232
|
params ||= {}
|
|
213
233
|
params[:id] = id
|
|
@@ -222,6 +242,11 @@ module Files
|
|
|
222
242
|
#
|
|
223
243
|
# Parameters:
|
|
224
244
|
# node_id (required) - string - Node ID at which execution should resume.
|
|
245
|
+
#
|
|
246
|
+
# params:: Hash of API operation parameter values.
|
|
247
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
248
|
+
#
|
|
249
|
+
# Returns a Files::AutomationRun.
|
|
225
250
|
def self.rerun(id, params = {}, options = {})
|
|
226
251
|
params ||= {}
|
|
227
252
|
params[:id] = id
|
|
@@ -63,6 +63,11 @@ module Files
|
|
|
63
63
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
|
64
64
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
|
65
65
|
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
|
66
|
+
#
|
|
67
|
+
# params:: Hash of API operation parameter values.
|
|
68
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
69
|
+
#
|
|
70
|
+
# Returns a Files::List of Files::BandwidthSnapshot objects.
|
|
66
71
|
def self.list(params = {}, options = {})
|
|
67
72
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
68
73
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -197,6 +197,11 @@ module Files
|
|
|
197
197
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
198
198
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
|
|
199
199
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `clickwrap_id`, `form_field_set_id`, `impacts_ui`, `remote_server_id` or `behavior`. Valid field combinations are `[ impacts_ui, behavior ]` and `[ behavior, remote_server_id ]`.
|
|
200
|
+
#
|
|
201
|
+
# params:: Hash of API operation parameter values.
|
|
202
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
203
|
+
#
|
|
204
|
+
# Returns a Files::List of Files::Behavior objects.
|
|
200
205
|
def self.list(params = {}, options = {})
|
|
201
206
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
202
207
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -214,6 +219,11 @@ module Files
|
|
|
214
219
|
|
|
215
220
|
# Parameters:
|
|
216
221
|
# id (required) - int64 - Behavior ID.
|
|
222
|
+
#
|
|
223
|
+
# params:: Hash of API operation parameter values.
|
|
224
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
225
|
+
#
|
|
226
|
+
# Returns a Files::Behavior.
|
|
217
227
|
def self.find(id, params = {}, options = {})
|
|
218
228
|
params ||= {}
|
|
219
229
|
params[:id] = id
|
|
@@ -235,6 +245,11 @@ module Files
|
|
|
235
245
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`. Valid field combinations are `[ impacts_ui, behavior ]`.
|
|
236
246
|
# path (required) - string - Path to operate on.
|
|
237
247
|
# ancestor_behaviors - boolean - If `true`, behaviors above this path are shown.
|
|
248
|
+
#
|
|
249
|
+
# params:: Hash of API operation parameter values.
|
|
250
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
251
|
+
#
|
|
252
|
+
# Returns a Files::List of Files::Behavior objects.
|
|
238
253
|
def self.list_for(path, params = {}, options = {})
|
|
239
254
|
params ||= {}
|
|
240
255
|
params[:path] = path
|
|
@@ -259,6 +274,11 @@ module Files
|
|
|
259
274
|
# description - string - Description for this behavior.
|
|
260
275
|
# path (required) - string - Path where this behavior should apply.
|
|
261
276
|
# behavior (required) - string - Behavior type.
|
|
277
|
+
#
|
|
278
|
+
# params:: Hash of API operation parameter values.
|
|
279
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
280
|
+
#
|
|
281
|
+
# Returns a Files::Behavior.
|
|
262
282
|
def self.create(params = {}, options = {})
|
|
263
283
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
264
284
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
@@ -279,6 +299,11 @@ module Files
|
|
|
279
299
|
# headers - object - Additional request headers to send via HTTP.
|
|
280
300
|
# body - object - Additional body parameters to include in the webhook payload.
|
|
281
301
|
# action - string - Action for test body.
|
|
302
|
+
#
|
|
303
|
+
# params:: Hash of API operation parameter values.
|
|
304
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
305
|
+
#
|
|
306
|
+
# Returns nil.
|
|
282
307
|
def self.webhook_test(params = {}, options = {})
|
|
283
308
|
raise InvalidParameterError.new("Bad parameter: url must be an String") if params[:url] and !params[:url].is_a?(String)
|
|
284
309
|
raise InvalidParameterError.new("Bad parameter: method must be an String") if params[:method] and !params[:method].is_a?(String)
|
|
@@ -300,6 +325,11 @@ module Files
|
|
|
300
325
|
# name - string - Name for this behavior.
|
|
301
326
|
# description - string - Description for this behavior.
|
|
302
327
|
# attachment_delete - boolean - If `true`, delete the file stored in `attachment`.
|
|
328
|
+
#
|
|
329
|
+
# params:: Hash of API operation parameter values.
|
|
330
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
331
|
+
#
|
|
332
|
+
# Returns a Files::Behavior.
|
|
303
333
|
def self.update(id, params = {}, options = {})
|
|
304
334
|
params ||= {}
|
|
305
335
|
params[:id] = id
|
|
@@ -314,6 +344,10 @@ module Files
|
|
|
314
344
|
Behavior.new(response.data, options)
|
|
315
345
|
end
|
|
316
346
|
|
|
347
|
+
# params:: Hash of API operation parameter values.
|
|
348
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
349
|
+
#
|
|
350
|
+
# Returns nil.
|
|
317
351
|
def self.delete(id, params = {}, options = {})
|
|
318
352
|
params ||= {}
|
|
319
353
|
params[:id] = id
|
|
@@ -620,6 +620,11 @@ module Files
|
|
|
620
620
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
621
621
|
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
622
622
|
# deleted - boolean - If true, only list deleted Share Links.
|
|
623
|
+
#
|
|
624
|
+
# params:: Hash of API operation parameter values.
|
|
625
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
626
|
+
#
|
|
627
|
+
# Returns a Files::List of Files::Bundle objects.
|
|
623
628
|
def self.list(params = {}, options = {})
|
|
624
629
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
625
630
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -644,6 +649,11 @@ module Files
|
|
|
644
649
|
# Parameters:
|
|
645
650
|
# id (required) - int64 - Bundle ID.
|
|
646
651
|
# deleted - boolean - If true, show a deleted Share Link.
|
|
652
|
+
#
|
|
653
|
+
# params:: Hash of API operation parameter values.
|
|
654
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
655
|
+
#
|
|
656
|
+
# Returns a Files::Bundle.
|
|
647
657
|
def self.find(id, params = {}, options = {})
|
|
648
658
|
params ||= {}
|
|
649
659
|
params[:id] = id
|
|
@@ -691,6 +701,11 @@ module Files
|
|
|
691
701
|
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
692
702
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
|
693
703
|
# watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
|
704
|
+
#
|
|
705
|
+
# params:: Hash of API operation parameter values.
|
|
706
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
707
|
+
#
|
|
708
|
+
# Returns a Files::Bundle.
|
|
694
709
|
def self.create(params = {}, options = {})
|
|
695
710
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
696
711
|
raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)
|
|
@@ -724,6 +739,11 @@ module Files
|
|
|
724
739
|
# to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
|
|
725
740
|
# note - string - Note to include in email.
|
|
726
741
|
# recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
|
|
742
|
+
#
|
|
743
|
+
# params:: Hash of API operation parameter values.
|
|
744
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
745
|
+
#
|
|
746
|
+
# Returns nil.
|
|
727
747
|
def self.share(id, params = {}, options = {})
|
|
728
748
|
params ||= {}
|
|
729
749
|
params[:id] = id
|
|
@@ -770,6 +790,11 @@ module Files
|
|
|
770
790
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
|
771
791
|
# watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
|
772
792
|
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
793
|
+
#
|
|
794
|
+
# params:: Hash of API operation parameter values.
|
|
795
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
796
|
+
#
|
|
797
|
+
# Returns a Files::Bundle.
|
|
773
798
|
def self.update(id, params = {}, options = {})
|
|
774
799
|
params ||= {}
|
|
775
800
|
params[:id] = id
|
|
@@ -799,6 +824,10 @@ module Files
|
|
|
799
824
|
Bundle.new(response.data, options)
|
|
800
825
|
end
|
|
801
826
|
|
|
827
|
+
# params:: Hash of API operation parameter values.
|
|
828
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
829
|
+
#
|
|
830
|
+
# Returns nil.
|
|
802
831
|
def self.delete(id, params = {}, options = {})
|
|
803
832
|
params ||= {}
|
|
804
833
|
params[:id] = id
|
|
@@ -86,6 +86,11 @@ module Files
|
|
|
86
86
|
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
87
87
|
# bundle_id - int64 - Bundle ID
|
|
88
88
|
# bundle_registration_id - int64 - Bundle Registration ID
|
|
89
|
+
#
|
|
90
|
+
# params:: Hash of API operation parameter values.
|
|
91
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
92
|
+
#
|
|
93
|
+
# Returns a Files::List of Files::BundleAction objects.
|
|
89
94
|
def self.list(params = {}, options = {})
|
|
90
95
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
91
96
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -45,6 +45,11 @@ module Files
|
|
|
45
45
|
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
46
46
|
# bundle_id - int64 - Bundle ID
|
|
47
47
|
# bundle_registration_id - int64 - BundleRegistration ID
|
|
48
|
+
#
|
|
49
|
+
# params:: Hash of API operation parameter values.
|
|
50
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
51
|
+
#
|
|
52
|
+
# Returns a Files::List of Files::BundleDownload objects.
|
|
48
53
|
def self.list(params = {}, options = {})
|
|
49
54
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
50
55
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -129,6 +129,11 @@ module Files
|
|
|
129
129
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
|
|
130
130
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
|
131
131
|
# bundle_id - int64 - Bundle ID
|
|
132
|
+
#
|
|
133
|
+
# params:: Hash of API operation parameter values.
|
|
134
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
135
|
+
#
|
|
136
|
+
# Returns a Files::List of Files::BundleNotification objects.
|
|
132
137
|
def self.list(params = {}, options = {})
|
|
133
138
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
134
139
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -148,6 +153,11 @@ module Files
|
|
|
148
153
|
|
|
149
154
|
# Parameters:
|
|
150
155
|
# id (required) - int64 - Bundle Notification ID.
|
|
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::BundleNotification.
|
|
151
161
|
def self.find(id, params = {}, options = {})
|
|
152
162
|
params ||= {}
|
|
153
163
|
params[:id] = id
|
|
@@ -168,6 +178,11 @@ module Files
|
|
|
168
178
|
# notify_user_id - int64 - The id of the user to notify.
|
|
169
179
|
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
|
170
180
|
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
|
181
|
+
#
|
|
182
|
+
# params:: Hash of API operation parameter values.
|
|
183
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
184
|
+
#
|
|
185
|
+
# Returns a Files::BundleNotification.
|
|
171
186
|
def self.create(params = {}, options = {})
|
|
172
187
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
173
188
|
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
|
@@ -181,6 +196,11 @@ module Files
|
|
|
181
196
|
# Parameters:
|
|
182
197
|
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
|
183
198
|
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
|
199
|
+
#
|
|
200
|
+
# params:: Hash of API operation parameter values.
|
|
201
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
202
|
+
#
|
|
203
|
+
# Returns a Files::BundleNotification.
|
|
184
204
|
def self.update(id, params = {}, options = {})
|
|
185
205
|
params ||= {}
|
|
186
206
|
params[:id] = id
|
|
@@ -191,6 +211,10 @@ module Files
|
|
|
191
211
|
BundleNotification.new(response.data, options)
|
|
192
212
|
end
|
|
193
213
|
|
|
214
|
+
# params:: Hash of API operation parameter values.
|
|
215
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
216
|
+
#
|
|
217
|
+
# Returns nil.
|
|
194
218
|
def self.delete(id, params = {}, options = {})
|
|
195
219
|
params ||= {}
|
|
196
220
|
params[:id] = id
|
|
@@ -108,6 +108,11 @@ module Files
|
|
|
108
108
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
|
|
109
109
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
|
110
110
|
# bundle_id (required) - int64 - List recipients for the bundle with this ID.
|
|
111
|
+
#
|
|
112
|
+
# params:: Hash of API operation parameter values.
|
|
113
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
114
|
+
#
|
|
115
|
+
# Returns a Files::List of Files::BundleRecipient objects.
|
|
111
116
|
def self.list(params = {}, options = {})
|
|
112
117
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
113
118
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -134,6 +139,11 @@ module Files
|
|
|
134
139
|
# company - string - Company of recipient.
|
|
135
140
|
# note - string - Note to include in email.
|
|
136
141
|
# share_after_create - boolean - Set to true to share the link with the recipient upon creation.
|
|
142
|
+
#
|
|
143
|
+
# params:: Hash of API operation parameter values.
|
|
144
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
145
|
+
#
|
|
146
|
+
# Returns a Files::BundleRecipient.
|
|
137
147
|
def self.create(params = {}, options = {})
|
|
138
148
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
139
149
|
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
|
@@ -85,6 +85,11 @@ module Files
|
|
|
85
85
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
86
86
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id` or `created_at`.
|
|
87
87
|
# bundle_id - int64 - ID of the associated Bundle
|
|
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::BundleRegistration objects.
|
|
88
93
|
def self.list(params = {}, options = {})
|
|
89
94
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
90
95
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -54,6 +54,11 @@ module Files
|
|
|
54
54
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
55
55
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
|
|
56
56
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `ai_task_id`, `user_id` or `workspace_id`.
|
|
57
|
+
#
|
|
58
|
+
# params:: Hash of API operation parameter values.
|
|
59
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
60
|
+
#
|
|
61
|
+
# Returns a Files::List of Files::ChatSession objects.
|
|
57
62
|
def self.list(params = {}, options = {})
|
|
58
63
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
59
64
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -71,6 +76,11 @@ module Files
|
|
|
71
76
|
|
|
72
77
|
# Parameters:
|
|
73
78
|
# id (required) - string - Chat Session ID.
|
|
79
|
+
#
|
|
80
|
+
# params:: Hash of API operation parameter values.
|
|
81
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
82
|
+
#
|
|
83
|
+
# Returns a Files::ChatSession.
|
|
74
84
|
def self.find(id, params = {}, options = {})
|
|
75
85
|
params ||= {}
|
|
76
86
|
params[:id] = id
|
|
@@ -154,6 +154,11 @@ module Files
|
|
|
154
154
|
# Parameters:
|
|
155
155
|
# 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.
|
|
156
156
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
157
|
+
#
|
|
158
|
+
# params:: Hash of API operation parameter values.
|
|
159
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
160
|
+
#
|
|
161
|
+
# Returns a Files::List of Files::ChildSiteManagementPolicy objects.
|
|
157
162
|
def self.list(params = {}, options = {})
|
|
158
163
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
159
164
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -169,6 +174,11 @@ module Files
|
|
|
169
174
|
|
|
170
175
|
# Parameters:
|
|
171
176
|
# id (required) - int64 - Child Site Management Policy ID.
|
|
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::ChildSiteManagementPolicy.
|
|
172
182
|
def self.find(id, params = {}, options = {})
|
|
173
183
|
params ||= {}
|
|
174
184
|
params[:id] = id
|
|
@@ -191,6 +201,11 @@ module Files
|
|
|
191
201
|
# policy_type (required) - string - Type of policy. Valid values: `settings`.
|
|
192
202
|
# name - string - Name for this policy.
|
|
193
203
|
# description - string - Description for this policy.
|
|
204
|
+
#
|
|
205
|
+
# params:: Hash of API operation parameter values.
|
|
206
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
207
|
+
#
|
|
208
|
+
# Returns a Files::ChildSiteManagementPolicy.
|
|
194
209
|
def self.create(params = {}, options = {})
|
|
195
210
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
196
211
|
raise InvalidParameterError.new("Bad parameter: skip_child_site_ids must be an Array") if params[:skip_child_site_ids] and !params[:skip_child_site_ids].is_a?(Array)
|
|
@@ -212,6 +227,11 @@ module Files
|
|
|
212
227
|
# policy_type - string - Type of policy. Valid values: `settings`.
|
|
213
228
|
# name - string - Name for this policy.
|
|
214
229
|
# description - string - Description for this policy.
|
|
230
|
+
#
|
|
231
|
+
# params:: Hash of API operation parameter values.
|
|
232
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
233
|
+
#
|
|
234
|
+
# Returns a Files::ChildSiteManagementPolicy.
|
|
215
235
|
def self.update(id, params = {}, options = {})
|
|
216
236
|
params ||= {}
|
|
217
237
|
params[:id] = id
|
|
@@ -228,6 +248,10 @@ module Files
|
|
|
228
248
|
ChildSiteManagementPolicy.new(response.data, options)
|
|
229
249
|
end
|
|
230
250
|
|
|
251
|
+
# params:: Hash of API operation parameter values.
|
|
252
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
253
|
+
#
|
|
254
|
+
# Returns nil.
|
|
231
255
|
def self.delete(id, params = {}, options = {})
|
|
232
256
|
params ||= {}
|
|
233
257
|
params[:id] = id
|
|
@@ -116,6 +116,11 @@ module Files
|
|
|
116
116
|
# 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.
|
|
117
117
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
118
118
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
|
|
119
|
+
#
|
|
120
|
+
# params:: Hash of API operation parameter values.
|
|
121
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
122
|
+
#
|
|
123
|
+
# Returns a Files::List of Files::Clickwrap objects.
|
|
119
124
|
def self.list(params = {}, options = {})
|
|
120
125
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
121
126
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -132,6 +137,11 @@ module Files
|
|
|
132
137
|
|
|
133
138
|
# Parameters:
|
|
134
139
|
# id (required) - int64 - Clickwrap ID.
|
|
140
|
+
#
|
|
141
|
+
# params:: Hash of API operation parameter values.
|
|
142
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
143
|
+
#
|
|
144
|
+
# Returns a Files::Clickwrap.
|
|
135
145
|
def self.find(id, params = {}, options = {})
|
|
136
146
|
params ||= {}
|
|
137
147
|
params[:id] = id
|
|
@@ -152,6 +162,11 @@ module Files
|
|
|
152
162
|
# use_with_bundles - string - Use this Clickwrap for Bundles?
|
|
153
163
|
# use_with_inboxes - string - Use this Clickwrap for Inboxes?
|
|
154
164
|
# use_with_users - string - Use this Clickwrap for Users? Values: `none`, `require` (new user signup via email invitation only), `require_all_users_once` (show to all users at their next web login; once accepted, not shown again), `require_all_users_always` (show to all users on every web login).
|
|
165
|
+
#
|
|
166
|
+
# params:: Hash of API operation parameter values.
|
|
167
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
168
|
+
#
|
|
169
|
+
# Returns a Files::Clickwrap.
|
|
155
170
|
def self.create(params = {}, options = {})
|
|
156
171
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
157
172
|
raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
|
|
@@ -169,6 +184,11 @@ module Files
|
|
|
169
184
|
# use_with_bundles - string - Use this Clickwrap for Bundles?
|
|
170
185
|
# use_with_inboxes - string - Use this Clickwrap for Inboxes?
|
|
171
186
|
# use_with_users - string - Use this Clickwrap for Users? Values: `none`, `require` (new user signup via email invitation only), `require_all_users_once` (show to all users at their next web login; once accepted, not shown again), `require_all_users_always` (show to all users on every web login).
|
|
187
|
+
#
|
|
188
|
+
# params:: Hash of API operation parameter values.
|
|
189
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
190
|
+
#
|
|
191
|
+
# Returns a Files::Clickwrap.
|
|
172
192
|
def self.update(id, params = {}, options = {})
|
|
173
193
|
params ||= {}
|
|
174
194
|
params[:id] = id
|
|
@@ -184,6 +204,10 @@ module Files
|
|
|
184
204
|
Clickwrap.new(response.data, options)
|
|
185
205
|
end
|
|
186
206
|
|
|
207
|
+
# params:: Hash of API operation parameter values.
|
|
208
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
209
|
+
#
|
|
210
|
+
# Returns nil.
|
|
187
211
|
def self.delete(id, params = {}, options = {})
|
|
188
212
|
params ||= {}
|
|
189
213
|
params[:id] = id
|
|
@@ -173,6 +173,11 @@ module Files
|
|
|
173
173
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
174
174
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `id` or `available_to_all_workspaces`.
|
|
175
175
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
176
|
+
#
|
|
177
|
+
# params:: Hash of API operation parameter values.
|
|
178
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
179
|
+
#
|
|
180
|
+
# Returns a Files::List of Files::CustomDomain objects.
|
|
176
181
|
def self.list(params = {}, options = {})
|
|
177
182
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
178
183
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -190,6 +195,11 @@ module Files
|
|
|
190
195
|
|
|
191
196
|
# Parameters:
|
|
192
197
|
# id (required) - int64 - Custom Domain ID.
|
|
198
|
+
#
|
|
199
|
+
# params:: Hash of API operation parameter values.
|
|
200
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
201
|
+
#
|
|
202
|
+
# Returns a Files::CustomDomain.
|
|
193
203
|
def self.find(id, params = {}, options = {})
|
|
194
204
|
params ||= {}
|
|
195
205
|
params[:id] = id
|
|
@@ -207,6 +217,11 @@ module Files
|
|
|
207
217
|
# Parameters:
|
|
208
218
|
# id (required) - int64 - Custom Domain ID.
|
|
209
219
|
# count (required) - int64 - Number of dedicated IP addresses to allocate.
|
|
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 a Files::CustomDomain.
|
|
210
225
|
def self.create_allocate_ip(id, params = {}, options = {})
|
|
211
226
|
params ||= {}
|
|
212
227
|
params[:id] = id
|
|
@@ -226,6 +241,11 @@ module Files
|
|
|
226
241
|
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
227
242
|
# ssl_certificate_id - int64 - Current SSL certificate ID.
|
|
228
243
|
# domain (required) - string - Customer-owned domain name.
|
|
244
|
+
#
|
|
245
|
+
# params:: Hash of API operation parameter values.
|
|
246
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
247
|
+
#
|
|
248
|
+
# Returns a Files::CustomDomain.
|
|
229
249
|
def self.create(params = {}, options = {})
|
|
230
250
|
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
231
251
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
|
|
@@ -245,6 +265,11 @@ module Files
|
|
|
245
265
|
# folder_behavior_id - int64 - Public Hosting behavior ID when this domain routes to a specific Public Hosting behavior. Preserved as historical context when `destination` becomes `unassigned`.
|
|
246
266
|
# ssl_certificate_id - int64 - Current SSL certificate ID.
|
|
247
267
|
# domain - string - Customer-owned domain name.
|
|
268
|
+
#
|
|
269
|
+
# params:: Hash of API operation parameter values.
|
|
270
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
271
|
+
#
|
|
272
|
+
# Returns a Files::CustomDomain.
|
|
248
273
|
def self.update(id, params = {}, options = {})
|
|
249
274
|
params ||= {}
|
|
250
275
|
params[:id] = id
|
|
@@ -260,6 +285,10 @@ module Files
|
|
|
260
285
|
CustomDomain.new(response.data, options)
|
|
261
286
|
end
|
|
262
287
|
|
|
288
|
+
# params:: Hash of API operation parameter values.
|
|
289
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
290
|
+
#
|
|
291
|
+
# Returns nil.
|
|
263
292
|
def self.delete(id, params = {}, options = {})
|
|
264
293
|
params ||= {}
|
|
265
294
|
params[:id] = id
|
|
@@ -114,6 +114,11 @@ module Files
|
|
|
114
114
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
115
115
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
|
|
116
116
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
117
|
+
#
|
|
118
|
+
# params:: Hash of API operation parameter values.
|
|
119
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
120
|
+
#
|
|
121
|
+
# Returns a Files::List of Files::DesktopConfigurationProfile objects.
|
|
117
122
|
def self.list(params = {}, options = {})
|
|
118
123
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
119
124
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -131,6 +136,11 @@ module Files
|
|
|
131
136
|
|
|
132
137
|
# Parameters:
|
|
133
138
|
# id (required) - int64 - Desktop Configuration Profile ID.
|
|
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::DesktopConfigurationProfile.
|
|
134
144
|
def self.find(id, params = {}, options = {})
|
|
135
145
|
params ||= {}
|
|
136
146
|
params[:id] = id
|
|
@@ -151,6 +161,11 @@ module Files
|
|
|
151
161
|
# workspace_id - int64 - Workspace ID
|
|
152
162
|
# use_for_all_users - boolean - Whether this profile applies to all users in the Workspace by default
|
|
153
163
|
# disable_drive_mounting - boolean - Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile
|
|
164
|
+
#
|
|
165
|
+
# params:: Hash of API operation parameter values.
|
|
166
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
167
|
+
#
|
|
168
|
+
# Returns a Files::DesktopConfigurationProfile.
|
|
154
169
|
def self.create(params = {}, options = {})
|
|
155
170
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
156
171
|
raise InvalidParameterError.new("Bad parameter: mount_mappings must be an Hash") if params[:mount_mappings] and !params[:mount_mappings].is_a?(Hash)
|
|
@@ -168,6 +183,11 @@ module Files
|
|
|
168
183
|
# mount_mappings - object - Mount point mappings for the desktop app. Keys must be a single uppercase Windows drive letter other than A, B, or C, and values are Files.com paths to mount there.
|
|
169
184
|
# use_for_all_users - boolean - Whether this profile applies to all users in the Workspace by default
|
|
170
185
|
# disable_drive_mounting - boolean - Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile
|
|
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::DesktopConfigurationProfile.
|
|
171
191
|
def self.update(id, params = {}, options = {})
|
|
172
192
|
params ||= {}
|
|
173
193
|
params[:id] = id
|
|
@@ -181,6 +201,10 @@ module Files
|
|
|
181
201
|
DesktopConfigurationProfile.new(response.data, options)
|
|
182
202
|
end
|
|
183
203
|
|
|
204
|
+
# params:: Hash of API operation parameter values.
|
|
205
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
206
|
+
#
|
|
207
|
+
# Returns nil.
|
|
184
208
|
def self.delete(id, params = {}, options = {})
|
|
185
209
|
params ||= {}
|
|
186
210
|
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::DnsRecord 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)
|
|
@@ -64,6 +64,11 @@ module Files
|
|
|
64
64
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
|
|
65
65
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
66
66
|
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
67
|
+
#
|
|
68
|
+
# params:: Hash of API operation parameter values.
|
|
69
|
+
# options:: Hash of optional request configuration passed to Files::Api.send_request.
|
|
70
|
+
#
|
|
71
|
+
# Returns a Files::List of Files::EmailIncomingMessage objects.
|
|
67
72
|
def self.list(params = {}, options = {})
|
|
68
73
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
69
74
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|