Class: Files::SettingsChange

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/settings_change.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ SettingsChange

Returns a new instance of SettingsChange.



7
8
9
10
 
# File 'lib/files.com/models/settings_change.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/settings_change.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/settings_change.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



63
64
65
 
# File 'lib/files.com/models/settings_change.rb', line 63

def self.all(params = {}, options = {})
  list(params, options)
end

.list(params = {}, options = {}) ⇒ Object

Parameters:

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: 10,000, 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 `api_key_id`, `created_at` or `user_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.

Raises:



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/files.com/models/settings_change.rb', line 52

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)
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)

  List.new(SettingsChange, params) do
    Api.send_request("/settings_changes", :get, params, options)
  end
end

Instance Method Details

#api_key_id ⇒ Object

int64 - The API key id responsible for this change



28
29
30
 
# File 'lib/files.com/models/settings_change.rb', line 28

def api_key_id
  @attributes[:api_key_id]
end

#changes ⇒ Object

array(string) - Markdown-formatted change messages.



13
14
15
 
# File 'lib/files.com/models/settings_change.rb', line 13

def changes
  @attributes[:changes]
end

#created_at ⇒ Object

date-time - The time this change was made



18
19
20
 
# File 'lib/files.com/models/settings_change.rb', line 18

def created_at
  @attributes[:created_at]
end

#user_id ⇒ Object

int64 - The user id responsible for this change



23
24
25
 
# File 'lib/files.com/models/settings_change.rb', line 23

def user_id
  @attributes[:user_id]
end

#user_is_files_support ⇒ Object

boolean - true if this change was performed by Files.com support.



33
34
35
 
# File 'lib/files.com/models/settings_change.rb', line 33

def user_is_files_support
  @attributes[:user_is_files_support]
end

#user_is_from_parent_site ⇒ Object

boolean - true if this change was performed by a user on a parent site.



38
39
40
 
# File 'lib/files.com/models/settings_change.rb', line 38

def user_is_from_parent_site
  @attributes[:user_is_from_parent_site]
end

#username ⇒ Object

string - The username of the user responsible for this change



43
44
45
 
# File 'lib/files.com/models/settings_change.rb', line 43

def username
  @attributes[:username]
end