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] = dataclass_field(default=None, kw_only=True)

The unique ID of the Schedule.

time_zone class-attribute instance-attribute

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

The Time Zone of the Schedule.

provision_status class-attribute instance-attribute

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

The Provision Status of the Schedule.

provision_status_code class-attribute instance-attribute

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

The Provision Status Code of the Schedule.

ListTimesOffResponse dataclass

ListTimesOffResponse(*, context: Optional[str] = None, value: Optional[List[TimeOffResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Time Off instances in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeOffResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Time Off instances

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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 | Mapping[str, Any]] = None, team_info: Optional[TeamInfo | Mapping[str, Any]] = None, shared_time_off: Optional[SharedTimeOff | Mapping[str, Any]] = None, draft_time_off: Optional[DraftTimeOff | Mapping[str, Any]] = None)

Response for Create a new Time Off instance

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the Time Off.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

user_id class-attribute instance-attribute

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

Assigned To User ID.

ListShiftsResponse dataclass

ListShiftsResponse(*, context: Optional[str] = None, value: Optional[List[ShiftResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Shifts in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[ShiftResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Shifts

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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 | Mapping[str, Any]] = None, user_info: Optional[UserInfo | Mapping[str, Any]] = None, team_info: Optional[TeamInfo | Mapping[str, Any]] = None, shared_shift: Optional[SharedShift | Mapping[str, Any]] = None, draft_shift: Optional[DraftShift | Mapping[str, Any]] = None)

Response for Create a new Shift

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the Shift.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

user_id class-attribute instance-attribute

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

Assigned To User ID.

scheduling_group_id class-attribute instance-attribute

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

Scheduling Group ID.

ListOpenShiftsResponse dataclass

ListOpenShiftsResponse(*, context: Optional[str] = None, value: Optional[List[OpenShiftResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Open Shifts in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[OpenShiftResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Open Shifts

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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 | Mapping[str, Any]] = None, team_info: Optional[TeamInfo | Mapping[str, Any]] = None, shared_open_shift: Optional[SharedOpenShift | Mapping[str, Any]] = None, draft_open_shift: Optional[DraftOpenShift | Mapping[str, Any]] = None)

Response for Create a new Open Shift

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The unique ID of the Open Shift.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

scheduling_group_id class-attribute instance-attribute

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

Scheduling Group ID

GetTimeOffReasonsResponse dataclass

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

Response for List all Time Off Reasons in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of Time Off Reasons.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

ListSchedulingGroupsResponse dataclass

ListSchedulingGroupsResponse(*, context: Optional[str] = None, value: Optional[List[SchedulingGroupResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Scheduling Groups in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[SchedulingGroupResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Scheduling Groups.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default=None, kw_only=True)

The unique ID of the Scheduling Group.

display_name class-attribute instance-attribute

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

The display name for the Scheduling Group.

is_active class-attribute instance-attribute

is_active: Optional[bool] = dataclass_field(default=None, kw_only=True, 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]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userIds'})

List of IDs of users in the Scheduling Group.

ListTimeOffRequestsResponse dataclass

ListTimeOffRequestsResponse(*, context: Optional[str] = None, value: Optional[List[TimeOffRequestResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Time Off requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeOffRequestResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Time Off requests.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default=None, kw_only=True)

The unique ID of the Time Off request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

assigned_to class-attribute instance-attribute

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

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

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

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

Time when the request was sent

sender_message class-attribute instance-attribute

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

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

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

The message from the manager

manager_user_id class-attribute instance-attribute

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

The ID of the manager that responded

start_date_time class-attribute instance-attribute

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

Start of time requested off

end_date_time class-attribute instance-attribute

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

End of time requested off

time_off_reason_id class-attribute instance-attribute

time_off_reason_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

ListOfferShiftRequestsResponse dataclass

ListOfferShiftRequestsResponse(*, context: Optional[str] = None, value: Optional[List[OfferShiftRequestResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Offer Shift requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[OfferShiftRequestResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Offer Shift requests.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default=None, kw_only=True)

The unique ID of the Offer Shift request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

assigned_to class-attribute instance-attribute

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

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

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

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

Time when the request was sent

sender_message class-attribute instance-attribute

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

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientActionDateTime'})

Time when the recipient responded

recipient_action_message class-attribute instance-attribute

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

The message from the recipient

recipient_user_id class-attribute instance-attribute

recipient_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

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

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

ListSwapShiftsChangeRequestsResponse dataclass

ListSwapShiftsChangeRequestsResponse(*, context: Optional[str] = None, value: Optional[List[SwapShiftsChangeRequestResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Swap Shifts requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[SwapShiftsChangeRequestResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Swap Shifts Change Requests.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default=None, kw_only=True)

The unique ID of the Swap Shift request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

assigned_to class-attribute instance-attribute

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

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

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

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

Time when the request was sent

sender_message class-attribute instance-attribute

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

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recipientActionDateTime'})

Time when the recipient responded

recipient_action_message class-attribute instance-attribute

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

The message from the recipient

recipient_user_id class-attribute instance-attribute

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

The ID of the recipient of the request

recipient_shift_id class-attribute instance-attribute

recipient_shift_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

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

The message from the manager

manager_user_id class-attribute instance-attribute

manager_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

ListOpenShiftChangeRequestsResponse dataclass

ListOpenShiftChangeRequestsResponse(*, context: Optional[str] = None, value: Optional[List[OpenShiftChangeRequestResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Open Shift requests in a team

Attributes

value class-attribute instance-attribute

value: Optional[List[OpenShiftChangeRequestResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Open Shift Change Requests.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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] = dataclass_field(default=None, kw_only=True)

The unique ID of the Open Shift Change request.

created_date_time class-attribute instance-attribute

created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})

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

assigned_to class-attribute instance-attribute

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

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

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

'approved', 'pending' or 'declined'

sender_date_time class-attribute instance-attribute

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

Time when the request was sent

sender_message class-attribute instance-attribute

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

The message from the request sender

sender_user_id class-attribute instance-attribute

sender_user_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managerActionDateTime'})

Time when the manager responded

manager_action_message class-attribute instance-attribute

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

The message from the manager

manager_user_id class-attribute instance-attribute

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

The ID of the manager that responded

open_shift_id class-attribute instance-attribute

open_shift_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

ListOpenShiftsCrossTeamResponse dataclass

ListOpenShiftsCrossTeamResponse(*, context: Optional[str] = None, value: Optional[List[OpenShiftResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Open Shifts from my teams

Attributes

value class-attribute instance-attribute

value: Optional[List[OpenShiftResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Open Shifts

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

ListShiftsCrossTeamResponse dataclass

ListShiftsCrossTeamResponse(*, context: Optional[str] = None, value: Optional[List[ShiftResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Shifts from my teams

Attributes

value class-attribute instance-attribute

value: Optional[List[ShiftResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Shifts

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

ListTimesOffCrossTeamResponse dataclass

ListTimesOffCrossTeamResponse(*, context: Optional[str] = None, value: Optional[List[TimeOffResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List all Times Off from my teams

Attributes

value class-attribute instance-attribute

value: Optional[List[TimeOffResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

List of Times off

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.nextLink'})

The URL to retrieve the next page.

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]]] = dataclass_field(default=None, kw_only=True)

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

WebHookRequest dataclass

WebHookRequest(notification_url: str)

Definition: WebHookRequest

Attributes

notification_url class-attribute instance-attribute

notification_url: str = dataclass_field(metadata={'wire_name': 'notificationUrl'})

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

WebhookPushResponse dataclass

WebhookPushResponse(*, value: Optional[List[WebhookNotificationEntity | Mapping[str, Any]]] = None)

Definition: WebhookPushResponse

Attributes

value class-attribute instance-attribute

value: Optional[List[WebhookNotificationEntity | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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 | Mapping[str, Any]] = None)

Definition: WebhookNotificationEntity

Attributes

subscription_id class-attribute instance-attribute

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

WebHook Subscription Id

expiration_date_time class-attribute instance-attribute

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

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

change_type class-attribute instance-attribute

change_type: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.id'})

Full resource path.

type_ class-attribute instance-attribute

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

Resoure Type.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

ID of the resource that is updated.

team_id class-attribute instance-attribute

team_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

Unique identifier for the subscription.

resource class-attribute instance-attribute

resource: Optional[str] = dataclass_field(default=None, kw_only=True)

Specifies the resource that will be monitored for changes.

application_id class-attribute instance-attribute

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

Identifier of the application used to create the subscription.

change_type class-attribute instance-attribute

change_type: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeOffReasonId'})

Time Off Reason ID.

start_date_time class-attribute instance-attribute

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

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

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeOffReasonId'})

Time Off Reason ID.

start_date_time class-attribute instance-attribute

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

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

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Shift Notes

start_date_time class-attribute instance-attribute

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

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

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

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

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

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'schedulingGroupId'})

The unique ID of the Scheduling Group.

display_name class-attribute instance-attribute

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

The display name for the Scheduling Group.

code class-attribute instance-attribute

code: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userId'})

The ID of the user.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'teamId'})

The ID of the team.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

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

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

end_date_time class-attribute instance-attribute

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

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

open_slot_count class-attribute instance-attribute

open_slot_count: Optional[int] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

Display Name

notes class-attribute instance-attribute

notes: Optional[str] = dataclass_field(default=None, kw_only=True)

Notes

start_date_time class-attribute instance-attribute

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

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

end_date_time class-attribute instance-attribute

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

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

open_slot_count class-attribute instance-attribute

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

Open Slot Count

CreateShiftRequest dataclass

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

Definition: CreateShiftRequest

Attributes

scheduling_group_id class-attribute instance-attribute

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

Scheduling Group ID

shared_shift class-attribute instance-attribute

shared_shift: Dict[str, Any] = dataclass_field(metadata={'wire_name': 'sharedShift'})

Shared version of the Shift.

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

Assigned to User ID

CreateTimeOffRequest dataclass

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

Definition: CreateTimeOffRequest

Attributes

shared_time_off class-attribute instance-attribute

shared_time_off: Dict[str, Any] = dataclass_field(metadata={'wire_name': 'sharedTimeOff'})

Shared version of a TimeOff.

user_id class-attribute instance-attribute

user_id: str = dataclass_field(metadata={'wire_name': 'userId'})

Assigned to User ID

ShiftsClient

ShiftsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

get_schedule async

get_schedule(team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Schedule's details

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

Swagger operation ID: GetSchedule.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_times_off

list_times_off(team_id: str, *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Time Off instances in a team

This operation returns all Time Off instances in a Schedule

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListTimesOff.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
start_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
end_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_time_off async

create_time_off(input: CreateTimeOffRequest | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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

Swagger operation ID: CreateTimeOff.

Parameters:

Name	Type	Description	Default
input	CreateTimeOffRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_time_off async

get_time_off(team_id: str, time_off_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Time Off instance

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

Swagger operation ID: GetTimeOff.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
time_off_id	str	The unique ID of the Time Off.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_time_off async

delete_time_off(team_id: str, time_off_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a Time Off instance

This operation deletes a Time Off using its unique ID.

Swagger operation ID: DeleteTimeOff.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
time_off_id	str	The unique ID of the Time Off.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_shifts

list_shifts(team_id: str, *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Shifts in a team

This operation returns all Shifts assigned to members of a team

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListShifts.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
start_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
end_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_shift async

create_shift(input: CreateShiftRequest | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a new Shift

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

Swagger operation ID: CreateShift.

Parameters:

Name	Type	Description	Default
input	CreateShiftRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_shift async

get_shift(team_id: str, shift_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Shift

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

Swagger operation ID: GetShift.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
shift_id	str	The unique ID of the Shift.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_shift async

delete_shift(team_id: str, shift_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a Shift

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

Swagger operation ID: DeleteShift.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
shift_id	str	The unique ID of the Shift.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_open_shifts

list_open_shifts(team_id: str, *, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Open Shifts in a team

This operation returns all Open Shifts in a team.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListOpenShifts.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
start_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
end_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

create_open_shift async

create_open_shift(input: EditOpenShiftRequest | Mapping[str, Any], team_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a new Open Shift

Create a new Open Shift in a Schedule.

Swagger operation ID: CreateOpenShift.

Parameters:

Name	Type	Description	Default
input	EditOpenShiftRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_open_shift async

get_open_shift(team_id: str, open_shift_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an Open Shift

This operation returns details for an Open Shift.

Swagger operation ID: GetOpenShift.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
open_shift_id	str	The unique ID of the Open Shift.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

update_open_shift async

update_open_shift(input: EditOpenShiftRequest | Mapping[str, Any], team_id: str, open_shift_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update an Open Shift

Update an Open Shift in a Schedule.

Swagger operation ID: UpdateOpenShift.

Parameters:

Name	Type	Description	Default
input	EditOpenShiftRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
open_shift_id	str	The unique ID of the Open Shift.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_open_shift async

delete_open_shift(team_id: str, open_shift_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete an Open Shift

This operation deletes an Open Shift.

Swagger operation ID: DeleteOpenShift.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
open_shift_id	str	The unique ID of the Open Shift.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_time_off_reasons

list_time_off_reasons(team_id: str, *, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Time Off Reasons in a team

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListTimeOffReasons.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_scheduling_groups

list_scheduling_groups(team_id: str, *, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Scheduling Groups in a team

This operation returns all Scheduling Groups in a Schedule.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListSchedulingGroups.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_scheduling_group async

get_scheduling_group(team_id: str, scheduling_group_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Scheduling Group

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

Swagger operation ID: GetSchedulingGroup.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
scheduling_group_id	str	The unique ID of the Scheduling Group.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_time_off_requests

list_time_off_requests(team_id: str, *, top: Optional[int] = None, state: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Time Off requests in a team

This operation returns all Time Off requests in a Schedule.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListTimeOffRequests.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
state	Optional[str]	Request state filter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_time_off_shift_request async

get_time_off_shift_request(team_id: str, time_off_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Time Off request

This operation returns a Time Off request by ID.

Swagger operation ID: GetTimeOffShiftRequest.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
time_off_request_id	str	The unique ID of the Time Off request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

time_off_request_approve async

time_off_request_approve(input: TimeOffRequestApproveInput | Mapping[str, Any], team_id: str, time_off_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Approve a Time Off request

This operation allows managers to approve a Time Off request.

Swagger operation ID: TimeOffRequestApprove.

Parameters:

Name	Type	Description	Default
input	TimeOffRequestApproveInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
time_off_request_id	str	The unique ID of the Time Off request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

time_off_request_decline async

time_off_request_decline(input: TimeOffRequestDeclineInput | Mapping[str, Any], team_id: str, time_off_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Decline a Time Off request

This operation allows managers to decline a Time Off request.

Swagger operation ID: TimeOffRequestDecline.

Parameters:

Name	Type	Description	Default
input	TimeOffRequestDeclineInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
time_off_request_id	str	The unique ID of the Time Off request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_offer_shift_requests

list_offer_shift_requests(team_id: str, *, top: Optional[int] = None, state: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Offer Shift requests in a team

This operation returns all Offer Shift requests in a Schedule.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListOfferShiftRequests.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
state	Optional[str]	Request state filter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_offer_shift_request async

get_offer_shift_request(team_id: str, offer_shift_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an Offer Shift request

This operation returns an Offer Shift request by ID.

Swagger operation ID: GetOfferShiftRequest.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
offer_shift_request_id	str	The unique ID of the Offer Shift request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

offer_shift_request_approve async

offer_shift_request_approve(input: OfferShiftRequestApproveInput | Mapping[str, Any], team_id: str, offer_shift_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Approve an Offer Shift request

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

Swagger operation ID: OfferShiftRequestApprove.

Parameters:

Name	Type	Description	Default
input	OfferShiftRequestApproveInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
offer_shift_request_id	str	The unique ID of the Offer Shift request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

offer_shift_request_decline async

offer_shift_request_decline(input: OfferShiftRequestDeclineInput | Mapping[str, Any], team_id: str, offer_shift_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Decline an Offer Shift request

This operation allows users to decline an Offer Shift request.

Swagger operation ID: OfferShiftRequestDecline.

Parameters:

Name	Type	Description	Default
input	OfferShiftRequestDeclineInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
offer_shift_request_id	str	The unique ID of the Offer Shift request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_swap_shifts_change_requests

list_swap_shifts_change_requests(team_id: str, *, top: Optional[int] = None, state: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Swap Shifts requests in a team

This operation returns all Swap Shifts requests in a Schedule.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListSwapShiftsChangeRequests.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
state	Optional[str]	Request state filter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_swap_shifts_change_request async

get_swap_shifts_change_request(team_id: str, swap_shifts_change_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get a Swap Shifts request

This operation returns a Swap Shifts request by ID.

Swagger operation ID: GetSwapShiftsChangeRequest.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
swap_shifts_change_request_id	str	The unique ID of the request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

swap_shifts_change_request_approve async

swap_shifts_change_request_approve(input: SwapShiftsChangeRequestApproveInput | Mapping[str, Any], team_id: str, swap_shifts_change_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Approve a Swap Shifts request

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

Swagger operation ID: SwapShiftsChangeRequestApprove.

Parameters:

Name	Type	Description	Default
input	SwapShiftsChangeRequestApproveInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
swap_shifts_change_request_id	str	The unique ID of the request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

swap_shifts_change_request_decline async

swap_shifts_change_request_decline(input: SwapShiftsChangeRequestDeclineInput | Mapping[str, Any], team_id: str, swap_shifts_change_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Decline a Swap Shifts request

This operation allows users to decline a Swap Shifts request.

Swagger operation ID: SwapShiftsChangeRequestDecline.

Parameters:

Name	Type	Description	Default
input	SwapShiftsChangeRequestDeclineInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
swap_shifts_change_request_id	str	The unique ID of the request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_open_shift_change_requests

list_open_shift_change_requests(team_id: str, *, top: Optional[int] = None, state: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Open Shift requests in a team

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListOpenShiftChangeRequests.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
state	Optional[str]	Request state filter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_open_shift_change_request async

get_open_shift_change_request(team_id: str, open_shift_change_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get an Open Shift request

This operation returns an Open Shift change request by ID.

Swagger operation ID: GetOpenShiftChangeRequest.

Parameters:

Name	Type	Description	Default
team_id	str	Add Team ID.	required
open_shift_change_request_id	str	The unique ID of the request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

open_shift_change_request_approve async

open_shift_change_request_approve(input: OpenShiftChangeRequestApproveInput | Mapping[str, Any], team_id: str, open_shift_change_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Approve an Open Shift request

This operation allows managers to approve an Open Shift request.

Swagger operation ID: OpenShiftChangeRequestApprove.

Parameters:

Name	Type	Description	Default
input	OpenShiftChangeRequestApproveInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
open_shift_change_request_id	str	The unique ID of the request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

open_shift_change_request_decline async

open_shift_change_request_decline(input: OpenShiftChangeRequestDeclineInput | Mapping[str, Any], team_id: str, open_shift_change_request_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Decline an Open Shift request

This operation allows managers to decline an Open Shift request.

Swagger operation ID: OpenShiftChangeRequestDecline.

Parameters:

Name	Type	Description	Default
input	OpenShiftChangeRequestDeclineInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
team_id	str	Add Team ID.	required
open_shift_change_request_id	str	The unique ID of the request.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_open_shifts_cross_team

list_open_shifts_cross_team(*, start_time: Optional[str] = None, end_time: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Open Shifts from my teams

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListOpenShiftsCrossTeam.

Parameters:

Name	Type	Description	Default
start_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
end_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_shifts_cross_team

list_shifts_cross_team(*, start_time: Optional[str] = None, end_time: Optional[str] = None, assigned_to_user_name: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Shifts from my teams

This operation returns assigned Shifts from all your teams.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListShiftsCrossTeam.

Parameters:

Name	Type	Description	Default
start_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
end_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
assigned_to_user_name	Optional[str]	Assigned to user with name.	None
top	Optional[int]	Items per page (enable Pagination under .../Settings).	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_times_off_cross_team

list_times_off_cross_team(*, start_time: Optional[str] = None, end_time: Optional[str] = None, assigned_to_user_name: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List all Times Off from my teams

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

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ListTimesOffCrossTeam.

Parameters:

Name	Type	Description	Default
start_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
end_time	Optional[str]	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).	None
assigned_to_user_name	Optional[str]	Assigned to user with name.	None
top	Optional[int]	How many times off to fetch.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_all_teams

list_all_teams(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List teams

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

Returns a single-page Azure Core async collection.

Swagger operation ID: GetAllTeams.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.