welkin.models.base
==================

.. py:module:: welkin.models.base


Classes
-------

.. autoapisummary::

   welkin.models.base.SchemaBase
   welkin.models.base.Resource
   welkin.models.base.Collection


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

.. py:class:: SchemaBase

   .. py:attribute:: subresources
      :value: ()



.. py:class:: Resource

   Bases: :py:obj:`dict`, :py:obj:`SchemaBase`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: nested_objects


   .. py:method:: get(resource, subresource=None, *args, **kwargs)

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: patch(resource, data, *args, **kwargs)


   .. py:method:: post(resource, *args, **kwargs)


   .. py:method:: put(resource, *args, **kwargs)


   .. py:method:: delete(resource, *args, **kwargs)


.. py:class:: Collection

   Bases: :py:obj:`list`, :py:obj:`SchemaBase`


   Built-in mutable sequence.

   If no argument is given, the constructor creates a new empty list.
   The argument must be an iterable if specified.


   .. py:attribute:: resource


   .. py:attribute:: iterator


   .. py:method:: get(*args, **kwargs)


   .. py:method:: post(*args, **kwargs)


   .. py:method:: patch(*args, **kwargs)


   .. py:method:: request(method, resource, paginate=False, *args, **kwargs)