Class: Recurly::Requests::DunningCampaignUpdate

Inherits:
Recurly::Request show all
Defined in:
lib/recurly/requests/dunning_campaign_update.rb

Instance Attribute Summary collapse

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

#code ⇒ String

Returns Campaign code.

Returns:

  • (String) —

    Campaign code.



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

define_attribute :code, String

#default_campaign ⇒ Boolean

Returns Set to true to make this the default campaign for accounts or plans without an assigned dunning campaign. Cannot be set on an inactive campaign, and cannot be unset directly—assign a different campaign as the default instead.

Returns:

  • (Boolean) —

    Set to true to make this the default campaign for accounts or plans without an assigned dunning campaign. Cannot be set on an inactive campaign, and cannot be unset directly—assign a different campaign as the default instead.



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

define_attribute :default_campaign, :Boolean

#description ⇒ String

Returns Campaign description.

Returns:

  • (String) —

    Campaign description.



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

define_attribute :description, String

#dunning_cycles ⇒ Array[DunningCycleCreate]

Returns Dunning Cycle settings. One entry per collection method (automatic, manual, trial); each type may appear at most once. Each cycle write fully replaces that cycle's current settings version.

Returns:

  • (Array[DunningCycleCreate]) —

    Dunning Cycle settings. One entry per collection method (automatic, manual, trial); each type may appear at most once. Each cycle write fully replaces that cycle's current settings version.



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

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

#name ⇒ String

Returns Campaign name.

Returns:

  • (String) —

    Campaign name.



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

define_attribute :name, String