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

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

Overview

DateRange module for projects/queries/dateRange endpoints

Instance Method Summary collapse

Instance Method Details

#create_date_range(project_id, query_id, opts = {}) ⇒ Hash

Create a new date range for query

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

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

    options hash of parameters

Options Hash (opts):

  • projectId (Integer) —

    Id of the project

  • queryId (Integer) —

    Id of the query

  • StoredDateRangeDTO (Array) —

    Date ranges to be stored

Returns:

  • (Hash) —

    New date range



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}/queries/#{query_id}/date-range", opts
end

#date_ranges(project_id, query_id) ⇒ Hash

Get all date ranges for query

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

Returns:

  • (Hash) —

    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}/queries/#{query_id}/date-range"
end

#delete_date_range(project_id, query_id, date_range_id) ⇒ Hash

Delete an existing date range for query

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

  • date_range_id (Integer) —

    Id of date range

Returns:

  • (Hash) —

    Deleted date range



60
61
62
 
# 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) ⇒ Hash

Get specific date range for query

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

  • date_range_id (Integer) —

    Id of date range

Returns:

  • (Hash) —

    Specific date range for query



22
23
24
 
# 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 = {}) ⇒ Hash

Update an existing date range for query

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

  • date_range_id (Integer) —

    Id of date range

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

    options hash of parameters

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

Returns:

  • (Hash) —

    Update date range



50
51
52
 
# 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