pyoaev.apis.document

Module Contents

class pyoaev.apis.document.Document(manager: RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

Bases: pyoaev.base.RESTObject

_id_attr = 'document_id'

class pyoaev.apis.document.DocumentManager(openaev: pyoaev.client.OpenAEV, parent: RESTObject | None = None)

Bases: pyoaev.base.RESTManager

Base class for CRUD operations on objects.

Derived class must define _path and _obj_cls.

_path: Base URL path on which requests will be sent (e.g. ‘/projects’) _obj_cls: The class of objects that will be created

_path = '/documents'

_obj_cls

download(document_id: str, **kwargs: Any) → Dict[str, Any]

upsert(document: Dict[str, Any], file: tuple, **kwargs: Any) → Dict[str, Any]