Current File : /home2/selectio/www/fms-worksuite/vendor/square/square/src/Models/Shift.php
<?php
declare(strict_types=1);
namespace Square\Models;
use stdClass;
/**
* 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.
*/
class Shift implements \JsonSerializable
{
/**
* @var string|null
*/
private $id;
/**
* @var string|null
*/
private $employeeId;
/**
* @var string|null
*/
private $locationId;
/**
* @var string|null
*/
private $timezone;
/**
* @var string
*/
private $startAt;
/**
* @var string|null
*/
private $endAt;
/**
* @var ShiftWage|null
*/
private $wage;
/**
* @var MBreak[]|null
*/
private $breaks;
/**
* @var string|null
*/
private $status;
/**
* @var int|null
*/
private $version;
/**
* @var string|null
*/
private $createdAt;
/**
* @var string|null
*/
private $updatedAt;
/**
* @var string|null
*/
private $teamMemberId;
/**
* @param string $startAt
*/
public function __construct(string $startAt)
{
$this->startAt = $startAt;
}
/**
* Returns Id.
*
* The UUID for this object.
*/
public function getId(): ?string
{
return $this->id;
}
/**
* Sets Id.
*
* The UUID for this object.
*
* @maps id
*/
public function setId(?string $id): void
{
$this->id = $id;
}
/**
* Returns Employee Id.
*
* The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id`
* instead.
*/
public function getEmployeeId(): ?string
{
return $this->employeeId;
}
/**
* Sets Employee Id.
*
* The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id`
* instead.
*
* @maps employee_id
*/
public function setEmployeeId(?string $employeeId): void
{
$this->employeeId = $employeeId;
}
/**
* Returns Location Id.
*
* The ID of the location this shift occurred at. The location should be based on
* where the employee clocked in.
*/
public function getLocationId(): ?string
{
return $this->locationId;
}
/**
* Sets Location Id.
*
* The ID of the location this shift occurred at. The location should be based on
* where the employee clocked in.
*
* @maps location_id
*/
public function setLocationId(?string $locationId): void
{
$this->locationId = $locationId;
}
/**
* Returns Timezone.
*
* 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.
*/
public function getTimezone(): ?string
{
return $this->timezone;
}
/**
* Sets Timezone.
*
* 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.
*
* @maps timezone
*/
public function setTimezone(?string $timezone): void
{
$this->timezone = $timezone;
}
/**
* Returns Start At.
*
* RFC 3339; shifted to the location timezone + offset. Precision up to the
* minute is respected; seconds are truncated.
*/
public function getStartAt(): string
{
return $this->startAt;
}
/**
* Sets Start At.
*
* RFC 3339; shifted to the location timezone + offset. Precision up to the
* minute is respected; seconds are truncated.
*
* @required
* @maps start_at
*/
public function setStartAt(string $startAt): void
{
$this->startAt = $startAt;
}
/**
* Returns End At.
*
* RFC 3339; shifted to the timezone + offset. Precision up to the minute is
* respected; seconds are truncated.
*/
public function getEndAt(): ?string
{
return $this->endAt;
}
/**
* Sets End At.
*
* RFC 3339; shifted to the timezone + offset. Precision up to the minute is
* respected; seconds are truncated.
*
* @maps end_at
*/
public function setEndAt(?string $endAt): void
{
$this->endAt = $endAt;
}
/**
* Returns Wage.
*
* The hourly wage rate used to compensate an employee for this shift.
*/
public function getWage(): ?ShiftWage
{
return $this->wage;
}
/**
* Sets Wage.
*
* The hourly wage rate used to compensate an employee for this shift.
*
* @maps wage
*/
public function setWage(?ShiftWage $wage): void
{
$this->wage = $wage;
}
/**
* Returns Breaks.
*
* A list of all the paid or unpaid breaks that were taken during this shift.
*
* @return MBreak[]|null
*/
public function getBreaks(): ?array
{
return $this->breaks;
}
/**
* Sets Breaks.
*
* A list of all the paid or unpaid breaks that were taken during this shift.
*
* @maps breaks
*
* @param MBreak[]|null $breaks
*/
public function setBreaks(?array $breaks): void
{
$this->breaks = $breaks;
}
/**
* Returns Status.
*
* Enumerates the possible status of a `Shift`.
*/
public function getStatus(): ?string
{
return $this->status;
}
/**
* Sets Status.
*
* Enumerates the possible status of a `Shift`.
*
* @maps status
*/
public function setStatus(?string $status): void
{
$this->status = $status;
}
/**
* Returns Version.
*
* 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.
*/
public function getVersion(): ?int
{
return $this->version;
}
/**
* Sets Version.
*
* 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.
*
* @maps version
*/
public function setVersion(?int $version): void
{
$this->version = $version;
}
/**
* Returns Created At.
*
* A read-only timestamp in RFC 3339 format; presented in UTC.
*/
public function getCreatedAt(): ?string
{
return $this->createdAt;
}
/**
* Sets Created At.
*
* A read-only timestamp in RFC 3339 format; presented in UTC.
*
* @maps created_at
*/
public function setCreatedAt(?string $createdAt): void
{
$this->createdAt = $createdAt;
}
/**
* Returns Updated At.
*
* A read-only timestamp in RFC 3339 format; presented in UTC.
*/
public function getUpdatedAt(): ?string
{
return $this->updatedAt;
}
/**
* Sets Updated At.
*
* A read-only timestamp in RFC 3339 format; presented in UTC.
*
* @maps updated_at
*/
public function setUpdatedAt(?string $updatedAt): void
{
$this->updatedAt = $updatedAt;
}
/**
* Returns Team Member Id.
*
* The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26".
*/
public function getTeamMemberId(): ?string
{
return $this->teamMemberId;
}
/**
* Sets Team Member Id.
*
* The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26".
*
* @maps team_member_id
*/
public function setTeamMemberId(?string $teamMemberId): void
{
$this->teamMemberId = $teamMemberId;
}
/**
* Encode this object to JSON
*
* @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields
* are set. (default: false)
*
* @return mixed
*/
public function jsonSerialize(bool $asArrayWhenEmpty = false)
{
$json = [];
if (isset($this->id)) {
$json['id'] = $this->id;
}
if (isset($this->employeeId)) {
$json['employee_id'] = $this->employeeId;
}
if (isset($this->locationId)) {
$json['location_id'] = $this->locationId;
}
if (isset($this->timezone)) {
$json['timezone'] = $this->timezone;
}
$json['start_at'] = $this->startAt;
if (isset($this->endAt)) {
$json['end_at'] = $this->endAt;
}
if (isset($this->wage)) {
$json['wage'] = $this->wage;
}
if (isset($this->breaks)) {
$json['breaks'] = $this->breaks;
}
if (isset($this->status)) {
$json['status'] = $this->status;
}
if (isset($this->version)) {
$json['version'] = $this->version;
}
if (isset($this->createdAt)) {
$json['created_at'] = $this->createdAt;
}
if (isset($this->updatedAt)) {
$json['updated_at'] = $this->updatedAt;
}
if (isset($this->teamMemberId)) {
$json['team_member_id'] = $this->teamMemberId;
}
$json = array_filter($json, function ($val) {
return $val !== null;
});
return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json;
}
}
Mini Shell