Skip to content

RecurrenceSettings

Source code in docs_src/capo_ssm_contacts/types/recurrence_settings.py
class RecurrenceSettings(TypedDict, closed=True):
    monthly_settings: NotRequired[
        "capo_ssm_contacts.types.monthly_settings.MonthlySettings"
    ]
    """<p>Information about on-call rotations that recur monthly.</p>"""
    weekly_settings: NotRequired[
        "capo_ssm_contacts.types.weekly_settings.WeeklySettings"
    ]
    """<p>Information about on-call rotations that recur weekly.</p>"""
    daily_settings: NotRequired["capo_ssm_contacts.types.daily_settings.DailySettings"]
    """<p>Information about on-call rotations that recur daily.</p>"""
    number_of_on_calls: "capo_ssm_contacts.types.number_of_on_calls.NumberOfOnCalls"
    """<p>The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of <code>2</code> designates that two of them are on call at any given time.</p>"""
    shift_coverages: NotRequired[
        "capo_ssm_contacts.types.shift_coverages_map.ShiftCoveragesMap"
    ]
    """<p>Information about the days of the week that the on-call rotation coverage includes.</p>"""
    recurrence_multiplier: (
        "capo_ssm_contacts.types.recurrence_multiplier.RecurrenceMultiplier"
    )
    """<p>The number of days, weeks, or months a single rotation lasts.</p>"""

daily_settings instance-attribute

daily_settings: NotRequired[DailySettings]

Information about on-call rotations that recur daily.

monthly_settings instance-attribute

monthly_settings: NotRequired[MonthlySettings]

Information about on-call rotations that recur monthly.

number_of_on_calls instance-attribute

number_of_on_calls: NumberOfOnCalls

The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule that contains ten contacts, a value of 2 designates that two of them are on call at any given time.

recurrence_multiplier instance-attribute

recurrence_multiplier: RecurrenceMultiplier

The number of days, weeks, or months a single rotation lasts.

shift_coverages instance-attribute

shift_coverages: NotRequired[ShiftCoveragesMap]

Information about the days of the week that the on-call rotation coverage includes.

weekly_settings instance-attribute

weekly_settings: NotRequired[WeeklySettings]

Information about on-call rotations that recur weekly.