View Source ExNylas.APIKeys (ExNylas v0.9.0)
Interface for Nylas API keys.
Summary
Functions
Create an API key for an application.
Create an API key for an application.
Delete an API key for an application.
Delete an API key for an application.
Find an API key for an application.
Find an API key for an application.
List API keys for an application.
List API keys for an application.
Functions
Link to this function
create(conn, application_id, body, signature, kid, nonce, timestamp)
View Source@spec create( ExNylas.Connection.t(), String.t(), map(), String.t(), String.t(), String.t(), String.t() ) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Create an API key for an application.
Examples
iex> {:ok, result} = ExNylas.APIKeys.create(conn, "application_id", %{name: "My API Key", expires_in: 90 }, "signature", "kid", "nonce", "timestamp")
Link to this function
create!(conn, application_id, body, signature, kid, nonce, timestamp)
View Source@spec create!( ExNylas.Connection.t(), String.t(), map(), String.t(), String.t(), String.t(), String.t() ) :: ExNylas.Response.t()
Create an API key for an application.
Examples
iex> result = ExNylas.APIKeys.create!(conn, "application_id", %{name: "My API Key", expires_in: 90 }, "signature", "kid", "nonce", "timestamp")
Link to this function
delete(conn, application_id, api_key_id, signature, kid, nonce, timestamp)
View Source@spec delete( ExNylas.Connection.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t() ) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Delete an API key for an application.
Examples
iex> {:ok, result} = ExNylas.APIKeys.delete(conn, "application_id", "api_key_id", "signature", "kid", "nonce", "timestamp")
Link to this function
delete!(conn, application_id, api_key_id, signature, kid, nonce, timestamp)
View Source@spec delete!( ExNylas.Connection.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t() ) :: ExNylas.Response.t()
Delete an API key for an application.
Examples
iex> result = ExNylas.APIKeys.delete!(conn, "application_id", "api_key_id", "signature", "kid", "nonce", "timestamp")
Link to this function
find(conn, application_id, api_key_id, signature, kid, nonce, timestamp)
View Source@spec find( ExNylas.Connection.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t() ) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
Find an API key for an application.
Examples
iex> {:ok, result} = ExNylas.APIKeys.find(conn, "application_id", "api_key_id", "signature", "kid", "nonce", "timestamp")
Link to this function
find!(conn, application_id, api_key_id, signature, kid, nonce, timestamp)
View Source@spec find!( ExNylas.Connection.t(), String.t(), String.t(), String.t(), String.t(), String.t(), String.t() ) :: ExNylas.Response.t()
Find an API key for an application.
Examples
iex> result = ExNylas.APIKeys.find!(conn, "application_id", "api_key_id", "signature", "kid", "nonce", "timestamp")
@spec list( ExNylas.Connection.t(), String.t(), String.t(), String.t(), String.t(), String.t() ) :: {:ok, ExNylas.Response.t()} | {:error, ExNylas.Response.t()}
List API keys for an application.
Examples
iex> {:ok, result} = ExNylas.APIKeys.list(conn, "application_id", "signature", "kid", "nonce", "timestamp")
@spec list!( ExNylas.Connection.t(), String.t(), String.t(), String.t(), String.t(), String.t() ) :: ExNylas.Response.t()
List API keys for an application.
Examples
iex> result = ExNylas.APIKeys.list!(conn, "application_id", "signature", "kid", "nonce", "timestamp")