import type * as Square from "../index";
/**
 * A record of the hourly rate, start, and end times for a single work shift
 * for an employee. This might include a record of the start and end times for breaks
 * taken during the shift.
 *
 * Deprecated at Square API version 2025-05-21. Replaced by [Timecard](entity:Timecard).
 * See the [migration notes](https://developer.squareup.com/docs/labor-api/what-it-does#migration-notes).
 */
export interface Shift {
    /** The UUID for this object. */
    id?: string;
    /** The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead. */
    employeeId?: string | null;
    /**
     * The ID of the location this shift occurred at. The location should be based on
     * where the employee clocked in.
     */
    locationId: string;
    /**
     * The read-only convenience value that is calculated from the location based
     * on the `location_id`. Format: the IANA timezone database identifier for the
     * location timezone.
     */
    timezone?: string | null;
    /**
     * RFC 3339; shifted to the location timezone + offset. Precision up to the
     * minute is respected; seconds are truncated.
     */
    startAt: string;
    /**
     * RFC 3339; shifted to the timezone + offset. Precision up to the minute is
     * respected; seconds are truncated.
     */
    endAt?: string | null;
    /**
     * Job and pay related information. If the wage is not set on create, it defaults to a wage
     * of zero. If the title is not set on create, it defaults to the name of the role the employee
     * is assigned to, if any.
     */
    wage?: Square.ShiftWage;
    /** A list of all the paid or unpaid breaks that were taken during this shift. */
    breaks?: Square.Break[] | null;
    /**
     * Describes the working state of the current `Shift`.
     * See [ShiftStatus](#type-shiftstatus) for possible values
     */
    status?: Square.ShiftStatus;
    /**
     * Used for resolving concurrency issues. The request fails if the version
     * provided does not match the server version at the time of the request. If not provided,
     * Square executes a blind write; potentially overwriting data from another
     * write.
     */
    version?: number;
    /** A read-only timestamp in RFC 3339 format; presented in UTC. */
    createdAt?: string;
    /** A read-only timestamp in RFC 3339 format; presented in UTC. */
    updatedAt?: string;
    /** The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26". */
    teamMemberId?: string | null;
    /** The tips declared by the team member for the shift. */
    declaredCashTipMoney?: Square.Money;
}