Closex.ClientBehaviour behaviour (closex v2.1.0)
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()
@type error() :: {:error, any()}
Link to this type
id()
@type id() :: String.t()
Link to this type
limit()
@type limit() :: Integer.t()
Link to this type
opts()
@type opts() :: Keyword.t()
Link to this type
result()
Link to this type
search_term()
@type search_term() :: String.t()
Link to this type
success()
@type success() :: {:ok, map()}
Link to this section Callbacks
Link to this callback
create_contact(map)
Link to this callback
create_contact(map, opts)
Link to this callback
create_email_activity(map)
Link to this callback
create_email_activity(map, opts)
Link to this callback
create_lead(map)
Link to this callback
create_lead(map, opts)
Link to this callback
create_note(map)
Link to this callback
create_note(map, opts)
Link to this callback
create_opportunity(map)
Link to this callback
create_opportunity(map, opts)
Link to this callback
create_sms_activity(map)
Link to this callback
create_sms_activity(map, opts)
Link to this callback
create_task(id, t)
Link to this callback
create_task(id, t, map)
Link to this callback
create_task(id, t, map, opts)
Link to this callback
find_activities(search_term)
@callback find_activities(search_term()) :: result()
Link to this callback
find_all_opportunities(search_term)
@callback find_all_opportunities(search_term()) :: result()
Link to this callback
find_all_opportunities(search_term, limit)
@callback find_all_opportunities(search_term(), limit()) :: result()
Link to this callback
find_call_activities(search_term)
@callback find_call_activities(search_term()) :: result()
Link to this callback
find_leads(search_term)
@callback find_leads(search_term()) :: result()
Link to this callback
find_leads(search_term, opts)
@callback find_leads(search_term(), opts()) :: result()
Link to this callback
find_opportunities(search_term)
@callback find_opportunities(search_term()) :: result()
Link to this callback
find_opportunities(search_term, opts)
@callback find_opportunities(search_term(), opts()) :: result()
Link to this callback
find_phone_numbers(search_term)
@callback find_phone_numbers(search_term()) :: result()
Link to this callback
find_phone_numbers(search_term, opts)
@callback find_phone_numbers(search_term(), opts()) :: result()
Link to this callback
get_contact(id)
Link to this callback
get_contact(id, opts)
Link to this callback
get_lead(id)
Link to this callback
get_lead(id, opts)
Link to this callback
get_lead_custom_field(id)
Link to this callback
get_lead_custom_field(id, opts)
Link to this callback
get_lead_statuses()
@callback get_lead_statuses() :: result()
Link to this callback
get_lead_statuses(opts)
Link to this callback
get_opportunities()
@callback get_opportunities() :: result()
Link to this callback
get_opportunities(opts)
Link to this callback
get_opportunity(id)
Link to this callback
get_opportunity(id, opts)
Link to this callback
get_opportunity_statuses()
@callback get_opportunity_statuses() :: result()
Link to this callback
get_opportunity_statuses(opts)
Link to this callback
get_organization(id)
Link to this callback
get_organization(id, opts)
Link to this callback
get_users()
@callback get_users() :: result()
Link to this callback
get_users(limit)
Link to this callback
log_call(map)
Link to this callback
log_call(map, opts)
Link to this callback
merge_leads(id, id)
Link to this callback
merge_leads(id, id, opts)
Link to this callback
send_email(map)
Link to this callback
send_email(map, opts)
Link to this callback
update_contact(id, map)
Link to this callback
update_contact(id, map, opts)
Link to this callback
update_lead(id, map)
Link to this callback
update_lead(id, map, opts)
Link to this callback
update_opportunity(id, map)
Link to this callback
update_opportunity(id, map, opts)
Link to this callback
update_task(id)
Link to this callback
update_task(id, map)
Link to this callback