Module: BusinessInsightApiClient::Api::Groups

Included in:
Client
Defined in:
lib/business_insight_api_client/api/groups.rb

Overview

Groups API based methods. This module contains methods to query the Groups API.

Instance Method Summary collapse

Instance Method Details

#create_group(group = {}) ⇒ Object

post: ‘/groups’

Parameters:

  • group (Hash) (defaults to: {}) —

    ({}) group to be created. See docs for parameters.

See Also:



23
24
25
 
# File 'lib/business_insight_api_client/api/groups.rb', line 23

def create_group(group = {})
  ::BusinessInsightApiClient::Mash.from_json client.post('/groups', group.to_json)
end

#group(id) ⇒ Object

get: ‘/groups/:id’

Parameters:

  • id (Integer) —

    group id

See Also:



16
17
18
 
# File 'lib/business_insight_api_client/api/groups.rb', line 16

def group(id)
  ::BusinessInsightApiClient::Mash.from_json client.get("/groups/#{id}")
end

#groups ⇒ Object

get: ‘/groups’

See Also:



9
10
11
 
# File 'lib/business_insight_api_client/api/groups.rb', line 9

def groups
  ::BusinessInsightApiClient::Mash.from_json client.get('/groups')
end

#update_group(group_id, group = {}) ⇒ Object

put: ‘/groups/:group_id’

Parameters:

  • group_id (Integer) —

    group to be updated.

  • group (Hash) (defaults to: {}) —

    ({}) parameters to be updated. See docs for parameters.

See Also:



31
32
33
 
# File 'lib/business_insight_api_client/api/groups.rb', line 31

def update_group(group_id, group = {})
  ::BusinessInsightApiClient::Mash.from_json client.put("/groups/#{group_id}", group.to_json)
end