Class: Files::GroupUser
- Inherits:
-
Object
- Object
- Files::GroupUser
- Defined in:
- lib/files.com/models/group_user.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(params = {}, options = {}) ⇒ Object
- .delete(id, params = {}, options = {}) ⇒ Object
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: user_id - int64 - User ID.
-
.update(id, params = {}, options = {}) ⇒ Object
Parameters: group_id (required) - int64 - Group ID to add user to.
Instance Method Summary collapse
-
#admin ⇒ Object
boolean - Is this user an administrator of this group?.
- #admin=(value) ⇒ Object
- #delete(params = {}) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#group_id ⇒ Object
int64 - Group ID.
- #group_id=(value) ⇒ Object
-
#group_name ⇒ Object
string - Group name.
- #group_name=(value) ⇒ Object
-
#id ⇒ Object
int64 - Group User ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ GroupUser
constructor
A new instance of GroupUser.
- #save ⇒ Object
-
#update(params = {}) ⇒ Object
Parameters: group_id (required) - int64 - Group ID to add user to.
-
#user_id ⇒ Object
int64 - User ID.
- #user_id=(value) ⇒ Object
-
#usernames ⇒ Object
array - A list of usernames for users in this group.
- #usernames=(value) ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ GroupUser
Returns a new instance of GroupUser.
7 8 9 10 |
# File 'lib/files.com/models/group_user.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/group_user.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/group_user.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
121 122 123 |
# File 'lib/files.com/models/group_user.rb', line 121 def self.all(params = {}, = {}) list(params, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
143 144 145 146 147 148 149 150 151 |
# File 'lib/files.com/models/group_user.rb', line 143 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("/group_users/#{params[:id]}", :delete, params, ) response.data end |
.destroy(id, params = {}, options = {}) ⇒ Object
153 154 155 |
# File 'lib/files.com/models/group_user.rb', line 153 def self.destroy(id, params = {}, = {}) delete(id, params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
user_id - int64 - User ID. If provided, will return group_users of this user.
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.
group_id - int64 - Group ID. If provided, will return group_users of this group.
108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/files.com/models/group_user.rb', line 108 def self.list(params = {}, = {}) 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: 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: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer) response, = Api.send_request("/group_users", :get, params, ) response.data.map do |entity_data| GroupUser.new(entity_data, ) end end |
.update(id, params = {}, options = {}) ⇒ Object
Parameters:
group_id (required) - int64 - Group ID to add user to.
user_id (required) - int64 - User ID to add to group.
admin - boolean - Is the user a group administrator?
129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/files.com/models/group_user.rb', line 129 def self.update(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 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: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) raise MissingParameterError.new("Parameter missing: group_id") unless params.dig(:group_id) raise MissingParameterError.new("Parameter missing: user_id") unless params.dig(:user_id) response, = Api.send_request("/group_users/#{params[:id]}", :patch, params, ) GroupUser.new(response.data, ) end |
Instance Method Details
#admin ⇒ Object
boolean - Is this user an administrator of this group?
40 41 42 |
# File 'lib/files.com/models/group_user.rb', line 40 def admin @attributes[:admin] end |
#admin=(value) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/group_user.rb', line 44 def admin=(value) @attributes[:admin] = value end |
#delete(params = {}) ⇒ Object
84 85 86 87 88 89 90 91 92 |
# File 'lib/files.com/models/group_user.rb', line 84 def delete(params = {}) params ||= {} params[:id] = @attributes[:id] raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[: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) Api.send_request("/group_users/#{@attributes[:id]}", :delete, params, @options) end |
#destroy(params = {}) ⇒ Object
94 95 96 |
# File 'lib/files.com/models/group_user.rb', line 94 def destroy(params = {}) delete(params) end |
#group_id ⇒ Object
int64 - Group ID
22 23 24 |
# File 'lib/files.com/models/group_user.rb', line 22 def group_id @attributes[:group_id] end |
#group_id=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/group_user.rb', line 26 def group_id=(value) @attributes[:group_id] = value end |
#group_name ⇒ Object
string - Group name
13 14 15 |
# File 'lib/files.com/models/group_user.rb', line 13 def group_name @attributes[:group_name] end |
#group_name=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/group_user.rb', line 17 def group_name=(value) @attributes[:group_name] = value end |
#id ⇒ Object
int64 - Group User ID.
58 59 60 |
# File 'lib/files.com/models/group_user.rb', line 58 def id @attributes[:id] end |
#id=(value) ⇒ Object
62 63 64 |
# File 'lib/files.com/models/group_user.rb', line 62 def id=(value) @attributes[:id] = value end |
#save ⇒ Object
98 99 100 |
# File 'lib/files.com/models/group_user.rb', line 98 def save update(@attributes) end |
#update(params = {}) ⇒ Object
Parameters:
group_id (required) - int64 - Group ID to add user to.
user_id (required) - int64 - User ID to add to group.
admin - boolean - Is the user a group administrator?
70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/files.com/models/group_user.rb', line 70 def update(params = {}) params ||= {} params[:id] = @attributes[:id] raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id] raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer) 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: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) raise MissingParameterError.new("Parameter missing: group_id") unless params.dig(:group_id) raise MissingParameterError.new("Parameter missing: user_id") unless params.dig(:user_id) Api.send_request("/group_users/#{@attributes[:id]}", :patch, params, @options) end |
#user_id ⇒ Object
int64 - User ID
31 32 33 |
# File 'lib/files.com/models/group_user.rb', line 31 def user_id @attributes[:user_id] end |
#user_id=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/group_user.rb', line 35 def user_id=(value) @attributes[:user_id] = value end |
#usernames ⇒ Object
array - A list of usernames for users in this group
49 50 51 |
# File 'lib/files.com/models/group_user.rb', line 49 def usernames @attributes[:usernames] end |
#usernames=(value) ⇒ Object
53 54 55 |
# File 'lib/files.com/models/group_user.rb', line 53 def usernames=(value) @attributes[:usernames] = value end |