class BrickFTP::RESTfulAPI::CreateGroup
Create a group
@see developers.files.com/#create-a-group Create a group
### Params
PARAMETER | TYPE | DESCRIPTION ——— | ———————— | ———– name | string | Name of the group. This is how the group will be displayed on the site. Maximum of 50 characters. notes | text | You may use this property to store any additional information you require. There are no restrictions on its formatting. user_ids | comma-separated integers | IDs of the users that are in this group.
Constants
- Params
Public Instance Methods
call(params)
click to toggle source
Creates a new group on the current site.
@param [BrickFTP::RESTfulAPI::CreateGroup::Params] params parameters for creating a Group @return [BrickFTP::Types::Group] created Group
# File lib/brick_ftp/restful_api/create_group.rb, line 35 def call(params) res = client.post('/api/rest/v1/groups.json', params.to_h.compact) BrickFTP::Types::Group.new(**res.symbolize_keys) end