closex v1.4.2 Closex.ClientBehaviour behaviour

Tools for interacting with the Close.io API

TODO: Add more docs

Link to this section Summary

Link to this section Types

Link to this type

error()

error() :: {:error, any()}
Link to this type

opts()

opts() :: Keyword.t()
Link to this type

result()

result() :: success() | error()
Link to this type

success()

success() :: {:ok, map()}

Link to this section Callbacks

Link to this callback

create_contact(map, opts)

create_contact(map(), opts()) :: result()
Link to this callback

create_lead(map, opts)

create_lead(map(), opts()) :: result()
Link to this callback

create_opportunity(map, opts)

create_opportunity(map(), opts()) :: result()
Link to this callback

create_sms_activity(map)

create_sms_activity(map()) :: result()
Link to this callback

create_sms_activity(map, opts)

create_sms_activity(map(), opts()) :: result()
Link to this callback

create_task(id, arg2, map, opts)

create_task(id(), String.t(), map(), opts()) :: result()
Link to this callback

find_all_opportunities(arg1, arg2)

find_all_opportunities(String.t(), Integer.t()) :: result()
Link to this callback

find_call_activities(arg1)

find_call_activities(String.t()) :: result()
Link to this callback

find_leads(arg1, opts)

find_leads(String.t(), opts()) :: result()
Link to this callback

find_opportunities(arg1, opts)

find_opportunities(String.t(), opts()) :: result()
Link to this callback

find_phone_numbers(arg1, opts)

find_phone_numbers(String.t(), opts()) :: result()
Link to this callback

get_lead(id, opts)

get_lead(id(), opts()) :: result()
Link to this callback

get_lead_custom_field(id, opts)

get_lead_custom_field(id(), opts()) :: result()
Link to this callback

get_lead_statuses(opts)

get_lead_statuses(opts()) :: result()
Link to this callback

get_opportunities(opts)

get_opportunities(opts()) :: result()
Link to this callback

get_opportunity(id, opts)

get_opportunity(id(), opts()) :: result()
Link to this callback

get_opportunity_statuses(opts)

get_opportunity_statuses(opts()) :: result()
Link to this callback

get_organization(id, opts)

get_organization(id(), opts()) :: result()
Link to this callback

get_users(opts)

get_users(opts()) :: result()
Link to this callback

log_call(map, opts)

log_call(map(), opts()) :: result()
Link to this callback

merge_leads(id, id)

merge_leads(id(), id()) :: result()
Link to this callback

send_email(map, opts)

send_email(map(), opts()) :: result()
Link to this callback

update_contact(id, map, opts)

update_contact(id(), map(), opts()) :: result()
Link to this callback

update_lead(id, map, opts)

update_lead(id(), map(), opts()) :: result()
Link to this callback

update_opportunity(id, map, opts)

update_opportunity(id(), map(), opts()) :: result()
Link to this callback

update_task(id, map)

update_task(id(), map()) :: result()