ExNylas.APIKeys (ExNylas v0.11.0)

Copy Markdown View Source

Interface for Nylas API keys.

Nylas docs

Summary

Functions

create(conn, application_id, body, signature, kid, nonce, timestamp)

Create an API key for an application.

create!(conn, application_id, body, signature, kid, nonce, timestamp)

Create an API key for an application.

delete(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

Delete an API key for an application.

delete!(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

Delete an API key for an application.

find(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

Find an API key for an application.

find!(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

Find an API key for an application.

list(conn, application_id, signature, kid, nonce, timestamp)

List API keys for an application.

list!(conn, application_id, signature, kid, nonce, timestamp)

List API keys for an application.

Functions

create(conn, application_id, body, signature, kid, nonce, timestamp)

@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")

create!(conn, application_id, body, signature, kid, nonce, timestamp)

@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")

delete(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

@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")

delete!(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

@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")

find(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

@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")

find!(conn, application_id, api_key_id, signature, kid, nonce, timestamp)

@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")

list(conn, application_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")

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")