Aurinko.API.Tasks (Aurinko v0.2.1)

Copy Markdown View Source

Aurinko Tasks API — manage task lists and todos.

Supports Google Tasks, Microsoft To Do, and Exchange Tasks.

Summary

Functions

create_task(token, task_list_id, params)

@spec create_task(String.t(), String.t(), map()) ::
  {:ok, Aurinko.Types.Task.t()} | {:error, Aurinko.Error.t()}

Create a task.

Parameters

  • :title — Task title (required)
  • :body — Task description
  • :due — Due date (DateTime)
  • :importance"low", "normal", or "high"
  • :status"notStarted", "inProgress", or "completed"

delete_task(token, task_list_id, task_id)

@spec delete_task(String.t(), String.t(), String.t()) ::
  :ok | {:error, Aurinko.Error.t()}

Delete a task.

list_task_lists(token, opts \\ [])

@spec list_task_lists(
  String.t(),
  keyword()
) :: {:ok, [map()]} | {:error, Aurinko.Error.t()}

List all task lists.

list_tasks(token, task_list_id, opts \\ [])

@spec list_tasks(String.t(), String.t(), keyword()) ::
  {:ok, Aurinko.Types.Pagination.t()} | {:error, Aurinko.Error.t()}

List tasks in a task list.

Options

  • :limit — Number of results
  • :page_token — Pagination token
  • :status — Filter by status ("notStarted", "inProgress", "completed")

update_task(token, task_list_id, task_id, params)

@spec update_task(String.t(), String.t(), String.t(), map()) ::
  {:ok, Aurinko.Types.Task.t()} | {:error, Aurinko.Error.t()}

Update a task.