Infusionsoft.Endpoints.XML.Search (Infusionsoft v0.7.0) View Source

Provides the raw endpoints to Infusionsoft's XML API for Search.

Link to this section Summary

Link to this section Functions

Link to this function

retrieve_available_fields(saved_search_id, user_id, token, app \\ nil)

View Source

Specs

retrieve_available_fields(
  integer(),
  integer() | String.t(),
  String.t(),
  nil | String.t()
) :: {:ok, map()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#search-retrieve-a-report-s-available-fields

Link to this function

retrieve_available_quick_searches(user_id, token, app \\ nil)

View Source

Specs

retrieve_available_quick_searches(
  integer() | String.t(),
  String.t(),
  nil | String.t()
) :: {:ok, map()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#search-retrieve-available-quick-searches

Link to this function

retrieve_default_quick_search(user_id, token, app \\ nil)

View Source

Specs

retrieve_default_quick_search(
  integer() | String.t(),
  String.t(),
  nil | String.t()
) :: {:ok, any()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#search-retrieve-the-default-quick-search

Link to this function

retrieve_partial_report(saved_search_id, user_id, page_number, return_fields, token, app \\ nil)

View Source

Specs

retrieve_partial_report(
  integer(),
  integer() | String.t(),
  integer(),
  [String.t()],
  String.t(),
  nil | String.t()
) :: {:ok, list()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#search-retrieve-a-partial-report-from-a-saved-search

Link to this function

retrieve_quick_search(search_type, user_id, search_data, token, app, opts \\ [])

View Source

Specs

retrieve_quick_search(
  String.t(),
  integer() | String.t(),
  String.t(),
  String.t(),
  nil | String.t(),
  keyword()
) :: {:ok, list()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#search-retrieve-a-quick-search-report

Available options: page - defaults to 0 limit - defaults to 1000

Link to this function

retrieve_search_report(saved_search_id, user_id, page_number, token, app \\ nil)

View Source

Specs

retrieve_search_report(
  integer(),
  integer() | String.t(),
  integer(),
  String.t(),
  nil | String.t()
) :: {:ok, list()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#search-retrieve-a-complete-report-from-a-saved-search