Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional _addresses

_addresses: Address[]

Optional _companies

_companies: UserCompany[]

Optional _emailAddresses

_emailAddresses: EmailAddress[]

Optional _phoneNumbers

_phoneNumbers: PhoneNumber[]

Optional addresses

addresses: Address[]

Optional appliedJobs

appliedJobs: Job[]

Optional archived

archived: null | Date

Optional assignments

assignments: Assignment[]

Readonly backObjects

backObjects: Set<Entity> = ...

Optional callToActionDetails

callToActionDetails: any[]

Optional callToActions

callToActions: string

Optional carts

carts: Cart[]

Optional categories

categories: Category[]

Optional clientToken

clientToken: null | string

Optional comments

comments: null | string

Optional companiesNeedStripe

companiesNeedStripe: Company[]

Optional companyInvitations

companyInvitations: CompanyInvitation[]

create

create: (options?: CreateOptions) => Promise<User> = ...

Type declaration

    • (options?: CreateOptions): Promise<User>

    • Parameters

      • Optional options: CreateOptions

      Returns Promise<User>

Optional created

created: null | Date

Optional createdInvoices

createdInvoices: Invoice[]

Optional draftComments

draftComments: DraftComment[]

Optional draftingJobs

draftingJobs: Job[]

Optional drafts

drafts: Draft[]

Optional emailAddresses

emailAddresses: EmailAddress[]

Optional enableClientEmails

enableClientEmails: boolean

Optional enableCrashReports

enableCrashReports: boolean

Optional enableInvoiceReminders

enableInvoiceReminders: boolean

Optional enrolledDomains

enrolledDomains: EnrolledDomain[]

Optional facebookUserId

facebookUserId: null | string

Optional forwardedDraftComments

forwardedDraftComments: DraftComment[]

Optional forwardedJobComments

forwardedJobComments: JobComment[]

Optional forwardedProductionComments

forwardedProductionComments: ProductionComment[]

Optional hasStore

hasStore: boolean

Optional id

id: number

Optional invoicesHas

invoicesHas: Invoice[]

Optional isAdminOfSubscribedCompany

isAdminOfSubscribedCompany: boolean

isDirty

isDirty: boolean = false

Optional isSuperUser

isSuperUser: boolean

Optional jobComments

jobComments: JobComment[]

key

key: string = ...

Optional managedJobs

managedJobs: Job[]

merchi

merchi: Merchi

Optional name

name: string

Optional notifications

notifications: Notification[]

Optional password

password: null | string

Optional payments

payments: Payment[]

Optional phoneNumbers

phoneNumbers: PhoneNumber[]

Optional preferredLanguage

preferredLanguage: null | string

Optional products

products: Product[]

Optional profilePicture

profilePicture: null | MerchiFile

propertiesMap

propertiesMap: Map<string, PropertyInfo>

publicCreate

publicCreate: (options?: CreateOptions) => Promise<User> = ...

Type declaration

    • (options?: CreateOptions): Promise<User>

    • Parameters

      • Optional options: CreateOptions

      Returns Promise<User>

Optional receivedDomainInvitations

receivedDomainInvitations: DomainInvitation[]

Optional resetSmsTokenDate

resetSmsTokenDate: null | Date

Optional resetToken

resetToken: null | string

Optional resetTokenDate

resetTokenDate: null | Date

Optional responsibleInvoices

responsibleInvoices: Invoice[]

Optional salt

salt: null | string

Optional saved_products

saved_products: Product[]

Optional sentDomainInvitations

sentDomainInvitations: DomainInvitation[]

Optional sentNotifications

sentNotifications: Notification[]

Optional sessions

sessions: Session[]

Optional shipmentsAsReceiver

shipmentsAsReceiver: Shipment[]

Optional shipmentsAsSender

shipmentsAsSender: Shipment[]

Optional smsClientToken

smsClientToken: null | string

Optional smsLoginThreshold

smsLoginThreshold: number

Optional smsToken

smsToken: null | string

Optional smsTokenConfirmed

smsTokenConfirmed: boolean

Optional systemRoles

systemRoles: SystemRole[]

Optional themes

themes: Theme[]

Optional timezone

timezone: null | string

Optional uploadFiles

uploadFiles: MerchiFile[]

Optional userCompanies

userCompanies: UserCompany[]

Static merchi

merchi: Merchi

Methods

cleanDirty

  • cleanDirty(): void

companies

createFactory

  • createFactory(__namedParameters: Object): (options?: CreateOptions) => Promise<this>

  • Parameters

    • __namedParameters: Object

    Returns (options?: CreateOptions) => Promise<this>

      • (options?: CreateOptions): Promise<this>

      • Parameters

        • Optional options: CreateOptions

        Returns Promise<this>

delete

  • delete(options?: DeleteOptions): Promise<this>

domainsByRoles

fromJson

  • fromJson(json: any, options?: FromJsonOptions): this

getPrimaryKeyValue

  • getPrimaryKeyValue(): any

hasAuthority

  • hasAuthority(domain: Domain, roles: Role[]): boolean

hasRoles

  • hasRoles(roles: Role[], combinationMethod?: { <T>(collection: undefined | null | List<T>, predicate?: ListIterateeCustom<T, boolean>): boolean; <T>(collection: undefined | null | T, predicate?: ObjectIterateeCustom<T, boolean>): boolean }): boolean

  • Parameters

    • roles: Role[]
    • combinationMethod: { <T>(collection: undefined | null | List<T>, predicate?: ListIterateeCustom<T, boolean>): boolean; <T>(collection: undefined | null | T, predicate?: ObjectIterateeCustom<T, boolean>): boolean } = ...
        • <T>(collection: undefined | null | List<T>, predicate?: ListIterateeCustom<T, boolean>): boolean
        • <T>(collection: undefined | null | T, predicate?: ObjectIterateeCustom<T, boolean>): boolean

        • Checks if predicate returns truthy for any element of collection. Iteration is stopped once predicate returns truthy. The predicate is invoked with three arguments: (value, index|key, collection).

          Type parameters

          • T

          Parameters

          • collection: undefined | null | List<T>

            The collection to iterate over.

          • Optional predicate: ListIterateeCustom<T, boolean>

            The function invoked per iteration.

          Returns boolean

          Returns true if any element passes the predicate check, else false.

        • see

          _.some

          Type parameters

          • T: object

          Parameters

          • collection: undefined | null | T
          • Optional predicate: ObjectIterateeCustom<T, boolean>

          Returns boolean

    Returns boolean

hasSystemRole

isDomainManager

  • isDomainManager(domain: Domain): boolean

isManagementTeam

  • isManagementTeam(domain: Domain): boolean

isNotClient

  • isNotClient(domain: Domain): boolean

isSuper

  • isSuper(): boolean

recover

  • recover(options?: SaveOptions): Promise<this>

roleInDomain

save

  • save(options?: SaveOptions): Promise<this>

toFormData

  • toFormData(options?: SerialiseOptions, fileIndex?: Counter): FormData

toJson

  • toJson(): any

updateOrder

  • updateOrder(property: string): void

Static get

  • get<T>(key: string | number, options?: GetOptions): Promise<InstanceType<T>>

  • Type parameters

    Parameters

    • key: string | number
    • Optional options: GetOptions

    Returns Promise<InstanceType<T>>

Static list

  • list<T>(options?: ListOptions): Promise<ListResponse<InstanceType<T>>>

Generated using TypeDoc