closex v1.4.4 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

limit()

limit() :: Integer.t()
Link to this type

opts()

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

result()

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

search_term()

search_term() :: String.t()
Link to this type

success()

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

Link to this section Callbacks

Link to this callback

create_contact(map)

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

create_contact(map, opts)

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

create_lead(map)

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

create_lead(map, opts)

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

create_note(map)

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

create_note(map, opts)

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

create_opportunity(map)

create_opportunity(map()) :: 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)

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

create_task(id, arg2, map)

create_task(id(), String.t(), map()) :: 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(search_term)

find_all_opportunities(search_term()) :: result()
Link to this callback

find_all_opportunities(search_term, limit)

find_all_opportunities(search_term(), limit()) :: result()
Link to this callback

find_call_activities(search_term)

find_call_activities(search_term()) :: result()
Link to this callback

find_leads(search_term)

find_leads(search_term()) :: result()
Link to this callback

find_leads(search_term, opts)

find_leads(search_term(), opts()) :: result()
Link to this callback

find_opportunities(search_term)

find_opportunities(search_term()) :: result()
Link to this callback

find_opportunities(search_term, opts)

find_opportunities(search_term(), opts()) :: result()
Link to this callback

find_phone_numbers(search_term)

find_phone_numbers(search_term()) :: result()
Link to this callback

find_phone_numbers(search_term, opts)

find_phone_numbers(search_term(), opts()) :: result()
Link to this callback

get_lead(id)

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

get_lead(id, opts)

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

get_lead_custom_field(id)

get_lead_custom_field(id()) :: 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()

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

get_lead_statuses(opts)

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

get_opportunities()

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

get_opportunities(opts)

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

get_opportunity(id)

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

get_opportunity(id, opts)

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

get_opportunity_statuses()

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

get_opportunity_statuses(opts)

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

get_organization(id)

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

get_organization(id, opts)

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

get_users()

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

get_users(limit)

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

log_call(map)

log_call(map()) :: 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

merge_leads(id, id, opts)

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

send_email(map)

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

send_email(map, opts)

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

update_contact(id, map)

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

update_contact(id, map, opts)

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

update_lead(id, map)

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

update_lead(id, map, opts)

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

update_opportunity(id, map)

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

update_opportunity(id, map, opts)

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

update_task(id)

update_task(id()) :: result()
Link to this callback

update_task(id, map)

update_task(id(), map()) :: result()
Link to this callback

update_task(id, map, opts)

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