recurly 2.18.24 → 3.0.0.beta.1

data/lib/recurly/requests/shipping_address_update.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Requests
+    class ShippingAddressUpdate < Request
+
+      # @!attribute city
+      #   @return [String]
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!attribute email
+      #   @return [String]
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute [r] id
+      #   @return [String] Shipping Address ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute nickname
+      #   @return [String]
+      define_attribute :nickname, String
+
+      # @!attribute phone
+      #   @return [String]
+      define_attribute :phone, String
+
+      # @!attribute postal_code
+      #   @return [String] Zip or postal code.
+      define_attribute :postal_code, String
+
+      # @!attribute region
+      #   @return [String] State or province.
+      define_attribute :region, String
+
+      # @!attribute street1
+      #   @return [String]
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String]
+      define_attribute :street2, String
+
+      # @!attribute vat_number
+      #   @return [String]
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Requests
+    class SubscriptionAddOnCreate < Request
+
+      # @!attribute code
+      #   @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
+
+      # @!attribute unit_amount
+      #   @return [Float] Override the default unit amount of the add-on by setting this value.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -0,0 +1,42 @@
+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}
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      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}
+
+      # @!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.
+      define_attribute :plan_code, String
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute quantity
+      #   @return [Integer] Optionally override the default quantity of 1.
+      define_attribute :quantity, Integer
+
+      # @!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"]}
+
+      # @!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.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_create.rb

@@ -0,0 +1,86 @@
+module Recurly
+  module Requests
+    class SubscriptionCreate < Request
+
+      # @!attribute account
+      #   @return [Hash] Account
+      define_attribute :account, Hash
+
+      # @!attribute add_ons
+      #   @return [Array[String]] Add-ons
+      define_attribute :add_ons, Array, {:item_type => String}
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      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.
+      define_attribute :coupon_code, String
+
+      # @!attribute credit_customer_notes
+      #   @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!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 plan_code
+      #   @return [String] Plan code
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] Plan ID
+      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
+
+      # @!attribute quantity
+      #   @return [Integer] Optionally override the default quantity of 1.
+      define_attribute :quantity, Integer
+
+      # @!attribute shipping_address
+      #   @return [Hash] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping_address, Hash
+
+      # @!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.
+      define_attribute :shipping_address_id, String
+
+      # @!attribute starts_at
+      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      define_attribute :starts_at, DateTime
+
+      # @!attribute terms_and_conditions
+      #   @return [String] This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+      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.
+      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_update.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Requests
+    class SubscriptionUpdate < Request
+
+      # @!attribute collection_method
+      #   @return [String] Change collection method
+      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+
+      # @!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
+
+      # @!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_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 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.
+      define_attribute :remaining_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
+
+      # @!attribute shipping_address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses.
+      define_attribute :shipping_address_id, String
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+      define_attribute :terms_and_conditions, String
+    end
+  end
+end

data/lib/recurly/requests/update_coupon.rb

@@ -0,0 +1,30 @@
+module Recurly
+  module Requests
+    class UpdateCoupon < 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.
+      define_attribute :hosted_description, String
+
+      # @!attribute invoice_description
+      #   @return [String] Description of the coupon on the invoice.
+      define_attribute :invoice_description, String
+
+      # @!attribute max_redemptions
+      #   @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+      define_attribute :max_redemptions, Integer
+
+      # @!attribute max_redemptions_per_account
+      #   @return [Integer] Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+      define_attribute :max_redemptions_per_account, Integer
+
+      # @!attribute name
+      #   @return [String] The internal name for the coupon.
+      define_attribute :name, String
+
+      # @!attribute redeem_by_date
+      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      define_attribute :redeem_by_date, String
+    end
+  end
+end