models.time_of_a_week module¶
-
class
models.time_of_a_week.
TimeOfAWeek
(days=None, end_time=None, is_all_day=None, start_time=None)[source]¶ Bases:
object
Implementation of the ‘TimeOfAWeek’ model.
Specifies a time period by specifying a single daily time period and one or more days of the week, for example 9 AM - 5 PM on Monday, Wednesday or Friday. If different time periods are required on different days, then multiple instances of this Weekly Time Period must be specified.
- Attributes:
- days (list of DayEnum): Array of Week Days. Specifies a list of days
of a week (such as ‘kSunday’) when the time period should be applied. If not set, the time range applies to all days of the week. Specifies a day in a week such as ‘kSunday’, ‘kMonday’, etc.
- end_time (TimeOfDay): Specifies the end time for the daily time
period.
- is_all_day (bool): All Day. Specifies that time range is applied for
entire day.
- start_time (TimeOfDay): Specifies the start time for the daily time
period.
-
classmethod
from_dictionary
(dictionary)[source]¶ Creates an instance of this model from a dictionary
- Args:
dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.
- Returns:
object: An instance of this structure class.