recurly 3.5.0 → 3.10.0

data/lib/recurly/errors/api_errors.rb

@@ -4,38 +4,80 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Errors
-    class BadRequestError < Errors::APIError; end
+    ERROR_MAP = {
+      "500" => "InternalServerError",
+      "502" => "BadGatewayError",
+      "503" => "ServiceUnavailableError",
+      "304" => "NotModifiedError",
+      "400" => "BadRequestError",
+      "401" => "UnauthorizedError",
+      "402" => "PaymentRequiredError",
+      "403" => "ForbiddenError",
+      "404" => "NotFoundError",
+      "406" => "NotAcceptableError",
+      "412" => "PreconditionFailedError",
+      "422" => "UnprocessableEntityError",
+      "429" => "TooManyRequestsError",
+    }
 
-    class InternalServerError < Errors::APIError; end
+    class ResponseError < Errors::APIError; end
 
-    class ImmutableSubscriptionError < Errors::APIError; end
+    class ServerError < ResponseError; end
 
-    class InvalidApiKeyError < Errors::APIError; end
+    class InternalServerError < ServerError; end
 
-    class InvalidApiVersionError < Errors::APIError; end
+    class BadGatewayError < ServerError; end
 
-    class InvalidContentTypeError < Errors::APIError; end
+    class ServiceUnavailableError < ServerError; end
 
-    class InvalidPermissionsError < Errors::APIError; end
+    class RedirectionError < ResponseError; end
 
-    class InvalidTokenError < Errors::APIError; end
+    class NotModifiedError < ResponseError; end
 
-    class NotFoundError < Errors::APIError; end
+    class ClientError < Errors::APIError; end
 
-    class SimultaneousRequestError < Errors::APIError; end
+    class BadRequestError < ClientError; end
 
-    class TransactionError < Errors::APIError; end
+    class InvalidContentTypeError < BadRequestError; end
 
-    class UnauthorizedError < Errors::APIError; end
+    class UnauthorizedError < ClientError; end
 
-    class UnavailableInApiVersionError < Errors::APIError; end
+    class PaymentRequiredError < ClientError; end
 
-    class UnknownApiVersionError < Errors::APIError; end
+    class ForbiddenError < ClientError; end
 
-    class ValidationError < Errors::APIError; end
+    class InvalidApiKeyError < ForbiddenError; end
 
-    class MissingFeatureError < Errors::APIError; end
+    class InvalidPermissionsError < ForbiddenError; end
 
-    class RateLimitedError < Errors::APIError; end
+    class NotFoundError < ClientError; end
+
+    class NotAcceptableError < ClientError; end
+
+    class UnknownApiVersionError < NotAcceptableError; end
+
+    class UnavailableInApiVersionError < NotAcceptableError; end
+
+    class InvalidApiVersionError < NotAcceptableError; end
+
+    class PreconditionFailedError < ClientError; end
+
+    class UnprocessableEntityError < ClientError; end
+
+    class ValidationError < UnprocessableEntityError; end
+
+    class MissingFeatureError < UnprocessableEntityError; end
+
+    class TransactionError < UnprocessableEntityError; end
+
+    class SimultaneousRequestError < UnprocessableEntityError; end
+
+    class ImmutableSubscriptionError < UnprocessableEntityError; end
+
+    class InvalidTokenError < UnprocessableEntityError; end
+
+    class TooManyRequestsError < ClientError; end
+
+    class RateLimitedError < TooManyRequestsError; end
   end
 end

data/lib/recurly/requests/add_on_create.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
       define_attribute :accounting_code, String
 
+      # @!attribute add_on_type
+      #   @return [String] Whether the add-on type is fixed, or usage-based.
+      define_attribute :add_on_type, String
+
       # @!attribute code
       #   @return [String] The unique identifier for the add-on within its plan. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
       define_attribute :code, String
@@ -27,13 +31,21 @@ module Recurly
       define_attribute :display_quantity, :Boolean
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item. Avaliable when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @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.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] System-generated unique identifier for an item. Available when the `Catalog: Item Add-Ons` feature is 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` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_id, String
 
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute measured_unit_name
+      #   @return [String] Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+      define_attribute :measured_unit_name, String
+
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name` is required.
       define_attribute :name, String
@@ -55,12 +67,20 @@ module Recurly
       define_attribute :tax_code, String
 
       # @!attribute tier_type
-      #   @return [String] The type of tiering used by the Add-on.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based).
       define_attribute :tier_type, String
 
       # @!attribute tiers
-      #   @return [Array[Tier]] At least one tier is required if `tier_type` is not 'flat'.
+      #   @return [Array[Tier]] If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
       define_attribute :tiers, Array, { :item_type => :Tier }
+
+      # @!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.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, required if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
     end
   end
 end

data/lib/recurly/requests/add_on_update.rb

@@ -30,6 +30,14 @@ module Recurly
       #   @return [String] Add-on ID
       define_attribute :id, String
 
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute measured_unit_name
+      #   @return [String] Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
+      define_attribute :measured_unit_name, String
+
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
       define_attribute :name, String
@@ -47,8 +55,12 @@ module Recurly
       define_attribute :tax_code, String
 
       # @!attribute tiers
-      #   @return [Array[Tier]] If tiers are provided in the request, all existing tiers on the Add-on will be removed and replaced by the tiers in the request.
+      #   @return [Array[Tier]] If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
       define_attribute :tiers, Array, { :item_type => :Tier }
+
+      # @!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.
+      define_attribute :usage_percentage, Float
     end
   end
 end

data/lib/recurly/requests/billing_info_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class BillingInfoCreate < Request
 
       # @!attribute account_number
-      #   @return [String] The bank account number. (ACH only)
+      #   @return [String] The bank account number. (ACH, Bacs only)
       define_attribute :account_number, String
 
       # @!attribute account_type
@@ -63,7 +63,7 @@ module Recurly
       define_attribute :month, String
 
       # @!attribute name_on_account
-      #   @return [String] The name associated with the bank account.
+      #   @return [String] The name associated with the bank account (ACH, SEPA, Bacs only)
       define_attribute :name_on_account, String
 
       # @!attribute number
@@ -78,18 +78,26 @@ module Recurly
       #   @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 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
 
       # @!attribute token_id
-      #   @return [String] A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).
+      #   @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
       define_attribute :token_id, String
 
       # @!attribute transaction_type
       #   @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/external_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 Requests
+    class ExternalTransaction < Request
+
+      # @!attribute amount
+      #   @return [Float] The total amount of the transcaction. Cannot excceed the invoice total.
+      define_attribute :amount, Float
+
+      # @!attribute collected_at
+      #   @return [DateTime] Datetime that the external payment was collected. Defaults to current datetime.
+      define_attribute :collected_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Used as the transaction's description.
+      define_attribute :description, String
+
+      # @!attribute payment_method
+      #   @return [String] Payment method used for the external transaction.
+      define_attribute :payment_method, String
+    end
+  end
+end

data/lib/recurly/requests/measured_unit_create.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 Requests
+    class MeasuredUnitCreate < Request
+
+      # @!attribute description
+      #   @return [String] Optional internal description.
+      define_attribute :description, String
+
+      # @!attribute display_name
+      #   @return [String] Display name for the measured unit.
+      define_attribute :display_name, String
+
+      # @!attribute name
+      #   @return [String] Unique internal name of the measured unit on your site.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/requests/measured_unit_update.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 Requests
+    class MeasuredUnitUpdate < Request
+
+      # @!attribute description
+      #   @return [String] Optional internal description.
+      define_attribute :description, String
+
+      # @!attribute display_name
+      #   @return [String] Display name for the measured unit.
+      define_attribute :display_name, String
+
+      # @!attribute name
+      #   @return [String] Unique internal name of the measured unit on your site.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/requests/plan_create.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [Array[AddOnCreate]] Add Ons
       define_attribute :add_ons, Array, { :item_type => :AddOnCreate }
 
+      # @!attribute allow_any_item_on_subscriptions
+      #   @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+      define_attribute :allow_any_item_on_subscriptions, :Boolean
+
       # @!attribute auto_renew
       #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
       define_attribute :auto_renew, :Boolean
@@ -74,6 +78,10 @@ module Recurly
       #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
       define_attribute :trial_length, Integer
 
+      # @!attribute trial_requires_billing_info
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+      define_attribute :trial_requires_billing_info, :Boolean
+
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
       define_attribute :trial_unit, String

data/lib/recurly/requests/plan_update.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [Array[AddOnCreate]] Add Ons
       define_attribute :add_ons, Array, { :item_type => :AddOnCreate }
 
+      # @!attribute allow_any_item_on_subscriptions
+      #   @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+      define_attribute :allow_any_item_on_subscriptions, :Boolean
+
       # @!attribute auto_renew
       #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
       define_attribute :auto_renew, :Boolean
@@ -70,6 +74,10 @@ module Recurly
       #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
       define_attribute :trial_length, Integer
 
+      # @!attribute trial_requires_billing_info
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
+      define_attribute :trial_requires_billing_info, :Boolean
+
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
       define_attribute :trial_unit, String

data/lib/recurly/requests/shipping_method_create.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 Requests
+    class ShippingMethodCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for shipping method.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are:  - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+      define_attribute :tax_code, String
+    end
+  end
+end

data/lib/recurly/requests/shipping_method_update.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 Requests
+    class ShippingMethodUpdate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for shipping method.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are:  - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+      define_attribute :tax_code, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -6,8 +6,12 @@ module Recurly
   module Requests
     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.
+      define_attribute :add_on_source, String
+
       # @!attribute code
-      #   @return [String] Add-on code
+      #   @return [String] If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
       define_attribute :code, String
 
       # @!attribute quantity
@@ -19,12 +23,16 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent.
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
       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.
       define_attribute :unit_amount, Float
+
+      # @!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.
+      define_attribute :usage_percentage, Float
     end
   end
 end

data/lib/recurly/requests/subscription_add_on_update.rb

@@ -6,12 +6,16 @@ module Recurly
   module Requests
     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.
+      define_attribute :add_on_source, String
+
       # @!attribute code
-      #   @return [String] Add-on code
+      #   @return [String] If a code is provided without an id, the subscription add-on attributes will be set to the current value for those attributes on the plan add-on unless provided in the request. If `add_on_source` is set to `plan_add_on` or left blank, then plan's add-on `code` should be used. If `add_on_source` is set to `item`, then the `code` from the associated item should be used.
       define_attribute :code, String
 
       # @!attribute id
-      #   @return [String] Set this to include or modify an existing subscription add-on.
+      #   @return [String] When an id is provided, the existing subscription add-on attributes will persist unless overridden in the request.
       define_attribute :id, String
 
       # @!attribute quantity
@@ -23,12 +27,16 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent.
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier with an `ending_quantity` of 999999999 which is the default if not provided.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
       #   @return [Float] Optionally, override the add-on's default unit amount.
       define_attribute :unit_amount, Float
+
+      # @!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
     end
   end
 end