Module: BWAPI::Client::Projects::StreamDashboards

Includes:
Streams
Included in:
BWAPI::Client::Projects
Defined in:
lib/bwapi/client/projects/stream_dashboards.rb,
lib/bwapi/client/projects/stream_dashboards/streams.rb

Overview

StreamDashboards module for projects/stream_dashboards endpoints

Defined Under Namespace

Modules: Streams

Instance Method Summary collapse

Methods included from Streams

#create_stream, #delete_stream, #get_stream, #get_streams, #update_stream

Instance Method Details

#create_stream_dashboard(project_id, opts = {}) ⇒ Hash

Create a new stream dashboard

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the stream

  • name (String) —

    Name of the stream

  • created (String) —

    The stream creation date

  • filter (String) —

    the stream filter

Returns:

  • (Hash) —

    New stream dashboard



57
58
59
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 57

def create_stream_dashboard(project_id, opts = {})
  post "projects/#{project_id}/streamDashboards", opts
end

#delete_stream_dashboard(project_id, stream_dashboard_id) ⇒ Object

Delete a stream dashboard

Parameters:

  • project_id (Integer) —

    Id of project

  • stream_dashboard_id (Integer) —

    Id of stream dashboard



79
80
81
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 79

def delete_stream_dashboard(project_id, stream_dashboard_id)
  delete "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}"
end

#get_stream_dashboard(project_id, stream_dashboard_id) ⇒ Hash

Get a stream dashboard

Parameters:

  • project_id (Integer) —

    Id of project

  • stream_dashboard_id (Integer) —

    Id of stream dashboard

Returns:

  • (Hash) —

    Stream dashboard



44
45
46
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 44

def get_stream_dashboard(project_id, stream_dashboard_id)
  get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}"
end

#get_stream_dashboard_complete(project_id, stream_dashboard_id) ⇒ Hash

Get a stream dashboard complete with streams

Parameters:

  • project_id (Integer) —

    Id of project

  • stream_dashboard_id (Integer) —

    Id of stream dashboard

Returns:

  • (Hash) —

    Stream dashboard complete with streams



35
36
37
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 35

def get_stream_dashboard_complete(project_id, stream_dashboard_id)
  get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/complete"
end

#get_stream_dashboards_summary(project_id) ⇒ Hash

Get a stream dashboards summary

Parameters:

  • project_id (Integer) —

    Id of project

  • opts (Hash) —

    options hash of parameters

Returns:

  • (Hash) —

    All stream dashboards summary for project



26
27
28
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 26

def get_stream_dashboards_summary(project_id)
  get "projects/#{project_id}/streamDashboards/summary"
end

#stream_dashboards(project_id, opts = {}) ⇒ Hash

Get all stream dashboards in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • page (Integer) —

    Page of projects to retrieve

  • pageSize (Integer) —

    Results per page of results

Returns:

  • (Hash) —

    All stream dashboards for project



15
16
17
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 15

def stream_dashboards(project_id, opts = {})
  get "projects/#{project_id}/streamDashboards", opts
end

#update_stream_dashboard(project_id, stream_dashboard_id, opts = {}) ⇒ Hash

Update a stream dashboard

Parameters:

  • project_id (Integer) —

    Id of project

  • stream_dashboard_id (Integer) —

    Id of stream dashboard

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the stream

  • name (String) —

    Name of the stream

  • created (String) —

    The stream creation date

  • filter (String) —

    the stream filter

Returns:

  • (Hash) —

    Updated stream dashboard



71
72
73
 
# File 'lib/bwapi/client/projects/stream_dashboards.rb', line 71

def update_stream_dashboard(project_id, stream_dashboard_id, opts = {})
  put "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}", opts
end