Class: Grafana::Api::Teams::Members

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/teams/members.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Members

Returns a new instance of Members.



5
6
7
 
# File 'lib/grafana-api/api/teams/members.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#bulk_update(team_id:, set_team_memberships_command:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def bulk_update(team_id:, set_team_memberships_command:)
  raise ArgumentError, 'team_id is required' if team_id.nil?
  raise ArgumentError, 'set_team_memberships_command is required' if set_team_memberships_command.nil?

  @connection.call(
    :PUT,
    '/teams/{team_id}/members'
      .gsub('{team_id}', ERB::Util.url_encode(team_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: set_team_memberships_command
  )
end

#create(team_id:, add_team_member_command:) ⇒ Object

Raises:

  • (ArgumentError) 


23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/grafana-api/api/teams/members.rb', line 23

def create(team_id:, add_team_member_command:)
  raise ArgumentError, 'team_id is required' if team_id.nil?
  raise ArgumentError, 'add_team_member_command is required' if add_team_member_command.nil?

  @connection.call(
    :POST,
    '/teams/{team_id}/members'
      .gsub('{team_id}', ERB::Util.url_encode(team_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: add_team_member_command
  )
end

#delete(team_id:, user_id:) ⇒ Object

Raises:

  • (ArgumentError) 


37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/grafana-api/api/teams/members.rb', line 37

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

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

#list(team_id:) ⇒ Object

Raises:

  • (ArgumentError) 


51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/grafana-api/api/teams/members.rb', line 51

def list(team_id:)
  raise ArgumentError, 'team_id is required' if team_id.nil?

  @connection.call(
    :GET,
    '/teams/{team_id}/members'
      .gsub('{team_id}', ERB::Util.url_encode(team_id.to_s)),
    type: [Grafana::Api::Models::TeamMemberDTO],
    auth: ['api_key', 'basic']
  )
end

#update(team_id:, user_id:, update_team_member_command:) ⇒ Object

Raises:

  • (ArgumentError) 


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/grafana-api/api/teams/members.rb', line 63

def update(team_id:, user_id:, update_team_member_command:)
  raise ArgumentError, 'team_id is required' if team_id.nil?
  raise ArgumentError, 'user_id is required' if user_id.nil?
  raise ArgumentError, 'update_team_member_command is required' if update_team_member_command.nil?

  @connection.call(
    :PUT,
    '/teams/{team_id}/members/{user_id}'
      .gsub('{team_id}', ERB::Util.url_encode(team_id.to_s))
      .gsub('{user_id}', ERB::Util.url_encode(user_id.to_s)),
    type: Grafana::Api::Models::SuccessResponseBody,
    auth: ['api_key', 'basic'],
    body: update_team_member_command
  )
end