welkin.models.calendar

Classes

`EventType`	Generic enumeration.
`EventStatus`	Generic enumeration.
`EventMode`	Generic enumeration.
`CalendarEvent`	dict() -> new empty dictionary
`CalendarEvents`	Built-in mutable sequence.
`Schedule`	dict() -> new empty dictionary
`Schedules`	Built-in mutable sequence.
`WorkHours`	Built-in mutable sequence.

Module Contents

class welkin.models.calendar.EventType

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

GROUP_THERAPY = 'GROUP_THERAPY'

APPOINTMENT = 'APPOINTMENT'

LEAVE = 'LEAVE'

ENCOUNTER = 'ENCOUNTER'

class welkin.models.calendar.EventStatus

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

SCHEDULED = 'SCHEDULED'

CANCELLED = 'CANCELLED'

COMPLETED = 'COMPLETED'

MISSED = 'MISSED'

class welkin.models.calendar.EventMode

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

IN_PERSON = 'IN-PERSON'

CALL = 'CALL'

VIDEO = 'VIDEO'

class welkin.models.calendar.CalendarEvent

Bases: 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)

create()

get(): Return the value for key if key is in the dictionary, else default.

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]

delete()

class welkin.models.calendar.CalendarEvents

Bases: 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.

resource

iterator

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)

class welkin.models.calendar.Schedule

Bases: 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)

class welkin.models.calendar.Schedules

Bases: 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.

resource

iterator

get(ids: list, from_date: datetime.datetime, to_date: datetime.datetime, include_cancelled: bool | None = None, available: bool = False, full: bool = False, *args, **kwargs)

class welkin.models.calendar.WorkHours

Bases: 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.

iterator

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