Class: Recurly::Resources::GiftCard

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::GiftCard

Defined in:

lib/recurly/resources/gift_card.rb

Instance Attribute Summary

• #balance ⇒ Float

  The remaining credit on the recipient account associated with this gift card.

• #canceled_at ⇒ DateTime

  When the gift card was canceled.

• #created_at ⇒ DateTime

  Created at.

• #currency ⇒ String

  3-letter ISO 4217 currency code.

• #delivered_at ⇒ DateTime

  When the gift card was sent to the recipient by Recurly via email, if method was email and the “Gift Card Delivery” email template was enabled.

• #delivery ⇒ GiftCardDelivery

  The delivery details for the gift card.

• #gifter_account_id ⇒ String

  The ID of the account that purchased the gift card.

• #id ⇒ String

  Gift card ID.

• #object ⇒ String

  Object type.

• #product_code ⇒ String

  The product code or SKU of the gift card product.

• #purchase_invoice_id ⇒ String

  The ID of the invoice for the gift card purchase made by the gifter.

• #recipient_account_id ⇒ String

  The ID of the account that redeemed the gift card redemption code.

• #redeemed_at ⇒ DateTime

  When the gift card was redeemed by the recipient.

• #redemption_code ⇒ String

  The unique redemption code for the gift card, generated by Recurly.

• #redemption_invoice_id ⇒ String

  The ID of the invoice for the gift card redemption made by the recipient.

• #unit_amount ⇒ Float

  The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.

• #updated_at ⇒ DateTime

  Last updated at.

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#balance ⇒ Float

Returns The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.

Returns:

• (Float) —

  The remaining credit on the recipient account associated with this gift card. Only has a value once the gift card has been redeemed. Can be used to create gift card balance displays for your customers.

# File 'lib/recurly/resources/gift_card.rb', line 11

define_attribute :balance, Float

#canceled_at ⇒ DateTime

Returns When the gift card was canceled.

Returns:

• (DateTime) —

  When the gift card was canceled.

# File 'lib/recurly/resources/gift_card.rb', line 15

define_attribute :canceled_at, DateTime

#created_at ⇒ DateTime

Returns Created at.

Returns:

• (DateTime) —

  Created at

# File 'lib/recurly/resources/gift_card.rb', line 19

define_attribute :created_at, DateTime

#currency ⇒ String

Returns 3-letter ISO 4217 currency code.

Returns:

• (String) —

  3-letter ISO 4217 currency code.

# File 'lib/recurly/resources/gift_card.rb', line 23

define_attribute :currency, String

#delivered_at ⇒ DateTime

Returns When the gift card was sent to the recipient by Recurly via email, if method was email and the “Gift Card Delivery” email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.

Returns:

• (DateTime) —

  When the gift card was sent to the recipient by Recurly via email, if method was email and the “Gift Card Delivery” email template was enabled. This will be empty for post delivery or email delivery where the email template was disabled.

# File 'lib/recurly/resources/gift_card.rb', line 27

define_attribute :delivered_at, DateTime

#delivery ⇒ GiftCardDelivery

Returns The delivery details for the gift card.

Returns:

• (GiftCardDelivery) —

  The delivery details for the gift card.

# File 'lib/recurly/resources/gift_card.rb', line 31

define_attribute :delivery, :GiftCardDelivery

#gifter_account_id ⇒ String

Returns The ID of the account that purchased the gift card.

Returns:

• (String) —

  The ID of the account that purchased the gift card.

# File 'lib/recurly/resources/gift_card.rb', line 35

define_attribute :gifter_account_id, String

#id ⇒ String

Returns Gift card ID.

Returns:

• (String) —

  Gift card ID

# File 'lib/recurly/resources/gift_card.rb', line 39

define_attribute :id, String

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

# File 'lib/recurly/resources/gift_card.rb', line 43

define_attribute :object, String

#product_code ⇒ String

Returns The product code or SKU of the gift card product.

Returns:

• (String) —

  The product code or SKU of the gift card product.

# File 'lib/recurly/resources/gift_card.rb', line 47

define_attribute :product_code, String

#purchase_invoice_id ⇒ String

Returns The ID of the invoice for the gift card purchase made by the gifter.

Returns:

• (String) —

  The ID of the invoice for the gift card purchase made by the gifter.

# File 'lib/recurly/resources/gift_card.rb', line 51

define_attribute :purchase_invoice_id, String

#recipient_account_id ⇒ String

Returns The ID of the account that redeemed the gift card redemption code. Does not have a value until gift card is redeemed.

Returns:

• (String) —

  The ID of the account that redeemed the gift card redemption code. Does not have a value until gift card is redeemed.

# File 'lib/recurly/resources/gift_card.rb', line 55

define_attribute :recipient_account_id, String

#redeemed_at ⇒ DateTime

Returns When the gift card was redeemed by the recipient.

Returns:

• (DateTime) —

  When the gift card was redeemed by the recipient.

# File 'lib/recurly/resources/gift_card.rb', line 59

define_attribute :redeemed_at, DateTime

#redemption_code ⇒ String

Returns The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.

Returns:

• (String) —

  The unique redemption code for the gift card, generated by Recurly. Will be 16 characters, alphanumeric, displayed uppercase, but accepted in any case at redemption. Used by the recipient account to create a credit in the amount of the `unit_amount` on their account.

# File 'lib/recurly/resources/gift_card.rb', line 63

define_attribute :redemption_code, String

#redemption_invoice_id ⇒ String

Returns The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.

Returns:

• (String) —

  The ID of the invoice for the gift card redemption made by the recipient. Does not have a value until gift card is redeemed.

# File 'lib/recurly/resources/gift_card.rb', line 67

define_attribute :redemption_invoice_id, String

#unit_amount ⇒ Float

Returns The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.

Returns:

• (Float) —

  The amount of the gift card, which is the amount of the charge to the gifter account and the amount of credit that is applied to the recipient account upon successful redemption.

# File 'lib/recurly/resources/gift_card.rb', line 71

define_attribute :unit_amount, Float

#updated_at ⇒ DateTime

Returns Last updated at.

Returns:

• (DateTime) —

  Last updated at

# File 'lib/recurly/resources/gift_card.rb', line 75

define_attribute :updated_at, DateTime