ShiftsClient

Attributes

Theme module-attribute

Theme = Literal['white', 'blue', 'green', 'purple', 'pink', 'yellow', 'gray', 'darkBlue', 'darkGreen', 'darkPurple', 'darkPink', 'darkYellow']

Activities module-attribute

Activities = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'TriggerForOpenShiftChangeRequests': {'operation_id': 'TriggerForOpenShiftChangeRequests', 'path': '/{connectionId}/trigger/teams/{teamId}/openshiftchangerequests', 'method': 'post', 'required_parameters': ['teamId', 'request'], 'callback_payload_type': None}, 'TriggerForSwapShiftsChangeRequests': {'operation_id': 'TriggerForSwapShiftsChangeRequests', 'path': '/{connectionId}/trigger/teams/{teamId}/swapshiftschangerequests', 'method': 'post', 'required_parameters': ['teamId', 'request'], 'callback_payload_type': None}, 'TriggerForOfferShiftRequests': {'operation_id': 'TriggerForOfferShiftRequests', 'path': '/{connectionId}/trigger/teams/{teamId}/offershiftrequests', 'method': 'post', 'required_parameters': ['teamId', 'request'], 'callback_payload_type': None}, 'TriggerForTimeOffRequests': {'operation_id': 'TriggerForTimeOffRequests', 'path': '/{connectionId}/trigger/teams/{teamId}/timeoffrequests', 'method': 'post', 'required_parameters': ['teamId', 'request'], 'callback_payload_type': None}, 'TriggerForShifts': {'operation_id': 'TriggerForShifts', 'path': '/{connectionId}/trigger/teams/{teamId}/shifts', 'method': 'post', 'required_parameters': ['teamId', 'request'], 'callback_payload_type': None}}

Classes

ScheduleResponse dataclass

ScheduleResponse(id: Optional[str] = None, time_zone: Optional[str] = None, provision_status: Optional[str] = None, provision_status_code: Optional[str] = None)

Response for Get a Schedule's details

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Schedule.

time_zone class-attribute instance-attribute

time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'timeZone'})

The Time Zone of the Schedule.

provision_status class-attribute instance-attribute

provision_status: Optional[str] = field(default=None, metadata={'wire_name': 'provisionStatus'})

The Provision Status of the Schedule.

provision_status_code class-attribute instance-attribute

provision_status_code: Optional[str] = field(default=None, metadata={'wire_name': 'provisionStatusCode'})

The Provision Status Code of the Schedule.

ListTimesOffResponse dataclass

ListTimesOffResponse(context: Optional[str] = None, value: Optional[List[TimeOffResponse]] = None)

Response for List all Time Off instances in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeOffResponse]] = None

List of Time Off instances

TimeOffResponse dataclass

TimeOffResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, user_id: Optional[str] = None, user_info: Optional[UserInfo] = None, team_info: Optional[TeamInfo] = None, shared_time_off: Optional[SharedTimeOff] = None, draft_time_off: Optional[DraftTimeOff] = None)

Response for Create a new Time Off instance

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Time Off.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

user_id class-attribute instance-attribute

user_id: Optional[str] = field(default=None, metadata={'wire_name': 'userId'})

Assigned To User ID.

ListShiftsResponse dataclass

ListShiftsResponse(context: Optional[str] = None, value: Optional[List[ShiftResponse]] = None)

Response for List all Shifts in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[ShiftResponse]] = None

List of Shifts

ShiftResponse dataclass

ShiftResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, user_id: Optional[str] = None, scheduling_group_id: Optional[str] = None, scheduling_group_info: Optional[SchedulingGroupInfo] = None, user_info: Optional[UserInfo] = None, team_info: Optional[TeamInfo] = None, shared_shift: Optional[SharedShift] = None, draft_shift: Optional[DraftShift] = None)

Response for Create a new Shift

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Shift.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

user_id class-attribute instance-attribute

user_id: Optional[str] = field(default=None, metadata={'wire_name': 'userId'})

Assigned To User ID.

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = field(default=None, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID.

ListOpenShiftsResponse dataclass

ListOpenShiftsResponse(context: Optional[str] = None, value: Optional[List[OpenShiftResponse]] = None)

Response for List all Open Shifts in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[OpenShiftResponse]] = None

List of Open Shifts

OpenShiftResponse dataclass

OpenShiftResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, scheduling_group_id: Optional[str] = None, scheduling_group_info: Optional[SchedulingGroupInfo] = None, team_info: Optional[TeamInfo] = None, shared_open_shift: Optional[SharedOpenShift] = None, draft_open_shift: Optional[DraftOpenShift] = None)

Response for Create a new Open Shift

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Open Shift.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = field(default=None, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID

GetTimeOffReasonsResponse dataclass

GetTimeOffReasonsResponse(context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List all Time Off Reasons in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

The list of Time Off Reasons.

ListSchedulingGroupsResponse dataclass

ListSchedulingGroupsResponse(context: Optional[str] = None, value: Optional[List[SchedulingGroupResponse]] = None)

Response for List all Scheduling Groups in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[SchedulingGroupResponse]] = None

List of Scheduling Groups.

SchedulingGroupResponse dataclass

SchedulingGroupResponse(id: Optional[str] = None, display_name: Optional[str] = None, is_active: Optional[bool] = None, user_ids: Optional[List[str]] = None)

Response for Get a Scheduling Group

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Scheduling Group.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The display name for the Scheduling Group.

is_active class-attribute instance-attribute

is_active: Optional[bool] = field(default=None, metadata={'wire_name': 'isActive'})

Indicates whether the Scheduling Group can be used when creating new entities or updating existing ones.

user_ids class-attribute instance-attribute

user_ids: Optional[List[str]] = field(default=None, metadata={'wire_name': 'userIds'})

List of IDs of users in the Scheduling Group.

ListTimeOffRequestsResponse dataclass

ListTimeOffRequestsResponse(context: Optional[str] = None, value: Optional[List[TimeOffRequestResponse]] = None)

Response for List all Time Off requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeOffRequestResponse]] = None

List of Time Off requests.

TimeOffRequestResponse dataclass

TimeOffRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, time_off_reason_id: Optional[str] = None)

Response for Get a Time Off request

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Time Off request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = field(default=None, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = None

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = field(default=None, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

Start of time requested off

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

End of time requested off

time_off_reason_id class-attribute instance-attribute

time_off_reason_id: Optional[str] = field(default=None, metadata={'wire_name': 'timeOffReasonId'})

The ID of the Time Off Reason

TimeOffRequestApproveInput dataclass

TimeOffRequestApproveInput(message: Optional[str] = None)

Approve a Time Off request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message from the manager to the sender/recipient when a request is accepted.

TimeOffRequestApproveResponse dataclass

TimeOffRequestApproveResponse(additional_properties: Dict[str, Any] = dict())

Response for Approve a Time Off request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TimeOffRequestDeclineInput dataclass

TimeOffRequestDeclineInput(message: Optional[str] = None)

Decline a Time Off request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message from the manager to the sender/recipient when a request is declined.

TimeOffRequestDeclineResponse dataclass

TimeOffRequestDeclineResponse(additional_properties: Dict[str, Any] = dict())

Response for Decline a Time Off request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListOfferShiftRequestsResponse dataclass

ListOfferShiftRequestsResponse(context: Optional[str] = None, value: Optional[List[OfferShiftRequestResponse]] = None)

Response for List all Offer Shift requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[OfferShiftRequestResponse]] = None

List of Offer Shift requests.

OfferShiftRequestResponse dataclass

OfferShiftRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, sender_shift_id: Optional[str] = None, recipient_action_date_time: Optional[str] = None, recipient_action_message: Optional[str] = None, recipient_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None)

Response for Get an Offer Shift request

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Offer Shift request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = field(default=None, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = None

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = field(default=None, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

sender_shift_id class-attribute instance-attribute

sender_shift_id: Optional[str] = field(default=None, metadata={'wire_name': 'senderShiftId'})

The ID of the Shift from the sender

recipient_action_date_time class-attribute instance-attribute

recipient_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionDateTime'})

Time when the recipient responded

recipient_action_message class-attribute instance-attribute

recipient_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionMessage'})

The message from the recipient

recipient_user_id class-attribute instance-attribute

recipient_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'recipientUserId'})

The ID of the recipient of the request

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

OfferShiftRequestApproveInput dataclass

OfferShiftRequestApproveInput(message: Optional[str] = None)

Approve an Offer Shift request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message when a request is accepted.

OfferShiftRequestApproveResponse dataclass

OfferShiftRequestApproveResponse(additional_properties: Dict[str, Any] = dict())

Response for Approve an Offer Shift request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

OfferShiftRequestDeclineInput dataclass

OfferShiftRequestDeclineInput(message: Optional[str] = None)

Decline an Offer Shift request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message when a request is declined.

OfferShiftRequestDeclineResponse dataclass

OfferShiftRequestDeclineResponse(additional_properties: Dict[str, Any] = dict())

Response for Decline an Offer Shift request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListSwapShiftsChangeRequestsResponse dataclass

ListSwapShiftsChangeRequestsResponse(context: Optional[str] = None, value: Optional[List[SwapShiftsChangeRequestResponse]] = None)

Response for List all Swap Shifts requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[SwapShiftsChangeRequestResponse]] = None

List of Swap Shifts Change Requests.

SwapShiftsChangeRequestResponse dataclass

SwapShiftsChangeRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, sender_shift_id: Optional[str] = None, recipient_action_date_time: Optional[str] = None, recipient_action_message: Optional[str] = None, recipient_user_id: Optional[str] = None, recipient_shift_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None)

Response for Get a Swap Shifts request

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Swap Shift request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = field(default=None, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = None

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = field(default=None, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

sender_shift_id class-attribute instance-attribute

sender_shift_id: Optional[str] = field(default=None, metadata={'wire_name': 'senderShiftId'})

The ID of the Shift from the sender

recipient_action_date_time class-attribute instance-attribute

recipient_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionDateTime'})

Time when the recipient responded

recipient_action_message class-attribute instance-attribute

recipient_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'recipientActionMessage'})

The message from the recipient

recipient_user_id class-attribute instance-attribute

recipient_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'recipientUserId'})

The ID of the recipient of the request

recipient_shift_id class-attribute instance-attribute

recipient_shift_id: Optional[str] = field(default=None, metadata={'wire_name': 'recipientShiftId'})

The ID of the Shift from the recipient

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

SwapShiftsChangeRequestApproveInput dataclass

SwapShiftsChangeRequestApproveInput(message: Optional[str] = None)

Approve a Swap Shifts request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message when a request is accepted.

SwapShiftsChangeRequestApproveResponse dataclass

SwapShiftsChangeRequestApproveResponse(additional_properties: Dict[str, Any] = dict())

Response for Approve a Swap Shifts request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SwapShiftsChangeRequestDeclineInput dataclass

SwapShiftsChangeRequestDeclineInput(message: Optional[str] = None)

Decline a Swap Shifts request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message when a request is declined.

SwapShiftsChangeRequestDeclineResponse dataclass

SwapShiftsChangeRequestDeclineResponse(additional_properties: Dict[str, Any] = dict())

Response for Decline a Swap Shifts request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListOpenShiftChangeRequestsResponse dataclass

ListOpenShiftChangeRequestsResponse(context: Optional[str] = None, value: Optional[List[OpenShiftChangeRequestResponse]] = None)

Response for List all Open Shift requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[OpenShiftChangeRequestResponse]] = None

List of Open Shift Change Requests.

OpenShiftChangeRequestResponse dataclass

OpenShiftChangeRequestResponse(id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, assigned_to: Optional[str] = None, state: Optional[str] = None, sender_date_time: Optional[str] = None, sender_message: Optional[str] = None, sender_user_id: Optional[str] = None, manager_action_date_time: Optional[str] = None, manager_action_message: Optional[str] = None, manager_user_id: Optional[str] = None, open_shift_id: Optional[str] = None)

Response for Get an Open Shift request

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the Open Shift Change request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

last_modified_date_time class-attribute instance-attribute

last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

assigned_to class-attribute instance-attribute

assigned_to: Optional[str] = field(default=None, metadata={'wire_name': 'assignedTo'})

The person the request is assigned to: 'manager' or 'recipient'

state class-attribute instance-attribute

state: Optional[str] = None

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

sender_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'senderDateTime'})

Time when the request was sent

sender_message class-attribute instance-attribute

sender_message: Optional[str] = field(default=None, metadata={'wire_name': 'senderMessage'})

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'senderUserId'})

The ID of the user that sent the request

manager_action_date_time class-attribute instance-attribute

manager_action_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

manager_action_message: Optional[str] = field(default=None, metadata={'wire_name': 'managerActionMessage'})

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = field(default=None, metadata={'wire_name': 'managerUserId'})

The ID of the manager that responded

open_shift_id class-attribute instance-attribute

open_shift_id: Optional[str] = field(default=None, metadata={'wire_name': 'openShiftId'})

The ID of the Open Shift being requested

OpenShiftChangeRequestApproveInput dataclass

OpenShiftChangeRequestApproveInput(message: Optional[str] = None)

Approve an Open Shift request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message from the manager to the sender/recipient when a request is accepted.

OpenShiftChangeRequestApproveResponse dataclass

OpenShiftChangeRequestApproveResponse(additional_properties: Dict[str, Any] = dict())

Response for Approve an Open Shift request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

OpenShiftChangeRequestDeclineInput dataclass

OpenShiftChangeRequestDeclineInput(message: Optional[str] = None)

Decline an Open Shift request

Attributes

message class-attribute instance-attribute

message: Optional[str] = None

A message from the manager to the sender/recipient when a request is declined.

OpenShiftChangeRequestDeclineResponse dataclass

OpenShiftChangeRequestDeclineResponse(additional_properties: Dict[str, Any] = dict())

Response for Decline an Open Shift request

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ListOpenShiftsCrossTeamResponse dataclass

ListOpenShiftsCrossTeamResponse(context: Optional[str] = None, value: Optional[List[OpenShiftResponse]] = None)

Response for List all Open Shifts from my teams

Attributes

value class-attribute instance-attribute

value: Optional[List[OpenShiftResponse]] = None

List of Open Shifts

ListShiftsCrossTeamResponse dataclass

ListShiftsCrossTeamResponse(context: Optional[str] = None, value: Optional[List[ShiftResponse]] = None)

Response for List all Shifts from my teams

Attributes

value class-attribute instance-attribute

value: Optional[List[ShiftResponse]] = None

List of Shifts

ListTimesOffCrossTeamResponse dataclass

ListTimesOffCrossTeamResponse(context: Optional[str] = None, value: Optional[List[TimeOffResponse]] = None)

Response for List all Times Off from my teams

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeOffResponse]] = None

List of Times off

GetAllTeamsResponse dataclass

GetAllTeamsResponse(context: Optional[str] = None, value: Optional[List[Dict[str, Any]]] = None)

Response for List teams

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = None

List of one or more Teams you are a part of.

WebHookRequest dataclass

WebHookRequest(notification_url: Optional[str] = None)

Definition: WebHookRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'notificationUrl'})

Specify a well-formed URL of the endpoint that will receive notifications.

WebhookPushResponse dataclass

WebhookPushResponse(value: Optional[List[WebhookNotificationEntity]] = None)

Definition: WebhookPushResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[WebhookNotificationEntity]] = None

List of values

WebhookNotificationEntity dataclass

WebhookNotificationEntity(subscription_id: Optional[str] = None, expiration_date_time: Optional[str] = None, change_type: Optional[str] = None, resource_data: Optional[WebhookPushResponseResourceEntity] = None)

Definition: WebhookNotificationEntity

Attributes

subscription_id class-attribute instance-attribute

subscription_id: Optional[str] = field(default=None, metadata={'wire_name': 'subscriptionId'})

WebHook Subscription Id

expiration_date_time class-attribute instance-attribute

expiration_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'expirationDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

change_type class-attribute instance-attribute

change_type: Optional[str] = field(default=None, metadata={'wire_name': 'changeType'})

Resource change type (created/updated/deleted).

WebhookPushResponseResourceEntity dataclass

WebhookPushResponseResourceEntity(id_2: Optional[str] = None, type_: Optional[str] = None, id: Optional[str] = None, team_id: Optional[str] = None)

Definition: WebhookPushResponseResourceEntity

Attributes

id_2 class-attribute instance-attribute

id_2: Optional[str] = field(default=None, metadata={'wire_name': '@odata.id'})

Full resource path.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': '@odata.type'})

Resoure Type.

id class-attribute instance-attribute

id: Optional[str] = None

ID of the resource that is updated.

team_id class-attribute instance-attribute

team_id: Optional[str] = field(default=None, metadata={'wire_name': 'teamId'})

ID of team where the update happened.

Subscription dataclass

Subscription(id: Optional[str] = None, resource: Optional[str] = None, application_id: Optional[str] = None, change_type: Optional[str] = None, client_state: Optional[str] = None, notification_url: Optional[str] = None, expiration_date_time: Optional[str] = None, creator_id: Optional[str] = None)

Definition: Subscription

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Unique identifier for the subscription.

resource class-attribute instance-attribute

resource: Optional[str] = None

Specifies the resource that will be monitored for changes.

application_id class-attribute instance-attribute

application_id: Optional[str] = field(default=None, metadata={'wire_name': 'applicationId'})

Identifier of the application used to create the subscription.

change_type class-attribute instance-attribute

change_type: Optional[str] = field(default=None, metadata={'wire_name': 'changeType'})

Indicates the type of change in the subscribed resource that will raise a notification.

client_state class-attribute instance-attribute

client_state: Optional[str] = field(default=None, metadata={'wire_name': 'clientState'})

Specifies the value of the clientState property sent by the service in each notification. The maximum length is 128 characters. The client can check that the notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each notification.

notification_url class-attribute instance-attribute

notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'notificationUrl'})

The URL of the endpoint that will receive the notifications. This URL must make use of the HTTPS protocol.

expiration_date_time class-attribute instance-attribute

expiration_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'expirationDateTime'})

Specifies the date and time when the webhook subscription expires (UTC).

creator_id class-attribute instance-attribute

creator_id: Optional[str] = field(default=None, metadata={'wire_name': 'creatorId'})

Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the id of the service principal corresponding to the app.

SharedTimeOff dataclass

SharedTimeOff(time_off_reason_id: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[Theme] = None)

Definition: SharedTimeOff

Attributes

time_off_reason_id class-attribute instance-attribute

time_off_reason_id: Optional[str] = field(default=None, metadata={'wire_name': 'timeOffReasonId'})

Time Off Reason ID.

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

DraftTimeOff dataclass

DraftTimeOff(time_off_reason_id: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[Theme] = None)

Definition: DraftTimeOff

Attributes

time_off_reason_id class-attribute instance-attribute

time_off_reason_id: Optional[str] = field(default=None, metadata={'wire_name': 'timeOffReasonId'})

Time Off Reason ID.

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

SharedShift dataclass

SharedShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[Theme] = None, activities: Optional[Activities] = None)

Definition: SharedShift

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = None

Shift Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

DraftShift dataclass

DraftShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[Theme] = None, activities: Optional[Activities] = None)

Definition: DraftShift

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = None

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

SchedulingGroupInfo dataclass

SchedulingGroupInfo(scheduling_group_id: Optional[str] = None, display_name: Optional[str] = None, code: Optional[str] = None)

Definition: SchedulingGroupInfo

Attributes

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = field(default=None, metadata={'wire_name': 'schedulingGroupId'})

The unique ID of the Scheduling Group.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The display name for the Scheduling Group.

code class-attribute instance-attribute

code: Optional[str] = None

The scheduling group code.

UserInfo dataclass

UserInfo(user_id: Optional[str] = None, display_name: Optional[str] = None)

Definition: UserInfo

Attributes

user_id class-attribute instance-attribute

user_id: Optional[str] = field(default=None, metadata={'wire_name': 'userId'})

The ID of the user.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The display name of the user.

TeamInfo dataclass

TeamInfo(team_id: Optional[str] = None, display_name: Optional[str] = None)

Definition: TeamInfo

Attributes

team_id class-attribute instance-attribute

team_id: Optional[str] = field(default=None, metadata={'wire_name': 'teamId'})

The ID of the team.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The display name for the team.

EditOpenShiftRequest dataclass

EditOpenShiftRequest(scheduling_group_id: Optional[str] = None, shared_open_shift: Optional[Dict[str, Any]] = None)

Definition: EditOpenShiftRequest

Attributes

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = field(default=None, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID

SharedOpenShift dataclass

SharedOpenShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[Theme] = None, open_slot_count: Optional[int] = None, activities: Optional[Activities] = None)

Definition: SharedOpenShift

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = None

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

open_slot_count class-attribute instance-attribute

open_slot_count: Optional[int] = field(default=None, metadata={'wire_name': 'openSlotCount'})

Open Slot Count

DraftOpenShift dataclass

DraftOpenShift(display_name: Optional[str] = None, notes: Optional[str] = None, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None, theme: Optional[Theme] = None, open_slot_count: Optional[int] = None, activities: Optional[Activities] = None)

Definition: DraftOpenShift

Attributes

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = None

Notes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'startDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'endDateTime'})

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

open_slot_count class-attribute instance-attribute

open_slot_count: Optional[int] = field(default=None, metadata={'wire_name': 'openSlotCount'})

Open Slot Count

CreateShiftRequest dataclass

CreateShiftRequest(scheduling_group_id: Optional[str] = None, shared_shift: Optional[Dict[str, Any]] = None, user_id: Optional[str] = None)

Definition: CreateShiftRequest

Attributes

scheduling_group_id class-attribute instance-attribute

scheduling_group_id: Optional[str] = field(default=None, metadata={'wire_name': 'schedulingGroupId'})

Scheduling Group ID

shared_shift class-attribute instance-attribute

shared_shift: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'sharedShift'})

Shared version of the Shift.

user_id class-attribute instance-attribute

user_id: Optional[str] = field(default=None, metadata={'wire_name': 'userId'})

Assigned to User ID

CreateTimeOffRequest dataclass

CreateTimeOffRequest(shared_time_off: Optional[Dict[str, Any]] = None, user_id: Optional[str] = None)

Definition: CreateTimeOffRequest

Attributes

shared_time_off class-attribute instance-attribute

shared_time_off: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'sharedTimeOff'})

Shared version of a TimeOff.

user_id class-attribute instance-attribute

user_id: Optional[str] = field(default=None, metadata={'wire_name': 'userId'})

Assigned to User ID

ShiftsClient

ShiftsClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for shifts connector.

Initialize a ShiftsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_schedule_async async

get_schedule_async(team_id: str) -> dict[str, Any] | None

Get a Schedule's details

This operation returns details of a Schedule using the Schedule's unique ID.

list_times_off_async async

list_times_off_async(team_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List all Time Off instances in a team

This operation returns all Time Off instances in a Schedule

create_time_off_async async

create_time_off_async(input: CreateTimeOffRequest, team_id: str) -> dict[str, Any] | None

Create a new Time Off instance

This operation creates a new Time Off instance and assigns it to a member of the team

get_time_off_async async

get_time_off_async(team_id: str, time_off_id: str) -> dict[str, Any] | None

Get a Time Off instance

This operation returns details for a Time Off using its unique ID.

delete_time_off_async async

delete_time_off_async(team_id: str, time_off_id: str) -> None

Delete a Time Off instance

This operation deletes a Time Off using its unique ID.

list_shifts_async async

list_shifts_async(team_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List all Shifts in a team

This operation returns all Shifts assigned to members of a team

create_shift_async async

create_shift_async(input: CreateShiftRequest, team_id: str) -> dict[str, Any] | None

Create a new Shift

This operation creates a new Shift and assigns it to a member of the team

get_shift_async async

get_shift_async(team_id: str, shift_id: str) -> dict[str, Any] | None

Get a Shift

This operation returns details for a Shift using the Shift's unique ID.

delete_shift_async async

delete_shift_async(team_id: str, shift_id: str) -> None

Delete a Shift

This operation deletes a Shift using the Shift's unique ID.

list_open_shifts_async async

list_open_shifts_async(team_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List all Open Shifts in a team

This operation returns all Open Shifts in a team.

create_open_shift_async async

create_open_shift_async(input: EditOpenShiftRequest, team_id: str) -> dict[str, Any] | None

Create a new Open Shift

Create a new Open Shift in a Schedule.

get_open_shift_async async

get_open_shift_async(team_id: str, open_shift_id: str) -> dict[str, Any] | None

Get an Open Shift

This operation returns details for an Open Shift.

update_open_shift_async async

update_open_shift_async(input: EditOpenShiftRequest, team_id: str, open_shift_id: str) -> dict[str, Any] | None

Update an Open Shift

Update an Open Shift in a Schedule.

delete_open_shift_async async

delete_open_shift_async(team_id: str, open_shift_id: str) -> None

Delete an Open Shift

This operation deletes an Open Shift.

list_time_off_reasons_async async

list_time_off_reasons_async(team_id: str, top: Optional[int] = None) -> dict[str, Any] | None

List all Time Off Reasons in a team

This operation returns the list of Time Off Reasons associated with a team.

list_scheduling_groups_async async

list_scheduling_groups_async(team_id: str, top: Optional[int] = None) -> dict[str, Any] | None

List all Scheduling Groups in a team

This operation returns all Scheduling Groups in a Schedule.

get_scheduling_group_async async

get_scheduling_group_async(team_id: str, scheduling_group_id: str) -> dict[str, Any] | None

Get a Scheduling Group

This operation returns details for a Scheduling Group using its unique ID.

list_time_off_requests_async async

list_time_off_requests_async(team_id: str, top: Optional[int] = None, state: Optional[str] = None) -> dict[str, Any] | None

List all Time Off requests in a team

This operation returns all Time Off requests in a Schedule.

get_time_off_shift_request_async async

get_time_off_shift_request_async(team_id: str, time_off_request_id: str) -> dict[str, Any] | None

Get a Time Off request

This operation returns a Time Off request by ID.

time_off_request_approve_async async

time_off_request_approve_async(input: TimeOffRequestApproveInput, team_id: str, time_off_request_id: str) -> dict[str, Any] | None

Approve a Time Off request

This operation allows managers to approve a Time Off request.

time_off_request_decline_async async

time_off_request_decline_async(input: TimeOffRequestDeclineInput, team_id: str, time_off_request_id: str) -> dict[str, Any] | None

Decline a Time Off request

This operation allows managers to decline a Time Off request.

list_offer_shift_requests_async async

list_offer_shift_requests_async(team_id: str, top: Optional[int] = None, state: Optional[str] = None) -> dict[str, Any] | None

List all Offer Shift requests in a team

This operation returns all Offer Shift requests in a Schedule.

get_offer_shift_request_async async

get_offer_shift_request_async(team_id: str, offer_shift_request_id: str) -> dict[str, Any] | None

Get an Offer Shift request

This operation returns an Offer Shift request by ID.

offer_shift_request_approve_async async

offer_shift_request_approve_async(input: OfferShiftRequestApproveInput, team_id: str, offer_shift_request_id: str) -> dict[str, Any] | None

Approve an Offer Shift request

This operation allows recipients/managers to approve an Offer Shift request.

offer_shift_request_decline_async async

offer_shift_request_decline_async(input: OfferShiftRequestDeclineInput, team_id: str, offer_shift_request_id: str) -> dict[str, Any] | None

Decline an Offer Shift request

This operation allows users to decline an Offer Shift request.

list_swap_shifts_change_requests_async async

list_swap_shifts_change_requests_async(team_id: str, top: Optional[int] = None, state: Optional[str] = None) -> dict[str, Any] | None

List all Swap Shifts requests in a team

This operation returns all Swap Shifts requests in a Schedule.

get_swap_shifts_change_request_async async

get_swap_shifts_change_request_async(team_id: str, swap_shifts_change_request_id: str) -> dict[str, Any] | None

Get a Swap Shifts request

This operation returns a Swap Shifts request by ID.

swap_shifts_change_request_approve_async async

swap_shifts_change_request_approve_async(input: SwapShiftsChangeRequestApproveInput, team_id: str, swap_shifts_change_request_id: str) -> dict[str, Any] | None

Approve a Swap Shifts request

This operation allows a user to approve a Swap Shifts request.

swap_shifts_change_request_decline_async async

swap_shifts_change_request_decline_async(input: SwapShiftsChangeRequestDeclineInput, team_id: str, swap_shifts_change_request_id: str) -> dict[str, Any] | None

Decline a Swap Shifts request

This operation allows users to decline a Swap Shifts request.

list_open_shift_change_requests_async async

list_open_shift_change_requests_async(team_id: str, top: Optional[int] = None, state: Optional[str] = None) -> dict[str, Any] | None

List all Open Shift requests in a team

This operation returns all Open Shift change requests in a Schedule.

get_open_shift_change_request_async async

get_open_shift_change_request_async(team_id: str, open_shift_change_request_id: str) -> dict[str, Any] | None

Get an Open Shift request

This operation returns an Open Shift change request by ID.

open_shift_change_request_approve_async async

open_shift_change_request_approve_async(input: OpenShiftChangeRequestApproveInput, team_id: str, open_shift_change_request_id: str) -> dict[str, Any] | None

Approve an Open Shift request

This operation allows managers to approve an Open Shift request.

open_shift_change_request_decline_async async

open_shift_change_request_decline_async(input: OpenShiftChangeRequestDeclineInput, team_id: str, open_shift_change_request_id: str) -> dict[str, Any] | None

Decline an Open Shift request

This operation allows managers to decline an Open Shift request.

list_open_shifts_cross_team_async async

list_open_shifts_cross_team_async(start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List all Open Shifts from my teams

This operation returns Open Shifts that need to be filled from all your teams.

list_shifts_cross_team_async async

list_shifts_cross_team_async(start_time: Optional[str] = None, end_time: Optional[str] = None, assigned_to_user_name: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List all Shifts from my teams

This operation returns assigned Shifts from all your teams.

list_times_off_cross_team_async async

list_times_off_cross_team_async(start_time: Optional[str] = None, end_time: Optional[str] = None, assigned_to_user_name: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

List all Times Off from my teams

This operation returns times when people are off from all your teams.

get_all_teams_async async

get_all_teams_async() -> dict[str, Any] | None

List teams

This operation retrieves a list of all the Teams (Office 365 Groups) you are a member of.