Class: Grafana::Api::Playlists

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Playlists

Returns a new instance of Playlists.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(create_playlist_command:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :POST,
    '/playlists',
    type: Grafana::Api::Models::Playlist,
    auth: ['api_key', 'basic'],
    body: create_playlist_command
  )
end

#delete(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/grafana-api/api/playlists.rb', line 21

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

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

#get(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/grafana-api/api/playlists.rb', line 33

def get(uid:)
  raise ArgumentError, 'uid is required' if uid.nil?

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

#items(uid:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def items(uid:)
  raise ArgumentError, 'uid is required' if uid.nil?

  @connection.call(
    :GET,
    '/playlists/{uid}/items'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: [Grafana::Api::Models::PlaylistItemDTO],
    auth: ['api_key', 'basic']
  )
end

#list(query: nil, limit: nil) ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'lib/grafana-api/api/playlists.rb', line 57

def list(query: nil, limit: nil)
  @connection.call(
    :GET,
    '/playlists',
    type: [Grafana::Api::Models::Playlist],
    auth: ['api_key', 'basic'],
    query: { 'query' => query, 'limit' => limit }
  )
end

#update(uid:, update_playlist_command:) ⇒ Object

Raises:

  • (ArgumentError) 


67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/grafana-api/api/playlists.rb', line 67

def update(uid:, update_playlist_command:)
  raise ArgumentError, 'uid is required' if uid.nil?
  raise ArgumentError, 'update_playlist_command is required' if update_playlist_command.nil?

  @connection.call(
    :PUT,
    '/playlists/{uid}'
      .gsub('{uid}', ERB::Util.url_encode(uid.to_s)),
    type: Grafana::Api::Models::PlaylistDTO,
    auth: ['api_key', 'basic'],
    body: update_playlist_command
  )
end