class BrickFTP::RESTfulAPI::UpdateGroup

Update a group

@see developers.files.com/#update-a-group Update 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(id, params) click to toggle source

Updates the specified group.

@param [Integer] id Globally unique identifier of each group.

Each group is given an ID automatically upon creation.

@param [BrickFTP::RESTfulAPI::UpdateGroup::Params] params parameters for updating a Group @return [BrickFTP::Types::Group] updated Group

# File lib/brick_ftp/restful_api/update_group.rb, line 37
def call(id, params)
  res = client.put("/api/rest/v1/groups/#{id}.json", params.to_h.compact)

  BrickFTP::Types::Group.new(**res.symbolize_keys)
end