recurly 4.26.0 → 4.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 389eea1b74d78e485eb08e34495178d7a383a9ac748e7e7f9f94ff7361520603
-  data.tar.gz: 22d328b1f98319385cde050be1199a3ec8d7b5f41ab833d7a9013ba87761ff72
+  metadata.gz: 16800abba256fceed49ee4141796878faa9b1d10c97752fd18e05ae6f7be3761
+  data.tar.gz: 8fcb048d891ab4ae3c6a401cdaf343d1889bd53337b976ca0d86616d53ae8706
 SHA512:
-  metadata.gz: a76f723999341f4e174891b7b17033ffdf21c563cabdd8709d648de76f51bb7374a8293b3ac255d95b571f92a1a1e889a07e9cedea9626fe7e659fbc90b165c2
-  data.tar.gz: 703c91e9c0f5ca8e76f04dd3bf74f81d2355d205dcd92d90a03d3f2bac48ff84ded8b09c63b55b885856f06d123814f83674142a532ec572f132bffaead3ab3e
+  metadata.gz: c108d83003c365f301e93d255078a067ff6ecf440ba1efc3d5e0de61d40be977b5de1f1668d4661c927aeb8d8650d4d49765f6be2c9206d4545fc0315a29becf
+  data.tar.gz: d1fc3157a45ac11d9e790d2510e7de1496a5549f1dd827b973ea69a056329b8a3b01b725c7b956a3ecbba896c03415316f29b94710408676a404e9ded6e5641a

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.28.0](https://github.com/recurly/recurly-client-ruby/tree/4.28.0) (2023-01-19)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.27.0...4.28.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Custom Fields on Line Items) [#821](https://github.com/recurly/recurly-client-ruby/pull/821) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [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)

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

@@ -135,6 +135,7 @@ module Recurly
     #       code: account_code,
     #       first_name: "Benjamin",
     #       last_name: "Du Monde",
+    #       preferred_time_zone: "America/Chicago",
     #       acquisition: {
     #         campaign: "podcast-marketing",
     #         channel: "social_media",
@@ -2245,6 +2246,15 @@ module Recurly
     #        :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)

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/line_item_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
       define_attribute :currency, String
 
+      # @!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] Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
       define_attribute :description, String

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/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/line_item.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [String] 3-letter ISO 4217 currency code.
       define_attribute :currency, String
 
+      # @!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] Description that appears on the invoice. For subscription related items this will be filled in automatically.
       define_attribute :description, String

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.26.0"
+  VERSION = "4.28.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:
@@ -722,6 +722,7 @@ paths:
               code: accountCode,
               firstName: 'Benjamin',
               lastName: 'Du Monde',
+              preferredTimeZone: 'America/Chicago',
               address: {
                 street1: '900 Camp St',
                 city: 'New Orleans',
@@ -750,6 +751,7 @@ paths:
                   "code": account_code,
                   "first_name": "Benjamin",
                   "last_name": "Du Monde",
+                  "preferred_time_zone": "America/Chicago",
                   "acquisition": {
                       "campaign": "podcast-marketing",
                       "channel": "social_media",
@@ -785,6 +787,7 @@ paths:
                   Code = accountCode,
                   FirstName = "Benjamin",
                   LastName = "Du Monde",
+                  PreferredTimeZone = "America/Chicago",
                   Address = new Address()
                   {
                       City = "New Orleans",
@@ -815,6 +818,7 @@ paths:
               code: account_code,
               first_name: "Benjamin",
               last_name: "Du Monde",
+              preferred_time_zone: "America/Chicago",
               acquisition: {
                 campaign: "podcast-marketing",
                 channel: "social_media",
@@ -853,6 +857,7 @@ paths:
               accountReq.setCode(accountCode);
               accountReq.setFirstName("Aaron");
               accountReq.setLastName("Du Monde");
+              accountReq.setPreferredTimeZone("America/Chicago");
 
               address.setStreet1("900 Camp St.");
               address.setCity("New Orleans");
@@ -879,6 +884,7 @@ paths:
                   "code" => $account_code,
                   "first_name" => "Douglas",
                   "last_name" => "DuMonde",
+                  "preferred_time_zone" => "America/Chicago",
                   "shipping_addresses" => [
                       [
                           "first_name" => "Douglas",
@@ -908,17 +914,17 @@ paths:
       - lang: Go
         source: "accountReq := &recurly.AccountCreate{\n\tCode:      &accountCode,\n\tFirstName:
           recurly.String(\"Isaac\"),\n\tLastName:  recurly.String(\"Du Monde\"),\n\tEmail:
-          \    recurly.String(\"isaac@example.com\"),\n\tBillingInfo: &recurly.BillingInfoCreate{\n\t\tFirstName:
-          recurly.String(\"Isaac\"),\n\t\tLastName:  recurly.String(\"Du Monde\"),\n\t\tAddress:
-          &recurly.AddressCreate{\n\t\t\tPhone:      recurly.String(\"415-555-5555\"),\n\t\t\tStreet1:
-          \   recurly.String(\"400 Alabama St.\"),\n\t\t\tCity:       recurly.String(\"San
-          Francisco\"),\n\t\t\tPostalCode: recurly.String(\"94110\"),\n\t\t\tCountry:
-          \   recurly.String(\"US\"),\n\t\t\tRegion:     recurly.String(\"CA\"),\n\t\t},\n\t\tNumber:
-          recurly.String(\"4111111111111111\"),\n\t\tMonth:  recurly.String(\"12\"),\n\t\tYear:
-          \  recurly.String(\"22\"),\n\t\tCvv:    recurly.String(\"123\"),\n\t},\n}\n\naccount,
-          err := client.CreateAccount(accountReq)\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.String(\"isaac@example.com\"),\n\tPreferredTimeZone: recurly.String(\"America/Los_Angeles\"),\n\tBillingInfo:
+          &recurly.BillingInfoCreate{\n\t\tFirstName: recurly.String(\"Isaac\"),\n\t\tLastName:
+          \ recurly.String(\"Du Monde\"),\n\t\tAddress: &recurly.AddressCreate{\n\t\t\tPhone:
+          \     recurly.String(\"415-555-5555\"),\n\t\t\tStreet1:    recurly.String(\"400
+          Alabama St.\"),\n\t\t\tCity:       recurly.String(\"San Francisco\"),\n\t\t\tPostalCode:
+          recurly.String(\"94110\"),\n\t\t\tCountry:    recurly.String(\"US\"),\n\t\t\tRegion:
+          \    recurly.String(\"CA\"),\n\t\t},\n\t\tNumber: recurly.String(\"4111111111111111\"),\n\t\tMonth:
+          \ recurly.String(\"12\"),\n\t\tYear:   recurly.String(\"22\"),\n\t\tCvv:
+          \   recurly.String(\"123\"),\n\t},\n}\n\naccount, err := client.CreateAccount(accountReq)\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}\nfmt.Printf(\"Created Account:
           %s\", account.Id)"
   "/accounts/{account_id}":
@@ -8092,6 +8098,8 @@ paths:
       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"
@@ -8110,7 +8118,8 @@ paths:
                 "$ref": "#/components/schemas/Error"
         '422':
           description: Tried applying credit to a legacy or closed invoice or there
-            was an error processing the credit payment.
+            was an error processing the credit payment, such as no available credit
+            on the account.
           content:
             application/json:
               schema:
@@ -8121,7 +8130,95 @@ paths:
             application/json:
               schema:
                 "$ref": "#/components/schemas/Error"
-      x-code-samples: []
+      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:
@@ -14597,6 +14694,8 @@ paths:
         The API request allows the inclusion of one of the following fields: **external_hpp_type** with `'adyen'` and **online_banking_payment_type** with `'ideal'` or `'sofort'` in the **billing_info** object.
 
         For additional information regarding shipping fees, please see https://docs.recurly.com/docs/shipping
+
+        Note: an email address is required on the account for a Pending Purchase.
       requestBody:
         content:
           application/json:
@@ -16177,6 +16276,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.
@@ -16279,6 +16383,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.
@@ -16684,6 +16794,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:
@@ -16877,7 +16989,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
@@ -17018,7 +17131,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:
@@ -18256,7 +18370,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
@@ -19023,6 +19141,8 @@ components:
           format: date-time
           title: End date
           description: If this date is provided, it indicates the end of a time range.
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         created_at:
           type: string
           format: date-time
@@ -19189,6 +19309,8 @@ components:
             true.  This origin creates a charge and opposite credit on the account
             to be used for future invoices.
           "$ref": "#/components/schemas/LineItemCreateOriginEnum"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         start_date:
           type: string
           format: date-time
@@ -20662,8 +20784,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
@@ -20740,8 +20862,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
@@ -20820,8 +20943,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
@@ -22002,7 +22125,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
@@ -22416,7 +22540,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
@@ -22496,8 +22621,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
@@ -22786,6 +22911,7 @@ components:
       - item
       - plan
       - subscription
+      - charge
     RefundTypeEnum:
       type: string
       enum:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.26.0
+  version: 4.28.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2023-01-19 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.26.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.28.0
 post_install_message: 
 rdoc_options: []
 require_paths: