Breezex.Tag (breezex v0.1.0) View Source

Module implementing the Breeze tags API.

Link to this section Summary

Functions

add_folder(config, name)

Add a folder.

add_folder(config, name, parent_id)

add_folder!(config, name)

add_folder!(config, name, parent_id)

add_tag(config, name)

Add a tag.

add_tag(config, name, folder_id)

add_tag!(config, name)

add_tag!(config, name, folder_id)

assign(config, params)

Assign a tag to a person.

assign!(config, params)

delete_folder(config, id)

Delete a folder by ID

delete_folder!(config, id)

delete_tag(config, id)

Delete a tag by ID

delete_tag!(config, id)

list_folders(config)

List all folders in Breeze

list_folders!(config)

list_people(config, id)

List people who are in a given tag, using the tag's ID

list_people!(config, id)

list_tags(config)

List all tags in Breeze

list_tags(config, id)

List all tags in a particular folder, by folder ID

list_tags!(config)

list_tags!(config, id)

unassign(config, params)

Remove a tag from a person.

unassign!(config, params)

Link to this section Functions

add_folder(config, name)

Specs

add_folder(map(), String.t()) :: Breezex.Client.client_response()

Add a folder.

Name required. Optionally, provide a parent folder ID.

add_folder(config, name, parent_id)

Specs

add_folder(map(), String.t(), integer()) :: Breezex.Client.client_response()

add_folder!(config, name)

Specs

add_folder!(map(), String.t()) :: {map(), list()} | no_return()

add_folder!(config, name, parent_id)

Specs

add_folder!(map(), String.t(), integer()) :: {map(), list()} | no_return()

add_tag(config, name)

Specs

add_tag(map(), String.t()) :: Breezex.Client.client_response()

Add a tag.

Name required. Optionally, provide a parent folder ID.

add_tag(config, name, folder_id)

Specs

add_tag(map(), String.t(), integer()) :: Breezex.Client.client_response()

add_tag!(config, name)

Specs

add_tag!(map(), String.t()) :: {map(), list()} | no_return()

add_tag!(config, name, folder_id)

Specs

add_tag!(map(), String.t(), integer()) :: {map(), list()} | no_return()

assign(config, params)

Specs

assign(map(), map()) :: Breezex.Client.client_response()

Assign a tag to a person.

Shape of params should be %{tag_id: tag_id, person_id: person_id}

assign!(config, params)

Specs

assign!(map(), map()) :: {map(), list()} | no_return()

delete_folder(config, id)

Specs

delete_folder(map(), String.t()) :: Breezex.Client.client_response()

Delete a folder by ID

delete_folder!(config, id)

Specs

delete_folder!(map(), String.t()) :: {map(), list()} | no_return()

delete_tag(config, id)

Specs

delete_tag(map(), String.t()) :: Breezex.Client.client_response()

Delete a tag by ID

delete_tag!(config, id)

Specs

delete_tag!(map(), String.t()) :: {map(), list()} | no_return()

list_folders(config)

Specs

list_folders(map()) :: Breezex.Client.client_response()

List all folders in Breeze

list_folders!(config)

Specs

list_folders!(map()) :: {map(), list()} | no_return()

list_people(config, id)

Specs

list_people(map(), String.t()) :: Breezex.Client.client_response()

List people who are in a given tag, using the tag's ID

list_people!(config, id)

Specs

list_people!(map(), String.t()) :: {map(), list()} | no_return()

unassign(config, params)

Specs

unassign(map(), map()) :: Breezex.Client.client_response()

Remove a tag from a person.

Shape of params should be %{tag_id: tag_id, person_id: person_id}

unassign!(config, params)

Specs

unassign!(map(), map()) :: {map(), list()} | no_return()