recurly 3.0.0.beta.2 → 3.0.0.beta.3

data/lib/recurly/errors.rb

@@ -18,7 +18,7 @@ module Recurly
       end
 
       def initialize(response, error)
-        super("#{self.class.name}: #{error.message}")
+        super(error.message)
         @response = response
         @recurly_error = error
       end

data/lib/recurly/requests/{create_account.rb → account_create.rb}

@@ -1,6 +1,6 @@
 module Recurly
   module Requests
-    class CreateAccount < Request
+    class AccountCreate < Request
 
       # @!attribute acquisition
       #   @return [AccountAcquisitionUpdatable]
@@ -26,6 +26,10 @@ module Recurly
       #   @return [String]
       define_attribute :company, String
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/{account_updatable.rb → account_update.rb}

@@ -1,6 +1,6 @@
 module Recurly
   module Requests
-    class AccountUpdatable < Request
+    class AccountUpdate < Request
 
       # @!attribute address
       #   @return [Address]
@@ -18,6 +18,10 @@ module Recurly
       #   @return [String]
       define_attribute :company, String
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/add_on_create.rb

@@ -11,8 +11,8 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[String]] Add-on pricing
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Add-on pricing
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute default_quantity
       #   @return [Integer] Default quantity for the hosted pages.

data/lib/recurly/requests/add_on_update.rb

@@ -11,8 +11,8 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[String]] Add-on pricing
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Add-on pricing
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute default_quantity
       #   @return [Integer] Default quantity for the hosted pages.

data/lib/recurly/requests/coupon_bulk_create.rb

@@ -0,0 +1,10 @@
+module Recurly
+  module Requests
+    class CouponBulkCreate < Request
+
+      # @!attribute number_of_unique_codes
+      #   @return [Integer] The quantity of unique coupon codes to generate
+      define_attribute :number_of_unique_codes, Integer
+    end
+  end
+end

data/lib/recurly/requests/{create_coupon.rb → coupon_create.rb}

@@ -1,6 +1,6 @@
 module Recurly
   module Requests
-    class CreateCoupon < Request
+    class CouponCreate < Request
 
       # @!attribute applies_to_all_plans
       #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
@@ -19,8 +19,8 @@ module Recurly
       define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
 
       # @!attribute currencies
-      #   @return [Array[String]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute discount_percent
       #   @return [Integer] The percent of the price discounted by the coupon.  Required if `discount_type` is `percent`.

data/lib/recurly/requests/coupon_redemption_create.rb

@@ -0,0 +1,14 @@
+module Recurly
+  module Requests
+    class CouponRedemptionCreate < Request
+
+      # @!attribute coupon_id
+      #   @return [String] Coupon ID
+      define_attribute :coupon_id, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+    end
+  end
+end

data/lib/recurly/requests/{update_coupon.rb → coupon_update.rb}

@@ -1,6 +1,6 @@
 module Recurly
   module Requests
-    class UpdateCoupon < Request
+    class CouponUpdate < Request
 
       # @!attribute hosted_description
       #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.

data/lib/recurly/requests/invoice_refund.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :external_refund, Hash
 
       # @!attribute line_items
-      #   @return [Array[String]] The line items to be refunded. This is required when `type=line_items`.
-      define_attribute :line_items, Array, {:item_type => String}
+      #   @return [Array[LineItemRefund]] The line items to be refunded. This is required when `type=line_items`.
+      define_attribute :line_items, Array, {:item_type => :LineItemRefund}
 
       # @!attribute refund_method
       #   @return [String] Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled. - `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled. - `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled. - `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.

data/lib/recurly/requests/line_item_refund.rb

@@ -0,0 +1,18 @@
+module Recurly
+  module Requests
+    class LineItemRefund < Request
+
+      # @!attribute id
+      #   @return [String] Line item ID
+      define_attribute :id, String
+
+      # @!attribute prorate
+      #   @return [Boolean] Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.
+      define_attribute :prorate, :Boolean
+
+      # @!attribute quantity
+      #   @return [Integer] Line item quantity to be refunded.
+      define_attribute :quantity, Integer
+    end
+  end
+end

data/lib/recurly/requests/plan_create.rb

@@ -7,16 +7,20 @@ module Recurly
       define_attribute :accounting_code, String
 
       # @!attribute add_ons
-      #   @return [Array[String]] Add Ons
-      define_attribute :add_ons, Array, {:item_type => String}
+      #   @return [Array[AddOnCreate]] Add Ons
+      define_attribute :add_ons, Array, {:item_type => :AddOnCreate}
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+      define_attribute :auto_renew, :Boolean
 
       # @!attribute code
       #   @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[String]] Pricing
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Pricing
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute description
       #   @return [String] Optional description, not displayed.

data/lib/recurly/requests/plan_update.rb

@@ -7,16 +7,20 @@ module Recurly
       define_attribute :accounting_code, String
 
       # @!attribute add_ons
-      #   @return [Array[String]] Add Ons
-      define_attribute :add_ons, Array, {:item_type => String}
+      #   @return [Array[AddOnCreate]] Add Ons
+      define_attribute :add_ons, Array, {:item_type => :AddOnCreate}
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+      define_attribute :auto_renew, :Boolean
 
       # @!attribute code
       #   @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[String]] Pricing
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Pricing
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute description
       #   @return [String] Optional description, not displayed.
@@ -30,14 +34,6 @@ module Recurly
       #   @return [String] Plan ID
       define_attribute :id, String, {:read_only => true}
 
-      # @!attribute interval_length
-      #   @return [Integer] Length of the plan's billing interval in `interval_unit`.
-      define_attribute :interval_length, Integer
-
-      # @!attribute interval_unit
-      #   @return [String] Unit for the plan's billing interval.
-      define_attribute :interval_unit, String, {:enum => ["days", "months"]}
-
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -6,10 +6,6 @@ module Recurly
       #   @return [String] Add-on code
       define_attribute :code, String
 
-      # @!attribute id
-      #   @return [String] Id of an existing subscription add on.
-      define_attribute :id, String
-
       # @!attribute quantity
       #   @return [Integer] Optionally override the default quantity.
       define_attribute :quantity, Integer

data/lib/recurly/requests/subscription_create.rb

@@ -3,12 +3,16 @@ module Recurly
     class SubscriptionCreate < Request
 
       # @!attribute account
-      #   @return [Hash] Account
-      define_attribute :account, Hash
+      #   @return [AccountCreate]
+      define_attribute :account, :AccountCreate
 
       # @!attribute add_ons
-      #   @return [Array[String]] Add-ons
-      define_attribute :add_ons, Array, {:item_type => String}
+      #   @return [Array[SubscriptionAddOnCreate]] Add-ons
+      define_attribute :add_ons, Array, {:item_type => :SubscriptionAddOnCreate}
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
 
       # @!attribute collection_method
       #   @return [String] Collection method
@@ -26,18 +30,22 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute customer_notes
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
       define_attribute :customer_notes, String
 
-      # @!attribute first_renewal_date
-      #   @return [DateTime] If set,indicates when the first renewal should occur. Subsequent renewals will be offset from this date. The first invoice will be prorated appropriately so that the customer only pays for the portion of the first billing period for which the subscription applies. Useful for forcing a subscription to renew on the first of the month.
-      define_attribute :first_renewal_date, DateTime
-
       # @!attribute net_terms
       #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
       define_attribute :net_terms, Integer
 
+      # @!attribute next_bill_date
+      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+      define_attribute :next_bill_date, DateTime
+
       # @!attribute plan_code
       #   @return [String] Plan code
       define_attribute :plan_code, String
@@ -54,6 +62,10 @@ module Recurly
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer
 
+      # @!attribute renewal_billing_cycles
+      #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+      define_attribute :renewal_billing_cycles, Integer
+
       # @!attribute shipping_address
       #   @return [Hash] Create a shipping address on the account and assign it to the subscription.
       define_attribute :shipping_address, Hash
@@ -71,7 +83,7 @@ module Recurly
       define_attribute :terms_and_conditions, String
 
       # @!attribute total_billing_cycles
-      #   @return [Integer] Renews the subscription for a specified number of total cycles, then automatically cancels. Defaults to the subscription renewing indefinitely.
+      #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_ends_at

data/lib/recurly/requests/subscription_pause.rb

@@ -0,0 +1,10 @@
+module Recurly
+  module Requests
+    class SubscriptionPause < Request
+
+      # @!attribute remaining_pause_cycles
+      #   @return [Integer] Number of billing cycles to pause the subscriptions.
+      define_attribute :remaining_pause_cycles, Integer
+    end
+  end
+end

data/lib/recurly/requests/subscription_update.rb

@@ -2,10 +2,18 @@ module Recurly
   module Requests
     class SubscriptionUpdate < Request
 
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
       # @!attribute collection_method
       #   @return [String] Change collection method
       define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute customer_notes
       #   @return [String] Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
       define_attribute :customer_notes, String
@@ -14,18 +22,22 @@ module Recurly
       #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
       define_attribute :net_terms, Integer
 
-      # @!attribute next_renewal_at
-      #   @return [DateTime] For an active subscription, this will change the next renewal date. For a subscription in a trial period, modifying the renewal date will change when the trial expires.
-      define_attribute :next_renewal_at, DateTime
+      # @!attribute next_bill_date
+      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires.
+      define_attribute :next_bill_date, DateTime
 
       # @!attribute po_number
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
       # @!attribute remaining_billing_cycles
-      #   @return [Integer] Renews the subscription for a specified number of cycles, then automatically cancels.
+      #   @return [Integer] The remaining billing cycles in the current term.
       define_attribute :remaining_billing_cycles, Integer
 
+      # @!attribute renewal_billing_cycles
+      #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+      define_attribute :renewal_billing_cycles, Integer
+
       # @!attribute shipping_address
       #   @return [Hash] Create a shipping address on the account and assign it to the subscription. If this and `shipping_address_id` are both present, `shipping_address_id` will take precedence."
       define_attribute :shipping_address, Hash

data/lib/recurly/resources/account.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [DateTime] When the account was created.
       define_attribute :created_at, DateTime, {:read_only => true}
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute [r] deleted_at
       #   @return [DateTime] If present, when the account was last marked inactive.
       define_attribute :deleted_at, DateTime, {:read_only => true}

data/lib/recurly/resources/account_acquisition.rb

@@ -3,8 +3,8 @@ module Recurly
     class AccountAcquisition < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute campaign
       #   @return [String] An arbitrary identifier for the marketing campaign that led to the acquisition of this account.

data/lib/recurly/resources/account_balance.rb

@@ -3,8 +3,8 @@ module Recurly
     class AccountBalance < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute balances
       #   @return [Hash] Account balance

data/lib/recurly/resources/add_on.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :created_at, DateTime, {:read_only => true}
 
       # @!attribute currencies
-      #   @return [Array[String]] Add-on pricing
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Add-on pricing
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute default_quantity
       #   @return [Integer] Default quantity for the hosted pages.

data/lib/recurly/resources/coupon.rb

@@ -71,8 +71,8 @@ module Recurly
       define_attribute :object, String, {:read_only => true}
 
       # @!attribute plans
-      #   @return [Array[String]] Plans
-      define_attribute :plans, Array, {:item_type => String}
+      #   @return [Array[PlanMini]] Plans
+      define_attribute :plans, Array, {:item_type => :PlanMini}
 
       # @!attribute plans_names
       #   @return [Array[String]] TODO

data/lib/recurly/resources/coupon_discount.rb

@@ -3,8 +3,8 @@ module Recurly
     class CouponDiscount < Resource
 
       # @!attribute currencies
-      #   @return [Array[String]] This is only present when `type=fixed`.
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] This is only present when `type=fixed`.
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute percent
       #   @return [Integer] This is only present when `type=percent`.

data/lib/recurly/resources/coupon_redemption_mini.rb

@@ -3,8 +3,8 @@ module Recurly
     class CouponRedemptionMini < Resource
 
       # @!attribute coupon
-      #   @return [Coupon]
-      define_attribute :coupon, :Coupon
+      #   @return [CouponMini]
+      define_attribute :coupon, :CouponMini
 
       # @!attribute [r] created_at
       #   @return [DateTime] Created at

data/lib/recurly/resources/credit_payment.rb

@@ -3,8 +3,8 @@ module Recurly
     class CreditPayment < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute action
       #   @return [String] The action for which the credit was created.
@@ -15,8 +15,8 @@ module Recurly
       define_attribute :amount, Float
 
       # @!attribute applied_to_invoice
-      #   @return [Invoice]
-      define_attribute :applied_to_invoice, :Invoice
+      #   @return [InvoiceMini]
+      define_attribute :applied_to_invoice, :InvoiceMini
 
       # @!attribute [r] created_at
       #   @return [DateTime] Created at
@@ -39,8 +39,8 @@ module Recurly
       define_attribute :original_credit_payment_id, String
 
       # @!attribute original_invoice
-      #   @return [Invoice]
-      define_attribute :original_invoice, :Invoice
+      #   @return [InvoiceMini]
+      define_attribute :original_invoice, :InvoiceMini
 
       # @!attribute refund_transaction
       #   @return [Transaction]