Class SubUser

Hierarchy (View Summary)

OntologyModel
- SubUser

Implements

ISubUser

Indexable

[x: string]: any

Index

Constructors

Accessors

Constructors

constructor

new SubUser(username?: string, password?: string): SubUser
Parameters
- Optionalusername: string
- Optionalpassword: string
Returns SubUser
Overrides OntologyModel.constructor
- Defined in src/models/subuser.ts:52

Properties

`Optional`address

address?: string

edges

edges: OntologyEdge[] = []

`Optional`email

email?: string

expand

expand: number

`Optional`first_name

first_name?: string

`Optional`language

language?: string

`Optional`last_name

last_name?: string

`Optional`last_online

last_online?: string

`Optional`login_password

login_password?: string

`Optional`login_username

login_username?: string

meta

meta: Meta = ...

`Optional`name

name?: string

`Optional`nickname

nickname?: string

`Optional`organization

organization?: string

`Optional`other_email

other_email?: OtherContact[]

`Optional`other_sms

other_sms?: OtherContact[]

`Optional`parent

parent?: IModel

parentEdges

parentEdges: OntologyEdge[] = []

`Optional`phone

phone?: string

`Optional`point_management

point_management?: PointManagement

`Optional`role

role?: string

`Optional`session_token

session_token?: string

`Optional`verified_email

verified_email?: boolean

`Optional`verified_sms

verified_sms?: boolean

`Static`attributes

attributes: string[] = ...

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/subuser'

Accessors

ontology

get ontology(): OntologyEdge[]
Get the ontology edges of the current object.

Returns OntologyEdge[]
The ontology edges of the current object.

Remarks
This is here for backwards compatibility.

Deprecated
Should use edges instead.
Inherited from OntologyModel.ontology
- Defined in src/models/model.ontology.ts:31
set ontology(edges: OntologyEdge[]): void
Set the ontology edges of the current object.
Parameters
- edges: OntologyEdge[]
  The ontology edges to set.
Returns void
Remarks
This is here for backwards compatibility.

Deprecated
Should use edges instead.
Inherited from OntologyModel.ontology
- Defined in src/models/model.ontology.ts:42

Methods

_create

_create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from OntologyModel._create
- Defined in src/models/model.ts:110

addChildrenToStore

addChildrenToStore(): void
Returns void
Inherited from OntologyModel.addChildrenToStore
- Defined in src/models/model.ts:73

addEdge

addEdge(edge: OntologyEdge): void
Parameters
- edge: OntologyEdge
Returns void
Inherited from OntologyModel.addEdge
- Defined in src/models/model.ontology.ts:50

addParentEdge

addParentEdge(params: IOntologyEdge, to: IOntologyModel): Promise<void>
Parameters
- params: IOntologyEdge
- to: IOntologyModel
Returns Promise<void>
Inherited from OntologyModel.addParentEdge
- Defined in src/models/model.ontology.ts:85

create

create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from OntologyModel.create
- Defined in src/models/model.ts:143

createEdge

createEdge(params: IEdge): Promise<OntologyEdge>
Parameters
- params: IEdge
Returns Promise<OntologyEdge>
Inherited from OntologyModel.createEdge
- Defined in src/models/model.ontology.ts:55

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from OntologyModel.delete
- Defined in src/models/model.ts:239

deleteBranch

deleteBranch(): Promise<void>
Returns Promise<void>
Inherited from OntologyModel.deleteBranch
- Defined in src/models/model.ontology.ts:166

deleteEdge

deleteEdge(params: IEdge): Promise<void>
Parameters
- params: IEdge
Returns Promise<void>
Inherited from OntologyModel.deleteEdge
- Defined in src/models/model.ontology.ts:113

deleteEdges

deleteEdges(): Promise<void>
Returns Promise<void>
Inherited from OntologyModel.deleteEdges
- Defined in src/models/model.ontology.ts:106

deleteModelFromEdge

deleteModelFromEdge(params: IEdge): Promise<void>
Parameters
- params: IEdge
Returns Promise<void>
Inherited from OntologyModel.deleteModelFromEdge
- Defined in src/models/model.ontology.ts:122

findEdge

findEdge(params: IEdge): Promise<undefined | OntologyEdge>
Parameters
- params: IEdge
Returns Promise<undefined | OntologyEdge>
Inherited from OntologyModel.findEdge
- Defined in src/models/model.ontology.ts:152

findEdges

findEdges(relationship: string): Promise<OntologyEdge[]>
Parameters
- relationship: string
Returns Promise<OntologyEdge[]>
Inherited from OntologyModel.findEdges
- Defined in src/models/model.ontology.ts:147

getAllEdges

getAllEdges(_force?: boolean): Promise<IOntologyEdge[]>
Parameters
- Optional_force: boolean
Returns Promise<IOntologyEdge[]>
Inherited from OntologyModel.getAllEdges
- Defined in src/models/model.ontology.ts:192

getAttributes

getAttributes(): string[]
Returns string[]
Overrides OntologyModel.getAttributes
- Defined in src/models/subuser.ts:58

getClass

getClass(): string
Returns string
Inherited from OntologyModel.getClass
- Defined in src/models/model.ts:57

getParent

getParent(): undefined | IModel
Returns undefined | IModel
Inherited from OntologyModel.getParent
- Defined in src/models/model.ts:82

getParentEdges

getParentEdges(): IOntologyEdge[]
Returns IOntologyEdge[]
Inherited from OntologyModel.getParentEdges
- Defined in src/models/model.ontology.ts:46

getType

getType(): string
Returns string
Inherited from OntologyModel.getType
- Defined in src/models/model.ts:41

getUrl

getUrl(): string
Returns string
Inherited from OntologyModel.getUrl
- Defined in src/models/model.ts:101

getVersion

getVersion(): string
Returns string
Inherited from OntologyModel.getVersion
- Defined in src/models/model.ts:45

id

id(): string
Returns string
Inherited from OntologyModel.id
- Defined in src/models/model.ts:37

loadAllChildren

loadAllChildren(json: null | JSONObject, reloadAll?: boolean): Promise<void>
Parameters
- json: null | JSONObject
- reloadAll: boolean = false
Returns Promise<void>
Inherited from OntologyModel.loadAllChildren
- Defined in src/models/model.ts:198

makeIndependent

makeIndependent(newUsername: string): Promise<boolean>
Parameters
- newUsername: string
Returns Promise<boolean>
- Defined in src/models/subuser.ts:95

parse

parse(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Inherited from OntologyModel.parse
- Defined in src/models/model.ts:252

parseChild

parseChild(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Inherited from OntologyModel.parseChild
- Defined in src/models/model.ts:267

path

path(): string
Returns string
Inherited from OntologyModel.path
- Defined in src/models/model.ts:53

preserve

preserve(): void
Returns void
Inherited from OntologyModel.preserve
- Defined in src/models/model.ts:87

reload

reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Inherited from OntologyModel.reload
- Defined in src/models/model.ts:226

reloadAndParse

reloadAndParse(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Inherited from OntologyModel.reloadAndParse
- Defined in src/models/model.ts:205

removeChild

removeChild(_: IModel): void
Parameters
- _: IModel
Returns void
Inherited from OntologyModel.removeChild
- Defined in src/models/model.ts:66

removeEdge

removeEdge(edge: IModel): void
Parameters
- edge: IModel
Returns void
Inherited from OntologyModel.removeEdge
- Defined in src/models/model.ontology.ts:136

removeParentEdge

removeParentEdge(edge: IOntologyEdge): void
Parameters
- edge: IOntologyEdge
Returns void
Inherited from OntologyModel.removeParentEdge
- Defined in src/models/model.ontology.ts:100

restore

restore(): void
Returns void
Inherited from OntologyModel.restore
- Defined in src/models/model.ts:90

setParent

setParent(parent?: IModel): void
Parameters
- Optionalparent: IModel
Returns void
Inherited from OntologyModel.setParent
- Defined in src/models/model.ts:77

toJSON

toJSON(customKeys?: string[]): JSONObject
Parameters
- OptionalcustomKeys: string[]
Returns JSONObject
Inherited from OntologyModel.toJSON
- Defined in src/models/model.ts:271

transverse

transverse(path: string, getAll?: boolean): Promise<IOntologyModel[]>
Parameters
- path: string
- OptionalgetAll: boolean
Returns Promise<IOntologyModel[]>
Inherited from OntologyModel.transverse
- Defined in src/models/model.ontology.ts:207

update

update(customKeys?: string[]): Promise<boolean>
Parameters
- OptionalcustomKeys: string[]
Returns Promise<boolean>
Inherited from OntologyModel.update
- Defined in src/models/model.ts:179

url

url(): string
Returns string
Inherited from OntologyModel.url
- Defined in src/models/model.ts:49

`Protected`usePutForUpdate

usePutForUpdate(): boolean
Returns boolean
Overrides OntologyModel.usePutForUpdate
- Defined in src/models/subuser.ts:62

`Protected`validate

validate(name: string, params: any): void
Parameters
- name: string
- params: any
Returns void
Inherited from OntologyModel.validate
- Defined in src/models/model.ts:97

`Static`fetch

fetch(): Promise<SubUser[]>
Returns Promise<SubUser[]>
Overrides OntologyModel.fetch
- Defined in src/models/subuser.ts:70

`Static`fetchById

fetchById(id: string): Promise<undefined | SubUser>
Parameters
- id: string
Returns Promise<undefined | SubUser>
- Defined in src/models/subuser.ts:78

`Static`fromArray

fromArray<T>(
    this: new () => T,
    json: JSONObject[],
    parent?: IModel,
): (string | T)[]
Type Parameters
- T
Parameters
- this: new () => T
- json: JSONObject[]
- Optionalparent: IModel
Returns (string | T)[]
Inherited from OntologyModel.fromArray
- Defined in src/models/model.ts:336

`Protected` `Static`generateOptions

generateOptions(params?: JSONObject): JSONObject
Parameters
- Optionalparams: JSONObject
Returns JSONObject
Inherited from OntologyModel.generateOptions
- Defined in src/models/model.ts:384

`Static`getMetaFilterResult

getMetaFilterResult(_filter?: Filter): string
Parameters
- Optional_filter: Filter
Returns string
Inherited from OntologyModel.getMetaFilterResult
- Defined in src/models/model.ts:93

`Static`validateMethod

validateMethod(
    type: undefined | string,
    name: string,
    params: any,
    isStatic?: boolean,
): void
Parameters
- type: undefined | string
- name: string
- params: any
- isStatic: boolean = false
Returns void
Inherited from OntologyModel.validateMethod
- Defined in src/models/model.ts:352