module BWAPI::Client::Projects::StreamDashboards
StreamDashboards
module for projects/stream_dashboards endpoints
Public Instance Methods
Create a new stream dashboard
@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the stream @option opts [String] name Name of the stream @option opts [String] created The stream creation date @option opts [String] filter the stream filter @return [Hash] New stream dashboard
# 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 a stream dashboard
@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard
# 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 a stream dashboard
@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @return [Hash] Stream dashboard
# 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 a stream dashboard complete with streams
@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @return [Hash] Stream dashboard complete with streams
# 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 a stream dashboards summary
@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] All stream dashboards summary for project
# File lib/bwapi/client/projects/stream_dashboards.rb, line 26 def get_stream_dashboards_summary(project_id) get "projects/#{project_id}/streamDashboards/summary" end
Get all stream dashboards in project
@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] All stream dashboards for project
# File lib/bwapi/client/projects/stream_dashboards.rb, line 15 def stream_dashboards(project_id, opts = {}) get "projects/#{project_id}/streamDashboards", opts end
Update a stream dashboard
@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the stream @option opts [String] name Name of the stream @option opts [String] created The stream creation date @option opts [String] filter the stream filter @return [Hash] Updated stream dashboard
# 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