recurly 3.22.0 → 3.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66774f5d5a08c4cd26758c2dd4c073c8b9515129caf340a76756f3f5ed55e712
-  data.tar.gz: 529eec421b40a5c80bd143338786871325deeb19a9818aaca8bd1e673075461f
+  metadata.gz: ed0b8401ee5879270989110b1b826589fe628d1befb4209b2f995bc8c2d55124
+  data.tar.gz: 62d1aba9f1e248b0ba1c9eeb790cdfd2d935d49e743d2f9cfa8ccaf6d33cb5e7
 SHA512:
-  metadata.gz: d90a2cb844beef990fb9537c1e6e294a0868bab10854ebaf45151b552ed6025a79423b687ad24844ff10af555a181b46b0d6496e7ecedaa227aac6b8570fd4c7
-  data.tar.gz: 9a2e29e819378925cf72c9d4959fa02b9120e02af32c7f45f054cce93b827b5796e13784288ead5694514047b479eb39cb3ce5444ac7511de117cb3de18bd5d1
+  metadata.gz: 650e5852f33c74e4407668d517f0b2f8c429a358782ac8c7f804378528f88e4b903cd173020666f0a7aeb794143d1e01693e15ae1eaa838bf3d7febef4ccd28a
+  data.tar.gz: 545373440597d3477a1eaf2210ae5963ff7a8784524d3332a126550f059917f8d3516becf4a2793be90a048666edb1437f3038f40aca4d6093938f7b26a431c2

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [3.24.0](https://github.com/recurly/recurly-client-ruby/tree/3.24.0) (2023-01-11)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.23.0...3.24.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2019-10-10 (Account Preferred Time Zone) [#815](https://github.com/recurly/recurly-client-ruby/pull/815) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [3.23.0](https://github.com/recurly/recurly-client-ruby/tree/3.23.0) (2022-11-17)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.22.0...3.23.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2019-10-10 (Apply Credit Balance feature) [#810](https://github.com/recurly/recurly-client-ruby/pull/810) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2019-10-10 [#806](https://github.com/recurly/recurly-client-ruby/pull/806) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [3.22.0](https://github.com/recurly/recurly-client-ruby/tree/3.22.0) (2022-10-21)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.21.0...3.22.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', '~> 3.22'
+gem 'recurly', '~> 3.24'
 ```
 
 > *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

@@ -565,7 +565,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/v2019-10-10#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
     #
@@ -610,7 +610,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the coupon redemption that is active on an account
+    # Fetch the coupon redemption that is active on an account
     #
     # {https://developers.recurly.com/api/v2019-10-10#operation/get_active_coupon_redemption get_active_coupon_redemption api documentation}
     #
@@ -916,7 +916,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/v2019-10-10#operation/list_account_notes list_account_notes api documentation}
     #
@@ -2060,6 +2060,29 @@ module Recurly
       get(path, **options)
     end
 
+    # Apply available credit to a pending or past due charge invoice
+    #
+    # {https://developers.recurly.com/api/v2019-10-10#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 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/v2019-10-10#operation/collect_invoice collect_invoice api documentation}
@@ -2240,7 +2263,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/v2019-10-10#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
     #
@@ -3427,7 +3450,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/v2019-10-10#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
     #
@@ -3808,7 +3831,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/v2019-10-10#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
     #
@@ -3824,7 +3847,7 @@ module Recurly
       pager(path, **options)
     end
 
-    # Show the settings for a dunning campaign
+    # Fetch a dunning campaign
     #
     # {https://developers.recurly.com/api/v2019-10-10#operation/get_dunning_campaign get_dunning_campaign api documentation}
     #

data/lib/recurly/requests/account_create.rb

@@ -70,6 +70,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

@@ -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 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

@@ -62,6 +62,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

@@ -75,7 +75,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
@@ -87,7 +87,7 @@ module Recurly
       define_attribute :usage_percentage, Float
 
       # @!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/billing_info_create.rb

@@ -103,7 +103,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]] 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/subscription_add_on_create.rb

@@ -23,7 +23,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 with an `ending_quantity` of 999999999 which is the default if not provided. 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 with an `ending_quantity` of 999999999 which is the default if not provided. 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
@@ -31,7 +31,7 @@ module Recurly
       define_attribute :unit_amount, Float
 
       # @!attribute usage_percentage
-      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. 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/account.rb

@@ -106,6 +106,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/invoice.rb

@@ -91,7 +91,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/v2019-10-10/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/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/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.22.0"
+  VERSION = "3.24.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
@@ -113,7 +113,7 @@ info:
     Please consider changing these messages in 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
@@ -180,7 +180,7 @@ info:
 
     ## Change Log
 
-    A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2019-10-10).
+    A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2019-10-10).
   version: v2019-10-10
 security:
 - api_key: []
@@ -304,6 +304,8 @@ tags:
   description: A purchase is a checkout containing at least one or more subscriptions
     or one-time charges (line items) and supports both coupon and gift card redemptions.
     All items purchased will be on one invoice and paid for with one transaction.
+    The purchases endpoint can also be used to immediately create a credit invoice
+    on an account, when Credit Invoices is enabled on your site.
 - name: usage
   x-displayName: Usage
   description: Send Recurly your customer usage and we will automatically bill them
@@ -343,7 +345,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:
@@ -542,8 +544,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -2425,8 +2427,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -2634,9 +2636,9 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_account_coupon_redemptions
-      summary: Show 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.
+      summary: List the coupon redemptions for an account
+      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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -2723,7 +2725,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: get_active_coupon_redemption
-      summary: Show the coupon redemption that is active on an account
+      summary: Fetch the coupon redemption that is active on an account
       parameters:
       - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -3086,8 +3088,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -3181,8 +3183,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -3617,8 +3619,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -3715,6 +3717,8 @@ paths:
       - line_item
       operationId: create_line_item
       summary: Create a new line item for the account
+      description: When using the Credit Invoices feature, utilize the purchases endpoint
+        in order to immediately post credit to a credit invoice.
       parameters:
       - "$ref": "#/components/parameters/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -3883,9 +3887,9 @@ paths:
       tags:
       - note
       operationId: list_account_notes
-      summary: Fetch a list of an account's notes
-      description: See the [Pagination Guide](/guides/pagination.html) to learn how
-        to use pagination in the API and Client Libraries.
+      summary: List an account's notes
+      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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -4092,8 +4096,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -4771,8 +4775,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -4867,8 +4871,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -4965,8 +4969,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/site_id"
       - "$ref": "#/components/parameters/account_id"
@@ -5040,8 +5044,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -5132,8 +5136,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -5995,8 +5999,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/site_id"
       - "$ref": "#/components/parameters/coupon_id"
@@ -6032,8 +6036,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/site_id"
       - "$ref": "#/components/parameters/limit"
@@ -6151,8 +6155,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -6169,6 +6173,7 @@ paths:
           enum:
           - account
           - item
+          - plan
           - subscription
       responses:
         '200':
@@ -6369,8 +6374,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -7191,8 +7196,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -7377,8 +7382,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -7868,6 +7873,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;
           }
+  "/sites/{site_id}/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)"
   "/sites/{site_id}/invoices/{invoice_id}/collect":
     put:
       tags:
@@ -8557,8 +8691,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/site_id"
       - "$ref": "#/components/parameters/invoice_id"
@@ -8658,9 +8792,9 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_invoice_coupon_redemptions
-      summary: Show 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.
+      summary: List the coupon redemptions applied to an invoice
+      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/site_id"
       - "$ref": "#/components/parameters/invoice_id"
@@ -8756,7 +8890,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/site_id"
       - "$ref": "#/components/parameters/invoice_id"
@@ -9006,8 +9140,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -9336,8 +9470,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -9997,8 +10131,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/site_id"
       - "$ref": "#/components/parameters/plan_id"
@@ -10659,8 +10793,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -10869,8 +11003,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -11120,8 +11254,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -12912,8 +13046,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/site_id"
       - "$ref": "#/components/parameters/subscription_id"
@@ -13009,8 +13143,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/site_id"
       - "$ref": "#/components/parameters/subscription_id"
@@ -13107,9 +13241,9 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_subscription_coupon_redemptions
-      summary: Show 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.
+      summary: List the coupon redemptions for a subscription
+      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/site_id"
       - "$ref": "#/components/parameters/subscription_id"
@@ -13402,8 +13536,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/site_id"
       - "$ref": "#/components/parameters/ids"
@@ -14403,9 +14537,9 @@ paths:
       tags:
       - dunning_campaigns
       operationId: list_dunning_campaigns
-      summary: Show 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.
+      summary: List the dunning campaigns for a site
+      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:
@@ -14435,7 +14569,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.
@@ -15437,6 +15571,11 @@ components:
           - sv-SE
           - tr-TR
           - zh-CN
+        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.
@@ -15569,6 +15708,12 @@ components:
           - sv-SE
           - tr-TR
           - zh-CN
+        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.
@@ -15723,9 +15868,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"
@@ -16061,7 +16212,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)
+            [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
             for an overview of how to configure usage add-ons.
         usage_percentage:
           type: number
@@ -16177,7 +16328,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
+            our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview
             of how to configure quantity-based pricing models.
           default: flat
           enum:
@@ -16428,7 +16579,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
@@ -17291,6 +17442,7 @@ components:
           enum:
           - account
           - item
+          - plan
           - subscription
         name:
           type: string
@@ -17714,7 +17866,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/v2019-10-10/index.html#operation/list_related_invoices)
+            to see purchase invoices refunded by this invoice.
           maxLength: 13
         number:
           type: string
@@ -18869,6 +19025,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         accounting_code:
           type: string
           title: Plan accounting code
@@ -19063,6 +19221,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           type: string
           title: Revenue schedule type
@@ -19277,6 +19437,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           type: string
           title: Revenue schedule type
@@ -20257,7 +20419,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 with an `ending_quantity` of 999999999 which is the
-            default if not provided. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
+            default if not provided. See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
             for an overview of how to configure quantity-based pricing models.
         usage_percentage:
           type: number
@@ -20266,7 +20428,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:
           type: string

metadata

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