recurly 2.18.21 → 3.0.0.beta.1

data/lib/recurly/resources/coupon_discount.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Resources
+    class CouponDiscount < Resource
+
+      # @!attribute currencies
+      #   @return [Array[String]] This is only present when `type=fixed`.
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute percent
+      #   @return [Integer] This is only present when `type=percent`.
+      define_attribute :percent, Integer
+
+      # @!attribute trial
+      #   @return [Hash] This is only present when `type=free_trial`.
+      define_attribute :trial, Hash
+
+      # @!attribute type
+      #   @return [String]
+      define_attribute :type, String, {:enum => ["percent", "fixed", "free_trial"]}
+    end
+  end
+end

data/lib/recurly/resources/coupon_redemption.rb

@@ -0,0 +1,46 @@
+module Recurly
+  module Resources
+    class CouponRedemption < Resource
+
+      # @!attribute account_id
+      #   @return [String] The Account ID on which the coupon was applied.
+      define_attribute :account_id, String
+
+      # @!attribute coupon
+      #   @return [Coupon]
+      define_attribute :coupon, :Coupon
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute discounted
+      #   @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
+      define_attribute :discounted, String
+
+      # @!attribute [r] id
+      #   @return [String] Coupon Redemption ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute [r] object
+      #   @return [String] Will always be `coupon`.
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute removed_at
+      #   @return [DateTime] The date and time the redemption was removed from the account (un-redeemed).
+      define_attribute :removed_at, DateTime
+
+      # @!attribute state
+      #   @return [String] Coupon Redemption state
+      define_attribute :state, String, {:enum => ["active", "inactive"]}
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/credit_payment.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Resources
+    class CreditPayment < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute action
+      #   @return [String] The action for which the credit was created.
+      define_attribute :action, String, {:enum => ["payment", "refund", "reduction", "write_off"]}
+
+      # @!attribute amount
+      #   @return [Float] Total credit payment amount applied to the charge invoice.
+      define_attribute :amount, Float
+
+      # @!attribute applied_to_invoice
+      #   @return [InvoiceMini]
+      define_attribute :applied_to_invoice, :InvoiceMini
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute id
+      #   @return [String] Credit Payment ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute original_credit_payment_id
+      #   @return [String] For credit payments with action `refund`, this is the credit payment that was refunded.
+      define_attribute :original_credit_payment_id, String
+
+      # @!attribute original_invoice
+      #   @return [InvoiceMini]
+      define_attribute :original_invoice, :InvoiceMini
+
+      # @!attribute refund_transaction
+      #   @return [Transaction]
+      define_attribute :refund_transaction, :Transaction
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!attribute uuid
+      #   @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+      define_attribute :uuid, String
+
+      # @!attribute [r] voided_at
+      #   @return [DateTime] Voided at
+      define_attribute :voided_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/error.rb

@@ -0,0 +1,18 @@
+module Recurly
+  module Resources
+    class Error < Resource
+
+      # @!attribute message
+      #   @return [String] Message
+      define_attribute :message, String
+
+      # @!attribute params
+      #   @return [Array[String]] Parameter specific errors
+      define_attribute :params, Array, {:item_type => String}
+
+      # @!attribute type
+      #   @return [String] Type
+      define_attribute :type, String, {:enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"]}
+    end
+  end
+end

data/lib/recurly/resources/error_may_have_transaction.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Resources
+    class ErrorMayHaveTransaction < Resource
+
+      # @!attribute message
+      #   @return [String] Message
+      define_attribute :message, String
+
+      # @!attribute params
+      #   @return [Array[String]] Parameter specific errors
+      define_attribute :params, Array, {:item_type => String}
+
+      # @!attribute transaction_error
+      #   @return [Hash] This is only included on errors with `type=transaction`.
+      define_attribute :transaction_error, Hash
+
+      # @!attribute type
+      #   @return [String] Type
+      define_attribute :type, String, {:enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"]}
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -0,0 +1,138 @@
+module Recurly
+  module Resources
+    class Invoice < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute balance
+      #   @return [Float] The outstanding balance remaining on this invoice.
+      define_attribute :balance, Float
+
+      # @!attribute closed_at
+      #   @return [DateTime] Date invoice was marked paid or failed.
+      define_attribute :closed_at, DateTime
+
+      # @!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 [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute credit_payments
+      #   @return [Array[CreditPayment]] Credit payments
+      define_attribute :credit_payments, Array, {:item_type => :CreditPayment}
+
+      # @!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.
+      define_attribute :customer_notes, String
+
+      # @!attribute discount
+      #   @return [Float] Total discounts applied to this invoice.
+      define_attribute :discount, Float
+
+      # @!attribute due_at
+      #   @return [DateTime] Date invoice is due. This is the date the net terms are reached.
+      define_attribute :due_at, DateTime
+
+      # @!attribute [r] id
+      #   @return [String] Invoice ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute line_items
+      #   @return [Array[LineItem]] Line items
+      define_attribute :line_items, Array, {:item_type => :LineItem}
+
+      # @!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 number
+      #   @return [String] If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
+      define_attribute :number, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute origin
+      #   @return [String] The event that created the invoice.
+      define_attribute :origin, String, {:enum => ["purchase", "line_item_refund", "open_amount_refund", "renewal", "immediate_change", "termination", "credit", "gift_card", "write_off"]}
+
+      # @!attribute paid
+      #   @return [Float] The total amount of successful payments transaction on this invoice.
+      define_attribute :paid, Float
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute previous_invoice_id
+      #   @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from.
+      define_attribute :previous_invoice_id, String
+
+      # @!attribute refundable_amount
+      #   @return [Float] The refundable amount on a charge invoice. It will be null for all other invoices.
+      define_attribute :refundable_amount, Float
+
+      # @!attribute state
+      #   @return [String] Invoice state
+      define_attribute :state, String, {:enum => ["pending", "processing", "past_due", "paid", "failed"]}
+
+      # @!attribute subscription_ids
+      #   @return [Array[String]] If the invoice is charging or refunding for one or more subscriptions, these are their IDs.
+      define_attribute :subscription_ids, Array, {:item_type => String}
+
+      # @!attribute subtotal
+      #   @return [Float] The summation of charges, discounts, and credits, before tax.
+      define_attribute :subtotal, Float
+
+      # @!attribute tax
+      #   @return [Float] The total tax on this invoice.
+      define_attribute :tax, Float
+
+      # @!attribute tax_info
+      #   @return [TaxInfo]
+      define_attribute :tax_info, :TaxInfo
+
+      # @!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 total
+      #   @return [Float] The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.
+      define_attribute :total, Float
+
+      # @!attribute transactions
+      #   @return [Array[Transaction]] Transactions
+      define_attribute :transactions, Array, {:item_type => :Transaction}
+
+      # @!attribute type
+      #   @return [String] Invoices are either charge, credit, or legacy invoices.
+      define_attribute :type, String, {:enum => ["charge", "credit", "legacy"]}
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!attribute vat_number
+      #   @return [String] VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.
+      define_attribute :vat_number, String
+
+      # @!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/resources/invoice_collection.rb

@@ -0,0 +1,18 @@
+module Recurly
+  module Resources
+    class InvoiceCollection < Resource
+
+      # @!attribute charge_invoice
+      #   @return [Invoice]
+      define_attribute :charge_invoice, :Invoice
+
+      # @!attribute credit_invoices
+      #   @return [Array[Invoice]] Credit invoices
+      define_attribute :credit_invoices, Array, {:item_type => :Invoice}
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/line_item.rb

@@ -0,0 +1,166 @@
+module Recurly
+  module Resources
+    class LineItem < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute accounting_code
+      #   @return [String] Internal accounting code to help you reconcile your revenue to the correct ledger. Line items created as part of a subscription invoice will use the plan or add-on's accounting code, otherwise the value will only be present if you define an accounting code when creating the line item.
+      define_attribute :accounting_code, String
+
+      # @!attribute add_on_code
+      #   @return [String] If the line item is a charge or credit for an add-on, this is its code.
+      define_attribute :add_on_code, String
+
+      # @!attribute add_on_id
+      #   @return [String] If the line item is a charge or credit for an add-on this is its ID.
+      define_attribute :add_on_id, String
+
+      # @!attribute amount
+      #   @return [Float] `(quantity * unit_amount) - (discount + tax)`
+      define_attribute :amount, Float
+
+      # @!attribute created_at
+      #   @return [DateTime] When the line item was created.
+      define_attribute :created_at, DateTime
+
+      # @!attribute credit_applied
+      #   @return [Float] The amount of credit from this line item that was applied to the invoice.
+      define_attribute :credit_applied, Float
+
+      # @!attribute credit_reason_code
+      #   @return [String] The reason the credit was given when line item is `type=credit`.
+      define_attribute :credit_reason_code, String, {:enum => ["general", "service", "promotional", "refund", "gift_card", "write_off"]}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute description
+      #   @return [String] Description that appears on the invoice. For subscription related items this will be filled in automatically.
+      define_attribute :description, String
+
+      # @!attribute discount
+      #   @return [Float] The discount applied to the line item.
+      define_attribute :discount, Float
+
+      # @!attribute end_date
+      #   @return [DateTime] If this date is provided, it indicates the end of a time range.
+      define_attribute :end_date, DateTime
+
+      # @!attribute id
+      #   @return [String] Line item ID
+      define_attribute :id, String
+
+      # @!attribute invoice_id
+      #   @return [String] Once the line item has been invoiced this will be the invoice's ID.
+      define_attribute :invoice_id, String
+
+      # @!attribute invoice_number
+      #   @return [String] Once the line item has been invoiced this will be the invoice's number. If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
+      define_attribute :invoice_number, String
+
+      # @!attribute legacy_category
+      #   @return [String] Category to describe the role of a line item on a legacy invoice: - "charges" refers to charges being billed for on this invoice. - "credits" refers to refund or proration credits. This portion of the invoice can be considered a credit memo. - "applied_credits" refers to previous credits applied to this invoice. See their `original_line_item_invoice_id` to determine where the credit first originated. - "carryforwards" can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.
+      define_attribute :legacy_category, String, {:enum => ["charge", "credit", "applied_credit", "carryforward"]}
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute origin
+      #   @return [String] A credit created from an original charge will have the value of the charge's origin.
+      define_attribute :origin, String, {:enum => ["plan", "plan_trial", "setup_fee", "add_on_trial", "add_on", "debit", "one_time", "credit", "coupon", "carryforward"]}
+
+      # @!attribute original_line_item_invoice_id
+      #   @return [String] The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
+      define_attribute :original_line_item_invoice_id, String
+
+      # @!attribute plan_code
+      #   @return [String] If the line item is a charge or credit for a plan or add-on, this is the plan's code.
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] If the line item is a charge or credit for a plan or add-on, this is the plan's ID.
+      define_attribute :plan_id, String
+
+      # @!attribute previous_line_item_id
+      #   @return [String] Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
+      define_attribute :previous_line_item_id, String
+
+      # @!attribute product_code
+      #   @return [String] For plan related line items this will be the plan's code, for add-on related line items it will be the add-on's code.
+      define_attribute :product_code, String
+
+      # @!attribute proration_rate
+      #   @return [Float] When a line item has been prorated, this is the rate of the proration. Proration rates were made available for line items created after March 30, 2017. For line items created prior to that date, the proration rate will be `null`, even if the line item was prorated.
+      define_attribute :proration_rate, Float
+
+      # @!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 refund
+      #   @return [Boolean] Refund?
+      define_attribute :refund, :Boolean
+
+      # @!attribute refunded_quantity
+      #   @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
+      define_attribute :refunded_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.
+      define_attribute :start_date, DateTime
+
+      # @!attribute state
+      #   @return [String] Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.
+      define_attribute :state, String, {:enum => ["pending", "invoiced"]}
+
+      # @!attribute subscription_id
+      #   @return [String] If the line item is a charge or credit for a subscription, this is its ID.
+      define_attribute :subscription_id, String
+
+      # @!attribute subtotal
+      #   @return [Float] `quantity * unit_amount`
+      define_attribute :subtotal, Float
+
+      # @!attribute tax
+      #   @return [Float] The tax amount for the line item.
+      define_attribute :tax, Float
+
+      # @!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 tax_info
+      #   @return [TaxInfo]
+      define_attribute :tax_info, :TaxInfo
+
+      # @!attribute taxable
+      #   @return [Boolean] `true` if the line item is taxable, `false` if it is not.
+      define_attribute :taxable, :Boolean
+
+      # @!attribute type
+      #   @return [String] Charges are positive line items that debit the account. Credits are negative line items that credit the account.
+      define_attribute :type, String, {:enum => ["charge", "credit"]}
+
+      # @!attribute unit_amount
+      #   @return [Float] Positive amount for a charge, negative amount for a credit.
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the line item was last changed.
+      define_attribute :updated_at, DateTime
+
+      # @!attribute uuid
+      #   @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+      define_attribute :uuid, String
+    end
+  end
+end