recurly 2.17.11 → 4.18.0

data/lib/recurly/resources/dunning_cycle.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 Resources
+    class DunningCycle < Resource
+
+      # @!attribute applies_to_manual_trial
+      #   @return [Boolean] Whether the dunning settings will be applied to manual trials. Only applies to trial cycles.
+      define_attribute :applies_to_manual_trial, :Boolean
+
+      # @!attribute created_at
+      #   @return [DateTime] When the current settings were created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute expire_subscription
+      #   @return [Boolean] Whether the subscription(s) should be cancelled at the end of the dunning cycle.
+      define_attribute :expire_subscription, :Boolean
+
+      # @!attribute fail_invoice
+      #   @return [Boolean] Whether the invoice should be failed at the end of the dunning cycle.
+      define_attribute :fail_invoice, :Boolean
+
+      # @!attribute first_communication_interval
+      #   @return [Integer] The number of days after a transaction failure before the first dunning email is sent.
+      define_attribute :first_communication_interval, Integer
+
+      # @!attribute intervals
+      #   @return [Array[DunningInterval]] Dunning intervals.
+      define_attribute :intervals, Array, { :item_type => :DunningInterval }
+
+      # @!attribute send_immediately_on_hard_decline
+      #   @return [Boolean] Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.
+      define_attribute :send_immediately_on_hard_decline, :Boolean
+
+      # @!attribute total_dunning_days
+      #   @return [Integer] The number of days between the first dunning email being sent and the end of the dunning cycle.
+      define_attribute :total_dunning_days, Integer
+
+      # @!attribute total_recycling_days
+      #   @return [Integer] The number of days between a transaction failure and the end of the dunning cycle.
+      define_attribute :total_recycling_days, Integer
+
+      # @!attribute type
+      #   @return [String] The type of invoice this cycle applies to.
+      define_attribute :type, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the current settings were updated in Recurly.
+      define_attribute :updated_at, DateTime
+
+      # @!attribute version
+      #   @return [Integer] Current campaign version.
+      define_attribute :version, Integer
+    end
+  end
+end

data/lib/recurly/resources/dunning_interval.rb

@@ -0,0 +1,18 @@
+# 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 Resources
+    class DunningInterval < Resource
+
+      # @!attribute days
+      #   @return [Integer] Number of days before sending the next email.
+      define_attribute :days, Integer
+
+      # @!attribute email_template
+      #   @return [String] Email template being used.
+      define_attribute :email_template, String
+    end
+  end
+end

data/lib/recurly/resources/error.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 Resources
+    class Error < Resource
+
+      # @!attribute message
+      #   @return [String] Message
+      define_attribute :message, String
+
+      # @!attribute params
+      #   @return [Array[Hash]] Parameter specific errors
+      define_attribute :params, Array, { :item_type => Hash }
+
+      # @!attribute type
+      #   @return [String] Type
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/error_may_have_transaction.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 Resources
+    class ErrorMayHaveTransaction < Resource
+
+      # @!attribute message
+      #   @return [String] Message
+      define_attribute :message, String
+
+      # @!attribute params
+      #   @return [Array[Hash]] Parameter specific errors
+      define_attribute :params, Array, { :item_type => Hash }
+
+      # @!attribute transaction_error
+      #   @return [TransactionError] This is only included on errors with `type=transaction`.
+      define_attribute :transaction_error, :TransactionError
+
+      # @!attribute type
+      #   @return [String] Type
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/export_dates.rb

@@ -0,0 +1,18 @@
+# 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 Resources
+    class ExportDates < Resource
+
+      # @!attribute dates
+      #   @return [Array[String]] An array of dates that have available exports.
+      define_attribute :dates, Array, { :item_type => String }
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/export_file.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 Resources
+    class ExportFile < Resource
+
+      # @!attribute href
+      #   @return [String] A presigned link to download the export file.
+      define_attribute :href, String
+
+      # @!attribute md5sum
+      #   @return [String] MD5 hash of the export file.
+      define_attribute :md5sum, String
+
+      # @!attribute name
+      #   @return [String] Name of the export file.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/resources/export_files.rb

@@ -0,0 +1,18 @@
+# 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 Resources
+    class ExportFiles < Resource
+
+      # @!attribute files
+      #   @return [Array[ExportFile]]
+      define_attribute :files, Array, { :item_type => :ExportFile }
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/fraud_info.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 Resources
+    class FraudInfo < Resource
+
+      # @!attribute decision
+      #   @return [String] Kount decision
+      define_attribute :decision, String
+
+      # @!attribute risk_rules_triggered
+      #   @return [Hash] Kount rules
+      define_attribute :risk_rules_triggered, Hash
+
+      # @!attribute score
+      #   @return [Integer] Kount score
+      define_attribute :score, Integer
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -0,0 +1,162 @@
+# 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 Resources
+    class Invoice < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute address
+      #   @return [InvoiceAddress]
+      define_attribute :address, :InvoiceAddress
+
+      # @!attribute balance
+      #   @return [Float] The outstanding balance remaining on this invoice.
+      define_attribute :balance, Float
+
+      # @!attribute billing_info_id
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+      define_attribute :billing_info_id, String
+
+      # @!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
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!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 dunning_campaign_id
+      #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+      define_attribute :dunning_campaign_id, String
+
+      # @!attribute has_more_line_items
+      #   @return [Boolean] Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
+      define_attribute :has_more_line_items, :Boolean
+
+      # @!attribute id
+      #   @return [String] Invoice ID
+      define_attribute :id, String
+
+      # @!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 object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute origin
+      #   @return [String] The event that created the invoice.
+      define_attribute :origin, String
+
+      # @!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 shipping_address
+      #   @return [ShippingAddress]
+      define_attribute :shipping_address, :ShippingAddress
+
+      # @!attribute state
+      #   @return [String] Invoice state
+      define_attribute :state, String
+
+      # @!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 and credits, before discounts and taxes.
+      define_attribute :subtotal, Float
+
+      # @!attribute tax
+      #   @return [Float] The total tax on this invoice.
+      define_attribute :tax, Float
+
+      # @!attribute tax_info
+      #   @return [TaxInfo] Tax info
+      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
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute uuid
+      #   @return [String] Invoice UUID
+      define_attribute :uuid, String
+
+      # @!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_address.rb

@@ -0,0 +1,54 @@
+# 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 Resources
+    class InvoiceAddress < Resource
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String] Company
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      define_attribute :country, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute last_name
+      #   @return [String] Last name
+      define_attribute :last_name, String
+
+      # @!attribute name_on_account
+      #   @return [String] Name on account
+      define_attribute :name_on_account, String
+
+      # @!attribute phone
+      #   @return [String] Phone number
+      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] Street 1
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String] Street 2
+      define_attribute :street2, String
+    end
+  end
+end

data/lib/recurly/resources/invoice_collection.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 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/invoice_mini.rb

@@ -0,0 +1,30 @@
+# 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 Resources
+    class InvoiceMini < Resource
+
+      # @!attribute id
+      #   @return [String] Invoice ID
+      define_attribute :id, String
+
+      # @!attribute number
+      #   @return [String] Invoice number
+      define_attribute :number, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute state
+      #   @return [String] Invoice state
+      define_attribute :state, String
+
+      # @!attribute type
+      #   @return [String] Invoice type
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/invoice_template.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 Resources
+    class InvoiceTemplate < Resource
+
+      # @!attribute code
+      #   @return [String] Invoice template code.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] When the invoice template was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Invoice template description.
+      define_attribute :description, String
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Invoice template name.
+      define_attribute :name, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the invoice template was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/item.rb

@@ -0,0 +1,82 @@
+# 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 Resources
+    class Item < Resource
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items.
+      define_attribute :accounting_code, String
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Item Pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute id
+      #   @return [String] Item ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute state
+      #   @return [String] The current state of the item.
+      define_attribute :state, String
+
+      # @!attribute tax_code
+      #   @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 you can use `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the item, `false` applies tax on the item.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/item_mini.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 Resources
+    class ItemMini < Resource
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute id
+      #   @return [String] Item ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute state
+      #   @return [String] The current state of the item.
+      define_attribute :state, String
+    end
+  end
+end