Class: Employee

employees.Employee()

new Employee()

Source:

Methods

(static) Employee#getClaimedTime() → {Null|Number}

Get the field value Timestamp of when this employee claimed their account
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Employee#getCustomId() → {Null|String}

Get the field value Custom ID of the employee
Source:
Returns:
Type
Null | String

(static) Employee#getDeletedTime() → {Null|Number}

Get the field value Timestamp of when this employee was deleted
Source:
Returns:
must be a long integer
Type
Null | Number

(static) Employee#getEmail() → {Null|String}

Get the field value Email of the employee (optional)
Source:
Returns:
Type
Null | String

(static) Employee#getEmployeeCards() → {Null|Array.<base.Reference>}

Get the field value This employee's employee cards
Source:
Returns:
An array of
Type
Null | Array.<base.Reference>

(static) Employee#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) Employee#getInviteSent() → {Null|Boolean}

Get the field value Returns true if this employee was sent an invite to activate their account
Source:
Returns:
Type
Null | Boolean

(static) Employee#getIsOwner() → {Null|Boolean}

Get the field value Returns true if this employee is the owner account for this merchant
Source:
Returns:
Type
Null | Boolean

(static) Employee#getMerchant() → {Null|base.Reference}

Get the field value The merchant employing this employee
Source:
Returns:
Type
Null | base.Reference

(static) Employee#getName() → {Null|String}

Get the field value Full name of the employee
Source:
Returns:
Type
Null | String

(static) Employee#getNickname() → {Null|String}

Get the field value Nickname of the employee (shows up on receipts)
Source:
Returns:
Type
Null | String

(static) Employee#getOrders() → {Null|Array.<base.Reference>}

Get the field value This employee's orders
Source:
Returns:
An array of
Type
Null | Array.<base.Reference>

(static) Employee#getPayments() → {Null|Array.<base.Reference>}

Get the field value This employee's payments
Source:
Returns:
An array of
Type
Null | Array.<base.Reference>

(static) Employee#getPin() → {Null|String}

Get the field value Employee PIN (hashed)
Source:
Returns:
Type
Null | String

(static) Employee#getRole() → {Null|employees.AccountRole}

Get the field value Employee System Role
Source:
Returns:
Type
Null | employees.AccountRole

(static) Employee#getRoles() → {Null|Array.<base.Reference>}

Get the field value
Source:
Returns:
An array of
Type
Null | Array.<base.Reference>

(static) Employee#getShifts() → {Null|Array.<base.Reference>}

Get the field value This employee's shifts
Source:
Returns:
An array of
Type
Null | Array.<base.Reference>

(static) Employee#getUnhashedPin() → {Null|String}

Get the field value Employee PIN
Source:
Returns:
Type
Null | String

(static) Employee#setClaimedTime(claimedTime)

Set the field value Timestamp of when this employee claimed their account
Parameters:
Name Type Description
claimedTime Null | Number must be a long integer
Source:

(static) Employee#setCustomId(customId)

Set the field value Custom ID of the employee
Parameters:
Name Type Description
customId Null | String
Source:

(static) Employee#setDeletedTime(deletedTime)

Set the field value Timestamp of when this employee was deleted
Parameters:
Name Type Description
deletedTime Null | Number must be a long integer
Source:

(static) Employee#setEmail(email)

Set the field value Email of the employee (optional)
Parameters:
Name Type Description
email Null | String
Source:

(static) Employee#setEmployeeCards(employeeCards)

Set the field value This employee's employee cards
Parameters:
Name Type Description
employeeCards Null | Array.<base.Reference> An array of
Source:

(static) Employee#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) Employee#setInviteSent(inviteSent)

Set the field value Returns true if this employee was sent an invite to activate their account
Parameters:
Name Type Description
inviteSent Null | Boolean
Source:

(static) Employee#setIsOwner(isOwner)

Set the field value Returns true if this employee is the owner account for this merchant
Parameters:
Name Type Description
isOwner Null | Boolean
Source:

(static) Employee#setMerchant(merchant)

Set the field value The merchant employing this employee
Parameters:
Name Type Description
merchant Null | base.Reference
Source:

(static) Employee#setName(name)

Set the field value Full name of the employee
Parameters:
Name Type Description
name Null | String
Source:

(static) Employee#setNickname(nickname)

Set the field value Nickname of the employee (shows up on receipts)
Parameters:
Name Type Description
nickname Null | String
Source:

(static) Employee#setOrders(orders)

Set the field value This employee's orders
Parameters:
Name Type Description
orders Null | Array.<base.Reference> An array of
Source:

(static) Employee#setPayments(payments)

Set the field value This employee's payments
Parameters:
Name Type Description
payments Null | Array.<base.Reference> An array of
Source:

(static) Employee#setPin(pin)

Set the field value Employee PIN (hashed)
Parameters:
Name Type Description
pin Null | String
Source:

(static) Employee#setRole(role)

Set the field value Employee System Role
Parameters:
Name Type Description
role Null | employees.AccountRole
Source:

(static) Employee#setRoles(roles)

Set the field value
Parameters:
Name Type Description
roles Null | Array.<base.Reference> An array of
Source:

(static) Employee#setShifts(shifts)

Set the field value This employee's shifts
Parameters:
Name Type Description
shifts Null | Array.<base.Reference> An array of
Source:

(static) Employee#setUnhashedPin(unhashedPin)

Set the field value Employee PIN
Parameters:
Name Type Description
unhashedPin Null | String
Source: