Search
Preparing search index...
The search index is not available
merchisdk
Options
All
Public
Public/Protected
All
Inherited
Menu
merchisdk
entities/email_address
EmailAddress
Class EmailAddress
Hierarchy
Entity
EmailAddress
Index
Constructors
constructor
Properties
archived
back
Objects
companies
create
email
Address
id
is
Dirty
key
merchi
properties
Map
users
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
Email
Address
(
merchi
?:
Merchi
)
:
EmailAddress
Parameters
Optional
merchi:
Merchi
Returns
EmailAddress
Properties
Optional
archived
archived
:
null
|
Date
Readonly
back
Objects
back
Objects
:
Set
<
Entity
>
= ...
Optional
companies
companies
:
Company
[]
create
create
:
(
options
?:
CreateOptions
)
=>
Promise
<
EmailAddress
>
= ...
Type declaration
(
options
?:
CreateOptions
)
:
Promise
<
EmailAddress
>
Parameters
Optional
options:
CreateOptions
Returns
Promise
<
EmailAddress
>
Optional
email
Address
email
Address
:
string
Optional
id
id
:
number
is
Dirty
is
Dirty
:
boolean
= false
key
key
:
string
= ...
merchi
merchi
:
Merchi
properties
Map
properties
Map
:
Map
<
string
,
PropertyInfo
>
Optional
users
users
:
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/email_
address
Email
Address
constructor
archived
back
Objects
companies
create
email
Address
id
is
Dirty
key
merchi
properties
Map
users
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