Class: Groupsync::Groups

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/groupsync/groups.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Groups

Returns a new instance of Groups.



5
6
7
 
# File 'lib/grafana-api/api/groupsync/groups.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(group_id:, group_attributes:) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/grafana-api/api/groupsync/groups.rb', line 9

def create(group_id:, group_attributes:)
  raise ArgumentError, 'group_id is required' if group_id.nil?
  raise ArgumentError, 'group_attributes is required' if group_attributes.nil?

  @connection.call(
    :POST,
    '/groupsync/groups/{group_id}'
      .gsub('{group_id}', ERB::Util.url_encode(group_id.to_s)),
    type: Grafana::Api::Models::MessageResponse,
    auth: ['api_key', 'basic'],
    body: group_attributes
  )
end

#delete(group_id:) ⇒ Object

Raises:

  • (ArgumentError) 


23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/grafana-api/api/groupsync/groups.rb', line 23

def delete(group_id:)
  raise ArgumentError, 'group_id is required' if group_id.nil?

  @connection.call(
    :DELETE,
    '/groupsync/groups/{group_id}'
      .gsub('{group_id}', ERB::Util.url_encode(group_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic']
  )
end

#list ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/grafana-api/api/groupsync/groups.rb', line 35

def list
  @connection.call(
    :GET,
    '/groupsync/groups',
    type: Grafana::Api::Models::GetGroupsResponse,
    auth: ['api_key', 'basic']
  )
end

#roles(group_id:) ⇒ Object

Raises:

  • (ArgumentError) 


44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/grafana-api/api/groupsync/groups.rb', line 44

def roles(group_id:)
  raise ArgumentError, 'group_id is required' if group_id.nil?

  @connection.call(
    :GET,
    '/groupsync/groups/{group_id}/roles'
      .gsub('{group_id}', ERB::Util.url_encode(group_id.to_s)),
    type: [Grafana::Api::Models::RoleDTO],
    auth: ['api_key', 'basic']
  )
end

#update(group_id:, group_attributes:) ⇒ Object

Raises:

  • (ArgumentError) 


56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/grafana-api/api/groupsync/groups.rb', line 56

def update(group_id:, group_attributes:)
  raise ArgumentError, 'group_id is required' if group_id.nil?
  raise ArgumentError, 'group_attributes is required' if group_attributes.nil?

  @connection.call(
    :PUT,
    '/groupsync/groups/{group_id}'
      .gsub('{group_id}', ERB::Util.url_encode(group_id.to_s)),
    type: Grafana::Api::Models::MessageResponse,
    auth: ['api_key', 'basic'],
    body: group_attributes
  )
end