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

@type error() :: {:error, any()}
@type id() :: String.t()
@type limit() :: Integer.t()
@type opts() :: Keyword.t()
@type result() :: success() | error()
Link to this type

search_term()

@type search_term() :: String.t()
@type success() :: {:ok, map()}

Link to this section Callbacks

Link to this callback

create_contact(map)

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

create_contact(map, opts)

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

create_email_activity(map)

@callback create_email_activity(map()) :: result()
Link to this callback

create_email_activity(map, opts)

@callback create_email_activity(map(), opts()) :: result()
Link to this callback

create_lead(map)

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

create_lead(map, opts)

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

create_note(map)

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

create_note(map, opts)

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

create_opportunity(map)

@callback create_opportunity(map()) :: result()
Link to this callback

create_opportunity(map, opts)

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

create_sms_activity(map)

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

create_sms_activity(map, opts)

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

create_task(id, t)

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

create_task(id, t, map)

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

create_task(id, t, map, opts)

@callback create_task(id(), String.t(), map(), opts()) :: result()
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)

@callback get_contact(id()) :: result()
Link to this callback

get_contact(id, opts)

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

get_lead(id, opts)

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

get_lead_custom_field(id)

@callback get_lead_custom_field(id()) :: result()
Link to this callback

get_lead_custom_field(id, opts)

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

get_lead_statuses()

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

get_lead_statuses(opts)

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

get_opportunities()

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

get_opportunities(opts)

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

get_opportunity(id)

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

get_opportunity(id, opts)

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

get_opportunity_statuses()

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

get_opportunity_statuses(opts)

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

get_organization(id)

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

get_organization(id, opts)

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

get_users(limit)

@callback get_users(limit()) :: result()
@callback log_call(map()) :: result()
Link to this callback

log_call(map, opts)

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

merge_leads(id, id)

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

merge_leads(id, id, opts)

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

send_email(map)

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

send_email(map, opts)

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

update_contact(id, map)

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

update_contact(id, map, opts)

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

update_lead(id, map)

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

update_lead(id, map, opts)

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

update_opportunity(id, map)

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

update_opportunity(id, map, opts)

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

update_task(id)

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

update_task(id, map)

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

update_task(id, map, opts)

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