Skip to content

Tag API

Source code in upriver/sdk/tag/tag_api.py 
8
9
def __init__(self, session: Session):
    self._session = session

get_all_tags 

get_all_tags()

Gets all tags.

RETURNS DESCRIPTION
List[Tag]

A list of all tags.
RAISES DESCRIPTION
requests.HTTPError

If the request fails.
Source code in upriver/sdk/tag/tag_api.py 
11
12
13
14
15
16
17
18
def get_all_tags(self) -> List[Tag]:
    """
    Gets all tags.
    :return: A list of all tags.
    :raises requests.HTTPError: If the request fails.
    """
    response = self._session.get("tag/all", "v1")
    return [Tag.model_validate(tag) for tag in response.json()]

get_tag 

get_tag(tag_name)

Gets a tag by name.

PARAMETER DESCRIPTION
tag_name

The name of the tag to get.

TYPE: str

RETURNS DESCRIPTION
Tag

The tag.
RAISES DESCRIPTION
requests.HTTPError

If the request fails.
Source code in upriver/sdk/tag/tag_api.py 
20
21
22
23
24
25
26
27
28
def get_tag(self, tag_name: str) -> Tag:
    """
    Gets a tag by name.
    :param tag_name: The name of the tag to get.
    :return: The tag.
    :raises requests.HTTPError: If the request fails.
    """
    response = self._session.get(f"tag/{tag_name}", "v1")
    return Tag.model_validate(response.json())

create_tag 

create_tag(tag)

Creates a tag.

PARAMETER DESCRIPTION
tag

The tag to create.

TYPE: Tag

RAISES DESCRIPTION
requests.HTTPError

If the request fails.
Source code in upriver/sdk/tag/tag_api.py 
30
31
32
33
34
35
36
def create_tag(self, tag: Tag) -> None:
    """
    Creates a tag.
    :param tag: The tag to create.
    :raises requests.HTTPError: If the request fails.
    """
    self._session.post("tag/new", "v1", json=tag)

update_tag 

update_tag(tag_name, updated_tag)

Updates a tag.

PARAMETER DESCRIPTION
tag_name

The name of the tag to update.

TYPE: str

updated_tag

The updated tag.

TYPE: Tag

RAISES DESCRIPTION
requests.HTTPError

If the request fails.
Source code in upriver/sdk/tag/tag_api.py 
38
39
40
41
42
43
44
45
def update_tag(self, tag_name: str, updated_tag: Tag) -> None:
    """
    Updates a tag.
    :param tag_name: The name of the tag to update.
    :param updated_tag: The updated tag.
    :raises requests.HTTPError: If the request fails.
    """
    self._session.post(f"tag/{tag_name}", "v1", json=updated_tag)

delete_tag 

delete_tag(tag_name)

Deletes a tag. Note: this action cannot be reversed!

PARAMETER DESCRIPTION
tag_name

The name of the tag to delete.

TYPE: str

RAISES DESCRIPTION
requests.HTTPError

If the request fails.
Source code in upriver/sdk/tag/tag_api.py 
47
48
49
50
51
52
53
def delete_tag(self, tag_name: str) -> None:
    """
    Deletes a tag. Note: this action cannot be reversed!
    :param tag_name: The name of the tag to delete.
    :raises requests.HTTPError: If the request fails.
    """
    self._session.delete(f"tag/{tag_name}", "v1", json=None)