recurly 2.18.21 → 3.0.0.beta.1

data/lib/recurly/requests/invoice_create.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Requests
+    class InvoiceCreate < Request
+
+      # @!attribute charge_customer_notes
+      #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings for charge invoices. Specify custom notes to add or override Customer Notes on charge invoices.
+      define_attribute :charge_customer_notes, String
+
+      # @!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"]}
+
+      # @!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.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, 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 po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!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.
+      define_attribute :terms_and_conditions, String
+
+      # @!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"]}
+
+      # @!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.
+      define_attribute :vat_reverse_charge_notes, String
+    end
+  end
+end

data/lib/recurly/requests/invoice_refund.rb

@@ -0,0 +1,30 @@
+module Recurly
+  module Requests
+    class InvoiceRefund < Request
+
+      # @!attribute amount
+      #   @return [Integer] The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
+      define_attribute :amount, Integer
+
+      # @!attribute credit_customer_notes
+      #   @return [String] Used as the Customer Notes on the credit invoice.  This field can only be include when the Credit Invoices feature is enabled.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute external_refund
+      #   @return [Hash] Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly.  Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount  This field can only be included when the Credit Invoices feature is enabled.
+      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}
+
+      # @!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"]}
+
+      # @!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"]}
+    end
+  end
+end

data/lib/recurly/requests/line_item_create.rb

@@ -0,0 +1,46 @@
+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"]}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute description
+      #   @return [String] Description that appears on the invoice.
+      define_attribute :description, String
+
+      # @!attribute end_date
+      #   @return [DateTime] If this date is provided, it indicates the end of a time range.
+      define_attribute :end_date, DateTime
+
+      # @!attribute quantity
+      #   @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
+      define_attribute :quantity, Integer
+
+      # @!attribute start_date
+      #   @return [DateTime] If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.
+      define_attribute :start_date, DateTime
+
+      # @!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.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute type
+      #   @return [String] Line item type.
+      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`.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/plan_create.rb

@@ -0,0 +1,66 @@
+module Recurly
+  module Requests
+    class PlanCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
+      define_attribute :accounting_code, String
+
+      # @!attribute add_ons
+      #   @return [Array[String]] Add Ons
+      define_attribute :add_ons, Array, {:item_type => String}
+
+      # @!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}
+
+      # @!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
+
+      # @!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
+
+      # @!attribute setup_fee_accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
+      define_attribute :setup_fee_accounting_code, 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.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the plan, `false` applies tax on the plan.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] Automatically terminate plans after a defined number of billing cycles.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_length
+      #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
+      define_attribute :trial_length, Integer
+
+      # @!attribute trial_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+    end
+  end
+end

data/lib/recurly/requests/plan_update.rb

@@ -0,0 +1,70 @@
+module Recurly
+  module Requests
+    class PlanUpdate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
+      define_attribute :accounting_code, String
+
+      # @!attribute add_ons
+      #   @return [Array[String]] Add Ons
+      define_attribute :add_ons, Array, {:item_type => String}
+
+      # @!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}
+
+      # @!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
+
+      # @!attribute [r] id
+      #   @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
+
+      # @!attribute setup_fee_accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
+      define_attribute :setup_fee_accounting_code, 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.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the plan, `false` applies tax on the plan.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] Automatically terminate plans after a defined number of billing cycles.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_length
+      #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
+      define_attribute :trial_length, Integer
+
+      # @!attribute trial_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+    end
+  end
+end

data/lib/recurly/requests/shipping_address_create.rb

@@ -0,0 +1,58 @@
+module Recurly
+  module Requests
+    class ShippingAddressCreate < 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 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/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