Class: Recurly::Requests::GiftCardDeliveryCreate

Inherits:

Recurly::Request

• Object
• Recurly::Request
• Recurly::Requests::GiftCardDeliveryCreate

Defined in:

lib/recurly/requests/gift_card_delivery_create.rb

Instance Attribute Summary

• #deliver_at ⇒ DateTime

  When the gift card should be delivered to the recipient.

• #email_address ⇒ String

  The email address of the recipient.

• #first_name ⇒ String

  The first name of the recipient.

• #gifter_name ⇒ String

  The name of the gifter for the purpose of a message displayed to the recipient.

• #last_name ⇒ String

  The last name of the recipient.

• #method ⇒ String

  Whether the delivery method is email or postal service.

• #personal_message ⇒ String

  The personal message from the gifter to the recipient.

• #recipient_address ⇒ Address

  Address information for the recipient.

Attributes inherited from Recurly::Request

#attributes

Method Summary

Methods inherited from Recurly::Request

#==, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::RequestCaster

#cast_request

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#deliver_at ⇒ DateTime

Returns When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.

Returns:

• (DateTime) —

  When the gift card should be delivered to the recipient. If null, the gift card will be delivered immediately. If a datetime is provided, the delivery will be in an hourly window, rounding down. For example, 6:23 pm will be in the 6:00 pm hourly batch.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 11

define_attribute :deliver_at, DateTime

#email_address ⇒ String

Returns The email address of the recipient. Required if `method` is `email`.

Returns:

• (String) —

  The email address of the recipient. Required if `method` is `email`.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 15

define_attribute :email_address, String

#first_name ⇒ String

Returns The first name of the recipient.

Returns:

• (String) —

  The first name of the recipient.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 19

define_attribute :first_name, String

#gifter_name ⇒ String

Returns The name of the gifter for the purpose of a message displayed to the recipient.

Returns:

• (String) —

  The name of the gifter for the purpose of a message displayed to the recipient.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 23

define_attribute :gifter_name, String

#last_name ⇒ String

Returns The last name of the recipient.

Returns:

• (String) —

  The last name of the recipient.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 27

define_attribute :last_name, String

#method ⇒ String

Returns Whether the delivery method is email or postal service.

Returns:

• (String) —

  Whether the delivery method is email or postal service.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 31

define_attribute :method, String

#personal_message ⇒ String

Returns The personal message from the gifter to the recipient.

Returns:

• (String) —

  The personal message from the gifter to the recipient.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 35

define_attribute :personal_message, String

#recipient_address ⇒ Address

Returns Address information for the recipient. Required if `method` is `post`.

Returns:

• (Address) —

  Address information for the recipient. Required if `method` is `post`.

# File 'lib/recurly/requests/gift_card_delivery_create.rb', line 39

define_attribute :recipient_address, :Address