recurly 3.16.0 → 4.0.1

data/lib/recurly/errors.rb

@@ -21,34 +21,17 @@ module Recurly
       # Error class based on the response code. This may occur when a load balancer
       # returns an error before it reaches Recurly's API.
       # @param response [Net::Response]
-      # @return [Errors::APIError,Errors::NetworkError]
-      # rubocop:disable Metrics/CyclomaticComplexity
+      # @return [Errors::APIError]
       def self.from_response(response)
-        case response
-        when Net::HTTPBadRequest # 400
-          Recurly::Errors::BadRequestError
-        when Net::HTTPUnauthorized, Net::HTTPForbidden # 401, 403
-          Recurly::Errors::UnauthorizedError
-        when Net::HTTPRequestTimeOut # 408
-          Recurly::Errors::TimeoutError
-        when Net::HTTPTooManyRequests # 429
-          Recurly::Errors::RateLimitedError
-        when Net::HTTPInternalServerError # 500
-          Recurly::Errors::InternalServerError
-        when Net::HTTPServiceUnavailable # 503
-          Recurly::Errors::UnavailableError
-        when Net::HTTPGatewayTimeOut # 504
-          Recurly::Errors::TimeoutError
-        when Net::HTTPServerError # 5xx
-          Recurly::Errors::UnavailableError
+        if Recurly::Errors::ERROR_MAP.has_key?(response.code)
+          Recurly::Errors.const_get(Recurly::Errors::ERROR_MAP[response.code])
         else
           Recurly::Errors::APIError
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
-      def initialize(response, error)
-        super(error.message)
+      def initialize(message, response = nil, error = nil)
+        super(message)
         @response = response
         @recurly_error = error
       end
@@ -64,5 +47,4 @@ module Recurly
   end
 
   require_relative "./errors/api_errors"
-  require_relative "./errors/network_errors"
 end

data/lib/recurly/errors/api_errors.rb

@@ -8,6 +8,7 @@ module Recurly
       "500" => "InternalServerError",
       "502" => "BadGatewayError",
       "503" => "ServiceUnavailableError",
+      "504" => "TimeoutError",
       "304" => "NotModifiedError",
       "400" => "BadRequestError",
       "401" => "UnauthorizedError",
@@ -32,6 +33,8 @@ module Recurly
 
     class ServiceUnavailableError < ServerError; end
 
+    class TimeoutError < ServerError; end
+
     class RedirectionError < ResponseError; end
 
     class NotModifiedError < ResponseError; end

data/lib/recurly/pager.rb

@@ -6,7 +6,7 @@ module Recurly
     def initialize(client:, path:, options: {})
       @client = client
       @path = path
-      @options = map_array_params(options)
+      @options = options
       rewind!
     end
 
@@ -16,7 +16,7 @@ module Recurly
       # Modify the @next url to set the :limit to 1
       original_next = @next
       @next = @path
-      fetch_next!(@options.merge(limit: 1))
+      fetch_next!(@options.merge(params: @options.fetch(:params, {}).merge({ limit: 1 })))
       # Restore the @next url to the original
       @next = original_next
       @data.first
@@ -24,7 +24,7 @@ module Recurly
 
     # Makes a HEAD request to the API to determine how many total records exist.
     def count
-      resource = @client.send(:head, self.next, @options)
+      resource = @client.send(:head, self.next, **@options)
       resource.get_response.total_records
     end
 
@@ -103,7 +103,7 @@ module Recurly
       Enumerator.new do |yielder|
         loop do
           # Pass in @options when requesting the first page (@data.empty?)
-          next_options = @data.empty? ? @options : {}
+          next_options = @data.empty? ? @options : @options.merge(params: {})
           fetch_next!(next_options)
           yielder << data
           unless has_more?
@@ -116,7 +116,7 @@ module Recurly
 
     def fetch_next!(options)
       path = extract_path(self.next)
-      page = @client.send(:get, path, options)
+      page = @client.send(:get, path, **options)
       @data = page.data.map { |d| JSONParser.from_json(d) }
       @has_more = page.has_more
       @next = page.next
@@ -132,15 +132,5 @@ module Recurly
       uri = URI(uri_or_path)
       uri.kind_of?(URI::HTTP) ? uri.request_uri : uri_or_path
     end
-
-    # Converts array parameters to CSV strings to maintain consistency with
-    # how the server expects the request to be formatted while providing the
-    # developer with an array type to maintain developer happiness!
-    def map_array_params(params)
-      @options = params.map do |key, param|
-        new_param = param.is_a?(Array) ? param.join(",") : param
-        [key, new_param]
-      end.to_h
-    end
   end
 end

data/lib/recurly/requests/{account_acquisition_updatable.rb → account_acquisition_update.rb}

@@ -4,7 +4,7 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Requests
-    class AccountAcquisitionUpdatable < Request
+    class AccountAcquisitionUpdate < Request
 
       # @!attribute campaign
       #   @return [String] An arbitrary identifier for the marketing campaign that led to the acquisition of this account.

data/lib/recurly/requests/account_create.rb

@@ -7,8 +7,8 @@ module Recurly
     class AccountCreate < Request
 
       # @!attribute acquisition
-      #   @return [AccountAcquisitionUpdatable]
-      define_attribute :acquisition, :AccountAcquisitionUpdatable
+      #   @return [AccountAcquisitionUpdate]
+      define_attribute :acquisition, :AccountAcquisitionUpdate
 
       # @!attribute address
       #   @return [Address]

data/lib/recurly/requests/account_purchase.rb

@@ -7,8 +7,8 @@ module Recurly
     class AccountPurchase < Request
 
       # @!attribute acquisition
-      #   @return [AccountAcquisitionUpdatable]
-      define_attribute :acquisition, :AccountAcquisitionUpdatable
+      #   @return [AccountAcquisitionUpdate]
+      define_attribute :acquisition, :AccountAcquisitionUpdate
 
       # @!attribute address
       #   @return [Address]

data/lib/recurly/requests/add_on_create.rb

@@ -27,7 +27,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent.
+      #   @return [Array[AddOnPricing]] * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent. * Must be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
@@ -39,7 +39,7 @@ module Recurly
       define_attribute :display_quantity, :Boolean
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Avaliable 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` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_code, String
 
       # @!attribute item_id

data/lib/recurly/requests/add_on_pricing.rb

@@ -11,8 +11,12 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute unit_amount
-      #   @return [Float] Unit price
+      #   @return [Float] Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
       define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
     end
   end
 end

data/lib/recurly/requests/add_on_update.rb

@@ -23,7 +23,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] If the add-on's `tier_type` is `tiered`, `volume` or `stairstep`, then `currencies` must be absent.
+      #   @return [Array[AddOnPricing]] If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then currencies must be absent. Must also be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
@@ -55,7 +55,7 @@ module Recurly
       define_attribute :optional, :Boolean
 
       # @!attribute revenue_schedule_type
-      #   @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If an `Item` is associated to the `AddOn` then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+      #   @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tax_code

data/lib/recurly/requests/address.rb

@@ -14,14 +14,6 @@ module Recurly
       #   @return [String] Country, 2-letter ISO 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 phone
       #   @return [String] Phone number
       define_attribute :phone, String

data/lib/recurly/requests/billing_info_create.rb

@@ -6,14 +6,6 @@ module Recurly
   module Requests
     class BillingInfoCreate < Request
 
-      # @!attribute account_number
-      #   @return [String] The bank account number. (ACH, Bacs only)
-      define_attribute :account_number, String
-
-      # @!attribute account_type
-      #   @return [String] The bank account type. (ACH only)
-      define_attribute :account_type, String
-
       # @!attribute address
       #   @return [Address]
       define_attribute :address, :Address
@@ -47,7 +39,7 @@ module Recurly
       define_attribute :gateway_token, String
 
       # @!attribute iban
-      #   @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. (SEPA only)
+      #   @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information
       define_attribute :iban, String
 
       # @!attribute ip_address
@@ -62,10 +54,6 @@ module Recurly
       #   @return [String] Expiration month
       define_attribute :month, String
 
-      # @!attribute name_on_account
-      #   @return [String] The name associated with the bank account (ACH, SEPA, Bacs only)
-      define_attribute :name_on_account, String
-
       # @!attribute number
       #   @return [String] Credit card number, spaces and dashes are accepted.
       define_attribute :number, String
@@ -78,14 +66,6 @@ module Recurly
       #   @return [Boolean] The `primary_payment_method` indicator is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` indicator. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
       define_attribute :primary_payment_method, :Boolean
 
-      # @!attribute routing_number
-      #   @return [String] The bank's rounting number. (ACH only)
-      define_attribute :routing_number, String
-
-      # @!attribute sort_code
-      #   @return [String] Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
-      define_attribute :sort_code, String
-
       # @!attribute tax_identifier
       #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.
       define_attribute :tax_identifier, String
@@ -106,10 +86,6 @@ module Recurly
       #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
       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)
-      define_attribute :type, String
-
       # @!attribute vat_number
       #   @return [String] VAT number
       define_attribute :vat_number, String

data/lib/recurly/requests/coupon_create.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :applies_to_all_items, :Boolean
 
       # @!attribute applies_to_all_plans
-      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
       define_attribute :applies_to_all_plans, :Boolean
 
       # @!attribute applies_to_non_plan_charges

data/lib/recurly/requests/coupon_redemption_create.rb

@@ -13,6 +13,10 @@ module Recurly
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
+
+      # @!attribute subscription_id
+      #   @return [String] Subscription ID
+      define_attribute :subscription_id, String
     end
   end
 end

data/lib/recurly/requests/external_transaction.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :description, String
 
       # @!attribute payment_method
-      #   @return [String] Payment method used for the external transaction.
+      #   @return [String] Payment method used for external transaction.
       define_attribute :payment_method, String
     end
   end

data/lib/recurly/requests/{invoice_updatable.rb → invoice_update.rb}

@@ -4,7 +4,7 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Requests
-    class InvoiceUpdatable < Request
+    class InvoiceUpdate < Request
 
       # @!attribute address
       #   @return [InvoiceAddress]

data/lib/recurly/requests/line_item_create.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Avaliable when the Credit Invoices and Subscription Billing Terms features are enabled.
+      #   @return [String] Unique code to identify an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id

data/lib/recurly/requests/purchase_create.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [AccountPurchase]
       define_attribute :account, :AccountPurchase
 
+      # @!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.
+      define_attribute :billing_info_id, String
+
       # @!attribute collection_method
       #   @return [String] Must be set to manual in order to preview a purchase for an Account that does not have payment information associated with the Billing Info.
       define_attribute :collection_method, String

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionAddOnCreate < Request
 
       # @!attribute add_on_source
-      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add_on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
       define_attribute :add_on_source, String
 
       # @!attribute code
@@ -27,9 +27,13 @@ module Recurly
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
-      #   @return [Float] * Optionally, override the add-on's default unit amount. * If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` must be absent.
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places.  Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute usage_percentage
       #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
       define_attribute :usage_percentage, Float

data/lib/recurly/requests/subscription_add_on_tier.rb

@@ -11,8 +11,12 @@ module Recurly
       define_attribute :ending_quantity, Integer
 
       # @!attribute unit_amount
-      #   @return [Float] Unit amount
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
       define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places.  Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
     end
   end
 end

data/lib/recurly/requests/subscription_add_on_update.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionAddOnUpdate < Request
 
       # @!attribute add_on_source
-      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add_on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
+      #   @return [String] Used to determine where the associated add-on data is pulled from. If this value is set to `plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated `plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then the associated add-on data will be pulled from the site's item catalog.
       define_attribute :add_on_source, String
 
       # @!attribute code
@@ -31,9 +31,13 @@ module Recurly
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
-      #   @return [Float] Optionally, override the add-on's default unit amount.
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` cannot be provided.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Optionally, override the add-on's default unit amount. If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount_decimal` cannot be provided. Only supported when the plan add-on's `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute usage_percentage
       #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
       define_attribute :usage_percentage, Float

data/lib/recurly/requests/subscription_change_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionChangeCreate < Request
 
       # @!attribute add_ons
-      #   @return [Array[SubscriptionAddOnUpdate]] If this value is omitted your existing add-ons will be removed. If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on's ID: `{"id": "abc123"}`.  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
+      #   @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.'  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
 
       # @!attribute collection_method

data/lib/recurly/requests/subscription_create.rb

@@ -18,13 +18,17 @@ module Recurly
       #   @return [Boolean] Whether the subscription renews at the end of its term.
       define_attribute :auto_renew, :Boolean
 
+      # @!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.
+      define_attribute :billing_info_id, String
+
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String
 
-      # @!attribute coupon_code
-      #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
-      define_attribute :coupon_code, String
+      # @!attribute coupon_codes
+      #   @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+      define_attribute :coupon_codes, Array, { :item_type => String }
 
       # @!attribute credit_customer_notes
       #   @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.