Infusionsoft v0.1.0 Infusionsoft.Schemas View Source

Provides functions for transforming field names.

The “to” functions take lists of Common names and turn them into REST or XML names.

The “from” functions take lists of REST or XML names and turn them into Common names.

Link to this section Summary

Functions

from_rest(names, token, type)

Takes a list of REST names and returns Common names

from_xml(names, token, type)

Takes a list of XML names and returns Common names

to_rest(names, token, type)

Takes a list of Common names and returns REST names

to_xml(names, token, type)

Takes a list of Common names and returns XML names

Link to this section Functions

from_rest(names, token, type)

from_rest([String.t()], String.t(), atom()) ::
  {:ok, list()} | {:error, String.t()}

Takes a list of REST names and returns Common names.

Names that aren’t in the standard set of REST names will be treated as custom field names.

Names that don’t match anything trigger an error showing all the names that didn’t match.

Examples

iex> Infusionsoft.Schemas.from_rest(["given_name"], "test_token", :contacts)
{:ok, ["First Name"]}

iex> Infusionsoft.Schemas.from_rest(["family_name"], "test_token", :not_a_valid_type)
{:error, "The type \"not_a_valid_type\" is invalid"}

iex> Infusionsoft.Schemas.from_rest(["Not a valid name"], "test_token", :contacts)
{:error, "The name \"Not a valid name\" is not a standard or custom contact field"}

from_xml(names, token, type)

from_xml([String.t()], String.t(), atom()) ::
  {:ok, list()} | {:error, String.t()}

Takes a list of XML names and returns Common names.

Names that aren’t in the standard set of XML names will be treated as custom field names.

Names that don’t match anything trigger an error showing all the names that didn’t match.

Examples

iex> Infusionsoft.Schemas.from_xml(["FirstName"], "test_token", :contacts)
{:ok, ["First Name"]}

iex> Infusionsoft.Schemas.from_xml(["LastName"], "test_token", :not_a_valid_type)
{:error, "The type \"not_a_valid_type\" is invalid"}

iex> Infusionsoft.Schemas.from_xml(["Not a valid name"], "test_token", :contacts)
{:error, "The name \"Not a valid name\" is not a standard or custom contact field"}

to_rest(names, token, type)

to_rest([String.t()], String.t(), atom()) ::
  {:ok, list()} | {:error, String.t()}

Takes a list of Common names and returns REST names.

Names that aren’t in the standard set of Common names will be treated as custom field names.

Names that don’t match anything trigger an error showing all the names that didn’t match.

Inputs are not case sensitive, but be careful to include any spaces. For example, “fIrSt NaMe” is fine but “Firstname” would fail.

Examples

iex> Infusionsoft.Schemas.to_rest(["First Name"], "test_token", :contacts)
{:ok, ["given_name"]}

iex> Infusionsoft.Schemas.to_rest(["lAsT nAmE"], "test_token", :contacts)
{:ok, ["family_name"]}

iex> Infusionsoft.Schemas.to_rest(["Last Name"], "test_token", :not_a_valid_type)
{:error, "The type \"not_a_valid_type\" is invalid"}

iex> Infusionsoft.Schemas.to_rest(["Not a valid name"], "test_token", :contacts)
{:error, "The name \"Not a valid name\" is not a standard or custom contact field"}

to_xml(names, token, type)

to_xml([String.t()], String.t(), atom()) :: {:ok, list()} | {:error, String.t()}

Takes a list of Common names and returns XML names.

Names that aren’t in the standard set of Common names will be treated as custom field names.

Names that don’t match anything trigger an error showing all the names that didn’t match.

Inputs are not case sensitive, but be careful to include any spaces. For example, “fIrSt NaMe” is fine but “Firstname” would fail.

Examples

iex> Infusionsoft.Schemas.to_xml(["First Name"], "test_token", :contacts)
{:ok, ["FirstName"]}

iex> Infusionsoft.Schemas.to_xml(["lAsT nAmE"], "test_token", :contacts)
{:ok, ["LastName"]}

iex> Infusionsoft.Schemas.to_xml(["Last Name"], "test_token", :not_a_valid_type)
{:error, "The type \"not_a_valid_type\" is invalid"}

iex> Infusionsoft.Schemas.to_xml(["Not a valid name"], "test_token", :contacts)
{:error, "The name \"Not a valid name\" is not a standard or custom contact field"}