View Source ExNylas.ConnectorCredentials (ExNylas v0.9.0)
Interface for Nylas connector credentials.
Summary
Functions
Create and validate a connector credential, use create/update to send to Nylas.
Create and validate a connector credential, use create/update to send to Nylas.
Create a connector credential.
Create a connector credential.
Delete a connector credential.
Delete a connector credential.
Find a connector credential.
Find a connector credential.
List connector credentials.
List connector credentials.
Update a connector credential.
Update a connector credential.
Functions
@spec build(map() | struct()) :: {:ok, struct()} | {:error, Ecto.Changeset.t()}
Create and validate a connector credential, use create/update to send to Nylas.
Examples
iex> {:ok, result} = ExNylas.ConnectorCredentials.build(payload)
Create and validate a connector credential, use create/update to send to Nylas.
Examples
iex> result = ExNylas.ConnectorCredentials.build!(payload)
@spec create(ExNylas.Connection.t(), String.t() | atom(), map()) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Create a connector credential.
Example
{:ok, cred} = ExNylas.ConnectorCredentials.create(conn, provider, body)
@spec create!(ExNylas.Connection.t(), String.t() | atom(), map()) :: ExNylas.Response.t()
Create a connector credential.
Example
cred = ExNylas.ConnectorCredentials.create!(conn, provider, body)
@spec delete(ExNylas.Connection.t(), String.t() | atom(), String.t()) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Delete a connector credential.
Example
{:ok, res} = ExNylas.ConnectorCredentials.delete(conn, provider, id)
@spec delete!(ExNylas.Connection.t(), String.t() | atom(), String.t()) :: ExNylas.Response.t()
Delete a connector credential.
Example
res = ExNylas.ConnectorCredentials.delete!(conn, provider, id)
@spec find(ExNylas.Connection.t(), String.t() | atom(), String.t()) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Find a connector credential.
Example
{:ok, cred} = ExNylas.ConnectorCredentials.find(conn, provider, id)
@spec find!(ExNylas.Connection.t(), String.t() | atom(), String.t()) :: ExNylas.Response.t()
Find a connector credential.
Example
cred = ExNylas.ConnectorCredentials.find(conn, provider, id)
@spec list(ExNylas.Connection.t(), String.t() | atom(), Keyword.t() | list()) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
List connector credentials.
Example
{:ok, creds} = ExNylas.ConnectorCredentials.list(conn, provider)
@spec list!(ExNylas.Connection.t(), String.t() | atom(), Keyword.t() | list()) :: ExNylas.Response.t()
List connector credentials.
Example
creds = ExNylas.ConnectorCredentials.list!(conn, provider)
@spec update(ExNylas.Connection.t(), String.t() | atom(), String.t(), map()) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Update a connector credential.
Examples
iex> {:ok, cred} = ExNylas.ConnectorCredentials.update(conn, provider, id, changeset)
@spec update!(ExNylas.Connection.t(), String.t() | atom(), String.t(), map()) :: ExNylas.Response.t()
Update a connector credential.
Examples
iex> cred = ExNylas.ConnectorCredentials.update!(conn, provider, id, changeset)