module BWAPI::Client::Projects::TwitterQueries

TwitterQueries module for projects/twitterqueries endpoints

Public Instance Methods

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

Create a twitter query in a project

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the query @option opts [String] name Name of the query @option opts [Boolean] authorised Is query authorised @option opts [Integer] averageMonthlyMentions Average monthly mentions @option opts [Array] contextTerms Content terms of the query @option opts [Array] excludedTerms Excluded terms of thequery @option opts [Array] includedTerms Included terms of terms query @option opts [Date] creationDate Date the query was created on @option opts [Integer] dailyLimit Daily limit of the query @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status @option opts [Integer] facebookPageId Id of the facebook page @option opts [String] facebookPageName Name of the facebook page @option opts [Boolean] failed Triggered too many Facebook API request failures @option opts [String] industry Industry of the query @option opts [Array] languages Query languages set @option opts [Date] lastModificationDate Last modification date of the query @option opts [String] type Query type @option opts [String] twitterLimit Twitter limit @option opts [String] twitterScreenName Twitter screen name @return [Hash] New twitter query

# File lib/bwapi/client/projects/twitter_queries.rb, line 47
def create_twitter_query(project_id, opts = {})
  post "projects/#{project_id}/twitterqueries", opts
end
delete_twitter_query(project_id, query_id) click to toggle source

Delete a Twitter query

TODO: Add parameters documentation

# File lib/bwapi/client/projects/twitter_queries.rb, line 83
def delete_twitter_query(project_id, query_id)
  delete "/projects/#{project_id}/twitterqueries/#{query_id}"
end
get_twitter_query(project_id, query_id) click to toggle source

Get a specific twitter query in a project

@param project_id [Integer] Id of project @param query_id [Integer] Id of twitter query @return [Hash] Specific twitter query

# File lib/bwapi/client/projects/twitter_queries.rb, line 19
def get_twitter_query(project_id, query_id)
  get "projects/#{project_id}/twitterqueries/#{query_id}"
end
twitter_queries(project_id) click to toggle source

Get all twitter queries in a project

@param project_id [Integer] Id of project @return [Hash] All twitter queries in project

# File lib/bwapi/client/projects/twitter_queries.rb, line 10
def twitter_queries(project_id)
  get "projects/#{project_id}/twitterqueries"
end
update_twitter_query(project_id, query_id, opts = {}) click to toggle source

Update an existing twitter query in a project

@param project_id [Integer] Id of project @param query_id [Integer] Id of query @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the query @option opts [String] name Name of the query @option opts [Boolean] authorised Is query authorised @option opts [Integer] averageMonthlyMentions Average monthly mentions @option opts [Array] contextTerms Content terms of the query @option opts [Array] excludedTerms Excluded terms of thequery @option opts [Array] includedTerms Included terms of terms query @option opts [Date] creationDate Date the query was created on @option opts [Integer] dailyLimit Daily limit of the query @option opts [Boolean] facebookCrawlComplete Facebook initial crawling status @option opts [Integer] facebookPageId Id of the facebook page @option opts [String] facebookPageName Name of the facebook page @option opts [Boolean] failed Triggered too many Facebook API request failures @option opts [String] industry Industry of the query @option opts [Array] languages Query languages set @option opts [Date] lastModificationDate Last modification date of the query @option opts [String] type Query type @option opts [String] twitterLimit Twitter limit @option opts [String] twitterScreenName Twitter screen name @return [Hash] Updated twitter query

# File lib/bwapi/client/projects/twitter_queries.rb, line 76
def update_twitter_query(project_id, query_id, opts = {})
  put "projects/#{project_id}/twitterqueries/#{query_id}", opts
end