recurly 3.28.0 → 3.29.1

data/lib/recurly/resources/invoice.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] A list of custom fields that were on the account at the time of invoice creation and were marked to be displayed on invoices. Read-only; cannot be set directly on the invoice.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!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
@@ -114,6 +118,10 @@ module Recurly
       #   @return [Float] The summation of charges and credits, before discounts and taxes.
       define_attribute :subtotal, Float
 
+      # @!attribute subtotal_after_discount
+      #   @return [Float] The summation of charges and credits, after discounts applied.
+      define_attribute :subtotal_after_discount, Float
+
       # @!attribute tax
       #   @return [Float] The total tax on this invoice.
       define_attribute :tax, Float

data/lib/recurly/resources/invoice_address.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [String] First name
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
+      define_attribute :geo_code, String
+
       # @!attribute last_name
       #   @return [String] Last name
       define_attribute :last_name, String

data/lib/recurly/resources/item.rb

@@ -67,7 +67,7 @@ module Recurly
       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`.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/resources/line_item.rb

@@ -23,7 +23,7 @@ module Recurly
       define_attribute :add_on_id, String
 
       # @!attribute amount
-      #   @return [Float] `(quantity * unit_amount) - (discount + tax)`
+      #   @return [Float] `(quantity * unit_amount) - discount + tax`
       define_attribute :amount, Float
 
       # @!attribute avalara_service_type
@@ -179,7 +179,7 @@ module Recurly
       define_attribute :tax, Float
 
       # @!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`.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -213,6 +213,10 @@ module Recurly
       # @!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 vertex_transaction_type
+      #   @return [String] Used by Vertex for tax calculations. Possible values are sale, rental, lease.
+      define_attribute :vertex_transaction_type, String
     end
   end
 end

data/lib/recurly/resources/payment_method.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
       define_attribute :billing_agreement_id, String
 
+      # @!attribute card_network_preference
+      #   @return [String] Represents the card network preference associated with the billing info for dual badged cards. Must be a supported card network.
+      define_attribute :card_network_preference, String
+
       # @!attribute card_type
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
       define_attribute :card_type, String

data/lib/recurly/resources/plan.rb

@@ -103,7 +103,7 @@ module Recurly
       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`.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/resources/shipping_address.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute geo_code
+      #   @return [String] Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.
+      define_attribute :geo_code, String
+
       # @!attribute id
       #   @return [String] Shipping Address ID
       define_attribute :id, String

data/lib/recurly/resources/subscription.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime
 
+      # @!attribute credit_application_policy
+      #   @return [CreditApplicationPolicy] Controls whether credit invoices are automatically applied to new invoices. The `mode` field determines the application behavior. When mode is `all`, the optional `allowed_origins` array can restrict which credit invoice origins are applied. - `all`: All available credit invoices are applied (default) - `none`: No credit invoices are applied automatically
+      define_attribute :credit_application_policy, :CreditApplicationPolicy
+
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
@@ -138,6 +142,10 @@ module Recurly
       #   @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 resume_at
+      #   @return [DateTime] The date the subscription billing resumes following a pause. Null unless the subscription is paused or scheduled to be paused.
+      define_attribute :resume_at, DateTime
+
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String

data/lib/recurly/resources/subscription_ramp_interval_response.rb

@@ -6,6 +6,10 @@ module Recurly
   module Resources
     class SubscriptionRampIntervalResponse < Resource
 
+      # @!attribute ending_on
+      #   @return [DateTime] Date the ramp interval ends
+      define_attribute :ending_on, DateTime
+
       # @!attribute remaining_billing_cycles
       #   @return [Integer] Represents how many billing cycles are left in a ramp interval.
       define_attribute :remaining_billing_cycles, Integer
@@ -14,6 +18,10 @@ module Recurly
       #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
 
+      # @!attribute starting_on
+      #   @return [DateTime] Date the ramp interval starts
+      define_attribute :starting_on, DateTime
+
       # @!attribute unit_amount
       #   @return [Integer] Represents the price for the ramp interval.
       define_attribute :unit_amount, Integer

data/lib/recurly/resources/tax_detail.rb

@@ -7,15 +7,15 @@ module Recurly
     class TaxDetail < Resource
 
       # @!attribute billable
-      #   @return [Boolean] Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
+      #   @return [Boolean] Whether or not the line item is taxable. Only populated for a single LineItem fetch when Avalara for Communications or Vertex is enabled.
       define_attribute :billable, :Boolean
 
       # @!attribute level
-      #   @return [String] Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications is enabled.
+      #   @return [String] Provides the jurisdiction level for the Communications tax applied. Example values include city, state and federal. Present only when Avalara for Communications or Vertex is enabled.
       define_attribute :level, String
 
       # @!attribute name
-      #   @return [String] Provides the name of the Communications tax applied. Present only when Avalara for Communications is enabled.
+      #   @return [String] Provides the name of the Communications tax applied. Present only when Avalara for Communications or Vertex is enabled.
       define_attribute :name, String
 
       # @!attribute rate
@@ -31,7 +31,7 @@ module Recurly
       define_attribute :tax, Float
 
       # @!attribute type
-      #   @return [String] Provides the tax type for the region or type of Comminications tax when Avalara for Communications is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.
+      #   @return [String] Provides the tax type for the region or type of Comminications tax when Avalara for Communications or Vertex is enabled. For Canadian Sales Tax, this will be GST, HST, QST or PST.
       define_attribute :type, String
     end
   end

data/lib/recurly/resources/tax_info.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :region, String
 
       # @!attribute tax_details
-      #   @return [Array[TaxDetail]] Provides additional tax details for Communications taxes when Avalara for Communications is enabled or Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
+      #   @return [Array[TaxDetail]] Provides additional tax details for Communications taxes when Avalara for Communications or Vertex Tax Breakdown is enabled or Canadian Sales Tax. Tax details will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.
       define_attribute :tax_details, Array, { :item_type => :TaxDetail }
 
       # @!attribute type

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.28.0"
+  VERSION = "3.29.1"
 end