Class: module:models/GiftCertificateItem

module:models/GiftCertificateItem(amount, recipientEmail)

new module:models/GiftCertificateItem(amount, recipientEmail)

Constructs a new GiftCertificateItem. A gift certificate item.

Parameters:
Name Type Description
amount Number

The certificate item amount.

recipientEmail String

The recipient's email.

Source:

Members

(inner) amount :Number

The certificate item amount.

Type:
  • Number
Source:

(inner) gift_certificate_item_id :String

Id used to identify this item

Type:
  • String
Source:

(inner) message :String

The certificate's message.

Type:
  • String
Source:

(inner) recipient_email :String

The recipient's email.

Type:
  • String
Source:

(inner) recipient_name :String

The recipient's name.

Type:
  • String
Source:

(inner) sender_name :String

The sender's name.

Type:
  • String
Source:

(inner) shipment_id :String

The shipment id.

Type:
  • String
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/GiftCertificateItem}

Constructs a GiftCertificateItem 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/GiftCertificateItem

Optional instance to populate.

Source:
Returns:

The populated GiftCertificateItem instance.

Type
module:models/GiftCertificateItem