module UkCompaniesHouse::Search

Public Class Methods

all(q, items_per_page = nil, start_index = nil) click to toggle source

Search Companies House

# File lib/uk_companies_house/search.rb, line 10
def all(q, items_per_page = nil, start_index = nil)
  params = {q: q,
            items_per_page: items_per_page,
            start_index: start_index}
  client.get("search", params)
end
client() click to toggle source
# File lib/uk_companies_house/search.rb, line 5
def client
  UkCompaniesHouse::Client.new
end
company(q, items_per_page = nil, start_index = nil) click to toggle source

Search company information

# File lib/uk_companies_house/search.rb, line 18
def company(q, items_per_page = nil, start_index = nil)
  params = {q: q,
            items_per_page: items_per_page,
            start_index: start_index}
  client.get("search/companies", params)
end
disqualified_officers(q, items_per_page = nil, start_index = nil) click to toggle source

Search for disqualified officer information

# File lib/uk_companies_house/search.rb, line 34
def disqualified_officers(q, items_per_page = nil, start_index = nil)
  params = {q: q,
            items_per_page: items_per_page,
            start_index: start_index}
  client.get("search/disqualified-officers", params)
end
officers(q, items_per_page = nil, start_index = nil) click to toggle source

Search for officer information

# File lib/uk_companies_house/search.rb, line 26
def officers(q, items_per_page = nil, start_index = nil)
  params = {q: q,
            items_per_page: items_per_page,
            start_index: start_index}
  client.get("search/officers", params)
end