Class: BrickFTP::RESTfulAPI::CreateGroup

Inherits:

Object

• Object
• BrickFTP::RESTfulAPI::CreateGroup

Includes:

Command

Defined in:

lib/brick_ftp/restful_api/create_group.rb

Overview

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.

See Also:

• Create a group

Defined Under Namespace

Classes: Params

Instance Method Summary

• #call(params) ⇒ BrickFTP::Types::Group

  Creates a new group on the current site.

Methods included from Command

included, #initialize

Instance Method Details

#call(params) ⇒ BrickFTP::Types::Group

Creates a new group on the current site.

Parameters:

• params (BrickFTP::RESTfulAPI::CreateGroup::Params) —

  parameters for creating a Group

Returns:

• (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