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

Includes:
Backfill, DateRange, Mentions, Move
Included in:
BWAPI::Client::Projects
Defined in:
lib/bwapi/client/projects/queries.rb,
lib/bwapi/client/projects/queries/move.rb,
lib/bwapi/client/projects/queries/backfill.rb,
lib/bwapi/client/projects/queries/mentions.rb,
lib/bwapi/client/projects/queries/date_range.rb

Overview

Queries module for projects/queries endpoints

Defined Under Namespace

Modules: Backfill, DateRange, Mentions, Move

Instance Method Summary collapse

Methods included from Move

#update_move

Methods included from Mentions

#delete_query_mention, #get_query_mention_content, #update_query_mention

Methods included from DateRange

#create_date_range, #date_ranges, #delete_date_range, #get_date_range, #update_date_range

Methods included from Backfill

#backfills, #create_backfill, #delete_backfill, #get_backfill

Instance Method Details

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

Create a new query in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the query

  • name (String) —

    Name of the project

  • dailyLimit (Integer) —

    Daily limit of the query

  • twitterLimit (Integer) —

    Twitter limit of the query

  • averageMonthlyMentions (Integer) —

    Average monthly mentions

  • type (String) —

    Query type

  • includedTerms (Array) —

    Included terms of terms query

  • contextTerms (Array) —

    Content terms of the query

  • excludedTerms (Array) —

    Excluded terms of thequery

  • languages (Array) —

    Query languages

  • twitterScreenName (String) —

    Tracked twitter screen name

  • industry (String) —

    Industry of the query

  • creationDate (Date) —

    Date the query was created on

  • lastModificationDate (Date) —

    Modification date of the query

Returns:

  • (Hash) —

    New query



69
70
71
 
# File 'lib/bwapi/client/projects/queries.rb', line 69

def create_query(project_id, opts = {})
  post "projects/#{project_id}/queries", opts
end

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

Create a wizard query in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the query

  • name (String) —

    Name of the project

  • dailyLimit (Integer) —

    Daily limit of the query

  • twitterLimit (Integer) —

    Twitter limit of the query

  • averageMonthlyMentions (Integer) —

    Average monthly mentions

  • type (String) —

    Query type

  • includedTerms (Array) —

    Included terms of terms query

  • contextTerms (Array) —

    Content terms of the query

  • excludedTerms (Array) —

    Excluded terms of thequery

  • languages (Array) —

    Query languages

  • twitterScreenName (String) —

    Tracked twitter screen name

  • industry (String) —

    Industry of the query

  • usecase (String) —

    The Usecase the Query was created for

  • type (String) —

    Type of query

  • queryWizardConfiguration (Object) —

    JSON object containing configuration for Query Wizard

  • creationDate (Date) —

    Date the query was created on

  • lastModificationDate (Date) —

    Modification date of the query

Returns:

  • (Hash) —

    New query wizard



95
96
97
 
# File 'lib/bwapi/client/projects/queries.rb', line 95

def create_wizard_query(project_id, opts = {})
  post "projects/#{project_id}/querywizard", opts
end

#delete_query(project_id, query_id) ⇒ Hash

Delete an existing query project

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

Returns:

  • (Hash) —

    Deleted query



154
155
156
 
# File 'lib/bwapi/client/projects/queries.rb', line 154

def delete_query(project_id, query_id)
  delete "projects/#{project_id}/queries/#{query_id}"
end

#get_query(project_id, query_id) ⇒ Hash

Get a specific query in project

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

Returns:

  • (Hash) —

    Specific query



46
47
48
 
# File 'lib/bwapi/client/projects/queries.rb', line 46

def get_query(project_id, query_id)
  get "projects/#{project_id}/queries/#{query_id}"
end

#get_wizard_query(project_id, query_id) ⇒ Hash

Get a specific wizard query in project

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

Returns:

  • (Hash) —

    Specific wizard query



37
38
39
 
# File 'lib/bwapi/client/projects/queries.rb', line 37

def get_wizard_query(project_id, query_id)
  get "projects/#{project_id}/querywizard/#{query_id}"
end

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

Get all queries in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • nameContains (String) —

    partial name to filter by

  • type (Array) —

    types of query to filter by

  • page (Integer) —

    Page of results to retrieve

  • pageSize (Integer) —

    Results per page of results

Returns:

  • (Hash) —

    All queries in project



20
21
22
 
# File 'lib/bwapi/client/projects/queries.rb', line 20

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

#queries_summary(project_id) ⇒ Hash

Get summary of all queries in project

Parameters:

  • project_id (Integer) —

    Id of project

Returns:

  • (Hash) —

    Summary of all queries in project



28
29
30
 
# File 'lib/bwapi/client/projects/queries.rb', line 28

def queries_summary(project_id)
  get "projects/#{project_id}/queries/summary"
end

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

Update an existing query in project

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of query

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the query

  • name (String) —

    Name of the project

  • dailyLimit (Integer) —

    Daily limit of the query

  • twitterLimit (Integer) —

    Twitter limit of the query

  • averageMonthlyMentions (Integer) —

    Average monthly mentions

  • type (String) —

    Query type

  • includedTerms (Array) —

    Included terms of terms query

  • contextTerms (Array) —

    Content terms of the query

  • excludedTerms (Array) —

    Excluded terms of thequery

  • languages (Array) —

    Query languages

  • twitterScreenName (String) —

    Tracked twitter screen name

  • industry (String) —

    Industry of the query

  • creationDate (Date) —

    Date the query was created on

  • lastModificationDate (Date) —

    Modification date of the query

Returns:

  • (Hash) —

    Updated query



119
120
121
 
# File 'lib/bwapi/client/projects/queries.rb', line 119

def update_query(project_id, query_id, opts = {})
  put "projects/#{project_id}/queries/#{query_id}", opts
end

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

Update an existing wizard query in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the query

  • name (String) —

    Name of the project

  • dailyLimit (Integer) —

    Daily limit of the query

  • twitterLimit (Integer) —

    Twitter limit of the query

  • averageMonthlyMentions (Integer) —

    Average monthly mentions

  • type (String) —

    Query type

  • includedTerms (Array) —

    Included terms of terms query

  • contextTerms (Array) —

    Content terms of the query

  • excludedTerms (Array) —

    Excluded terms of thequery

  • languages (Array) —

    Query languages

  • twitterScreenName (String) —

    Tracked twitter screen name

  • industry (String) —

    Industry of the query

  • usecase (String) —

    The Usecase the Query was created for

  • type (String) —

    Type of query

  • queryWizardConfiguration (Object) —

    JSON object containing configuration for Query Wizard

  • creationDate (Date) —

    Date the query was created on

  • lastModificationDate (Date) —

    Modification date of the query

Returns:

  • (Hash) —

    Update query wizard



145
146
147
 
# File 'lib/bwapi/client/projects/queries.rb', line 145

def update_wizard_query(project_id, query_id, opts = {})
  put "projects/#{project_id}/querywizard/#{query_id}", opts
end