new module:models/GiftCertificate()
Constructs a new GiftCertificate
.
Document representing a gift certificate.
- Source:
Members
(readonly) StatusEnum :String
Allowed values for the status
property.
Type:
- String
- Source:
(inner) amount :Number
The gift certificate original amount.
Type:
- Number
- Source:
(inner) balance :Number
The gift certificate balance.
Type:
- Number
- Source:
(inner) description :String
The gift certificate description.
Type:
- String
- Source:
(inner) enabled :Boolean
Is the gift certificate is enabled?
Type:
- Boolean
- Source:
(inner, constant) issued
value: "issued"
- Source:
(inner) masked_gift_certificate_code :String
The masked gift certificate code.
Type:
- String
- Source:
(inner) merchant_id :String
The merchant ID.
Type:
- String
- Source:
(inner) message :String
The message.
Type:
- String
- Source:
(inner, constant) partially_redeemed
value: "partially_redeemed"
- Source:
(inner, constant) pending
value: "pending"
- Source:
(inner) recipient_email :String
The recipient email.
Type:
- String
- Source:
(inner) recipient_name :String
The recipient name.
Type:
- String
- Source:
(inner, constant) redeemed
value: "redeemed"
- Source:
(inner) sender_name :String
The sender name.
Type:
- String
- Source:
(inner) status :module:models/GiftCertificate.StatusEnum
The gift certificate status.
Type:
- module:models/GiftCertificate.StatusEnum
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/GiftCertificate}
Constructs a GiftCertificate
from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data
to obj
if supplied or a new instance if not.
Parameters:
Name | Type | Description |
---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/GiftCertificate | Optional instance to populate. |
- Source:
Returns:
The populated GiftCertificate
instance.