CompaniesHouse (CompaniesHouse v0.2.0)

View Source

Documentation for CompaniesHouse.

Summary

Functions

get_company_profile(company_number, client \\ %Client{})
get_filing_history(company_number, transaction_id, client \\ %Client{})
get_officer_appointment(company_number, appointment_id, client \\ %Client{})
get_person_with_significant_control(company_number, psc_id, client \\ %Client{})
get_registered_office_address(company_number, client \\ %Client{})
list_company_officers(company_number, params \\ [], client \\ %Client{})
list_filing_history(company_number, params \\ [], client \\ %Client{})
list_persons_with_significant_control(company_number, params \\ [], client \\ %Client{})
search_companies(query, params \\ [], client \\ %Client{})
search_officers(query, params \\ [], client \\ %Client{})

Functions

get_company_profile(company_number, client \\ %Client{})

@spec get_company_profile(
  company_number :: String.t(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()

get_filing_history(company_number, transaction_id, client \\ %Client{})

@spec get_filing_history(String.t(), String.t(), client :: CompaniesHouse.Client.t()) ::
  CompaniesHouse.Response.t()

get_officer_appointment(company_number, appointment_id, client \\ %Client{})

@spec get_officer_appointment(
  String.t(),
  String.t(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()

get_person_with_significant_control(company_number, psc_id, client \\ %Client{})

@spec get_person_with_significant_control(
  String.t(),
  String.t(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()

get_registered_office_address(company_number, client \\ %Client{})

@spec get_registered_office_address(
  company_number :: String.t(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()

list_company_officers(company_number, params \\ [], client \\ %Client{})

@spec list_company_officers(
  company_number :: String.t(),
  params :: keyword(),
  client :: CompaniesHouse.Client.t()
) :: CompaniesHouse.Response.t()

list_filing_history(company_number, params \\ [], client \\ %Client{})

@spec list_filing_history(String.t(), keyword(), client :: CompaniesHouse.Client.t()) ::
  CompaniesHouse.Response.t()

list_persons_with_significant_control(company_number, params \\ [], client \\ %Client{})

@spec list_persons_with_significant_control(
  String.t(),
  keyword(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()

search_companies(query, params \\ [], client \\ %Client{})

@spec search_companies(
  query :: String.t(),
  params :: keyword(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()

search_officers(query, params \\ [], client \\ %Client{})

@spec search_officers(
  query :: String.t(),
  params :: keyword(),
  client :: CompaniesHouse.Client.t()
) ::
  CompaniesHouse.Response.t()