recurly 3.17.0 → 3.19.0

data/lib/recurly/resources/dunning_campaigns_bulk_update_response.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 DunningCampaignsBulkUpdateResponse < Resource
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plans
+      #   @return [Array[Plan]] An array containing all of the `Plan` resources that have been updated.
+      define_attribute :plans, Array, { :item_type => :Plan }
+    end
+  end
+end

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/invoice.rb

@@ -19,7 +19,7 @@ module Recurly
       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.
+      #   @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
@@ -54,6 +54,10 @@ module Recurly
       #   @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 id
       #   @return [String] Invoice ID
       define_attribute :id, String
@@ -107,7 +111,7 @@ module Recurly
       define_attribute :subscription_ids, Array, { :item_type => String }
 
       # @!attribute subtotal
-      #   @return [Float] The summation of charges, discounts, and credits, before tax.
+      #   @return [Float] The summation of charges and credits, before discounts and taxes.
       define_attribute :subtotal, Float
 
       # @!attribute tax

data/lib/recurly/resources/invoice_address.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute first_name

data/lib/recurly/resources/line_item.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line 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 bill_for_account_id
+      #   @return [String] The UUID of the account responsible for originating the line item.
+      define_attribute :bill_for_account_id, String
+
       # @!attribute created_at
       #   @return [DateTime] When the line item was created.
       define_attribute :created_at, DateTime
@@ -63,7 +67,7 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute external_sku
-      #   @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.
       define_attribute :external_sku, String
 
       # @!attribute id
@@ -79,11 +83,11 @@ module Recurly
       define_attribute :invoice_number, String
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] Unique code to identify an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.
       define_attribute :item_id, String
 
       # @!attribute legacy_category

data/lib/recurly/resources/payment_method.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
       define_attribute :card_type, String
 
+      # @!attribute cc_bin_country
+      #   @return [String] The 2-letter ISO 3166-1 alpha-2 country code associated with the credit card BIN, if known by Recurly. Available on the BillingInfo object only. Available when the BIN country lookup feature is enabled.
+      define_attribute :cc_bin_country, String
+
       # @!attribute exp_month
       #   @return [Integer] Expiration month.
       define_attribute :exp_month, Integer

data/lib/recurly/resources/plan.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute hosted_pages
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages

data/lib/recurly/resources/plan_pricing.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
       define_attribute :setup_fee, Float
 
+      # @!attribute tax_inclusive
+      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      define_attribute :tax_inclusive, :Boolean
+
       # @!attribute unit_amount
       #   @return [Float] Unit price
       define_attribute :unit_amount, Float

data/lib/recurly/resources/pricing.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!attribute tax_inclusive
+      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      define_attribute :tax_inclusive, :Boolean
+
       # @!attribute unit_amount
       #   @return [Float] Unit price
       define_attribute :unit_amount, Float

data/lib/recurly/resources/shipping_address.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute created_at

data/lib/recurly/resources/subscription.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [DateTime] Activated at
       define_attribute :activated_at, DateTime
 
+      # @!attribute active_invoice_id
+      #   @return [String] The invoice ID of the latest invoice created for an active subscription.
+      define_attribute :active_invoice_id, String
+
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOn]] Add-ons
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }

data/lib/recurly/resources/subscription_change.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
+      # @!attribute billing_info
+      #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
+      define_attribute :billing_info, :SubscriptionChangeBillingInfo
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime
@@ -66,6 +70,10 @@ module Recurly
       #   @return [String] The ID of the subscription that is going to be changed.
       define_attribute :subscription_id, String
 
+      # @!attribute tax_inclusive
+      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      define_attribute :tax_inclusive, :Boolean
+
       # @!attribute unit_amount
       #   @return [Float] Unit amount
       define_attribute :unit_amount, Float

data/lib/recurly/resources/subscription_change_billing_info.rb

@@ -0,0 +1,14 @@
+# 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 SubscriptionChangeBillingInfo < Resource
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_change_preview.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
+      # @!attribute billing_info
+      #   @return [SubscriptionChangeBillingInfo] Accept nested attributes for three_d_secure_action_result_token_id
+      define_attribute :billing_info, :SubscriptionChangeBillingInfo
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime
@@ -66,6 +70,10 @@ module Recurly
       #   @return [String] The ID of the subscription that is going to be changed.
       define_attribute :subscription_id, String
 
+      # @!attribute tax_inclusive
+      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      define_attribute :tax_inclusive, :Boolean
+
       # @!attribute unit_amount
       #   @return [Float] Unit amount
       define_attribute :unit_amount, Float

data/lib/recurly/resources/tax_detail.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 TaxDetail < Resource
+
+      # @!attribute rate
+      #   @return [Float] Provides the tax rate for the region.
+      define_attribute :rate, Float
+
+      # @!attribute region
+      #   @return [String] Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code.
+      define_attribute :region, String
+
+      # @!attribute tax
+      #   @return [Float] The total tax applied for this tax type.
+      define_attribute :tax, Float
+
+      # @!attribute type
+      #   @return [String] Provides the tax type for the region. For Canadian Sales Tax, this will be GST, HST, QST or PST.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/tax_info.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
       define_attribute :region, String
 
+      # @!attribute tax_details
+      #   @return [Array[TaxDetail]] Provides additional tax details for 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 LineItem.
+      define_attribute :tax_details, Array, { :item_type => :TaxDetail }
+
       # @!attribute type
       #   @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
       define_attribute :type, String

data/lib/recurly/resources/transaction.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String] When processed, result from checking the overall AVS on the transaction.
       define_attribute :avs_check, String
 
+      # @!attribute backup_payment_method_used
+      #   @return [Boolean] Indicates if the transaction was completed using a backup payment
+      define_attribute :backup_payment_method_used, :Boolean
+
       # @!attribute billing_address
       #   @return [Address]
       define_attribute :billing_address, :Address
@@ -83,7 +87,7 @@ module Recurly
       define_attribute :invoice, :InvoiceMini
 
       # @!attribute ip_address_country
-      #   @return [String] IP address's country
+      #   @return [String] Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
       define_attribute :ip_address_country, String
 
       # @!attribute ip_address_v4

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.17.0"
+  VERSION = "3.19.0"
 end