recurly 4.11.0 → 4.14.0

data/lib/recurly/client.rb

@@ -11,7 +11,11 @@ module Recurly
   class Client
     require_relative "./client/operations"
 
-    BASE_URL = "https://v3.recurly.com"
+    API_HOSTS = {
+      us: "https://v3.recurly.com",
+      eu: "https://v3.eu.recurly.com",
+    }
+    REGION = :us
     CA_FILE = File.join(File.dirname(__FILE__), "../data/ca-certificates.crt")
     BINARY_TYPES = [
       "application/pdf",
@@ -52,13 +56,18 @@ module Recurly
     #   client = Recurly::Client.new(api_key: API_KEY2)
     #   sub = client.get_subscription(subscription_id: 'uuid-abcd7890')
     #
+    # @param region [String] The DataCenter that is called by the API. Default to "us"
     # @param base_url [String] The base URL for the API. Defaults to "https://v3.recurly.com"
     # @param ca_file [String] The CA bundle to use when connecting to the API. Defaults to "data/ca-certificates.crt"
     # @param api_key [String] The private API key
     # @param logger [Logger] A logger to use. Defaults to creating a new STDOUT logger with level WARN.
-    def initialize(base_url: BASE_URL, ca_file: CA_FILE, api_key:, logger: nil)
+    def initialize(region: REGION, base_url: API_HOSTS[:us], ca_file: CA_FILE, api_key:, logger: nil)
       raise ArgumentError, "'api_key' must be set to a non-nil value" if api_key.nil?
 
+      raise ArgumentError, "Invalid region type. Expected one of: #{API_HOSTS.keys.join(", ")}" if !API_HOSTS.key?(region)
+
+      base_url = API_HOSTS[region] if base_url == API_HOSTS[:us] && API_HOSTS.key?(region)
+
       set_api_key(api_key)
       set_connection_options(base_url, ca_file)
 
@@ -110,7 +119,9 @@ module Recurly
 
     def get(path, **options)
       validate_options!(**options)
+
       request = Net::HTTP::Get.new build_url(path, options)
+
       set_headers(request, options[:headers])
       http_response = run_request(request, options)
       handle_response! request, http_response
@@ -168,6 +179,7 @@ module Recurly
 
         begin
           http.start unless http.started?
+
           log_attrs = {
             method: request.method,
             path: request.path,

data/lib/recurly/errors/api_errors.rb

@@ -29,6 +29,8 @@ module Recurly
 
     class ServiceNotAvailableError < InternalServerError; end
 
+    class TaxServiceError < InternalServerError; end
+
     class BadGatewayError < ServerError; end
 
     class ServiceUnavailableError < ServerError; end

data/lib/recurly/requests/account_create.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute email
@@ -54,6 +54,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      define_attribute :invoice_template_id, String
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/account_purchase.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute email
@@ -58,6 +58,10 @@ module Recurly
       #   @return [String] Optional, but if present allows an existing account to be used and updated as part of the purchase.
       define_attribute :id, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      define_attribute :invoice_template_id, String
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/account_update.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute email
@@ -46,6 +46,10 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template.  Available when the Invoice Customization feature is enabled.  Used to specify which invoice template, if any, should be used to generate invoices for the account.
+      define_attribute :invoice_template_id, String
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/requests/add_on_create.rb

@@ -39,11 +39,11 @@ module Recurly
       define_attribute :display_quantity, :Boolean
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Available when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] Unique code to identify an item. Available when the `Credit Invoices` feature are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       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. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_id, String
 
       # @!attribute measured_unit_id

data/lib/recurly/requests/billing_info_create.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] *STRONGLY RECOMMENDED*
       define_attribute :cvv, String
 
+      # @!attribute external_hpp_type
+      #   @return [String] Use for Adyen HPP billing info.
+      define_attribute :external_hpp_type, String
+
       # @!attribute first_name
       #   @return [String] First name
       define_attribute :first_name, String
@@ -74,6 +78,10 @@ module Recurly
       #   @return [String] Credit card number, spaces and dashes are accepted.
       define_attribute :number, String
 
+      # @!attribute online_banking_payment_type
+      #   @return [String] Use for Online Banking billing info.
+      define_attribute :online_banking_payment_type, String
+
       # @!attribute paypal_billing_agreement_id
       #   @return [String] PayPal billing agreement ID
       define_attribute :paypal_billing_agreement_id, String
@@ -111,7 +119,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute type
-      #   @return [String] The payment method type for a non-credit card based billing info. The value of `bacs` is the only accepted value (Bacs only)
+      #   @return [String] The payment method type for a non-credit card based billing info. `bacs` and `becs` are the only accepted values.
       define_attribute :type, String
 
       # @!attribute vat_number

data/lib/recurly/requests/line_item_create.rb

@@ -35,11 +35,11 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!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 origin

data/lib/recurly/requests/plan_create.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

data/lib/recurly/requests/plan_update.rb

@@ -39,7 +39,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

data/lib/recurly/requests/subscription_add_on_tier.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :unit_amount_decimal, String
 
       # @!attribute usage_percentage
-      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
+      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers subscription add ons. Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/requests/tier.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :ending_quantity, Integer
 
       # @!attribute usage_percentage
-      #   @return [String] Decimal usage percentage.
+      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers add ons. Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/account.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :deleted_at, DateTime
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute email
@@ -90,6 +90,10 @@ module Recurly
       #   @return [String]
       define_attribute :id, String
 
+      # @!attribute invoice_template_id
+      #   @return [String] Unique ID to identify an invoice template. Available when the Invoice Customization feature is enabled. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
+      define_attribute :invoice_template_id, String
+
       # @!attribute last_name
       #   @return [String]
       define_attribute :last_name, String

data/lib/recurly/resources/account_mini.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
       define_attribute :dunning_campaign_id, String
 
       # @!attribute email

data/lib/recurly/resources/add_on.rb

@@ -74,6 +74,10 @@ module Recurly
       #   @return [Boolean] Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
       define_attribute :optional, :Boolean
 
+      # @!attribute percentage_tiers
+      #   @return [Array[PercentageTiersByCurrency]] Percentage Tiers
+      define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
+
       # @!attribute plan_id
       #   @return [String] Plan ID
       define_attribute :plan_id, String

data/lib/recurly/resources/invoice.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :due_at, DateTime
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. Available when the Dunning Campaigns feature is enabled. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+      #   @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
@@ -146,6 +146,10 @@ module Recurly
       #   @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

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

@@ -67,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
@@ -83,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/percentage_tier.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 PercentageTier < Resource
+
+      # @!attribute ending_amount
+      #   @return [Float] Ending amount for the tier. Allows up to 2 decimal places. The last tier ending_amount is null.
+      define_attribute :ending_amount, Float
+
+      # @!attribute usage_percentage
+      #   @return [String] Decimal usage percentage.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/resources/percentage_tiers_by_currency.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 PercentageTiersByCurrency < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute tiers
+      #   @return [Array[PercentageTier]] Tiers
+      define_attribute :tiers, Array, { :item_type => :PercentageTier }
+    end
+  end
+end

data/lib/recurly/resources/plan.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute dunning_campaign_id
-      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. 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.
+      #   @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

data/lib/recurly/resources/subscription_add_on.rb

@@ -30,6 +30,10 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute percentage_tiers
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request.
+      define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
+
       # @!attribute quantity
       #   @return [Integer] Add-on quantity
       define_attribute :quantity, Integer

data/lib/recurly/resources/subscription_add_on_percentage_tier.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 SubscriptionAddOnPercentageTier < Resource
+
+      # @!attribute ending_amount
+      #   @return [Float] Ending amount
+      define_attribute :ending_amount, Float
+
+      # @!attribute usage_percentage
+      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/resources/subscription_add_on_tier.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :unit_amount_decimal, String
 
       # @!attribute usage_percentage
-      #   @return [String] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places represented as a string. A value between 0.0 and 100.0. Optionally, override tiers' default usage percentage. Required if add-on's `add_on_type` is `usage` and `usage_type` is `percentage`. Must be omitted otherwise.
+      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers subscription add ons. Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/resources/tier.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :ending_quantity, Integer
 
       # @!attribute usage_percentage
-      #   @return [String] Decimal usage percentage.
+      #   @return [String] This field is deprecated. Do not used it anymore for percentage tiers add ons. Use the percentage_tiers object instead.
       define_attribute :usage_percentage, String
     end
   end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.11.0"
+  VERSION = "4.14.0"
 end