Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 1.86 KB

File metadata and controls

49 lines (40 loc) · 1.86 KB

Teammate

Properties

Name Type Description Notes
teammateId String Unique indentifier [optional]
userId Integer User ID of the teammate [optional]
name String Name [optional]
lastActivity OffsetDateTime Last activity [optional]
appId String Access level is for this App [optional]
invitationStatus InvitationStatusEnum Invitation status [optional]
email String Email address [optional]
appAccessLevel AppAccessLevelEnum App access level [optional]
hasAccessToAllStores Boolean The user has access to all stores for the app (including new stores that added later) [optional]
storeIds List<Integer> Store IDs the user has access to (if HasAccessToAllStores is false) [optional]
propertyIds List<String> Property Ids the user has access to (if HasAccessToAllStores is false) [optional]

Enum: InvitationStatusEnum

Name Value
PENDING "Pending"
ACCEPTED "Accepted"
EXPIRED "Expired"

Enum: AppAccessLevelEnum

Name Value
NONE "None"
OWNER "Owner"
STOREOWNER "StoreOwner"
PROPERTYOWNER "PropertyOwner"
MANAGEDOWNER "ManagedOwner"
INTEGRATOR "Integrator"
PROPERTYMANAGER "PropertyManager"
STOREMANAGER "StoreManager"
STORESTAFF "StoreStaff"
STAFFMEMBER "StaffMember"
STOREREADONLYACCESS "StoreReadOnlyAccess"
FINANCEMANGER "FinanceManger"
ONBOARDING "Onboarding"
SUPPORT "Support"