Generated Latest Changes for v2021-02-25 (Account Preferred Time Zone)

lib/recurly/client/operations.rb

@@ -2245,6 +2245,15 @@ def get_invoice_pdf(invoice_id:, **options)
     #        :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)

lib/recurly/requests/account_create.rb

@@ -74,6 +74,10 @@ class AccountCreate < Request
       #   @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 }

lib/recurly/requests/account_purchase.rb

@@ -78,6 +78,10 @@ class AccountPurchase < Request
       #   @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

lib/recurly/requests/account_update.rb

@@ -66,6 +66,10 @@ class AccountUpdate < Request
       #   @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

lib/recurly/requests/add_on_create.rb

@@ -63,7 +63,7 @@ class AddOnCreate < Request
       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

lib/recurly/requests/add_on_update.rb

@@ -55,7 +55,7 @@ class AddOnUpdate < Request
       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

lib/recurly/requests/subscription_add_on_create.rb

@@ -15,7 +15,7 @@ class SubscriptionAddOnCreate < Request
       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

lib/recurly/requests/subscription_add_on_update.rb

@@ -19,7 +19,7 @@ class SubscriptionAddOnUpdate < Request
       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

lib/recurly/resources/account.rb

@@ -110,6 +110,10 @@ class Account < Resource
       #   @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 }

lib/recurly/resources/add_on.rb

@@ -75,7 +75,7 @@ class AddOn < Resource
       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

lib/recurly/resources/invoice.rb

@@ -103,7 +103,7 @@ class Invoice < Resource
       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

lib/recurly/resources/subscription_add_on.rb

@@ -31,7 +31,7 @@ class SubscriptionAddOn < Resource
       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

lib/recurly/resources/usage.rb

@@ -35,7 +35,7 @@ class Usage < Resource
       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