Module: BWAPI::Client::Admin::Clients::Search

Included in:
BWAPI::Client::Admin
Defined in:
lib/bwapi/client/admin/search.rb

Overview

Search module for admin/search endpoints

Instance Method Summary collapse

Instance Method Details

#search_query_name(opts) ⇒ Hashie::Mash Also known as: query_name

Get a list of query names

Parameters:

  • opts (Hash) —

    options hash of parameters

Options Hash (opts):

  • text (Integer) —

    Text expression

Returns:

  • (Hashie::Mash) —

    List of query names



23
24
25
 
# File 'lib/bwapi/client/admin/search.rb', line 23

def search_query_name opts
  get "admin/search/queryname"
end

#search_query_text(opts) ⇒ Hashie::Mash Also known as: query_text

Get a list of queries

Parameters:

  • opts (Hash) —

    options hash of parameters

Options Hash (opts):

  • text (Integer) —

    Text expression

Returns:

  • (Hashie::Mash) —

    List of queries



13
14
15
 
# File 'lib/bwapi/client/admin/search.rb', line 13

def search_query_text opts
  get "admin/search/querytext"
end

#search_rule_text(opts) ⇒ Hashie::Mash Also known as: rule_text

Get a list of rules

Parameters:

  • opts (Hash) —

    options hash of parameters

Options Hash (opts):

  • text (Integer) —

    Text expression

Returns:

  • (Hashie::Mash) —

    List of rules



33
34
35
 
# File 'lib/bwapi/client/admin/search.rb', line 33

def search_rule_text opts
  get "admin/search/ruletext"
end