Module: BWAPI::Client::Projects::Queries::DateRange

Included in:
BWAPI::Client::Projects::Queries
Defined in:
lib/bwapi/client/projects/queries/date_range.rb

Instance Method Summary collapse

Instance Method Details

#create_date_range(project_id, query_id, opts) ⇒ Hashie::Mash

Create a new date range for query

Options Hash (opts):

  • projectId (Integer) —

    Id of the project

  • queryId (Integer) —

    Id of the query

  • StoredDateRangeDTO (Array) —

    Date ranges to be stored



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

def create_date_range project_id, query_id, opts
  post "projects/#{project_id}/#{query_id}/date-range", opts
end

#date_range(project_id, query_id, date_range_id) ⇒ Hashie::Mash

Get specific date range for query



22
23
24
 
# File 'lib/bwapi/client/projects/queries/date_range.rb', line 22

def date_range project_id, query_id, date_range_id
  get "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}"
end

#date_ranges(project_id, query_id) ⇒ Hashie::Mash

Get all date ranges for query



12
13
14
 
# File 'lib/bwapi/client/projects/queries/date_range.rb', line 12

def date_ranges project_id, query_id
  get "projects/#{project_id}/#{query_id}/date-range"
end

#delete_date_range(project_id, query_id, date_range_id) ⇒ Hashie::Mash

Delete an existing date range for query



59
60
61
 
# File 'lib/bwapi/client/projects/queries/date_range.rb', line 59

def delete_date_range project_id, query_id, date_range_id
   delete "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}"
end

#update_date_range(project_id, query_id, opts) ⇒ Hashie::Mash

Update an existing date range for query

Options Hash (opts):

  • projectId (Integer) —

    Id of the project

  • queryId (Integer) —

    Id of the query

  • dateRangeId (Integer) —

    Id of the date range

  • StoredDateRangeDTO (Array) —

    Date ranges to be edited



49
50
51
 
# File 'lib/bwapi/client/projects/queries/date_range.rb', line 49

def update_date_range project_id, query_id, opts
  put "projects/#{project_id}/#{query_id}/date-range/#{date_range_id}", opts
end