Class: Conductor::Http::Api::GroupResourceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/conductor/http/api/group_resource_api.rb

Overview

GroupResourceApi - API for group management operations (Orkes)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = nil) ⇒ GroupResourceApi

Returns a new instance of GroupResourceApi.



12
13
14
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 12

def initialize(api_client = nil)
  @api_client = api_client || ApiClient.new
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



10
11
12
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 10

def api_client
  @api_client
end

Instance Method Details

#add_user_to_group(group_id, user_id) ⇒ Object

Add a user to a group



39
40
41
42
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 39

def add_user_to_group(group_id, user_id)
  @api_client.call_api('/groups/{groupId}/users/{userId}', 'POST',
                       path_params: { groupId: group_id, userId: user_id }, return_http_data_only: true)
end

#add_users_to_group(group_id, user_ids) ⇒ Object

Add multiple users to a group



57
58
59
60
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 57

def add_users_to_group(group_id, user_ids)
  @api_client.call_api('/groups/{groupId}/users', 'POST', path_params: { groupId: group_id }, body: user_ids,
                                                          return_http_data_only: true)
end

#delete_group(id) ⇒ Object

Delete a group



34
35
36
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 34

def delete_group(id)
  @api_client.call_api('/groups/{id}', 'DELETE', path_params: { id: id }, return_http_data_only: true)
end

#get_granted_permissions(group_id) ⇒ Object

Get granted permissions for a group



69
70
71
72
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 69

def get_granted_permissions(group_id)
  @api_client.call_api('/groups/{groupId}/permissions', 'GET', path_params: { groupId: group_id },
                                                               return_type: 'Object', return_http_data_only: true)
end

#get_group(id) ⇒ Object

Get a group by ID



23
24
25
26
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 23

def get_group(id)
  @api_client.call_api('/groups/{id}', 'GET', path_params: { id: id }, return_type: 'Group',
                                              return_http_data_only: true)
end

#get_users_in_group(id) ⇒ Object

Get users in a group



45
46
47
48
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 45

def get_users_in_group(id)
  @api_client.call_api('/groups/{id}/users', 'GET', path_params: { id: id },
                                                    return_type: 'Array<ConductorUser>', return_http_data_only: true)
end

#list_groups ⇒ Object

List all groups



29
30
31
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 29

def list_groups
  @api_client.call_api('/groups', 'GET', return_type: 'Array<Group>', return_http_data_only: true)
end

#remove_user_from_group(group_id, user_id) ⇒ Object

Remove a user from a group



51
52
53
54
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 51

def remove_user_from_group(group_id, user_id)
  @api_client.call_api('/groups/{groupId}/users/{userId}', 'DELETE',
                       path_params: { groupId: group_id, userId: user_id }, return_http_data_only: true)
end

#remove_users_from_group(group_id, user_ids) ⇒ Object

Remove multiple users from a group



63
64
65
66
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 63

def remove_users_from_group(group_id, user_ids)
  @api_client.call_api('/groups/{groupId}/users', 'DELETE', path_params: { groupId: group_id }, body: user_ids,
                                                            return_http_data_only: true)
end

#upsert_group(body, id) ⇒ Object

Create or update a group



17
18
19
20
 
# File 'lib/conductor/http/api/group_resource_api.rb', line 17

def upsert_group(body, id)
  @api_client.call_api('/groups/{id}', 'PUT', path_params: { id: id }, body: body, return_type: 'Group',
                                              return_http_data_only: true)
end