paperap.resources.workflows module

METADATA:

File: workflows.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.workflows.WorkflowResource(client)[source]

Bases: StandardResource[Workflow, WorkflowQuerySet]

Resource for managing workflows.

Parameters:: client (PaperlessClient)

model_class: alias of Workflow

queryset_class: alias of WorkflowQuerySet

name: str = 'workflows'

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

class paperap.resources.workflows.WorkflowTriggerResource(client)[source]

Bases: StandardResource[WorkflowTrigger, WorkflowTriggerQuerySet]

Resource for managing workflow triggers.

Parameters:: client (PaperlessClient)

model_class: alias of WorkflowTrigger

queryset_class: alias of WorkflowTriggerQuerySet

name: str = 'workflow_triggers'

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

class paperap.resources.workflows.WorkflowActionResource(client)[source]

Bases: StandardResource[WorkflowAction, WorkflowActionQuerySet]

Resource for managing workflow actions.

Parameters:: client (PaperlessClient)

model_class: alias of WorkflowAction

queryset_class: alias of WorkflowActionQuerySet

name: str = 'workflow_actions'

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