paperap.resources.users module

---

METADATA:

File: users.py

Project: paperap

Created: 2025-03-04

Version: 0.0.9

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann

---

LAST MODIFIED:

2025-03-04 By Jess Mann

class paperap.resources.users.UserResource(client)

Bases: StandardResource[User, UserQuerySet]

Resource for managing users.

Parameters:

client (PaperlessClient)

model_class

alias of User

queryset_class

alias of UserQuerySet

get_current()

Get the current authenticated user.

Return type:

User

Returns:

The current user.

endpoints: ClassVar[Endpoints] = {'create': <string.Template object>, 'delete': <string.Template object>, 'detail': <string.Template object>, 'list': <string.Template object>, 'update': <string.Template object>}

client: PaperlessClient

name: str

class paperap.resources.users.GroupResource(client)

Bases: StandardResource[Group, GroupQuerySet]

Resource for managing groups.

Parameters:

client (PaperlessClient)

model_class

alias of Group

queryset_class

alias of GroupQuerySet

endpoints: ClassVar[Endpoints] = {'create': <string.Template object>, 'delete': <string.Template object>, 'detail': <string.Template object>, 'list': <string.Template object>, 'update': <string.Template object>}

client: PaperlessClient

name: str