module BWAPI::Client::Projects::Queries::DateRange

DateRange module for projects/queries/dateRange endpoints

Public Instance Methods

create_date_range(project_id, query_id, opts = {}) click to toggle source

Create a new date range for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param opts [Hash] options hash of parameters @option opts [Integer] projectId Id of the project @option opts [Integer] queryId Id of the query @option opts [Array] StoredDateRangeDTO Date ranges to be stored @return [Hash] New date range

# File lib/bwapi/client/projects/queries/date_range.rb, line 35
def create_date_range(project_id, query_id, opts = {})
  post "projects/#{project_id}/queries/#{query_id}/date-range", opts
end
date_ranges(project_id, query_id) click to toggle source

Get all date ranges for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @return [Hash] All date ranges for query

# File lib/bwapi/client/projects/queries/date_range.rb, line 12
def date_ranges(project_id, query_id)
  get "projects/#{project_id}/queries/#{query_id}/date-range"
end
delete_date_range(project_id, query_id, date_range_id) click to toggle source

Delete an existing date range for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param date_range_id [Integer] Id of date range @return [Hash] Deleted date range

# File lib/bwapi/client/projects/queries/date_range.rb, line 60
def delete_date_range(project_id, query_id, date_range_id)
  delete "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}"
end
get_date_range(project_id, query_id, date_range_id) click to toggle source

Get specific date range for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param date_range_id [Integer] Id of date range @return [Hash] Specific date range for query

# File lib/bwapi/client/projects/queries/date_range.rb, line 22
def get_date_range(project_id, query_id, date_range_id)
  get "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}"
end
update_date_range(project_id, query_id, date_range_id, opts = {}) click to toggle source

Update an existing date range for query

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param date_range_id [Integer] Id of date range @param opts [Hash] options hash of parameters @option opts [Integer] projectId Id of the project @option opts [Integer] queryId Id of the query @option opts [Integer] dateRangeId Id of the date range @option opts [Array] StoredDateRangeDTO Date ranges to be edited @return [Hash] Update date range

# File lib/bwapi/client/projects/queries/date_range.rb, line 50
def update_date_range(project_id, query_id, date_range_id, opts = {})
  put "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}", opts
end