recurly 4.23.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3425e11a326e6886fe09606f3cd02f155ded5fb774f639d20f47f2a4def65f3
-  data.tar.gz: 39d0917188e796d37e7179a86e78427dab022cf94ea3d6c13b734153d54f2b0c
+  metadata.gz: 83cc9874a222552398eccba8e97f844e448644398831199e20e9eeb09d91443a
+  data.tar.gz: dab0e9563f9771f46d4be709e33394305f8c59bc77fa2cd4394106cef1edd8a6
 SHA512:
-  metadata.gz: c06705fdd51268f7f1a298dc6b92ab65c4a972106d32d2e7909ac6852d780ab0024170da9c0f028d43695fe17706371684f93366217bbf3577fd9e1200068854
-  data.tar.gz: 63565f407525519ff2594677070a394675c7500d03565d704c0bd07e4ef7afa94ffb2d9839efd07f527bc65fc9979090d4ab4cf1166d988d7879fcbb757576e9
+  metadata.gz: beeb8fd85be7c0b63d7f2ab7c786684e774d731a3d3f501aba66428bb6de7e58c79fd0e4ab6786790e58195cd675c286f259bb98cb0652366a0ab49b885fed11
+  data.tar.gz: a2bb85d2f395c94dbe172aabbc281d0e30f6ffd034d85368616a2a921cee68fc6836ae75dbb023299edc2b8b4d31a61f382d9e43e6f130e10a9130bd5d7a2148

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.23.0
+current_version = 4.25.0
 parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [4.25.0](https://github.com/recurly/recurly-client-ruby/tree/4.25.0) (2022-11-15)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.24.0...4.25.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (External Subscriptions feature) [#809](https://github.com/recurly/recurly-client-ruby/pull/809) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#807](https://github.com/recurly/recurly-client-ruby/pull/807) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.24.0](https://github.com/recurly/recurly-client-ruby/tree/4.24.0) (2022-11-03)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.23.0...4.24.0)
+
+
+
+
+
 ## [4.23.0](https://github.com/recurly/recurly-client-ruby/tree/4.23.0) (2022-10-27)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.22.0...4.23.0)

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 4.23'
+gem 'recurly', '~> 4.25'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.

data/lib/recurly/client/operations.rb

@@ -588,7 +588,7 @@ module Recurly
       delete(path, **options)
     end
 
-    # Show the coupon redemptions for an account
+    # List the coupon redemptions for an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
     #
@@ -636,7 +636,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the coupon redemptions that are active on an account
+    # List the coupon redemptions that are active on an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documentation}
     #
@@ -950,7 +950,7 @@ module Recurly
       post(path, body, Requests::LineItemCreate, **options)
     end
 
-    # Fetch a list of an account's notes
+    # List an account's notes
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documentation}
     #
@@ -2046,6 +2046,68 @@ module Recurly
       delete(path, **options)
     end
 
+    # List a site's external products
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_products list_external_products api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #
+    # @return [Pager<Resources::ExternalProduct>] A list of the the external_products on a site.
+    #
+    def list_external_products(**options)
+      path = "/external_products"
+      pager(path, **options)
+    end
+
+    # Fetch an external product
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_product get_external_product api documentation}
+    #
+    # @param external_product_id [String] External product id
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalProduct] Settings for an external product.
+    #
+    def get_external_product(external_product_id:, **options)
+      path = interpolate_path("/external_products/{external_product_id}", external_product_id: external_product_id)
+      get(path, **options)
+    end
+
+    # List a site's external subscriptions
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_external_subscriptions list_external_subscriptions api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #
+    # @return [Pager<Resources::ExternalSubscription>] A list of the the external_subscriptions on a site.
+    #
+    def list_external_subscriptions(**options)
+      path = "/external_subscriptions"
+      pager(path, **options)
+    end
+
+    # Fetch an external subscription
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_external_subscription get_external_subscription api documentation}
+    #
+    # @param external_subscription_id [String] External subscription id
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::ExternalSubscription] Settings for an external subscription.
+    #
+    def get_external_subscription(external_subscription_id:, **options)
+      path = interpolate_path("/external_subscriptions/{external_subscription_id}", external_subscription_id: external_subscription_id)
+      get(path, **options)
+    end
+
     # List a site's invoices
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoices list_invoices api documentation}
@@ -2357,7 +2419,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the coupon redemptions applied to an invoice
+    # List the coupon redemptions applied to an invoice
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
     #
@@ -3586,7 +3648,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the coupon redemptions for a subscription
+    # List the coupon redemptions for a subscription
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
     #
@@ -4015,7 +4077,7 @@ module Recurly
       get(path, **options)
     end
 
-    # Show the dunning campaigns for a site
+    # List the dunning campaigns for a site
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
     #
@@ -4032,7 +4094,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the settings for a dunning campaign
+    # Fetch a dunning campaign
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation}
     #
@@ -4078,7 +4140,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the settings for an invoice template
+    # Fetch an invoice template
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_template get_invoice_template api documentation}
     #
@@ -4092,7 +4154,7 @@ module Recurly
       get(path, **options)
     end
 
-    # Show all entitlements granted to an account
+    # List entitlements granted to an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}
     #
@@ -4110,5 +4172,23 @@ module Recurly
       path = interpolate_path("/accounts/{account_id}/entitlements", account_id: account_id)
       pager(path, **options)
     end
+
+    # List an account's external subscriptions
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_external_subscriptions list_account_external_subscriptions api documentation}
+    #
+    # @param account_id [String] Account ID or code. For ID no prefix is used e.g. +e28zov4fw0v2+. For code use prefix +code-+, e.g. +code-bob+.
+    # @param params [Hash] Optional query string parameters:
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #
+    # @return [Pager<Resources::ExternalSubscription>] A list of the the external_subscriptions on an account.
+    #
+    def list_account_external_subscriptions(account_id:, **options)
+      path = interpolate_path("/accounts/{account_id}/external_subscriptions", account_id: account_id)
+      pager(path, **options)
+    end
   end
 end

data/lib/recurly/errors/webhooks_errors.rb

@@ -0,0 +1,5 @@
+module Recurly
+  module Errors
+    class SignatureVerificationError < StandardError; end
+  end
+end

data/lib/recurly/errors.rb

@@ -48,4 +48,5 @@ module Recurly
 
   require_relative "./errors/api_errors"
   require_relative "./errors/network_errors"
+  require_relative "./errors/webhooks_errors"
 end

data/lib/recurly/requests/add_on_create.rb

@@ -79,13 +79,17 @@ module Recurly
       define_attribute :tax_code, String
 
       # @!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). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!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 without an `ending_quantity` value which represents the final tier.
       define_attribute :tiers, Array, { :item_type => :Tier }
 
+      # @!attribute usage_calculation_type
+      #   @return [String] The type of calculation to be employed for an add-on.  Cumulative billing will sum all usage records created in the current billing cycle.  Last-in-period billing will apply only the most recent usage record in the billing period.  If no value is specified, cumulative billing will be used.
+      define_attribute :usage_calculation_type, 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, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
       define_attribute :usage_percentage, Float
@@ -95,7 +99,7 @@ module Recurly
       define_attribute :usage_timeframe, String
 
       # @!attribute usage_type
-      #   @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+      #   @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
       define_attribute :usage_type, String
     end
   end

data/lib/recurly/requests/add_on_update.rb

@@ -70,6 +70,10 @@ module Recurly
       #   @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 without an `ending_quantity` value which represents the final tier.
       define_attribute :tiers, Array, { :item_type => :Tier }
 
+      # @!attribute usage_calculation_type
+      #   @return [String] The type of calculation to be employed for an add-on.  Cumulative billing will sum all usage records created in the current billing cycle.  Last-in-period billing will apply only the most recent usage record in the billing period.  If no value is specified, cumulative billing will be used.
+      define_attribute :usage_calculation_type, 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, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
       define_attribute :usage_percentage, Float

data/lib/recurly/requests/billing_info_create.rb

@@ -115,7 +115,7 @@ module Recurly
       define_attribute :three_d_secure_action_result_token_id, String
 
       # @!attribute token_id
-      #   @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+      #   @return [String] A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
       define_attribute :token_id, String
 
       # @!attribute transaction_type

data/lib/recurly/requests/plan_create.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String

data/lib/recurly/requests/plan_update.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [Array[PlanPricing]] Optional when the pricing model is 'ramp'.
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -27,7 +27,7 @@ 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. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @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 without an `ending_quantity` value which represents the final tier. See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
@@ -39,7 +39,7 @@ module Recurly
       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.
+      #   @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://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
       define_attribute :usage_percentage, Float
     end
   end

data/lib/recurly/resources/add_on.rb

@@ -95,7 +95,7 @@ module Recurly
       define_attribute :tax_code, String
 
       # @!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). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers
@@ -106,6 +106,10 @@ module Recurly
       #   @return [DateTime] Last updated at
       define_attribute :updated_at, DateTime
 
+      # @!attribute usage_calculation_type
+      #   @return [String] The type of calculation to be employed for an add-on.  Cumulative billing will sum all usage records created in the current billing cycle.  Last-in-period billing will apply only the most recent usage record in the billing period.  If no value is specified, cumulative billing will be used.
+      define_attribute :usage_calculation_type, 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

data/lib/recurly/resources/external_product.rb

@@ -0,0 +1,38 @@
+# 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 ExternalProduct < Resource
+
+      # @!attribute created_at
+      #   @return [DateTime] When the external product was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute external_product_references
+      #   @return [Array[ExternalProductReferenceMini]] List of external product references of the external product.
+      define_attribute :external_product_references, Array, { :item_type => :ExternalProductReferenceMini }
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Name to identify the external product in Recurly.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plan
+      #   @return [PlanMini] Just the important parts.
+      define_attribute :plan, :PlanMini
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the external product was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/external_product_reference_mini.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 ExternalProductReferenceMini < Resource
+
+      # @!attribute created_at
+      #   @return [DateTime] When the external product was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute external_connection_type
+      #   @return [String] Source connection platform.
+      define_attribute :external_connection_type, String
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external product ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] object
+      define_attribute :object, String
+
+      # @!attribute reference_code
+      #   @return [String] A code which associates the external product to a corresponding object or resource in an external platform like the Apple App Store or Google Play Store.
+      define_attribute :reference_code, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the external product was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/external_resource_mini.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 Resources
+    class ExternalResourceMini < Resource
+
+      # @!attribute external_object_reference
+      #   @return [String] Identifier or URL reference where the resource is canonically available in the external platform.
+      define_attribute :external_object_reference, String
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external resource ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/external_subscription.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 ExternalSubscription < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute activated_at
+      #   @return [DateTime] When the external subscription was activated in the external platform.
+      define_attribute :activated_at, DateTime
+
+      # @!attribute app_identifier
+      #   @return [String] Identifier of the app that generated the external subscription.
+      define_attribute :app_identifier, String
+
+      # @!attribute auto_renew
+      #   @return [Boolean] An indication of whether or not the external subscription will auto-renew at the expiration date.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute created_at
+      #   @return [DateTime] When the external subscription was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute expires_at
+      #   @return [DateTime] When the external subscription expires in the external platform.
+      define_attribute :expires_at, DateTime
+
+      # @!attribute external_product_reference
+      #   @return [ExternalProductReferenceMini] External Product Reference details
+      define_attribute :external_product_reference, :ExternalProductReferenceMini
+
+      # @!attribute external_resource
+      #   @return [ExternalResourceMini] External Resource mini details
+      define_attribute :external_resource, :ExternalResourceMini
+
+      # @!attribute id
+      #   @return [String] System-generated unique identifier for an external subscription ID, e.g. `e28zov4fw0v2`.
+      define_attribute :id, String
+
+      # @!attribute last_purchased
+      #   @return [DateTime] When a new billing event occurred on the external subscription in conjunction with a recent billing period, reactivation or upgrade/downgrade.
+      define_attribute :last_purchased, DateTime
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute quantity
+      #   @return [Integer] An indication of the quantity of a subscribed item's quantity.
+      define_attribute :quantity, Integer
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the external subscription was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/plan.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!attribute deleted_at
       #   @return [DateTime] Deleted at
       define_attribute :deleted_at, DateTime

data/lib/recurly/resources/subscription_add_on.rb

@@ -47,7 +47,7 @@ module Recurly
       define_attribute :subscription_id, String
 
       # @!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). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers
@@ -66,6 +66,10 @@ module Recurly
       #   @return [DateTime] Updated at
       define_attribute :updated_at, DateTime
 
+      # @!attribute usage_calculation_type
+      #   @return [String] The type of calculation to be employed for an add-on.  Cumulative billing will sum all usage records created in the current billing cycle.  Last-in-period billing will apply only the most recent usage record in the billing period.  If no value is specified, cumulative billing will be used.
+      define_attribute :usage_calculation_type, 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/resources/usage.rb

@@ -43,7 +43,7 @@ module Recurly
       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). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.23.0"
+  VERSION = "4.25.0"
 end

data/lib/recurly/webhooks.rb

@@ -0,0 +1,52 @@
+module Recurly
+  module Webhooks
+    DEFAULT_TOLERANCE = 5 * 60 * 1000
+
+    # Verify webhook signature
+    #
+    # @param header [String] recurly-signature header from request
+    # @param secret [String] Shared secret for notification endpoint
+    # @param body [String] Request POST body
+    # @param tolerance [Integer] Allowed notification time drift in milliseconds
+    # @example
+    #   begin
+    #     Recurly::Webhooks.verify_signature(header,
+    #                                        ENV['WEBHOOKS_KEY'],
+    #                                        request.body)
+    #   rescue Recurly::Errors::SignatureVerificationError => e
+    #     puts e.message
+    #   end
+    #
+    def self.verify_signature(header, secret, body, tolerance: DEFAULT_TOLERANCE)
+      s_timestamp, *signatures = header.split(",")
+      timestamp = Integer(s_timestamp)
+      now = (Time.now.to_f * 1000).to_i
+
+      if (now - timestamp).abs > tolerance
+        raise Recurly::Errors::SignatureVerificationError.new(
+          "Notification (#{Time.at(timestamp / 1000.0)}) is more than #{tolerance / 1000.0}s out of date"
+        )
+      end
+
+      expected = OpenSSL::HMAC.hexdigest("sha256", secret, "#{timestamp}.#{body}")
+
+      unless signatures.any? { |s| secure_compare(expected, s) }
+        raise Recurly::Errors::SignatureVerificationError.new(
+          "No matching signatures found for payload"
+        )
+      end
+    end
+
+    # https://github.com/rack/rack/blob/2-2-stable/lib/rack/utils.rb#L374
+    # https://github.com/heartcombo/devise/blob/4-1-stable/lib/devise.rb#L477
+    def self.secure_compare(a, b)
+      return false if a.bytesize != b.bytesize
+      l = a.unpack("C#{a.bytesize}")
+
+      res = 0
+      b.each_byte { |byte| res |= byte ^ l.shift }
+      res == 0
+    end
+    private_class_method :secure_compare
+  end
+end

data/lib/recurly.rb

@@ -9,6 +9,7 @@ require "recurly/http"
 require "recurly/errors"
 require "recurly/connection_pool"
 require "recurly/client"
+require "recurly/webhooks"
 
 module Recurly
   STRICT_MODE = ENV["RECURLY_STRICT_MODE"] && ENV["RECURLY_STRICT_MODE"].downcase == "true"