Class: Increase::Resources::Groups

Inherits:

Object

• Object
• Increase::Resources::Groups

Defined in:

lib/increase/resources/groups.rb

Instance Method Summary

• #initialize(client:) ⇒ Groups constructor private

  A new instance of Groups.

• #retrieve(request_options: {}) ⇒ Increase::Models::Group

  Returns details for the currently authenticated Group.

Constructor Details

#initialize(client:) ⇒ Groups

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Groups.

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/groups.rb', line 27

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Increase::Models::Group

Returns details for the currently authenticated Group.

Parameters:

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Models::Group)

See Also:

• Models::GroupRetrieveParams

# File 'lib/increase/resources/groups.rb', line 15

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "groups/current",
    model: Increase::Group,
    options: params[:request_options]
  )
end