Mercury.Categories (mercury_client v1.0.0)

The Mercury Categories API — expense categories.

Summary

Functions

create(client, attrs)

Creates a new expense category. POST /categories

create!(client, attrs)

delete(client, category_id)

Deletes a category. DELETE /categories/{id}

delete!(client, category_id)

list(client, opts \\ [])

Returns one page of categories. GET /categories

list!(client, opts \\ [])

stream(client, opts \\ [])

A lazy, auto-paginating stream of every category.

update(client, category_id, attrs)

Renames a category. PUT /categories/{id}

update!(client, category_id, attrs)

Functions

create(client, attrs)

@spec create(client :: Mercury.Client.t(), attrs :: map() | keyword()) ::
  {:ok, Mercury.Category.t()} | {:error, Exception.t()}

Creates a new expense category. POST /categories

create!(client, attrs)

@spec create!(client :: Mercury.Client.t(), attrs :: map() | keyword()) ::
  Mercury.Category.t()

delete(client, category_id)

@spec delete(client :: Mercury.Client.t(), category_id :: String.t()) ::
  :ok | {:error, Exception.t()}

Deletes a category. DELETE /categories/{id}

delete!(client, category_id)

@spec delete!(client :: Mercury.Client.t(), category_id :: String.t()) :: :ok

list(client, opts \\ [])

@spec list(client :: Mercury.Client.t(), opts :: keyword()) ::
  {:ok, Mercury.Page.t(Mercury.Category.t())} | {:error, Exception.t()}

Returns one page of categories. GET /categories

list!(client, opts \\ [])

@spec list!(client :: Mercury.Client.t(), opts :: keyword()) ::
  Mercury.Page.t(Mercury.Category.t())

stream(client, opts \\ [])

@spec stream(client :: Mercury.Client.t(), opts :: keyword()) :: Enumerable.t()

A lazy, auto-paginating stream of every category.

update(client, category_id, attrs)

@spec update(
  client :: Mercury.Client.t(),
  category_id :: String.t(),
  attrs :: map() | keyword()
) ::
  {:ok, Mercury.Category.t()} | {:error, Exception.t()}

Renames a category. PUT /categories/{id}

update!(client, category_id, attrs)

@spec update!(
  client :: Mercury.Client.t(),
  category_id :: String.t(),
  attrs :: map() | keyword()
) ::
  Mercury.Category.t()