Skip to content

GetTimeOffResponse

Source code in docs_src/capo_connectscheduling/types/get_time_off_response.py
class GetTimeOffResponse(TypedDict, closed=True):
    time_off_id: "capo_connectscheduling.types.time_off_id.TimeOffId"
    """<p>The identifier of the time off request.</p>"""
    user_id: "capo_connectscheduling.types.user_id.UserId"
    """<p>The identifier of the user the time off is for.</p>"""
    shift_activity_id: "capo_connectscheduling.types.shift_activity_id.ShiftActivityId"
    """<p>The identifier of the shift activity for the time off request.</p>"""
    start_at: "datetime.datetime"
    """<p>The start of the time off window, inclusive, as sent to <code>CreateTimeOff</code>.</p>"""
    end_at: "datetime.datetime"
    """<p>The end of the time off window, exclusive, as sent to <code>CreateTimeOff</code>.</p>"""
    status: "capo_connectscheduling.types.time_off_status.TimeOffStatus"
    """<p>The status of the time off request.</p> <ul> <li> <p> <code>PENDING</code>: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request <code>PENDING</code>, so an <code>APPROVED</code> request can become <code>PENDING</code> and then end <code>APPROVED</code> or <code>REJECTED</code>.</p> </li> <li> <p> <code>AWAITING_APPROVAL</code>: the request is waiting for an <code>ApproveTimeOff</code> or <code>RejectTimeOff</code> call.</p> </li> </ul>"""
    description: NotRequired["capo_connectscheduling.types.description.Description"]
    """<p>The description of the time off request. <code>CreateTimeOff</code> sets it, and <code>CancelTimeOff</code> replaces or removes it. An edit in the Connect Customer admin website can also change it. <code>GetTimeOff</code> doesn't return descriptions sent with <code>ApproveTimeOff</code> or <code>RejectTimeOff</code>.</p>"""
    validation_results: NotRequired[
        "capo_connectscheduling.types.time_off_validation_results.TimeOffValidationResults"
    ]
    """<p>Warnings or failures produced while processing the time off request.</p>"""
    created_by: "capo_connectscheduling.types.actor_info.ActorInfo"
    """<p>The identity that created the request. Immutable for the life of the request.</p>"""
    created_at: "datetime.datetime"
    """<p>The timestamp when the time off request was created.</p>"""
    updated_by: NotRequired["capo_connectscheduling.types.actor_info.ActorInfo"]
    """<p>The identity that made the most recent <code>ApproveTimeOff</code>, <code>RejectTimeOff</code>, or <code>CancelTimeOff</code> call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an <code>AUTOMATIC</code> request. <code>UpdatedAt</code> also changes when a <code>PENDING</code> request changes to another status and for other edits, which don't set <code>UpdatedBy</code>.</p>"""
    updated_at: "datetime.datetime"
    """<p>The timestamp when the time off request was last modified.</p>"""

created_at instance-attribute

created_at: datetime

The timestamp when the time off request was created.

created_by instance-attribute

created_by: ActorInfo

The identity that created the request. Immutable for the life of the request.

description instance-attribute

description: NotRequired[Description]

The description of the time off request. CreateTimeOff sets it, and CancelTimeOff replaces or removes it. An edit in the Connect Customer admin website can also change it. GetTimeOff doesn't return descriptions sent with ApproveTimeOff or RejectTimeOff.

end_at instance-attribute

end_at: datetime

The end of the time off window, exclusive, as sent to CreateTimeOff.

shift_activity_id instance-attribute

shift_activity_id: ShiftActivityId

The identifier of the shift activity for the time off request.

start_at instance-attribute

start_at: datetime

The start of the time off window, inclusive, as sent to CreateTimeOff.

status instance-attribute

status: TimeOffStatus

The status of the time off request.

  • PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.

  • AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.

time_off_id instance-attribute

time_off_id: TimeOffId

The identifier of the time off request.

updated_at instance-attribute

updated_at: datetime

The timestamp when the time off request was last modified.

updated_by instance-attribute

updated_by: NotRequired[ActorInfo]

The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.

user_id instance-attribute

user_id: UserId

The identifier of the user the time off is for.

validation_results instance-attribute

validation_results: NotRequired[TimeOffValidationResults]

Warnings or failures produced while processing the time off request.