Module: BWAPI::Client::Projects::DecahoseQueries

Included in:
BWAPI::Client::Projects
Defined in:
lib/bwapi/client/projects/decahose_queries.rb

Overview

Decahose Queries module for projects/decahosequeries endpoints

Instance Method Summary collapse

Instance Method Details

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

Create a new decahose query in project

Parameters:

  • project_id (Integer) —

    Id of project

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

    options hash of parameters

Options Hash (opts):

  • id (String) —

    Id of the decahose 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) —

    Mod. date of the query

Returns:

  • (Hash) —

    New decahose query



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

def create_decahose_query(project_id, opts = {})
  post "projects/#{project_id}/decahosequeries", opts
end

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

Get all decahose 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

  • page (Integer) —

    Page of results to retrieve

  • pageSize (Integer) —

    Results per page of results

Returns:

  • (Hash) —

    All queries in project



14
15
16
 
# File 'lib/bwapi/client/projects/decahose_queries.rb', line 14

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

#delete_decahose_query(project_id, decahose_query_id) ⇒ Hash

Delete an existing decahose query project

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of decahose query

Returns:

  • (Hash) —

    Deleted decahose query



79
80
81
 
# File 'lib/bwapi/client/projects/decahose_queries.rb', line 79

def delete_decahose_query(project_id, decahose_query_id)
  delete "projects/#{project_id}/decahosequeries/#{decahose_query_id}"
end

#get_decahose_query(project_id, decahose_query_id) ⇒ Hash

Get a specific decahose query in project

Parameters:

  • project_id (Integer) —

    Id of project

  • decahose_query_id (Integer) —

    Id of decahose query

Returns:

  • (Hash) —

    Specific decahose query



23
24
25
 
# File 'lib/bwapi/client/projects/decahose_queries.rb', line 23

def get_decahose_query(project_id, decahose_query_id)
  get "projects/#{project_id}/decahosequeries/#{decahose_query_id}"
end

#update_decahose_query(project_id, decahose_query_id, opts = {}) ⇒ Hash

Update an existing decahose query in project

Parameters:

  • project_id (Integer) —

    Id of project

  • query_id (Integer) —

    Id of decahose 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) —

    Mod. date of the query

Returns:

  • (Hash) —

    Updated query



70
71
72
 
# File 'lib/bwapi/client/projects/decahose_queries.rb', line 70

def update_decahose_query(project_id, decahose_query_id, opts = {})
  put "projects/#{project_id}/decahosequeries/#{decahose_query_id}", opts
end