recurly 3.9.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
@@ -34,6 +38,14 @@ module Recurly
       #   @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
@@ -61,6 +73,14 @@ module Recurly
       # @!attribute tiers
       #   @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
@@ -49,6 +57,10 @@ module Recurly
       # @!attribute tiers
       #   @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/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/subscription_add_on_create.rb

@@ -29,6 +29,10 @@ module Recurly
       # @!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

@@ -33,6 +33,10 @@ module Recurly
       # @!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

data/lib/recurly/requests/subscription_purchase.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [SubscriptionShippingPurchase] Create a shipping address on the account and assign it to the subscription.
       define_attribute :shipping, :SubscriptionShippingPurchase
 
+      # @!attribute starts_at
+      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      define_attribute :starts_at, DateTime
+
       # @!attribute total_billing_cycles
       #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer

data/lib/recurly/requests/usage_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 UsageCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      define_attribute :amount, Float
+
+      # @!attribute merchant_tag
+      #   @return [String] Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+      define_attribute :merchant_tag, String
+
+      # @!attribute recording_timestamp
+      #   @return [DateTime] When the usage was recorded in your system.
+      define_attribute :recording_timestamp, DateTime
+
+      # @!attribute usage_timestamp
+      #   @return [DateTime] When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
+      define_attribute :usage_timestamp, DateTime
+    end
+  end
+end

data/lib/recurly/resources/add_on.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.
       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.
       define_attribute :code, String
@@ -46,6 +50,10 @@ module Recurly
       #   @return [ItemMini] Just the important parts.
       define_attribute :item, :ItemMini
 
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for an measured unit associated with the add-on.
+      define_attribute :measured_unit_id, String
+
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.
       define_attribute :name, String
@@ -85,6 +93,14 @@ module Recurly
       # @!attribute updated_at
       #   @return [DateTime] Last updated at
       define_attribute :updated_at, DateTime
+
+      # @!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.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
     end
   end
 end

data/lib/recurly/resources/add_on_mini.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.
       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.
       define_attribute :code, String
@@ -26,6 +30,10 @@ module Recurly
       #   @return [String] Item ID
       define_attribute :item_id, String
 
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for an measured unit associated with the add-on.
+      define_attribute :measured_unit_id, String
+
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.
       define_attribute :name, String
@@ -33,6 +41,14 @@ module Recurly
       # @!attribute object
       #   @return [String] Object type
       define_attribute :object, 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.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
     end
   end
 end

data/lib/recurly/resources/measured_unit.rb

@@ -0,0 +1,46 @@
+# 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 MeasuredUnit < Resource
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Optional internal description.
+      define_attribute :description, String
+
+      # @!attribute display_name
+      #   @return [String] Display name for the measured unit. Can only contain spaces, underscores and must be alphanumeric.
+      define_attribute :display_name, String
+
+      # @!attribute id
+      #   @return [String] Item ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Unique internal name of the measured unit on your site.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute state
+      #   @return [String] The current state of the measured unit.
+      define_attribute :state, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/subscription_add_on.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :tier_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] Empty unless `tier_type` is `tiered`, `volume`, or `stairstep`.
+      #   @return [Array[SubscriptionAddOnTier]] If tiers are provided in the request, all existing tiers on the Subscription Add-on will be removed and replaced by the tiers in the request.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
@@ -57,6 +57,10 @@ module Recurly
       # @!attribute updated_at
       #   @return [DateTime] Updated at
       define_attribute :updated_at, DateTime
+
+      # @!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

data/lib/recurly/resources/subscription_change.rb

@@ -30,6 +30,10 @@ module Recurly
       #   @return [String] The ID of the Subscription Change.
       define_attribute :id, String
 
+      # @!attribute invoice_collection
+      #   @return [InvoiceCollection] Invoice Collection
+      define_attribute :invoice_collection, :InvoiceCollection
+
       # @!attribute object
       #   @return [String] Object type
       define_attribute :object, String

data/lib/recurly/resources/subscription_change_preview.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute invoice_collection
-      #   @return [InvoiceCollection] Invoice collection
+      #   @return [InvoiceCollection] Invoice Collection
       define_attribute :invoice_collection, :InvoiceCollection
 
       # @!attribute object

data/lib/recurly/resources/usage.rb

@@ -0,0 +1,62 @@
+# 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 Usage < Resource
+
+      # @!attribute amount
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      define_attribute :amount, Float
+
+      # @!attribute billed_at
+      #   @return [DateTime] When the usage record was billed on an invoice.
+      define_attribute :billed_at, DateTime
+
+      # @!attribute created_at
+      #   @return [DateTime] When the usage record was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute measured_unit_id
+      #   @return [String] The ID of the measured unit associated with the add-on the usage record is for.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute merchant_tag
+      #   @return [String] Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+      define_attribute :merchant_tag, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute recording_timestamp
+      #   @return [DateTime] When the usage was recorded in your system.
+      define_attribute :recording_timestamp, DateTime
+
+      # @!attribute tier_type
+      #   @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[SubscriptionAddOnTier]] The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = null
+      define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the usage record was billed on an invoice.
+      define_attribute :updated_at, DateTime
+
+      # @!attribute usage_timestamp
+      #   @return [DateTime] When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
+      define_attribute :usage_timestamp, DateTime
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
+    end
+  end
+end