Infusionsoft

v0.3.0

Infusionsoft v0.3.0 Infusionsoft.Endpoints.XML.Data View Source

Provides the raw endpoints to Infusionsoft’s XML API for Data actions.

Link to this section Summary

Functions

authenticate_user(username, password_hash, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-validate-a-user-s-credentials

count_records(data, table, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-count-a-data-table-s-records

create_custom_field(name, table, type, header, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-create-a-custom-field

create_record(data, table, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-create-a-record

delete_record(id, table, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-delete-a-record

find_by_field(value, field, table, return_fields, token, app, opts \\ [])

https://developer.infusionsoft.com/docs/xml-rpc/#data-find-a-record-by-matching-a-specific-field

query_all_from_table(query, table, r_fields, token, app, opts \\ [])

Helper to recurse and get the full number of records instead of one page

query_table(query, table, return_fields, token, app, opts \\ [])

https://developer.infusionsoft.com/docs/xml-rpc/#data-query-a-data-table

retrieve_app_settings(module, setting, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-retrieve-application-setting

retrieve_appt_ical(id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-retrieve-an-appointment-s-icalendar-file

retrieve_record(id, table, fields, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-retrieve-a-record

update_custom_field(id, data, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-update-a-custom-field

update_record(data, id, table, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#data-update-a-record

Link to this section Functions

Link to this function authenticate_user(username, password_hash, token, app \\ nil) View Source 
authenticate_user(String.t(), String.t(), String.t(), nil | String.t()) ::
  {:ok, integer() | String.t()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-validate-a-user-s-credentials

Link to this function count_records(data, table, token, app \\ nil) View Source 
count_records(map(), String.t(), String.t(), nil | String.t()) ::
  {:ok, integer()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-count-a-data-table-s-records

Link to this function create_custom_field(name, table, type, header, token, app \\ nil) View Source 
create_custom_field(
  String.t(),
  String.t(),
  String.t(),
  integer(),
  String.t(),
  nil | String.t()
) :: {:ok, integer()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-create-a-custom-field

Link to this function create_record(data, table, token, app \\ nil) View Source 
create_record(map(), String.t(), String.t(), nil | String.t()) ::
  {:ok, integer()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-create-a-record

Link to this function delete_record(id, table, token, app \\ nil) View Source 
delete_record(integer(), String.t(), String.t(), nil | String.t()) ::
  {:ok, boolean()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-delete-a-record

Link to this function find_by_field(value, field, table, return_fields, token, app, opts \\ []) View Source 
find_by_field(
  String.t(),
  String.t(),
  String.t(),
  [String.t()],
  String.t(),
  nil | String.t(),
  keyword()
) :: {:ok, list()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-find-a-record-by-matching-a-specific-field

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

Link to this function query_all_from_table(query, table, r_fields, token, app, opts \\ []) View Source 
query_all_from_table(
  map(),
  String.t(),
  [String.t()],
  String.t(),
  nil | String.t(),
  keyword()
) :: {:ok, list()} | {:error, String.t()}

Helper to recurse and get the full number of records instead of one page

https://developer.infusionsoft.com/docs/xml-rpc/#data-query-a-data-table

Available options: order_by - defualts to Id ascending - defaults to false

Link to this function query_table(query, table, return_fields, token, app, opts \\ []) View Source 
query_table(
  map(),
  String.t(),
  [String.t()],
  String.t(),
  nil | String.t(),
  keyword()
) :: {:ok, list()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-query-a-data-table

Available options: page - defaults to 0 limit - defaults to 1000 order_by - defualts to Id ascending - defaults to false

Link to this function retrieve_app_settings(module, setting, token, app \\ nil) View Source 
retrieve_app_settings(String.t(), String.t(), String.t(), nil | String.t()) ::
  {:ok, String.t()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-retrieve-application-setting

Link to this function retrieve_appt_ical(id, token, app \\ nil) View Source 
retrieve_appt_ical(integer(), String.t(), nil | String.t()) ::
  {:ok, String.t()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-retrieve-an-appointment-s-icalendar-file

Link to this function retrieve_record(id, table, fields, token, app \\ nil) View Source 
retrieve_record(
  integer(),
  String.t(),
  [String.t()],
  String.t(),
  nil | String.t()
) :: {:ok, map()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-retrieve-a-record

Link to this function update_custom_field(id, data, token, app \\ nil) View Source 
update_custom_field(integer(), map(), String.t(), nil | String.t()) ::
  {:ok, boolean()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-update-a-custom-field

Link to this function update_record(data, id, table, token, app \\ nil) View Source 
update_record(map(), integer(), String.t(), String.t(), nil | String.t()) ::
  {:ok, integer()} | {:error, String.t()}

https://developer.infusionsoft.com/docs/xml-rpc/#data-update-a-record