recurly 4.25.0 → 4.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83cc9874a222552398eccba8e97f844e448644398831199e20e9eeb09d91443a
-  data.tar.gz: dab0e9563f9771f46d4be709e33394305f8c59bc77fa2cd4394106cef1edd8a6
+  metadata.gz: 640a24b929e9682d7617c76acc1a64e15e7ffab1911caf2c451d87a66879636b
+  data.tar.gz: 3f8a5c5064c8e7171dc6e6b0ff7159c4da7bb6e483795053455a0cd46024525e
 SHA512:
-  metadata.gz: beeb8fd85be7c0b63d7f2ab7c786684e774d731a3d3f501aba66428bb6de7e58c79fd0e4ab6786790e58195cd675c286f259bb98cb0652366a0ab49b885fed11
-  data.tar.gz: a2bb85d2f395c94dbe172aabbc281d0e30f6ffd034d85368616a2a921cee68fc6836ae75dbb023299edc2b8b4d31a61f382d9e43e6f130e10a9130bd5d7a2148
+  metadata.gz: add90da54e5859f423bb14382674297aab1cd4807e3238c31bb7b8edc23ee2c963efa0acdeae40a4943678960d375c1d19dfea7666c753b422e54782c5cc1d7f
+  data.tar.gz: 116106098e2251a1cf36031e2f15e51853052ffe7ec5da674a441a1b231ae3b81327cb00264d7cab48e43b4c925ae21c39b7d979c89e3082e39208b263d29e0f

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.27.0](https://github.com/recurly/recurly-client-ruby/tree/4.27.0) (2023-01-11)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.26.0...4.27.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Account Preferred Time Zone) [#816](https://github.com/recurly/recurly-client-ruby/pull/816) ([douglasmiller](https://github.com/douglasmiller))
+
+
+
+## [4.26.0](https://github.com/recurly/recurly-client-ruby/tree/4.26.0) (2022-11-17)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.25.0...4.26.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Apply Credit Balance feature) [#811](https://github.com/recurly/recurly-client-ruby/pull/811) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [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)

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.25'
+gem 'recurly', '~> 4.27'
 ```
 
 > *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

@@ -2236,6 +2236,30 @@ module Recurly
       get(path, **options)
     end
 
+    # Apply available credit to a pending or past due charge invoice
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/apply_credit_balance apply_credit_balance api documentation}
+    #
+    # @param invoice_id [String] Invoice ID or number. For ID no prefix is used e.g. +e28zov4fw0v2+. For number use prefix +number-+, e.g. +number-1000+.
+    # @param params [Hash] Optional query string parameters:
+    #        :site_id [String] Site ID or subdomain. For ID no prefix is used e.g. +e28zov4fw0v2+. For subdomain use prefix +subdomain-+, e.g. +subdomain-recurly+.
+    #
+    # @return [Resources::Invoice] The updated invoice.
+    # @example
+    #   begin
+    #     invoice = @client.apply_credit_balance(invoice_id: invoice_id)
+    #     puts "Applied credit balance to invoice #{invoice}"
+    #   rescue Recurly::Errors::NotFoundError
+    #     # If the resource was not found, you may want to alert the user or
+    #     # just return nil
+    #     puts "Resource Not Found"
+    #   end
+    #
+    def apply_credit_balance(invoice_id:, **options)
+      path = interpolate_path("/invoices/{invoice_id}/apply_credit_balance", invoice_id: invoice_id)
+      put(path, **options)
+    end
+
     # Collect a pending or past due, automatic invoice
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/collect_invoice collect_invoice api documentation}

data/lib/recurly/requests/account_create.rb

@@ -74,6 +74,10 @@ module Recurly
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
       define_attribute :preferred_locale, String
 
+      # @!attribute preferred_time_zone
+      #   @return [String] Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
+      define_attribute :preferred_time_zone, String
+
       # @!attribute shipping_addresses
       #   @return [Array[ShippingAddressCreate]]
       define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddressCreate }

data/lib/recurly/requests/account_purchase.rb

@@ -78,6 +78,10 @@ module Recurly
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
       define_attribute :preferred_locale, String
 
+      # @!attribute preferred_time_zone
+      #   @return [String] Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
+      define_attribute :preferred_time_zone, String
+
       # @!attribute tax_exempt
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
       define_attribute :tax_exempt, :Boolean

data/lib/recurly/requests/account_update.rb

@@ -66,6 +66,10 @@ module Recurly
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
       define_attribute :preferred_locale, String
 
+      # @!attribute preferred_time_zone
+      #   @return [String] Used to determine the time zone of emails sent on behalf of the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
+      define_attribute :preferred_time_zone, String
+
       # @!attribute tax_exempt
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
       define_attribute :tax_exempt, :Boolean

data/lib/recurly/requests/add_on_create.rb

@@ -63,7 +63,7 @@ module Recurly
       define_attribute :optional, :Boolean
 
       # @!attribute percentage_tiers
-      #   @return [Array[PercentageTiersByCurrency]] Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.
+      #   @return [Array[PercentageTiersByCurrency]] Array of objects which must have at least one set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
 
       # @!attribute plan_id

data/lib/recurly/requests/add_on_update.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :optional, :Boolean
 
       # @!attribute percentage_tiers
-      #   @return [Array[PercentageTiersByCurrency]] `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.
+      #   @return [Array[PercentageTiersByCurrency]] `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.  This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
 
       # @!attribute revenue_schedule_type

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute percentage_tiers
-      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage.
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
 
       # @!attribute quantity

data/lib/recurly/requests/subscription_add_on_update.rb

@@ -19,7 +19,7 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute percentage_tiers
-      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
 
       # @!attribute quantity

data/lib/recurly/resources/account.rb

@@ -110,6 +110,10 @@ module Recurly
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
       define_attribute :preferred_locale, String
 
+      # @!attribute preferred_time_zone
+      #   @return [String] The [IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.
+      define_attribute :preferred_time_zone, String
+
       # @!attribute shipping_addresses
       #   @return [Array[ShippingAddress]] The shipping addresses on the account.
       define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddress }

data/lib/recurly/resources/account_balance_amount.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [Float] Total amount the account is past due.
       define_attribute :amount, Float
 
+      # @!attribute available_credit_amount
+      #   @return [Float] Total amount of the open balances on credit invoices for the account.
+      define_attribute :available_credit_amount, Float
+
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String

data/lib/recurly/resources/add_on.rb

@@ -75,7 +75,7 @@ module Recurly
       define_attribute :optional, :Boolean
 
       # @!attribute percentage_tiers
-      #   @return [Array[PercentageTiersByCurrency]] Percentage Tiers
+      #   @return [Array[PercentageTiersByCurrency]] This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
 
       # @!attribute plan_id

data/lib/recurly/resources/invoice.rb

@@ -103,7 +103,7 @@ module Recurly
       define_attribute :po_number, String
 
       # @!attribute previous_invoice_id
-      #   @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from.
+      #   @return [String] On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed) feature enabled. Sites with Only Bill What Changed enabled should use the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices) to see purchase invoices refunded by this invoice.
       define_attribute :previous_invoice_id, String
 
       # @!attribute refundable_amount

data/lib/recurly/resources/subscription_add_on.rb

@@ -31,7 +31,7 @@ module Recurly
       define_attribute :object, String
 
       # @!attribute percentage_tiers
-      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
+      #   @return [Array[SubscriptionAddOnPercentageTier]] If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
 
       # @!attribute quantity

data/lib/recurly/resources/usage.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :object, String
 
       # @!attribute percentage_tiers
-      #   @return [Array[SubscriptionAddOnPercentageTier]] The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []
+      #   @return [Array[SubscriptionAddOnPercentageTier]] The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []. This feature is currently in development and requires approval and enablement, please contact support.
       define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
 
       # @!attribute recording_timestamp

data/lib/recurly/version.rb

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

data/openapi/api.yaml

@@ -343,13 +343,13 @@ tags:
 - 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.
+    Recurly platform and instead is managed by third-party platforms like Apple App
+    Store and Google Play Store.
 - 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.
+    platform and instead is managed by third-party platforms like Apple App Store
+    and Google Play Store.
 paths:
   "/sites":
     get:
@@ -358,7 +358,7 @@ paths:
       description: |
         This route is most useful for finding a site's ID for subsequent requests.
 
-        See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
+        See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
       tags:
       - site
       parameters:
@@ -571,8 +571,8 @@ paths:
       - account
       operationId: list_accounts
       summary: List a site's accounts
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -2502,8 +2502,8 @@ paths:
       - billing_infos
       operationId: list_billing_infos
       summary: Get the list of billing information associated with an account
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -2707,8 +2707,8 @@ paths:
       - coupon_redemption
       operationId: list_account_coupon_redemptions
       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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -2804,8 +2804,8 @@ paths:
       - coupon_redemption
       operationId: list_active_coupon_redemptions
       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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       responses:
@@ -3132,8 +3132,8 @@ paths:
       - credit_payment
       operationId: list_account_credit_payments
       summary: List an account's credit payments
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/limit"
@@ -3239,8 +3239,8 @@ paths:
       - invoice
       operationId: list_account_invoices
       summary: List an account's invoices
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -3681,8 +3681,8 @@ paths:
       - line_item
       operationId: list_account_line_items
       summary: List an account's line items
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -3957,8 +3957,8 @@ paths:
       - note
       operationId: list_account_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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -4171,8 +4171,8 @@ paths:
       - shipping_address
       operationId: list_shipping_addresses
       summary: Fetch a list of an account's shipping addresses
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -4853,8 +4853,8 @@ paths:
       - subscription
       operationId: list_account_subscriptions
       summary: List an account's subscriptions
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -4957,8 +4957,8 @@ paths:
       - transaction
       operationId: list_account_transactions
       summary: List an account's transactions
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -5063,8 +5063,8 @@ paths:
       - account
       operationId: list_child_accounts
       summary: List an account's child accounts
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/account_id"
       - "$ref": "#/components/parameters/ids"
@@ -5146,8 +5146,8 @@ paths:
       - account_acquisition
       operationId: list_account_acquisition
       summary: List a site's account acquisition data
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -5245,8 +5245,8 @@ paths:
       - coupon
       operationId: list_coupons
       summary: List a site's coupons
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -6009,8 +6009,8 @@ paths:
       - unique_coupon_code
       operationId: list_unique_coupon_codes
       summary: List unique coupon codes associated with a bulk coupon
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/coupon_id"
       - "$ref": "#/components/parameters/ids"
@@ -6045,8 +6045,8 @@ paths:
       - credit_payment
       operationId: list_credit_payments
       summary: List a site's credit payments
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/limit"
       - "$ref": "#/components/parameters/order"
@@ -6175,8 +6175,8 @@ paths:
       - custom_field_definition
       operationId: list_custom_field_definitions
       summary: List a site's custom field definitions
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -6400,8 +6400,8 @@ paths:
       - account
       operationId: list_invoice_template_accounts
       summary: List an invoice template's associated accounts
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/invoice_template_id"
       - "$ref": "#/components/parameters/ids"
@@ -6445,8 +6445,8 @@ paths:
       - item
       operationId: list_items
       summary: List a site's items
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -7280,8 +7280,8 @@ paths:
       - measured_unit
       operationId: list_measured_unit
       summary: List a site's measured units
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -7460,8 +7460,8 @@ paths:
       - 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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/sort_dates"
       responses:
@@ -7518,8 +7518,8 @@ paths:
       - 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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/sort_dates"
       responses:
@@ -7583,8 +7583,8 @@ paths:
       - invoice
       operationId: list_invoices
       summary: List a site's invoices
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -8084,6 +8084,135 @@ paths:
               // Something bad happened... tell the user so that they can fix it?
               echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;
           }
+  "/invoices/{invoice_id}/apply_credit_balance":
+    put:
+      tags:
+      - invoice
+      operationId: apply_credit_balance
+      summary: Apply available credit to a pending or past due charge invoice
+      description: Apply credit payment to the outstanding balance on an existing
+        charge invoice from an account’s available balance from existing credit invoices.
+        Credit that was refunded from the invoice cannot be applied back to the invoice
+        as payment.
+      parameters:
+      - "$ref": "#/components/parameters/site_id"
+      - "$ref": "#/components/parameters/invoice_id"
+      responses:
+        '200':
+          description: The updated invoice.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Invoice"
+        '404':
+          description: Incorrect site or invoice ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '422':
+          description: Tried applying credit to a legacy or closed invoice or there
+            was an error processing the credit payment, such as no available credit
+            on the account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples:
+      - lang: Node.js
+        source: |
+          try {
+            const invoice = await client.applyCreditBalance(invoiceId)
+            console.log('Applied credit balance to invoice: ', invoice)
+          } catch (err) {
+            if (err instanceof recurly.errors.ValidationError) {
+              // If the request was not valid, you may want to tell your user
+              // why. You can find the invalid params and reasons in err.params
+              console.log('Failed validation', err.params)
+            } else {
+              // If we don't know what to do with the err, we should
+              // probably re-raise and let our web framework and logger handle it
+              console.log('Unknown Error: ', err)
+            }
+          }
+      - lang: Python
+        source: |
+          try:
+              invoice = client.apply_credit_balance(invoice_id)
+              print("Applied credit balance to invoice %s" % invoice.id)
+          except recurly.errors.NotFoundError:
+              # If the resource was not found, you may want to alert the user or
+              # just return nil
+              print("Resource Not Found")
+      - lang: ".NET"
+        source: |
+          try
+          {
+              Invoice invoice = client.ApplyCreditBalance(invoiceId);
+              Console.WriteLine($"Applied credit balance to invoice #{invoice.Number}");
+          }
+          catch (Recurly.Errors.Validation ex)
+          {
+              // If the request was not valid, you may want to tell your user
+              // why. You can find the invalid params and reasons in ex.Error.Params
+              Console.WriteLine($"Failed validation: {ex.Error.Message}");
+          }
+          catch (Recurly.Errors.ApiError ex)
+          {
+              // Use ApiError to catch a generic error from the API
+              Console.WriteLine($"Unexpected Recurly Error: {ex.Error.Message}");
+          }
+      - lang: Ruby
+        source: |
+          begin
+            invoice = @client.apply_credit_balance(invoice_id: invoice_id)
+            puts "Applied credit balance to invoice #{invoice}"
+          rescue Recurly::Errors::NotFoundError
+            # If the resource was not found, you may want to alert the user or
+            # just return nil
+            puts "Resource Not Found"
+          end
+      - lang: Java
+        source: |
+          try {
+            final Invoice invoice = client.applyCreditBalance(invoiceId);
+            System.out.println("Applied credit balance to invoice " + invoice.getId());
+          } catch (final ValidationException e) {
+            // If the request was not valid, you may want to tell your user
+            // why. You can find the invalid params and reasons in e.getError().getParams()
+            System.out.println("Failed validation: " + e.getError().getMessage());
+          } catch (final ApiException e) {
+              // Use ApiException to catch a generic error from the API
+              System.out.println("Unexpected Recurly Error: " + e.getError().getMessage());
+          }
+      - lang: PHP
+        source: |
+          try {
+              $invoice = $client->applyCreditBalance($invoice_id);
+
+              echo 'Applied credit balance to invoice:' . PHP_EOL;
+              var_dump($invoice);
+          } catch (\Recurly\Errors\Validation $e) {
+              // If the request was not valid, you may want to tell your user
+              // why. You can find the invalid params and reasons in err.params
+              var_dump($e);
+          } catch (\Recurly\RecurlyError $e) {
+              // If we don't know what to do with the err, we should
+              // probably re-raise and let our web framework and logger handle it
+              var_dump($e);
+          }
+      - lang: Go
+        source: "invoice, err := client.ApplyCreditBalance(invoiceID)\nif e, ok :=
+          err.(*recurly.Error); ok {\n\tif e.Type == recurly.ErrorTypeValidation {\n\t\tfmt.Printf(\"Failed
+          validation: %v\", e)\n\t\treturn nil, err\n\t}\n\tfmt.Printf(\"Unexpected
+          Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfmt.Printf(\"Applied credit
+          balance to invoice: %v\", invoice)"
   "/invoices/{invoice_id}/collect":
     put:
       tags:
@@ -8768,8 +8897,8 @@ paths:
       - line_item
       operationId: list_invoice_line_items
       summary: List an invoice's line items
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/invoice_id"
       - "$ref": "#/components/parameters/ids"
@@ -8878,8 +9007,8 @@ paths:
       - coupon_redemption
       operationId: list_invoice_coupon_redemptions
       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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/invoice_id"
       - "$ref": "#/components/parameters/ids"
@@ -8978,7 +9107,7 @@ paths:
         For a charge invoice the related invoices will be credit invoices.
         For a credit invoice the related invoices will be charge invoices.
 
-        See the [Pagination Guide](/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
+        See the [Pagination Guide](/developers/guides/pagination.html) to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/invoice_id"
       responses:
@@ -9232,8 +9361,8 @@ paths:
       - line_item
       operationId: list_line_items
       summary: List a site's line items
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -9573,8 +9702,8 @@ paths:
       - plan
       operationId: list_plans
       summary: List a site's plans
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -10242,8 +10371,8 @@ paths:
       - add-on
       operationId: list_plan_add_ons
       summary: List a plan's add-ons
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/plan_id"
       - "$ref": "#/components/parameters/ids"
@@ -10908,8 +11037,8 @@ paths:
       - add-on
       operationId: list_add_ons
       summary: List a site's add-ons
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -11126,8 +11255,8 @@ paths:
       - shipping_method
       operationId: list_shipping_methods
       summary: List a site's shipping methods
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -11372,8 +11501,8 @@ paths:
       - subscription
       operationId: list_subscriptions
       summary: List a site's subscriptions
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -13252,8 +13381,8 @@ paths:
       - invoice
       operationId: list_subscription_invoices
       summary: List a subscription's invoices
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/subscription_id"
       - "$ref": "#/components/parameters/ids"
@@ -13356,8 +13485,8 @@ paths:
       - line_item
       operationId: list_subscription_line_items
       summary: List a subscription's line items
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/subscription_id"
       - "$ref": "#/components/parameters/ids"
@@ -13463,8 +13592,8 @@ paths:
       - coupon_redemption
       operationId: list_subscription_coupon_redemptions
       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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/subscription_id"
       - "$ref": "#/components/parameters/ids"
@@ -13762,8 +13891,8 @@ paths:
       - transaction
       operationId: list_transactions
       summary: List a site's transactions
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/ids"
       - "$ref": "#/components/parameters/limit"
@@ -15043,8 +15172,8 @@ paths:
       - dunning_campaigns
       operationId: list_dunning_campaigns
       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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/sort_dates"
       responses:
@@ -15146,8 +15275,8 @@ paths:
       - invoice_templates
       operationId: list_invoice_templates
       summary: Show the invoice templates for a site
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/sort_dates"
       responses:
@@ -15241,8 +15370,8 @@ paths:
       - 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.
+      description: See the [Pagination Guide](/developers/guides/pagination.html)
+        to learn how to use pagination in the API and Client Libraries.
       parameters:
       - "$ref": "#/components/parameters/sort_dates"
       responses:
@@ -16139,6 +16268,11 @@ components:
             behalf of the merchant to the customer. The list of locales is restricted
             to those the merchant has enabled on the site.
           "$ref": "#/components/schemas/PreferredLocaleEnum"
+        preferred_time_zone:
+          type: string
+          example: America/Los_Angeles
+          description: Used to determine the time zone of emails sent on behalf of
+            the merchant to the customer. Must be a [supported IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
         cc_emails:
           type: string
           description: Additional email address that should receive account correspondence.
@@ -16241,6 +16375,12 @@ components:
           description: Used to determine the language and locale of emails sent on
             behalf of the merchant to the customer.
           "$ref": "#/components/schemas/PreferredLocaleEnum"
+        preferred_time_zone:
+          type: string
+          example: America/Los_Angeles
+          description: The [IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names)
+            used to determine the time zone of emails sent on behalf of the merchant
+            to the customer.
         cc_emails:
           type: string
           description: Additional email address that should receive account correspondence.
@@ -16400,9 +16540,15 @@ components:
         processing_prepayment_amount:
           type: number
           format: float
-          title: Amount
+          title: Processing Prepayment Amount
           description: Total amount for the prepayment credit invoices in a `processing`
             state on the account.
+        available_credit_amount:
+          type: number
+          format: float
+          title: Available Credit Amount
+          description: Total amount of the open balances on credit invoices for the
+            account.
     InvoiceAddress:
       allOf:
       - "$ref": "#/components/schemas/Address"
@@ -16640,6 +16786,8 @@ components:
         percentage_tiers:
           type: array
           title: Percentage Tiers
+          description: This feature is currently in development and requires approval
+            and enablement, please contact support.
           items:
             "$ref": "#/components/schemas/PercentageTiersByCurrency"
         external_sku:
@@ -16833,7 +16981,8 @@ components:
             Array of objects which must have at least one set of tiers
             per currency and the currency code. The tier_type must be `volume` or `tiered`,
             if not, it must be absent. There must be one tier without an `ending_amount` value
-            which represents the final tier.
+            which represents the final tier. This feature is currently in development and
+            requires approval and enablement, please contact support.
       required:
       - code
       - name
@@ -16974,7 +17123,8 @@ components:
             `percentage_tiers` is an array of objects, which must have the set of tiers
             per currency and the currency code. The tier_type must be `volume` or `tiered`,
             if not, it must be absent. There must be one tier without an `ending_amount` value
-            which represents the final tier.
+            which represents the final tier.  This feature is currently in development and
+            requires approval and enablement, please contact support.
     BillingInfo:
       type: object
       properties:
@@ -18212,7 +18362,11 @@ components:
           type: string
           title: Previous invoice ID
           description: On refund invoices, this value will exist and show the invoice
-            ID of the purchase invoice the refund was created from.
+            ID of the purchase invoice the refund was created from. This field is
+            only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed)
+            feature enabled. Sites with Only Bill What Changed enabled should use
+            the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices)
+            to see purchase invoices refunded by this invoice.
           maxLength: 13
         number:
           type: string
@@ -20618,8 +20772,8 @@ components:
           description: |
             If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
             removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
-            add_on.usage_type is percentage.
-            There must be one tier without an `ending_amount` value which represents the final tier.
+            add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
+            This feature is currently in development and requires approval and enablement, please contact support.
         usage_percentage:
           type: number
           format: float
@@ -20696,8 +20850,9 @@ components:
           minItems: 1
           description: |
             If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
-            removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value which represents the final tier.
-            Use only if add_on.tier_type is tiered or volume and add_on.usage_type is percentage.
+            removed and replaced by the percentage tiers in the request. There must be one tier without ending_amount value
+            which represents the final tier. Use only if add_on.tier_type is tiered or volume and add_on.usage_type is
+            percentage. This feature is currently in development and requires approval and enablement, please contact support.
         usage_percentage:
           type: number
           format: float
@@ -20776,8 +20931,8 @@ components:
           description: |
             If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
             removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
-            add_on.usage_type is percentage.
-            There must be one tier without an `ending_amount` value which represents the final tier.
+            add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the
+            final tier. This feature is currently in development and requires approval and enablement, please contact support.
         usage_percentage:
           type: number
           format: float
@@ -21958,7 +22113,8 @@ components:
           items:
             "$ref": "#/components/schemas/SubscriptionAddOnPercentageTier"
           description: The percentage tiers of the subscription based on the usage_timestamp.
-            If tier_type = flat, percentage_tiers = []
+            If tier_type = flat, percentage_tiers = []. This feature is currently
+            in development and requires approval and enablement, please contact support.
         measured_unit_id:
           type: string
           description: The ID of the measured unit associated with the add-on the
@@ -22372,7 +22528,8 @@ components:
           description: Time the object was last updated
     ExternalProduct:
       type: object
-      description: Product from an external resource such as Apple App or Google Play.
+      description: Product from an external resource such as Apple App Store or Google
+        Play Store.
       properties:
         id:
           type: string
@@ -22452,8 +22609,8 @@ components:
           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.
+      description: Subscription from an external resource such as Apple App Store
+        or Google Play Store.
       properties:
         id:
           type: string
@@ -23314,7 +23471,9 @@ components:
       - Dankort
       - Diners Club
       - Discover
+      - ELO
       - Forbrugsforeningen
+      - Hipercard
       - JCB
       - Laser
       - Maestro

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.25.0
+  version: 4.27.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -326,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.25.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.27.0
 post_install_message: 
 rdoc_options: []
 require_paths: