welkin.models.user
==================

.. py:module:: welkin.models.user


Classes
-------

.. autoapisummary::

   welkin.models.user.User
   welkin.models.user.UserState
   welkin.models.user.Users


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

.. py:class:: User

   Bases: :py:obj:`welkin.models.base.Resource`


   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:: subresources


   .. py:method:: create()


   .. py:method:: get()

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



   .. py:method:: update(**kwargs)

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



   .. py:method:: delete()


.. py:class:: UserState

   Bases: :py:obj:`enum.Enum`


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: ACTIVE
      :value: 'ACTIVE'



   .. py:attribute:: INACTIVE
      :value: 'INACTIVE'



   .. py:attribute:: PROVISIONED
      :value: 'PROVISIONED'



.. py:class:: Users

   Bases: :py:obj:`welkin.models.base.Collection`


   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(search: str | None = None, region: str | None = None, seat_assigned: bool | None = None, user_state: str | None = None, *args, **kwargs)