recurly 4.24.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f585c84e359302293e13409b5162b2ad56241f342b0c9e9c2c4200f29782a32
-  data.tar.gz: d8908b9d5e9cefcce7a9fa6cfa0d75b69dcd8b885ac6ce6dacc2ec416f56c1a1
+  metadata.gz: 83cc9874a222552398eccba8e97f844e448644398831199e20e9eeb09d91443a
+  data.tar.gz: dab0e9563f9771f46d4be709e33394305f8c59bc77fa2cd4394106cef1edd8a6
 SHA512:
-  metadata.gz: 3d42081e4d4e095850d9b1158e8c798ab0cc11d9f9d68bb895ba77808a2d6f4f1a0bdfeac2c6394d704ea74add4df4ba63ca2eca70d1c05c1b3499e3c9bbbb76
-  data.tar.gz: 1bb51683c999694c1843c378754ba2fb6556d205db5f50ebf93cde4cb46997548cd31f3062b75f6b1db7d3bb575a3040ddea88276f1172fca424785e96b92304
+  metadata.gz: beeb8fd85be7c0b63d7f2ab7c786684e774d731a3d3f501aba66428bb6de7e58c79fd0e4ab6786790e58195cd675c286f259bb98cb0652366a0ab49b885fed11
+  data.tar.gz: a2bb85d2f395c94dbe172aabbc281d0e30f6ffd034d85368616a2a921cee68fc6836ae75dbb023299edc2b8b4d31a61f382d9e43e6f130e10a9130bd5d7a2148

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # 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)

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.24'
+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/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.24.0"
+  VERSION = "4.25.0"
 end

data/openapi/api.yaml

@@ -57,7 +57,7 @@ info:
 
     We encourage you to update to the latest version of the API and corresponding client library,
     as most recent versions are more performant than their predecessors. See the
-    [changelog](https://developers.recurly.com/api/changelog.html) for a comprehensive list of changes
+    [changelog](https://recurly.com/developers/api/changelog.html) for a comprehensive list of changes
     introduced in the latest API version.
 
     ### Default Versions
@@ -114,7 +114,7 @@ info:
     Please consider changing these messages in the target system to be better
     suited to the audience of the system.
 
-    Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
+    Please see [transaction error codes](https://recurly.com/developers/pages/api-transaction-errors.html) for more details.
 
     ## Pagination
     ### Response Schema
@@ -181,7 +181,7 @@ info:
 
     ## Change Log
 
-    A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2021-02-25---current-ga-version).
+    A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2021-02-25---current-ga-version).
   version: v2021-02-25
 security:
 - api_key: []
@@ -199,6 +199,8 @@ x-tagGroups:
   - purchase
   - usage
   - automated_exports
+  - external_subscriptions
+  - external_products
 - name: Products and Promotions
   tags:
   - item
@@ -338,6 +340,16 @@ tags:
 - name: dunning_campaigns
   x-displayName: Dunning Campaigns
   description: Settings used when attempting to dun customers whose payments are declined.
+- name: external_subscriptions
+  x-displayName: External Subscription
+  description: A subscription from an external resource that is not managed by the
+    Recurly platform and instead is managed by third-party platforms like Apple Store
+    and Google Play.
+- name: external_products
+  x-displayName: External Product
+  description: A product from an external resource that is not managed by the Recurly
+    platform and instead is managed by third-party platforms like Apple Store and
+    Google Play.
 paths:
   "/sites":
     get:
@@ -2694,7 +2706,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_account_coupon_redemptions
-      summary: Show the coupon redemptions for an account
+      summary: List the coupon redemptions for an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -2791,7 +2803,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_active_coupon_redemptions
-      summary: Show the coupon redemptions that are active on an account
+      summary: List the coupon redemptions that are active on an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -3944,7 +3956,7 @@ paths:
       tags:
       - note
       operationId: list_account_notes
-      summary: Fetch a list of an account's notes
+      summary: List an account's notes
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -7442,6 +7454,129 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/external_products":
+    get:
+      tags:
+      - external_products
+      operationId: list_external_products
+      summary: List a site's external products
+      description: See the [Pagination Guide](/guides/pagination.html) to learn how
+        to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/sort_dates"
+      responses:
+        '200':
+          description: A list of the the external_products on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProductList"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/external_products/{external_product_id}":
+    parameters:
+    - "$ref": "#/components/parameters/external_product_id"
+    get:
+      tags:
+      - external_products
+      operationId: get_external_product
+      summary: Fetch an external product
+      responses:
+        '200':
+          description: Settings for an external product.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalProduct"
+        '404':
+          description: Incorrect site or external product ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/external_subscriptions":
+    get:
+      tags:
+      - external_subscriptions
+      operationId: list_external_subscriptions
+      summary: List a site's external subscriptions
+      description: See the [Pagination Guide](/guides/pagination.html) to learn how
+        to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/sort_dates"
+      responses:
+        '200':
+          description: A list of the the external_subscriptions on a site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalSubscriptionList"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/external_subscriptions/{external_subscription_id}":
+    parameters:
+    - "$ref": "#/components/parameters/external_subscription_id"
+    get:
+      tags:
+      - external_subscriptions
+      operationId: get_external_subscription
+      summary: Fetch an external subscription
+      responses:
+        '200':
+          description: Settings for an external subscription.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalSubscription"
+        '404':
+          description: Incorrect site or external subscription ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Validation error with external resource connection or feature
+            flag.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/invoices":
     get:
       tags:
@@ -8742,7 +8877,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_invoice_coupon_redemptions
-      summary: Show the coupon redemptions applied to an invoice
+      summary: List the coupon redemptions applied to an invoice
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -13327,7 +13462,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_subscription_coupon_redemptions
-      summary: Show the coupon redemptions for a subscription
+      summary: List the coupon redemptions for a subscription
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14907,7 +15042,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: list_dunning_campaigns
-      summary: Show the dunning campaigns for a site
+      summary: List the dunning campaigns for a site
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14939,7 +15074,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: get_dunning_campaign
-      summary: Show the settings for a dunning campaign
+      summary: Fetch a dunning campaign
       responses:
         '200':
           description: Settings for a dunning campaign.
@@ -15042,7 +15177,7 @@ paths:
       tags:
       - invoice_templates
       operationId: get_invoice_template
-      summary: Show the settings for an invoice template
+      summary: Fetch an invoice template
       responses:
         '200':
           description: Settings for an invoice template.
@@ -15077,7 +15212,7 @@ paths:
       tags:
       - account
       operationId: list_entitlements
-      summary: Show all entitlements granted to an account
+      summary: List entitlements granted to an account
       responses:
         '200':
           description: A list of the entitlements granted to an account.
@@ -15098,6 +15233,38 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/accounts/{account_id}/external_subscriptions":
+    parameters:
+    - "$ref": "#/components/parameters/account_id"
+    get:
+      tags:
+      - account
+      operationId: list_account_external_subscriptions
+      summary: List an account's external subscriptions
+      description: See the [Pagination Guide](/guides/pagination.html) to learn how
+        to use pagination in the API and Client Libraries.
+      parameters:
+      - "$ref": "#/components/parameters/sort_dates"
+      responses:
+        '200':
+          description: A list of the the external_subscriptions on an account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/ExternalSubscriptionList"
+        '404':
+          description: Incorrect account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
 servers:
 - url: https://v3.recurly.com
 - url: https://v3.eu.recurly.com
@@ -15165,6 +15332,20 @@ components:
       required: true
       schema:
         type: string
+    external_product_id:
+      name: external_product_id
+      in: path
+      description: External product id
+      required: true
+      schema:
+        type: string
+    external_subscription_id:
+      name: external_subscription_id
+      in: path
+      description: External subscription id
+      required: true
+      schema:
+        type: string
     invoice_template_id:
       name: invoice_template_id
       in: path
@@ -16369,6 +16550,8 @@ components:
           "$ref": "#/components/schemas/AddOnTypeEnum"
         usage_type:
           "$ref": "#/components/schemas/UsageTypeEnum"
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         usage_percentage:
           type: number
           format: float
@@ -16522,6 +16705,8 @@ components:
           "$ref": "#/components/schemas/AddOnTypeCreateEnum"
         usage_type:
           "$ref": "#/components/schemas/UsageTypeCreateEnum"
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         usage_percentage:
           type: number
           format: float
@@ -16682,6 +16867,8 @@ components:
             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.
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         measured_unit_id:
           type: string
           title: Measured Unit ID
@@ -16882,7 +17069,7 @@ components:
         token_id:
           type: string
           title: Token ID
-          description: A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+          description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
           maxLength: 22
         first_name:
           type: string
@@ -19090,6 +19277,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19260,6 +19449,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19474,6 +19665,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -20401,6 +20594,8 @@ components:
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
         tier_type:
           "$ref": "#/components/schemas/TierTypeEnum"
+        usage_calculation_type:
+          "$ref": "#/components/schemas/UsageCalculationTypeEnum"
         usage_timeframe:
           "$ref": "#/components/schemas/UsageTimeframeEnum"
         tiers:
@@ -20491,7 +20686,7 @@ components:
             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)
+            See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
             for an overview of how to configure quantity-based pricing models.
         percentage_tiers:
           type: array
@@ -20512,7 +20707,7 @@ components:
           description: 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)
+            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.
         revenue_schedule_type:
           title: Revenue schedule type
@@ -22175,6 +22370,184 @@ components:
           type: string
           format: date-time
           description: Time the object was last updated
+    ExternalProduct:
+      type: object
+      description: Product from an external resource such as Apple App or Google Play.
+      properties:
+        id:
+          type: string
+          title: External product ID.
+          description: System-generated unique identifier for an external product
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        name:
+          type: string
+          title: Name
+          description: Name to identify the external product in Recurly.
+        plan:
+          "$ref": "#/components/schemas/PlanMini"
+        created_at:
+          type: string
+          format: date-time
+          description: When the external product was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          description: When the external product was updated in Recurly.
+        external_product_references:
+          type: array
+          title: External Product References
+          description: List of external product references of the external product.
+          items:
+            "$ref": "#/components/schemas/ExternalProductReferenceMini"
+    ExternalProductList:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/ExternalProduct"
+    ExternalProductReferenceMini:
+      type: object
+      title: External Product Reference details
+      description: External Product Reference details
+      properties:
+        id:
+          type: string
+          title: External Product ID
+          description: System-generated unique identifier for an external product
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: object
+        reference_code:
+          type: string
+          title: reference_code
+          description: 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.
+        external_connection_type:
+          type: string
+          title: external_connection_type
+          description: Source connection platform.
+        created_at:
+          type: string
+          format: date-time
+          description: When the external product was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          description: When the external product was updated in Recurly.
+    ExternalSubscription:
+      type: object
+      description: Subscription from an external resource such as Apple App or Google
+        Play.
+      properties:
+        id:
+          type: string
+          title: External subscription ID
+          description: System-generated unique identifier for an external subscription
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        account:
+          "$ref": "#/components/schemas/AccountMini"
+        external_resource:
+          "$ref": "#/components/schemas/ExternalResourceMini"
+        external_product_reference:
+          "$ref": "#/components/schemas/ExternalProductReferenceMini"
+        last_purchased:
+          type: string
+          format: date-time
+          title: Last purchased
+          description: When a new billing event occurred on the external subscription
+            in conjunction with a recent billing period, reactivation or upgrade/downgrade.
+        auto_renew:
+          type: boolean
+          title: Auto-renew
+          description: An indication of whether or not the external subscription will
+            auto-renew at the expiration date.
+          default: false
+        app_identifier:
+          type: string
+          title: App identifier
+          description: Identifier of the app that generated the external subscription.
+        quantity:
+          type: integer
+          title: Quantity
+          description: An indication of the quantity of a subscribed item's quantity.
+          default: 1
+          minimum: 0
+        activated_at:
+          type: string
+          format: date-time
+          title: Activated at
+          description: When the external subscription was activated in the external
+            platform.
+        expires_at:
+          type: string
+          format: date-time
+          title: Expires at
+          description: When the external subscription expires in the external platform.
+        created_at:
+          type: string
+          format: date-time
+          title: Created at
+          description: When the external subscription was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          title: Updated at
+          description: When the external subscription was updated in Recurly.
+    ExternalSubscriptionList:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/ExternalSubscription"
+    ExternalResourceMini:
+      type: object
+      title: External Resource mini details
+      properties:
+        id:
+          type: string
+          title: External resource ID
+          description: System-generated unique identifier for an external resource
+            ID, e.g. `e28zov4fw0v2`.
+        object:
+          type: string
+          title: Object type
+        external_object_reference:
+          type: string
+          title: External Object Reference
+          description: Identifier or URL reference where the resource is canonically
+            available in the external platform.
+          maxLength: 255
+          readOnly: true
     CustomerPermission:
       type: object
       properties:
@@ -22367,6 +22740,7 @@ components:
       enum:
       - account
       - item
+      - plan
       - subscription
     RefundTypeEnum:
       type: string
@@ -22392,6 +22766,15 @@ components:
       - percentage
       title: Usage Type
       description: Type of usage, returns usage type if `add_on_type` is `usage`.
+    UsageCalculationTypeEnum:
+      type: string
+      description: 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.
+      enum:
+      - cumulative
+      - last_in_period
     BillingStatusEnum:
       type: string
       default: unbilled
@@ -22596,7 +22979,7 @@ components:
       title: Usage Type
       description: |
         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
+        [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an
         overview of how to configure usage add-ons.
     TierTypeEnum:
       type: string
@@ -22604,7 +22987,7 @@ components:
       description: |
         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
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
       default: flat
       enum:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.24.0
+  version: 4.25.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -252,6 +252,10 @@ files:
 - lib/recurly/resources/export_dates.rb
 - lib/recurly/resources/export_file.rb
 - lib/recurly/resources/export_files.rb
+- lib/recurly/resources/external_product.rb
+- lib/recurly/resources/external_product_reference_mini.rb
+- lib/recurly/resources/external_resource_mini.rb
+- lib/recurly/resources/external_subscription.rb
 - lib/recurly/resources/fraud_info.rb
 - lib/recurly/resources/granted_by.rb
 - lib/recurly/resources/invoice.rb
@@ -322,7 +326,7 @@ metadata:
   changelog_uri: https://github.com/recurly/recurly-client-ruby/blob/master/CHANGELOG.md
   documentation_uri: https://recurly.github.io/recurly-client-ruby/
   homepage_uri: https://github.com/recurly/recurly-client-ruby
-  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.24.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.25.0
 post_install_message: 
 rdoc_options: []
 require_paths: