Class: Files::Permission
- Inherits:
-
Object
- Object
- Files::Permission
- Defined in:
- lib/files.com/models/permission.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(path, params = {}, options = {}) ⇒ Object
-
.create(path, params = {}, options = {}) ⇒ Object
Parameters: group_id - int64 - Group ID path - string - Folder path permission - string - Permission type.
-
.delete(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - Permission ID.
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.list(path, params = {}, options = {}) ⇒ Object
Parameters: page - int64 - Current page number.
Instance Method Summary collapse
-
#group_id ⇒ Object
int64 - Group ID.
- #group_id=(value) ⇒ Object
-
#group_name ⇒ Object
string - Group name if applicable.
- #group_name=(value) ⇒ Object
-
#id ⇒ Object
int64 - Permission ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ Permission
constructor
A new instance of Permission.
-
#path ⇒ Object
string - Folder path This must be slash-delimited, but it must neither start nor end with a slash.
- #path=(value) ⇒ Object
-
#permission ⇒ Object
string - Permission type.
- #permission=(value) ⇒ Object
-
#recursive ⇒ Object
boolean - Does this permission apply to subfolders?.
- #recursive=(value) ⇒ Object
- #save ⇒ Object
-
#user_id ⇒ Object
int64 - User ID.
- #user_id=(value) ⇒ Object
-
#username ⇒ Object
string - User’s username.
- #username=(value) ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ Permission
Returns a new instance of Permission.
7 8 9 10 |
# File 'lib/files.com/models/permission.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/permission.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/permission.rb', line 5 def @options end |
Class Method Details
.all(path, params = {}, options = {}) ⇒ Object
114 115 116 |
# File 'lib/files.com/models/permission.rb', line 114 def self.all(path, params = {}, = {}) list(path, params, ) end |
.create(path, params = {}, options = {}) ⇒ Object
Parameters:
group_id - int64 - Group ID
path - string - Folder path
permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `previewonly`, or `history`
recursive - boolean - Apply to subfolders recursively?
user_id - int64 - User ID. Provide `username` or `user_id`
username - string - User username. Provide `username` or `user_id`
125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/files.com/models/permission.rb', line 125 def self.create(path, params = {}, = {}) params ||= {} params[:path] = path raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String) raise InvalidParameterError.new("Bad parameter: permission must be an String") if params.dig(:permission) and !params.dig(:permission).is_a?(String) 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: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String) response, = Api.send_request("/permissions", :post, params, ) Permission.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Permission ID.
140 141 142 143 144 145 146 147 148 |
# File 'lib/files.com/models/permission.rb', line 140 def self.delete(id, params = {}, = {}) params ||= {} params[:id] = id raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) response, = Api.send_request("/permissions/#{params[:id]}", :delete, params, ) response.data end |
.destroy(id, params = {}, options = {}) ⇒ Object
150 151 152 |
# File 'lib/files.com/models/permission.rb', line 150 def self.destroy(id, params = {}, = {}) delete(id, params, ) end |
.list(path, params = {}, options = {}) ⇒ Object
Parameters:
page - int64 - Current page number.
per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
path - string - Permission path. If provided, will scope permissions to this path.
group_id - string - Group ID. If provided, will scope permissions to this group.
user_id - string - User ID. If provided, will scope permissions to this user.
include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups?
101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/files.com/models/permission.rb', line 101 def self.list(path, params = {}, = {}) params ||= {} params[:path] = path raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer) 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: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String) raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String) raise InvalidParameterError.new("Bad parameter: group_id must be an String") if params.dig(:group_id) and !params.dig(:group_id).is_a?(String) raise InvalidParameterError.new("Bad parameter: user_id must be an String") if params.dig(:user_id) and !params.dig(:user_id).is_a?(String) response, = Api.send_request("/permissions", :get, params, ) end |
Instance Method Details
#group_id ⇒ Object
int64 - Group ID
49 50 51 |
# File 'lib/files.com/models/permission.rb', line 49 def group_id @attributes[:group_id] end |
#group_id=(value) ⇒ Object
53 54 55 |
# File 'lib/files.com/models/permission.rb', line 53 def group_id=(value) @attributes[:group_id] = value end |
#group_name ⇒ Object
string - Group name if applicable
58 59 60 |
# File 'lib/files.com/models/permission.rb', line 58 def group_name @attributes[:group_name] end |
#group_name=(value) ⇒ Object
62 63 64 |
# File 'lib/files.com/models/permission.rb', line 62 def group_name=(value) @attributes[:group_name] = value end |
#id ⇒ Object
int64 - Permission ID
13 14 15 |
# File 'lib/files.com/models/permission.rb', line 13 def id @attributes[:id] end |
#id=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/permission.rb', line 17 def id=(value) @attributes[:id] = value end |
#path ⇒ Object
string - Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
22 23 24 |
# File 'lib/files.com/models/permission.rb', line 22 def path @attributes[:path] end |
#path=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/permission.rb', line 26 def path=(value) @attributes[:path] = value end |
#permission ⇒ Object
string - Permission type
67 68 69 |
# File 'lib/files.com/models/permission.rb', line 67 def @attributes[:permission] end |
#permission=(value) ⇒ Object
71 72 73 |
# File 'lib/files.com/models/permission.rb', line 71 def (value) @attributes[:permission] = value end |
#recursive ⇒ Object
boolean - Does this permission apply to subfolders?
76 77 78 |
# File 'lib/files.com/models/permission.rb', line 76 def recursive @attributes[:recursive] end |
#recursive=(value) ⇒ Object
80 81 82 |
# File 'lib/files.com/models/permission.rb', line 80 def recursive=(value) @attributes[:recursive] = value end |
#save ⇒ Object
84 85 86 87 88 89 90 91 |
# File 'lib/files.com/models/permission.rb', line 84 def save if @attributes[:path] raise NotImplementedError.new("The Permission object doesn't support updates.") else new_obj = Permission.create(@attributes, @options) @attributes = new_obj.attributes end end |
#user_id ⇒ Object
int64 - User ID
31 32 33 |
# File 'lib/files.com/models/permission.rb', line 31 def user_id @attributes[:user_id] end |
#user_id=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/permission.rb', line 35 def user_id=(value) @attributes[:user_id] = value end |
#username ⇒ Object
string - User’s username
40 41 42 |
# File 'lib/files.com/models/permission.rb', line 40 def username @attributes[:username] end |
#username=(value) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/permission.rb', line 44 def username=(value) @attributes[:username] = value end |