Class: Files::HistoryExportResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of HistoryExportResult.



7
8
9
10
 
# File 'lib/files.com/models/history_export_result.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/history_export_result.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



144
145
146
 
# File 'lib/files.com/models/history_export_result.rb', line 144

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

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
history_export_id (required) - int64 - ID of the associated history export.

Raises:



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/files.com/models/history_export_result.rb', line 132

def self.list(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: history_export_id must be an Integer") if params.dig(:history_export_id) and !params.dig(:history_export_id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: history_export_id") unless params.dig(:history_export_id)

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

Instance Method Details

#action ⇒ Object

string - What action was taken. Valid values: ‘create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`



68
69
70
 
# File 'lib/files.com/models/history_export_result.rb', line 68

def action
  @attributes[:action]
end

#created_at ⇒ Object

int64 - When the action happened



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

def created_at
  @attributes[:created_at]
end

#destination ⇒ Object

string - File moved to this destination folder



53
54
55
 
# File 'lib/files.com/models/history_export_result.rb', line 53

def destination
  @attributes[:destination]
end

#failure_type ⇒ Object

string - The type of login failure, if applicable. Valid values: ‘expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`



73
74
75
 
# File 'lib/files.com/models/history_export_result.rb', line 73

def failure_type
  @attributes[:failure_type]
end

#file_id ⇒ Object

int64 - File ID related to the action



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

def file_id
  @attributes[:file_id]
end

#folder ⇒ Object

string - Folder in which the action occurred



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

def folder
  @attributes[:folder]
end

#id ⇒ Object

int64 - Action ID



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

def id
  @attributes[:id]
end

#interface ⇒ Object

string - Inteface through which the action was taken. Valid values: ‘web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`



78
79
80
 
# File 'lib/files.com/models/history_export_result.rb', line 78

def interface
  @attributes[:interface]
end

#ip ⇒ Object

string - Client IP that performed the action



58
59
60
 
# File 'lib/files.com/models/history_export_result.rb', line 58

def ip
  @attributes[:ip]
end

#parent_id ⇒ Object

int64 - ID of the parent folder



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

def parent_id
  @attributes[:parent_id]
end

#path ⇒ Object

string - Path of the related action This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.



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

def path
  @attributes[:path]
end

#src ⇒ Object

string - File move originated from this path



48
49
50
 
# File 'lib/files.com/models/history_export_result.rb', line 48

def src
  @attributes[:src]
end

#target_expires_at ⇒ Object

int64 - If searching for Histories about API keys, this is when the API key will expire



103
104
105
 
# File 'lib/files.com/models/history_export_result.rb', line 103

def target_expires_at
  @attributes[:target_expires_at]
end

#target_id ⇒ Object

int64 - ID of the object (such as Users, or API Keys) on which the action was taken



83
84
85
 
# File 'lib/files.com/models/history_export_result.rb', line 83

def target_id
  @attributes[:target_id]
end

#target_name ⇒ Object

string - Name of the User, Group or other object with a name related to this action



88
89
90
 
# File 'lib/files.com/models/history_export_result.rb', line 88

def target_name
  @attributes[:target_name]
end

#target_permission ⇒ Object

string - Permission level of the action



93
94
95
 
# File 'lib/files.com/models/history_export_result.rb', line 93

def target_permission
  @attributes[:target_permission]
end

#target_permission_set ⇒ Object

string - If searching for Histories about API keys, this represents the permission set of the associated API key



108
109
110
 
# File 'lib/files.com/models/history_export_result.rb', line 108

def target_permission_set
  @attributes[:target_permission_set]
end

#target_platform ⇒ Object

string - If searching for Histories about API keys, this is the platform on which the action was taken



113
114
115
 
# File 'lib/files.com/models/history_export_result.rb', line 113

def target_platform
  @attributes[:target_platform]
end

#target_recursive ⇒ Object

boolean - Whether or not the action was recursive



98
99
100
 
# File 'lib/files.com/models/history_export_result.rb', line 98

def target_recursive
  @attributes[:target_recursive]
end

#target_user_id ⇒ Object

int64 - If searching for Histories about API keys, this is the User ID on which the action was taken



123
124
125
 
# File 'lib/files.com/models/history_export_result.rb', line 123

def target_user_id
  @attributes[:target_user_id]
end

#target_username ⇒ Object

string - If searching for Histories about API keys, this is the username on which the action was taken



118
119
120
 
# File 'lib/files.com/models/history_export_result.rb', line 118

def target_username
  @attributes[:target_username]
end

#user_id ⇒ Object

int64 - User ID



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

def user_id
  @attributes[:user_id]
end

#username ⇒ Object

string - Username of the user that performed the action



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

def username
  @attributes[:username]
end