recurly 3.0.0.beta.4 → 3.0.0.beta.5

data/lib/recurly/requests/subscription_change_create.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] Collection method
-      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
+      define_attribute :collection_method, String
 
       # @!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.
@@ -40,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
 
       # @!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

@@ -20,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
 
       # @!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.

data/lib/recurly/requests/subscription_purchase.rb

@@ -0,0 +1,58 @@
+# 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 SubscriptionPurchase < Request
+
+      # @!attribute add_ons
+      #   @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 custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!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
+
+      # @!attribute plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String
+
+      # @!attribute quantity
+      #   @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
+      #   @return [SubscriptionShippingPurchase] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping, :SubscriptionShippingPurchase
+
+      # @!attribute total_billing_cycles
+      #   @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
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value in cents. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_shipping_purchase.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 SubscriptionShippingPurchase < Request
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_update.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] Change collection method
-      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
+      define_attribute :collection_method, String
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
@@ -43,7 +43,7 @@ module Recurly
       define_attribute :renewal_billing_cycles, Integer
 
       # @!attribute shipping_address
-      #   @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."
+      #   @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

data/lib/recurly/resources/account.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute bill_to
       #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
-      define_attribute :bill_to, String, { :enum => ["self", "parent"] }
+      define_attribute :bill_to, String
 
       # @!attribute billing_info
       #   @return [BillingInfo]
@@ -22,25 +22,25 @@ module Recurly
       #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
       define_attribute :cc_emails, String
 
-      # @!attribute [r] code
+      # @!attribute code
       #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
-      define_attribute :code, String, { :read_only => true }
+      define_attribute :code, String
 
       # @!attribute company
       #   @return [String]
       define_attribute :company, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] When the account was created.
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
-      # @!attribute [r] deleted_at
+      # @!attribute deleted_at
       #   @return [DateTime] If present, when the account was last marked inactive.
-      define_attribute :deleted_at, DateTime, { :read_only => true }
+      define_attribute :deleted_at, DateTime
 
       # @!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.
@@ -54,21 +54,21 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute [r] hosted_login_token
+      # @!attribute hosted_login_token
       #   @return [String] The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `https://{subdomain}.recurly.com/account/{hosted_login_token}`.
-      define_attribute :hosted_login_token, String, { :read_only => true }
+      define_attribute :hosted_login_token, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String]
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute parent_account_id
       #   @return [String] The UUID of the parent account associated with this account.
@@ -76,23 +76,23 @@ module Recurly
 
       # @!attribute preferred_locale
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
-      define_attribute :preferred_locale, String, { :enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"] }
+      define_attribute :preferred_locale, String
 
       # @!attribute shipping_addresses
       #   @return [Array[ShippingAddress]] The shipping addresses on the account.
       define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddress }
 
-      # @!attribute [r] state
+      # @!attribute state
       #   @return [String] Accounts can be either active or inactive.
-      define_attribute :state, String, { :read_only => true, :enum => ["active", "inactive"] }
+      define_attribute :state, String
 
       # @!attribute tax_exempt
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
       define_attribute :tax_exempt, :Boolean
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] When the account was last changed.
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
 
       # @!attribute username
       #   @return [String] A secondary value for the account.

data/lib/recurly/resources/account_acquisition.rb

@@ -16,31 +16,31 @@ module Recurly
 
       # @!attribute channel
       #   @return [String] The channel through which the account was acquired.
-      define_attribute :channel, String, { :enum => ["referral", "social_media", "email", "paid_search", "organic_search", "direct_traffic", "marketing_content", "blog", "events", "outbound_sales", "advertising", "public_relations", "other"] }
+      define_attribute :channel, String
 
       # @!attribute cost
       #   @return [Hash] Account balance
       define_attribute :cost, Hash
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] When the account acquisition data was created.
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String]
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute subchannel
       #   @return [String] An arbitrary subchannel string representing a distinction/subcategory within a broader channel.
       define_attribute :subchannel, String
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] When the account acquisition data was last changed.
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
     end
   end
 end

data/lib/recurly/resources/account_balance.rb

@@ -14,9 +14,9 @@ module Recurly
       #   @return [Array[AccountBalanceAmount]]
       define_attribute :balances, Array, { :item_type => :AccountBalanceAmount }
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute past_due
       #   @return [Boolean]

data/lib/recurly/resources/account_mini.rb

@@ -26,17 +26,17 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String]
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute parent_account_id
       #   @return [String]

data/lib/recurly/resources/account_note.rb

@@ -10,21 +10,21 @@ module Recurly
       #   @return [String]
       define_attribute :account_id, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime]
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String]
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute message
       #   @return [String]
       define_attribute :message, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute user
       #   @return [User]

data/lib/recurly/resources/add_on.rb

@@ -14,9 +14,9 @@ module Recurly
       #   @return [String] The unique identifier for the add-on within its plan.
       define_attribute :code, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
       # @!attribute currencies
       #   @return [Array[AddOnPricing]] Add-on pricing
@@ -26,41 +26,41 @@ module Recurly
       #   @return [Integer] Default quantity for the hosted pages.
       define_attribute :default_quantity, Integer
 
-      # @!attribute [r] deleted_at
+      # @!attribute deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, { :read_only => true }
+      define_attribute :deleted_at, DateTime
 
       # @!attribute display_quantity
       #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
       define_attribute :display_quantity, :Boolean
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Add-on ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.
       define_attribute :name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
-      # @!attribute [r] plan_id
+      # @!attribute plan_id
       #   @return [String] Plan ID
-      define_attribute :plan_id, String, { :read_only => true }
+      define_attribute :plan_id, String
 
-      # @!attribute [r] state
+      # @!attribute state
       #   @return [String] Add-ons can be either active or inactive.
-      define_attribute :state, String, { :read_only => true, :enum => ["active", "inactive"] }
+      define_attribute :state, String
 
       # @!attribute tax_code
-      #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature `P0000000` is `physical`, `D0000000` is `digital`, and an empty string is `unknown`.
       define_attribute :tax_code, String
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] Last updated at
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
     end
   end
 end

data/lib/recurly/resources/add_on_mini.rb

@@ -14,17 +14,17 @@ module Recurly
       #   @return [String] The unique identifier for the add-on within its plan.
       define_attribute :code, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Add-on ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.
       define_attribute :name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
     end
   end
 end

data/lib/recurly/resources/billing_info.rb

@@ -6,9 +6,9 @@ module Recurly
   module Resources
     class BillingInfo < Resource
 
-      # @!attribute [r] account_id
+      # @!attribute account_id
       #   @return [String]
-      define_attribute :account_id, String, { :read_only => true }
+      define_attribute :account_id, String
 
       # @!attribute address
       #   @return [Address]
@@ -18,45 +18,45 @@ module Recurly
       #   @return [String]
       define_attribute :company, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] When the billing information was created.
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
       # @!attribute first_name
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute [r] fraud
+      # @!attribute fraud
       #   @return [Hash] Most recent fraud result.
-      define_attribute :fraud, Hash, { :read_only => true }
+      define_attribute :fraud, Hash
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String]
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute payment_method
       #   @return [Hash]
       define_attribute :payment_method, Hash
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] When the billing information was last changed.
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
 
-      # @!attribute [r] updated_by
+      # @!attribute updated_by
       #   @return [Hash]
-      define_attribute :updated_by, Hash, { :read_only => true }
+      define_attribute :updated_by, Hash
 
-      # @!attribute [r] valid
+      # @!attribute valid
       #   @return [Boolean]
-      define_attribute :valid, :Boolean, { :read_only => true }
+      define_attribute :valid, :Boolean
 
       # @!attribute vat_number
       #   @return [String] Customer's VAT number (to avoid having the VAT applied). This is only used for automatically collected invoices.