recurly 3.0.0.beta.3 → 3.0.0.beta.4

data/lib/recurly/requests/invoice_create.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class InvoiceCreate < Request
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
-      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
 
       # @!attribute credit_customer_notes
       #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for credit invoices. Specify customer notes to add or override Customer Notes on credit invoices.
@@ -32,7 +36,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Specify a type to limit the type of line items that will be invoiced.
-      define_attribute :type, String, {:enum => ["charge", "credit"]}
+      define_attribute :type, String, { :enum => ["charge", "credit"] }
 
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.

data/lib/recurly/requests/invoice_refund.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class InvoiceRefund < Request
@@ -16,15 +20,15 @@ module Recurly
 
       # @!attribute line_items
       #   @return [Array[LineItemRefund]] The line items to be refunded. This is required when `type=line_items`.
-      define_attribute :line_items, Array, {:item_type => :LineItemRefund}
+      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.
-      define_attribute :refund_method, String, {:enum => ["transaction_first", "credit_first", "all_credit", "all_transaction"]}
+      define_attribute :refund_method, String, { :enum => ["transaction_first", "credit_first", "all_credit", "all_transaction"] }
 
       # @!attribute type
       #   @return [String] The type of refund. Amount and line items cannot both be specified in the request.
-      define_attribute :type, String, {:enum => ["amount", "line_items"]}
+      define_attribute :type, String, { :enum => ["amount", "line_items"] }
     end
   end
 end

data/lib/recurly/requests/invoice_updatable.rb

@@ -0,0 +1,34 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class InvoiceUpdatable < Request
+
+      # @!attribute address
+      #   @return [InvoiceAddress]
+      define_attribute :address, :InvoiceAddress
+
+      # @!attribute customer_notes
+      #   @return [String] Customer notes are an optional note field.
+      define_attribute :customer_notes, String
+
+      # @!attribute net_terms
+      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. Changing Net terms changes due_on, and the invoice could move between past due and pending.
+      define_attribute :net_terms, Integer
+
+      # @!attribute po_number
+      #   @return [String] This identifies the PO number associated with the invoice. Not editable for credit invoices.
+      define_attribute :po_number, String
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Terms and conditions are an optional note field. Not editable for credit invoices.
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute vat_reverse_charge_notes
+      #   @return [String] VAT Reverse Charge Notes are editable only if there was a VAT reverse charge applied to the invoice.
+      define_attribute :vat_reverse_charge_notes, String
+    end
+  end
+end

data/lib/recurly/requests/line_item_create.rb

@@ -1,10 +1,14 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class LineItemCreate < Request
 
       # @!attribute credit_reason_code
       #   @return [String] The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
-      define_attribute :credit_reason_code, String, {:enum => ["general", "service", "promotional"]}
+      define_attribute :credit_reason_code, String, { :enum => ["general", "service", "promotional"] }
 
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -36,7 +40,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Line item type.
-      define_attribute :type, String, {:enum => ["charge", "credit"]}
+      define_attribute :type, String, { :enum => ["charge", "credit"] }
 
       # @!attribute unit_amount
       #   @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`.

data/lib/recurly/requests/line_item_refund.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class LineItemRefund < Request

data/lib/recurly/requests/plan_create.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class PlanCreate < Request
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute add_ons
       #   @return [Array[AddOnCreate]] Add Ons
-      define_attribute :add_ons, Array, {:item_type => :AddOnCreate}
+      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.
@@ -19,16 +23,16 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[Hash]] Pricing
-      define_attribute :currencies, Array, {:item_type => Hash}
+      #   @return [Array[PlanPricing]] Pricing
+      define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
       # @!attribute hosted_pages
-      #   @return [Hash] Hosted pages settings
-      define_attribute :hosted_pages, Hash
+      #   @return [PlanHostedPages] Hosted pages settings
+      define_attribute :hosted_pages, :PlanHostedPages
 
       # @!attribute interval_length
       #   @return [Integer] Length of the plan's billing interval in `interval_unit`.
@@ -36,7 +40,7 @@ module Recurly
 
       # @!attribute interval_unit
       #   @return [String] Unit for the plan's billing interval.
-      define_attribute :interval_unit, String, {:enum => ["days", "months"]}
+      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.
@@ -64,7 +68,7 @@ module Recurly
 
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
-      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+      define_attribute :trial_unit, String, { :enum => ["days", "months"] }
     end
   end
 end

data/lib/recurly/requests/plan_hosted_pages.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class PlanHostedPages < Request
+
+      # @!attribute bypass_confirmation
+      #   @return [Boolean] If `true`, the customer will be sent directly to your `success_url` after a successful signup, bypassing Recurly's hosted confirmation page.
+      define_attribute :bypass_confirmation, :Boolean
+
+      # @!attribute cancel_url
+      #   @return [String] URL to redirect to on canceled signup on the hosted payment pages.
+      define_attribute :cancel_url, String
+
+      # @!attribute display_quantity
+      #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the plan.
+      define_attribute :display_quantity, :Boolean
+
+      # @!attribute success_url
+      #   @return [String] URL to redirect to after signup on the hosted payment pages.
+      define_attribute :success_url, String
+    end
+  end
+end

data/lib/recurly/requests/plan_pricing.rb

@@ -0,0 +1,22 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class PlanPricing < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute setup_fee
+      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      define_attribute :setup_fee, Float
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/plan_update.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class PlanUpdate < Request
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute add_ons
       #   @return [Array[AddOnCreate]] Add Ons
-      define_attribute :add_ons, Array, {:item_type => :AddOnCreate}
+      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.
@@ -19,20 +23,20 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[Hash]] Pricing
-      define_attribute :currencies, Array, {:item_type => Hash}
+      #   @return [Array[PlanPricing]] Pricing
+      define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
       # @!attribute hosted_pages
-      #   @return [Hash] Hosted pages settings
-      define_attribute :hosted_pages, Hash
+      #   @return [PlanHostedPages] Hosted pages settings
+      define_attribute :hosted_pages, :PlanHostedPages
 
       # @!attribute [r] id
       #   @return [String] Plan ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
@@ -60,7 +64,7 @@ module Recurly
 
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
-      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+      define_attribute :trial_unit, String, { :enum => ["days", "months"] }
     end
   end
 end

data/lib/recurly/requests/shipping_address_create.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class ShippingAddressCreate < Request

data/lib/recurly/requests/shipping_address_update.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class ShippingAddressUpdate < Request
@@ -24,7 +28,7 @@ module Recurly
 
       # @!attribute [r] id
       #   @return [String] Shipping Address ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute last_name
       #   @return [String]

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class SubscriptionAddOnCreate < Request
@@ -6,6 +10,10 @@ module Recurly
       #   @return [String] Add-on code
       define_attribute :code, String
 
+      # @!attribute id
+      #   @return [String] Setting this field allows you to reference an existing add-on.
+      define_attribute :id, String
+
       # @!attribute quantity
       #   @return [Integer] Optionally override the default quantity.
       define_attribute :quantity, Integer

data/lib/recurly/requests/subscription_change_create.rb

@@ -1,27 +1,35 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class SubscriptionChangeCreate < Request
 
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOnCreate]] If you set this value you include all the add-ons and their quantities and amounts. The values you include will replace the previous values entirely.
-      define_attribute :add_ons, Array, {:item_type => :SubscriptionAddOnCreate}
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
 
       # @!attribute collection_method
       #   @return [String] Collection method
-      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
 
       # @!attribute coupon_codes
       #   @return [Array[String]] A list of coupon_codes to be redeemed on the subscription during the change. Only allowed if timeframe is now and you change something about the subscription that creates an invoice.
-      define_attribute :coupon_codes, Array, {:item_type => String}
+      define_attribute :coupon_codes, Array, { :item_type => String }
 
       # @!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 plan_code
-      #   @return [String] The plan code.
+      #   @return [String] If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
       define_attribute :plan_code, String
 
+      # @!attribute plan_id
+      #   @return [String] If you want to change to a new plan, you can provide the plan's code or id. If both are provided the `plan_id` will be used.
+      define_attribute :plan_id, String
+
       # @!attribute po_number
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
@@ -32,7 +40,7 @@ module Recurly
 
       # @!attribute timeframe
       #   @return [String] The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now or when the subscription renews. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to "renewal" so the change takes affect at the end of the current billing cycle.
-      define_attribute :timeframe, String, {:enum => ["now", "renewal"]}
+      define_attribute :timeframe, String, { :enum => ["now", "renewal"] }
 
       # @!attribute unit_amount
       #   @return [Float] Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.

data/lib/recurly/requests/subscription_create.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class SubscriptionCreate < Request
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOnCreate]] Add-ons
-      define_attribute :add_ons, Array, {:item_type => :SubscriptionAddOnCreate}
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
 
       # @!attribute auto_renew
       #   @return [Boolean] Whether the subscription renews at the end of its term.
@@ -16,7 +20,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] Collection method
-      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
 
       # @!attribute coupon_code
       #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
@@ -32,7 +36,7 @@ module Recurly
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
-      define_attribute :custom_fields, Array, {:item_type => :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.
@@ -47,11 +51,11 @@ module Recurly
       define_attribute :next_bill_date, DateTime
 
       # @!attribute plan_code
-      #   @return [String] Plan code
+      #   @return [String] You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
       define_attribute :plan_code, String
 
       # @!attribute plan_id
-      #   @return [String] Plan ID
+      #   @return [String] You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
       define_attribute :plan_id, String
 
       # @!attribute po_number
@@ -67,8 +71,8 @@ module Recurly
       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
+      #   @return [ShippingAddressCreate] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping_address, :ShippingAddressCreate
 
       # @!attribute shipping_address_id
       #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `shipping_address` are both present, `shipping_address` will take precedence.

data/lib/recurly/requests/subscription_pause.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class SubscriptionPause < Request

data/lib/recurly/requests/subscription_update.rb

@@ -1,3 +1,7 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class SubscriptionUpdate < Request
@@ -8,11 +12,11 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] Change collection method
-      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
-      define_attribute :custom_fields, Array, {:item_type => :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.
@@ -39,8 +43,8 @@ module Recurly
       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
+      #   @return [ShippingAddressCreate] 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, :ShippingAddressCreate
 
       # @!attribute shipping_address_id
       #   @return [String] Assign a shipping address from the account's existing shipping addresses.