Packages

closex

1.1.3
2.1.0 2.0.1 2.0.0 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.0 1.2.0 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.5 1.0.4 1.0.3 1.0.2 1.0.0 0.9.0 0.8.3 0.8.2 0.8.1 0.8.0 0.7.0 0.6.0 0.5.14 0.5.13 0.5.12 0.5.11 0.5.10 0.5.9 0.5.8 0.5.7 0.5.6 0.5.5 0.5.4 0.5.3 0.5.2 0.5.1 0.5.0 0.4.1 0.4.0 0.3.0 0.2.0 0.1.0

Close.io HTTP client for Elixir

HexDocs

Current section

Files

Jump to
Readme
50 Versions
3 Dependencies
Dependants
Files
Activity
closex lib closex client_behaviour.ex
Raw

lib/closex/client_behaviour.ex 

defmodule Closex.ClientBehaviour do

  @moduledoc """

  Tools for interacting with the Close.io API



  TODO: Add more docs

  """



  @type id :: String.t()

  @type opts :: Keyword.t()

  @type success :: {:ok, map}

  @type error :: {:error, any}

  @type result :: success | error



  @callback find_leads(String.t(), opts) :: result

  @callback find_opportunities(String.t(), opts) :: result

  @callback get_lead(id, opts) :: result

  @callback create_lead(map, opts) :: result

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

  @callback get_opportunity(id, opts) :: result

  @callback get_opportunities(opts) :: result

  @callback create_opportunity(map, opts) :: result

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

  @callback create_task(id, String.t(), map, opts) :: result

  @callback get_lead_custom_field(id, opts) :: result

  @callback get_organization(id, opts) :: result

  @callback get_lead_statuses(opts) :: result

  @callback get_opportunity_statuses(opts) :: result

  @callback send_email(map, opts) :: result

  @callback get_users(opts) :: result

  @callback find_all_opportunities(String.t(), Integer.t()) :: result

  @callback create_contact(map, opts) :: result

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

end