Search
Preparing search index...
The search index is not available
merchisdk
Options
All
Public
Public/Protected
All
Inherited
Menu
merchisdk
entities/user_company
UserCompany
Class UserCompany
Hierarchy
Entity
UserCompany
Index
Constructors
constructor
Properties
archived
back
Objects
company
create
id
is
Admin
is
Dirty
key
main
merchi
properties
Map
user
merchi
Methods
clean
Dirty
create
Factory
delete
from
Json
get
Primary
Key
Value
recover
save
to
Form
Data
to
Json
update
Order
get
list
Constructors
constructor
new
User
Company
(
merchi
?:
Merchi
)
:
UserCompany
Parameters
Optional
merchi:
Merchi
Returns
UserCompany
Properties
Optional
archived
archived
:
null
|
Date
Readonly
back
Objects
back
Objects
:
Set
<
Entity
>
= ...
Optional
company
company
:
null
|
Company
create
create
:
(
options
?:
CreateOptions
)
=>
Promise
<
UserCompany
>
= ...
Type declaration
(
options
?:
CreateOptions
)
:
Promise
<
UserCompany
>
Parameters
Optional
options:
CreateOptions
Returns
Promise
<
UserCompany
>
Optional
id
id
:
number
Optional
is
Admin
is
Admin
:
boolean
is
Dirty
is
Dirty
:
boolean
= false
key
key
:
string
= ...
Optional
main
main
:
null
|
boolean
merchi
merchi
:
Merchi
properties
Map
properties
Map
:
Map
<
string
,
PropertyInfo
>
Optional
user
user
:
null
|
User
Static
merchi
merchi
:
Merchi
Methods
clean
Dirty
clean
Dirty
(
)
:
void
Returns
void
create
Factory
create
Factory
(
__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
>
Parameters
Optional
options:
DeleteOptions
Returns
Promise
<
this
>
from
Json
from
Json
(
json
:
any
, options
?:
FromJsonOptions
)
:
this
Parameters
json:
any
Optional
options:
FromJsonOptions
Returns
this
get
Primary
Key
Value
get
Primary
Key
Value
(
)
:
any
Returns
any
recover
recover
(
options
?:
SaveOptions
)
:
Promise
<
this
>
Parameters
Optional
options:
SaveOptions
Returns
Promise
<
this
>
save
save
(
options
?:
SaveOptions
)
:
Promise
<
this
>
Parameters
Optional
options:
SaveOptions
Returns
Promise
<
this
>
to
Form
Data
to
Form
Data
(
options
?:
SerialiseOptions
, fileIndex
?:
Counter
)
:
FormData
Parameters
Optional
options:
SerialiseOptions
Optional
fileIndex:
Counter
Returns
FormData
to
Json
to
Json
(
)
:
any
Returns
any
update
Order
update
Order
(
property
:
string
)
:
void
Parameters
property:
string
Returns
void
Static
get
get<T>
(
key
:
string
|
number
, options
?:
GetOptions
)
:
Promise
<
InstanceType
<
T
>
>
Type parameters
T
:
typeof
Entity
Parameters
key:
string
|
number
Optional
options:
GetOptions
Returns
Promise
<
InstanceType
<
T
>
>
Static
list
list<T>
(
options
?:
ListOptions
)
:
Promise
<
ListResponse
<
InstanceType
<
T
>
>
>
Type parameters
T
:
typeof
Entity
Parameters
Optional
options:
ListOptions
Returns
Promise
<
ListResponse
<
InstanceType
<
T
>
>
>
Modules
entities/user_
company
User
Company
constructor
archived
back
Objects
company
create
id
is
Admin
is
Dirty
key
main
merchi
properties
Map
user
merchi
clean
Dirty
create
Factory
delete
from
Json
get
Primary
Key
Value
recover
save
to
Form
Data
to
Json
update
Order
get
list
Generated using
TypeDoc