pyoaev.apis.payload
===================

.. py:module:: pyoaev.apis.payload




Module Contents
---------------

.. py:class:: Payload(manager: RESTManager, attrs: Dict[str, Any], *, created_from_list: bool = False)

   Bases: :py:obj:`pyoaev.base.RESTObject`


   .. py:attribute:: _id_attr
      :value: 'payload_id'



.. py:class:: PayloadManager(openaev: pyoaev.client.OpenAEV, parent: Optional[RESTObject] = None)

   Bases: :py:obj:`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


   .. py:attribute:: _path
      :value: '/payloads'



   .. py:attribute:: _obj_cls


   .. py:method:: upsert(payload: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]


   .. py:method:: deprecate(payloads_processed: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]