Class: BrickFTP::RESTfulAPI::GetGroup

Inherits:

Object

• Object
• BrickFTP::RESTfulAPI::GetGroup

Includes:

Command

Defined in:

lib/brick_ftp/restful_api/get_group.rb

Overview

Show a group

See Also:

• Show a group

Instance Method Summary

• #call(id) ⇒ BrickFTP::Types::Group^?

  Returns a single group.

Methods included from Command

included, #initialize

Instance Method Details

#call(id) ⇒ BrickFTP::Types::Group^?

Returns a single group.

Parameters:

• id (Integer) —

  Globally unique identifier of each group. Each group is given an ID automatically upon creation.

Returns:

• (BrickFTP::Types::Group, nil) —

  found Group or nil

# File 'lib/brick_ftp/restful_api/get_group.rb', line 19

def call(id)
  res = client.get("/api/rest/v1/groups/#{id}.json")
  return nil if !res || res.empty?

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