Class: Recurly::Resources::DunningCampaign

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::DunningCampaign

Defined in:

lib/recurly/resources/dunning_campaign.rb

Instance Attribute Summary

• #code ⇒ String

  Campaign code.

• #created_at ⇒ DateTime

  When the current campaign was created in Recurly.

• #default_campaign ⇒ Boolean

  Whether or not this is the default campaign for accounts or plans without an assigned dunning campaign.

• #deleted_at ⇒ DateTime

  When the current campaign was deleted in Recurly.

• #description ⇒ String

  Campaign description.

• #dunning_cycles ⇒ Array[DunningCycle]

  Dunning Cycle settings.

• #id ⇒ String
• #name ⇒ String

  Campaign name.

• #object ⇒ String

  Object type.

• #updated_at ⇒ DateTime

  When the current campaign was updated in Recurly.

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

#code ⇒ String

Returns Campaign code.

Returns:

• (String) —

  Campaign code.

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

define_attribute :code, String

#created_at ⇒ DateTime

Returns When the current campaign was created in Recurly.

Returns:

• (DateTime) —

  When the current campaign was created in Recurly.

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

define_attribute :created_at, DateTime

#default_campaign ⇒ Boolean

Returns Whether or not this is the default campaign for accounts or plans without an assigned dunning campaign.

Returns:

• (Boolean) —

  Whether or not this is the default campaign for accounts or plans without an assigned dunning campaign.

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

define_attribute :default_campaign, :Boolean

#deleted_at ⇒ DateTime

Returns When the current campaign was deleted in Recurly.

Returns:

• (DateTime) —

  When the current campaign was deleted in Recurly.

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

define_attribute :deleted_at, DateTime

#description ⇒ String

Returns Campaign description.

Returns:

• (String) —

  Campaign description.

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

define_attribute :description, String

#dunning_cycles ⇒ Array[DunningCycle]

Returns Dunning Cycle settings.

Returns:

• (Array[DunningCycle]) —

  Dunning Cycle settings.

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

define_attribute :dunning_cycles, Array, { :item_type => :DunningCycle }

#id ⇒ String

Returns:

• (String)

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

define_attribute :id, String

#name ⇒ String

Returns Campaign name.

Returns:

• (String) —

  Campaign name.

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

define_attribute :name, String

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

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

define_attribute :object, String

#updated_at ⇒ DateTime

Returns When the current campaign was updated in Recurly.

Returns:

• (DateTime) —

  When the current campaign was updated in Recurly.

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

define_attribute :updated_at, DateTime