Employee

January 22, 2020 ยท View on GitHub

Description

An employee object that is used by the external API.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringUUID for this object.[optional]
first_namegetFirstName()setFirstName($value)stringThe employee's first name.[optional]
last_namegetLastName()setLastName($value)stringThe employee's last name.[optional]
emailgetEmail()setEmail($value)stringThe employee's email address[optional]
phone_numbergetPhoneNumber()setPhoneNumber($value)stringThe employee's phone number in E.164 format, i.e. "+12125554250"[optional]
location_idsgetLocationIds()setLocationIds($value)string[]A list of location IDs where this employee has access to.[optional]
statusgetStatus()setStatus($value)stringSpecifies the status of the employees being fetched. See EmployeeStatus for possible values[optional]
is_ownergetIsOwner()setIsOwner($value)boolWhether this employee is the owner of the merchant. Each merchant has one owner employee, and that employee has full authority over the account.[optional]
created_atgetCreatedAt()setCreatedAt($value)stringA read-only timestamp in RFC 3339 format.[optional]
updated_atgetUpdatedAt()setUpdatedAt($value)stringA read-only timestamp in RFC 3339 format.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]