welkin.models.calendar
======================

.. py:module:: welkin.models.calendar


Classes
-------

.. autoapisummary::

   welkin.models.calendar.EventType
   welkin.models.calendar.EventStatus
   welkin.models.calendar.EventMode
   welkin.models.calendar.CalendarEvent
   welkin.models.calendar.CalendarEvents
   welkin.models.calendar.Schedule
   welkin.models.calendar.Schedules
   welkin.models.calendar.WorkHours


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

.. py:class:: EventType

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


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: GROUP_THERAPY
      :value: 'GROUP_THERAPY'



   .. py:attribute:: APPOINTMENT
      :value: 'APPOINTMENT'



   .. py:attribute:: LEAVE
      :value: 'LEAVE'



   .. py:attribute:: ENCOUNTER
      :value: 'ENCOUNTER'



.. py:class:: EventStatus

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


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: SCHEDULED
      :value: 'SCHEDULED'



   .. py:attribute:: CANCELLED
      :value: 'CANCELLED'



   .. py:attribute:: COMPLETED
      :value: 'COMPLETED'



   .. py:attribute:: MISSED
      :value: 'MISSED'



.. py:class:: EventMode

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


   Generic enumeration.

   Derive from this class to define new enumerations.


   .. py:attribute:: IN_PERSON
      :value: 'IN-PERSON'



   .. py:attribute:: CALL
      :value: 'CALL'



   .. py:attribute:: VIDEO
      :value: 'VIDEO'



.. py:class:: CalendarEvent

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

   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(from_date: datetime.datetime, to_date: datetime.datetime, participant_ids: list | None = None, event_type: str | None = None, sort: str | None = None, include_cancelled: bool | None = None, include_encounter_info: bool | None = None, exclude_assigned_to_encounter_events: bool | None = None, viewer_timezone: str | None = None, *args, **kwargs)


.. py:class:: Schedule

   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:class:: Schedules

   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(ids: list, from_date: datetime.datetime, to_date: datetime.datetime, include_cancelled: bool | None = None, available: bool = False, full: bool = False, *args, **kwargs)


.. py:class:: WorkHours

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


   .. py:method:: get(from_date: datetime.datetime, to_date: datetime.datetime, psm_ids: list | None = None, timezone: str | None = None, *args, **kwargs)