Exact.CRM.Contact (exact_online v0.1.0)

People, each belonging to an Exact.CRM.Account.

"Account" holds the GUID of the account the contact belongs to and is required on create.

Exact.CRM.Contact.create(client, %{
  "Account" => account_id,
  "FirstName" => "Ada",
  "LastName" => "Lovelace",
  "Email" => "ada@example.com"
})

Reference: Contacts

Summary

Functions

create(client, attrs, opts \\ [])

Creates a record. See Exact.Client.post/4.

delete(client, id, opts \\ [])

Deletes a record. See Exact.Client.delete/3.

get(client, id, opts \\ [])

Fetches one record by its ID. See Exact.Client.get/3.

key()

The primary key field of this resource.

list(client, opts \\ [])

Fetches one page. See Exact.Client.list/3.

path()

The path of this resource, relative to the division.

path(id)

The path of a single record, including the key predicate.

stream(client, opts \\ [])

Streams every record. See Exact.Client.stream/3.

update(client, id, attrs, opts \\ [])

Updates a record with the given fields. See Exact.Client.put/4.

Functions

create(client, attrs, opts \\ [])

@spec create(Exact.Client.t(), map(), keyword()) ::
  {:ok, map() | nil} | {:error, Exact.Error.t()}

Creates a record. See Exact.Client.post/4.

delete(client, id, opts \\ [])

@spec delete(Exact.Client.t(), term(), keyword()) ::
  {:ok, nil} | {:error, Exact.Error.t()}

Deletes a record. See Exact.Client.delete/3.

get(client, id, opts \\ [])

@spec get(Exact.Client.t(), term(), keyword()) ::
  {:ok, map() | nil} | {:error, Exact.Error.t()}

Fetches one record by its ID. See Exact.Client.get/3.

key()

@spec key() :: String.t()

The primary key field of this resource.

list(client, opts \\ [])

@spec list(Exact.Client.t(), keyword()) ::
  {:ok, Exact.Page.t()} | {:error, Exact.Error.t()}

Fetches one page. See Exact.Client.list/3.

path()

@spec path() :: String.t()

The path of this resource, relative to the division.

path(id)

@spec path(term()) :: String.t()

The path of a single record, including the key predicate.

Useful for the endpoints this module does not wrap, such as an action or a navigation property.

stream(client, opts \\ [])

@spec stream(Exact.Client.t(), keyword()) :: Enumerable.t()

Streams every record. See Exact.Client.stream/3.

update(client, id, attrs, opts \\ [])

@spec update(Exact.Client.t(), term(), map(), keyword()) ::
  {:ok, map() | nil} | {:error, Exact.Error.t()}

Updates a record with the given fields. See Exact.Client.put/4.