files.com 1.1.769 → 1.1.771

data/lib/files.com/models/email_log.rb

@@ -67,6 +67,11 @@ module Files
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
     #   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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
     #   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 `[ status ]`, `[ created_at ]` or `[ status, created_at ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::EmailLog objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

data/lib/files.com/models/event_channel.rb

@@ -125,6 +125,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `enabled`, `default_channel` or `workspace_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `default_channel` or `workspace_id`. Valid field combinations are `[ workspace_id, enabled ]` and `[ workspace_id, default_channel ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::EventChannel objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -142,6 +147,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Event Channel ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventChannel.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -162,6 +172,11 @@ module Files
     #   description - string - Event Channel description.
     #   enabled - boolean - Whether this Event Channel can dispatch events.
     #   default_channel - boolean - Whether this Event Channel is the default destination for newly published events.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventChannel.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
@@ -178,6 +193,11 @@ module Files
     #   description - string - Event Channel description.
     #   enabled - boolean - Whether this Event Channel can dispatch events.
     #   default_channel - boolean - Whether this Event Channel is the default destination for newly published events.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventChannel.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -191,6 +211,10 @@ module Files
       EventChannel.new(response.data, options)
     end
 
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns nil.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/event_delivery_attempt.rb

@@ -89,6 +89,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status`, `event_record_id`, `event_target_id` or `workspace_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id`, `event_record_id` or `event_target_id`. Valid field combinations are `[ workspace_id, status ]`, `[ workspace_id, event_record_id ]` or `[ workspace_id, event_target_id ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::EventDeliveryAttempt objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -106,6 +111,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Event Delivery Attempt ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventDeliveryAttempt.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/event_record.rb

@@ -94,6 +94,11 @@ module Files
     #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `event_type`.
     #   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
     #   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::EventRecord objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -116,6 +121,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Event Record ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventRecord.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/event_subscription.rb

@@ -199,6 +199,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `enabled`, `event_channel_id` or `workspace_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `event_channel_id` or `workspace_id`. Valid field combinations are `[ enabled, event_channel_id ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, event_channel_id ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::EventSubscription objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -216,6 +221,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Event Subscription ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventSubscription.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -243,6 +253,11 @@ module Files
     #   filter - object - Structured event payload filter.
     #   delivery_policy - object - Event Subscription delivery policy.
     #   event_target_ids - array(int64) - Event Target IDs this subscription sends to.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventSubscription.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: event_channel_id must be an Integer") if params[:event_channel_id] and !params[:event_channel_id].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
@@ -272,6 +287,11 @@ module Files
     #   filter - object - Structured event payload filter.
     #   delivery_policy - object - Event Subscription delivery policy.
     #   event_target_ids - array(int64) - Event Target IDs this subscription sends to.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventSubscription.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -291,6 +311,10 @@ module Files
       EventSubscription.new(response.data, options)
     end
 
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns nil.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/event_target.rb

@@ -143,6 +143,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `enabled` or `workspace_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `target_type` or `workspace_id`. Valid field combinations are `[ enabled, target_type ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, target_type ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::EventTarget objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -160,6 +165,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Event Target ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventTarget.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -182,6 +192,11 @@ module Files
     #   config (required) - object - Event Target configuration. Folder targets accept path and format (json or csv).
     #   delivery_policy - object - Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400.
     #   target_type (required) - string - Event Target type.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventTarget.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
@@ -203,6 +218,11 @@ module Files
     #   enabled - boolean - Whether this Event Target can receive events.
     #   config - object - Event Target configuration. Folder targets accept path and format (json or csv).
     #   delivery_policy - object - Event Target delivery policy. Email and folder targets support batch_interval in seconds, between 600 and 86400.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::EventTarget.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -217,6 +237,10 @@ module Files
       EventTarget.new(response.data, options)
     end
 
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns nil.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/exavault_api_request_log.rb

@@ -78,6 +78,11 @@ module Files
     #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `request_ip` and `request_method`. Valid field combinations are `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
     #   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 `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
     #   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 `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ created_at ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_ip, created_at ]`, `[ request_method, success ]`, `[ request_method, created_at ]`, `[ success, created_at ]`, `[ request_ip, request_method, success ]`, `[ request_ip, request_method, created_at ]`, `[ request_ip, success, created_at ]`, `[ request_method, success, created_at ]` or `[ request_ip, request_method, success, created_at ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::ExavaultApiRequestLog objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)

data/lib/files.com/models/expectation.rb

@@ -357,6 +357,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name` or `disabled`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled` and `workspace_id`. Valid field combinations are `[ workspace_id, disabled ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::Expectation objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -374,6 +379,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Expectation ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::Expectation.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -410,6 +420,11 @@ module Files
     #   max_open_interval - int64 - Hard-stop duration in seconds for unscheduled expectations.
     #   criteria - object - Versioned success criteria definition for the expectation, including optional Files Transform Script content validation in criteria v2.
     #   workspace_id - int64 - Workspace ID. `0` means the default workspace.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::Expectation.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
@@ -437,6 +452,11 @@ module Files
     end
 
     # Manually open an Expectation window
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExpectationEvaluation.
     def self.trigger_evaluation(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -469,6 +489,11 @@ module Files
     #   max_open_interval - int64 - Hard-stop duration in seconds for unscheduled expectations.
     #   criteria - object - Versioned success criteria definition for the expectation, including optional Files Transform Script content validation in criteria v2.
     #   workspace_id - int64 - Workspace ID. `0` means the default workspace.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::Expectation.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -499,6 +524,10 @@ module Files
       Expectation.new(response.data, options)
     end
 
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns nil.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/expectation_evaluation.rb

@@ -104,6 +104,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `expectation_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expectation_id` and `workspace_id`. Valid field combinations are `[ workspace_id, expectation_id ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::ExpectationEvaluation objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -121,6 +126,11 @@ module Files
 
     # Parameters:
     #   id (required) - int64 - Expectation Evaluation ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExpectationEvaluation.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/expectation_incident.rb

@@ -127,6 +127,11 @@ module Files
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `expectation_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expectation_id` and `workspace_id`. Valid field combinations are `[ workspace_id, expectation_id ]`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::ExpectationIncident objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       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
 
     # Parameters:
     #   id (required) - int64 - Expectation Incident ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExpectationIncident.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -159,6 +169,11 @@ module Files
     end
 
     # Resolve an expectation incident
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExpectationIncident.
     def self.resolve(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -173,6 +188,11 @@ module Files
     #
     # Parameters:
     #   snoozed_until (required) - string - Time until which the incident should remain snoozed.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExpectationIncident.
     def self.snooze(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -186,6 +206,11 @@ module Files
     end
 
     # Acknowledge an expectation incident
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExpectationIncident.
     def self.acknowledge(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/external_event.rb

@@ -79,6 +79,11 @@ module Files
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
     #   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
     #   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::ExternalEvent objects.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       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
 
     # Parameters:
     #   id (required) - int64 - External Event ID.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExternalEvent.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -117,6 +127,11 @@ module Files
     # Parameters:
     #   status (required) - string - Status of event.
     #   body (required) - string - Event body
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::ExternalEvent.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)

data/lib/files.com/models/file.rb

@@ -1314,6 +1314,11 @@ module Files
     #   with_previews - boolean - Include file preview information?
     #   with_priority_color - boolean - Include file priority color information?
     #   with_direct_connection_info - boolean - Include optional direct connection information for a direct Agent transfer attempt?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::File.
     def self.download(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1345,6 +1350,11 @@ module Files
     #   with_rename - boolean - Allow file rename instead of overwrite?
     #   buffered_upload - boolean - If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
     #   with_direct_connection_info - boolean - Include optional direct connection information for a direct Agent transfer attempt?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::File.
     def self.create(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1369,6 +1379,11 @@ module Files
     #   custom_metadata - object - Custom metadata map of keys and values. Limited to 32 keys, 256 characters per key and 1024 characters per value.
     #   provided_mtime - string - Modified time of file.
     #   priority_color - string - Priority/Bookmark color of file.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::File.
     def self.update(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1384,6 +1399,11 @@ module Files
 
     # Parameters:
     #   recursive - boolean - If true, will recursively delete folders.  Otherwise, will error on non-empty folders.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns nil.
     def self.delete(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1404,6 +1424,11 @@ module Files
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   with_previews - boolean - Include file preview information?
     #   with_priority_color - boolean - Include file priority color information?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::File.
     def self.find(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1420,6 +1445,11 @@ module Files
     end
 
     # List the contents of a ZIP file
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns an Array of Files::ZipListEntry objects.
     def self.zip_list_contents(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1439,6 +1469,11 @@ module Files
     #   copy_behaviors - boolean - If copying a folder, also copy supported behaviors, email notification subscriptions, and per-folder branding to the destination folder tree?
     #   structure - boolean - Copy structure only?
     #   overwrite - boolean - Overwrite existing file(s) in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.copy(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1456,6 +1491,11 @@ module Files
     # Parameters:
     #   destination (required) - string - Move destination path.
     #   overwrite - boolean - Overwrite existing file(s) in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.move(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1478,6 +1518,11 @@ module Files
     #   width - int64 - Maximum output width for image_convert.
     #   height - int64 - Maximum output height for image_convert.
     #   overwrite - boolean - Overwrite existing file in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.transform(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1506,6 +1551,11 @@ module Files
     #   use_all_private_keys - boolean - Use every accessible private GPG key in the source workspace for decryption.
     #   ignore_mdc_error - boolean - Ignore errors from the MDC (modification detection code) check.
     #   overwrite - boolean - Overwrite existing file in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.gpg_decrypt(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1529,6 +1579,11 @@ module Files
     #   signing_key_id - int64 - Optional GPG Key ID to sign with.
     #   armor - boolean - Output ASCII-armored encrypted data.
     #   overwrite - boolean - Overwrite existing file in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.gpg_encrypt(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1550,6 +1605,11 @@ module Files
     #   destination (required) - string - Destination folder path for extracted files.
     #   filename - string - Optional single entry filename to extract.
     #   overwrite - boolean - Overwrite existing files in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.unzip(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -1567,6 +1627,11 @@ module Files
     #   paths (required) - array(string) - Paths to include in the ZIP.
     #   destination (required) - string - Destination file path for the ZIP.
     #   overwrite - boolean - Overwrite existing file in the destination?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileAction.
     def self.zip(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params[:paths] and !params[:paths].is_a?(Array)
       raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
@@ -1589,6 +1654,11 @@ module Files
     #   with_rename - boolean - Allow file rename instead of overwrite?
     #   buffered_upload - boolean - If true, and the path refers to a destination not stored on Files.com (such as a remote server mount), the upload will be uploaded first to Files.com before being sent to the remote server mount. This can allow clients to upload using parallel parts to a remote server destination that does not offer parallel parts support natively.
     #   with_direct_connection_info - boolean - Include optional direct connection information for a direct Agent transfer attempt?
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns an Array of Files::FileUploadPart objects.
     def self.begin_upload(path, params = {}, options = {})
       params ||= {}
       params[:path] = path

data/lib/files.com/models/file_comment.rb

@@ -91,6 +91,11 @@ module Files
     #   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.
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   path (required) - string - Path to operate on.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::List of Files::FileComment objects.
     def self.list_for(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
@@ -107,6 +112,11 @@ module Files
     # Parameters:
     #   body (required) - string - Comment body.
     #   path (required) - string - File path.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileComment.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
@@ -119,6 +129,11 @@ module Files
 
     # Parameters:
     #   body (required) - string - Comment body.
+    #
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns a Files::FileComment.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -131,6 +146,10 @@ module Files
       FileComment.new(response.data, options)
     end
 
+    # params:: Hash of API operation parameter values.
+    # options:: Hash of optional request configuration passed to Files::Api.send_request.
+    #
+    # Returns nil.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id