recurly 4.5.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab15012ab4dc0ad0a98506632f63d7496dd6a4efe39d970810f353c10b10a22d
-  data.tar.gz: cec6000b28ccbf14ed002a73476c296df2d46b6266664e24b0978e6e1ed0600e
+  metadata.gz: 38f52125b8c12aad80f605fc94ea0587a73ea82823fb8aec6b2deae2f706983c
+  data.tar.gz: f223a30e3a884cb319e020cb074aa00b88aeb0d44529ddab8539f5636dc38ce0
 SHA512:
-  metadata.gz: 53a4a6da3a7e648e813678acc0a3f565ecead9c0c114fad15f75b4eeb46f2c049e689d563db26ea5fb958ca40e318f1e7a28ed435b9a14fefe4bb0fbc9bc45fd
-  data.tar.gz: a384b0e85ebad2b40a2aa4c1909c57c0e16065b2aa63c2084b815fdb1f6be81e2d97fa4e7bcaf22ce6599c7ddd7fd6935476e2f3f49aef5952f9cc4467d1484f
+  metadata.gz: 7ec68d64ac36472c09c7267b3439eb2b3d63e0d7c17ad8245068c0378395e1562d4de229b360c8aab6ac2995db1c4fa1804c230f4ec1831213bb51cf8bed6d36
+  data.tar.gz: 922e7c9f74131d607115100ae592da8f6d50fa72760d66d90b6e15ec824a31e1d34c6202895f43d37a482bf493bbd5e06bad3fa184008b54bc42d637f2ef062f

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## [4.9.0](https://github.com/recurly/recurly-client-ruby/tree/4.9.0) (2021-09-16)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.8.0...4.9.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Support to new subscription fields and response) [#725](https://github.com/recurly/recurly-client-ruby/pull/725) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.8.0](https://github.com/recurly/recurly-client-ruby/tree/4.8.0) (2021-09-01)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.7.0...4.8.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (Dunning Campaigns feature) [#724](https://github.com/recurly/recurly-client-ruby/pull/724) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.7.0](https://github.com/recurly/recurly-client-ruby/tree/4.7.0) (2021-08-19)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.6.0...4.7.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 (get_preview_renewal) [#722](https://github.com/recurly/recurly-client-ruby/pull/722) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.6.0](https://github.com/recurly/recurly-client-ruby/tree/4.6.0) (2021-08-11)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.5.0...4.6.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#720](https://github.com/recurly/recurly-client-ruby/pull/720) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.5.0](https://github.com/recurly/recurly-client-ruby/tree/4.5.0) (2021-08-02)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.4.0...4.5.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.5'
+gem 'recurly', '~> 4.9'
 ```
 
 > *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

@@ -3300,6 +3300,20 @@ module Recurly
       put(path, **options)
     end
 
+    # Fetch a preview of a subscription's renewal invoice(s)
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_preview_renewal get_preview_renewal api documenation}
+    #
+    # @param subscription_id [String] Subscription ID or UUID. For ID no prefix is used e.g. +e28zov4fw0v2+. For UUID use prefix +uuid-+, e.g. +uuid-123457890+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::InvoiceCollection] A preview of the subscription's renewal invoice(s).
+    #
+    def get_preview_renewal(subscription_id:, **options)
+      path = interpolate_path("/subscriptions/{subscription_id}/preview_renewal", subscription_id: subscription_id)
+      get(path, **options)
+    end
+
     # Fetch a subscription's pending change
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_subscription_change get_subscription_change api documenation}
@@ -3889,5 +3903,50 @@ module Recurly
       path = interpolate_path("/export_dates/{export_date}/export_files", export_date: export_date)
       get(path, **options)
     end
+
+    # Show the dunning campaigns for a site
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documenation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #        :sort [String] Sort field. You *really* only want to sort by +updated_at+ in ascending
+    #   order. In descending order updated records will move behind the cursor and could
+    #   prevent some records from being returned.
+    #
+    #
+    # @return [Pager<Resources::DunningCampaign>] A list of the the dunning_campaigns on an account.
+    #
+    def list_dunning_campaigns(**options)
+      path = "/dunning_campaigns"
+      pager(path, **options)
+    end
+
+    # Show the settings for a dunning campaign
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documenation}
+    #
+    # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::DunningCampaign] Settings for a dunning campaign.
+    #
+    def get_dunning_campaign(dunning_campaign_id:, **options)
+      path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
+      get(path, **options)
+    end
+
+    # Assign a dunning campaign to multiple plans
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documenation}
+    #
+    # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
+    #
+    def put_dunning_campaign_bulk_update(body:, **options)
+      path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
+      put(path, body, Requests::DunningCampaignsBulkUpdate, **options)
+    end
   end
 end

data/lib/recurly/requests/account_create.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @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 dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/account_purchase.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @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 dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/account_update.rb

@@ -30,6 +30,10 @@ module Recurly
       #   @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 dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/requests/dunning_campaigns_bulk_update.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class DunningCampaignsBulkUpdate < Request
+
+      # @!attribute plan_codes
+      #   @return [Array[String]] List of `plan_codes` associated with the Plans for which the dunning campaign should be updated. Required unless `plan_ids` is present.
+      define_attribute :plan_codes, Array, { :item_type => String }
+
+      # @!attribute plan_ids
+      #   @return [Array[String]] List of `plan_ids` associated with the Plans for which the dunning campaign should be updated. Required unless `plan_codes` is present.
+      define_attribute :plan_ids, Array, { :item_type => String }
+    end
+  end
+end

data/lib/recurly/requests/plan_create.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute hosted_pages
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages

data/lib/recurly/requests/plan_update.rb

@@ -38,6 +38,10 @@ module Recurly
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute hosted_pages
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages

data/lib/recurly/requests/subscription_change_billing_info_create.rb

@@ -0,0 +1,14 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class SubscriptionChangeBillingInfoCreate < Request
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -10,6 +10,10 @@ module Recurly
       #   @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.'  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
 
+      # @!attribute billing_info
+      #   @return [SubscriptionChangeBillingInfoCreate]
+      define_attribute :billing_info, :SubscriptionChangeBillingInfoCreate
+
       # @!attribute collection_method
       #   @return [String] Collection method
       define_attribute :collection_method, String

data/lib/recurly/requests/subscription_change_shipping_create.rb

@@ -6,6 +6,14 @@ module Recurly
   module Requests
     class SubscriptionChangeShippingCreate < Request
 
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and address are both present, address will take precedence.
+      define_attribute :address_id, String
+
       # @!attribute amount
       #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
       define_attribute :amount, Float

data/lib/recurly/requests/subscription_pause.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionPause < Request
 
       # @!attribute remaining_pause_cycles
-      #   @return [Integer] Number of billing cycles to pause the subscriptions.
+      #   @return [Integer] Number of billing cycles to pause the subscriptions. A value of 0 will cancel any pending pauses on the subscription.
       define_attribute :remaining_pause_cycles, Integer
     end
   end

data/lib/recurly/requests/subscription_update.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String] Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
       define_attribute :customer_notes, String
 
+      # @!attribute gateway_code
+      #   @return [String] If present, this subscription's transactions will use the payment gateway with this code.
+      define_attribute :gateway_code, String
+
       # @!attribute net_terms
       #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
       define_attribute :net_terms, Integer

data/lib/recurly/resources/account.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @return [DateTime] If present, when the account was last marked inactive.
       define_attribute :deleted_at, DateTime
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String

data/lib/recurly/resources/account_mini.rb

@@ -18,6 +18,10 @@ module Recurly
       #   @return [String]
       define_attribute :company, String
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer.
       define_attribute :email, String

data/lib/recurly/resources/dunning_campaign.rb

@@ -0,0 +1,50 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class DunningCampaign < Resource
+
+      # @!attribute code
+      #   @return [String] Campaign code.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] When the current campaign was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute default_campaign
+      #   @return [Boolean] Whether or not this is the default campaign for accounts or plans without an assigned dunning campaign.
+      define_attribute :default_campaign, :Boolean
+
+      # @!attribute deleted_at
+      #   @return [DateTime] When the current campaign was deleted in Recurly.
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Campaign description.
+      define_attribute :description, String
+
+      # @!attribute dunning_cycles
+      #   @return [Array[DunningCycle]] Dunning Cycle settings.
+      define_attribute :dunning_cycles, Array, { :item_type => :DunningCycle }
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Campaign name.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the current campaign was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/dunning_campaigns_bulk_update_response.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class DunningCampaignsBulkUpdateResponse < Resource
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plans
+      #   @return [Array[Plan]] An array containing all of the `Plan` resources that have been updated.
+      define_attribute :plans, Array, { :item_type => :Plan }
+    end
+  end
+end

data/lib/recurly/resources/dunning_cycle.rb

@@ -0,0 +1,58 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class DunningCycle < Resource
+
+      # @!attribute applies_to_manual_trial
+      #   @return [Boolean] Whether the dunning settings will be applied to manual trials. Only applies to trial cycles.
+      define_attribute :applies_to_manual_trial, :Boolean
+
+      # @!attribute created_at
+      #   @return [DateTime] When the current settings were created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute expire_subscription
+      #   @return [Boolean] Whether the subscription(s) should be cancelled at the end of the dunning cycle.
+      define_attribute :expire_subscription, :Boolean
+
+      # @!attribute fail_invoice
+      #   @return [Boolean] Whether the invoice should be failed at the end of the dunning cycle.
+      define_attribute :fail_invoice, :Boolean
+
+      # @!attribute first_communication_interval
+      #   @return [Integer] The number of days after a transaction failure before the first dunning email is sent.
+      define_attribute :first_communication_interval, Integer
+
+      # @!attribute intervals
+      #   @return [Array[DunningInterval]] Dunning intervals.
+      define_attribute :intervals, Array, { :item_type => :DunningInterval }
+
+      # @!attribute send_immediately_on_hard_decline
+      #   @return [Boolean] Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.
+      define_attribute :send_immediately_on_hard_decline, :Boolean
+
+      # @!attribute total_dunning_days
+      #   @return [Integer] The number of days between the first dunning email being sent and the end of the dunning cycle.
+      define_attribute :total_dunning_days, Integer
+
+      # @!attribute total_recycling_days
+      #   @return [Integer] The number of days between a transaction failure and the end of the dunning cycle.
+      define_attribute :total_recycling_days, Integer
+
+      # @!attribute type
+      #   @return [String] The type of invoice this cycle applies to.
+      define_attribute :type, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the current settings were updated in Recurly.
+      define_attribute :updated_at, DateTime
+
+      # @!attribute version
+      #   @return [Integer] Current campaign version.
+      define_attribute :version, Integer
+    end
+  end
+end

data/lib/recurly/resources/dunning_interval.rb

@@ -0,0 +1,18 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Resources
+    class DunningInterval < Resource
+
+      # @!attribute days
+      #   @return [Integer] Number of days before sending the next email.
+      define_attribute :days, Integer
+
+      # @!attribute email_template
+      #   @return [String] Email template being used.
+      define_attribute :email_template, String
+    end
+  end
+end

data/lib/recurly/resources/invoice.rb

@@ -54,6 +54,10 @@ module Recurly
       #   @return [DateTime] Date invoice is due. This is the date the net terms are reached.
       define_attribute :due_at, DateTime
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify the dunning campaign used when dunning the invoice. Available when the Dunning Campaigns feature is enabled. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute has_more_line_items
       #   @return [Boolean] Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
       define_attribute :has_more_line_items, :Boolean

data/lib/recurly/resources/plan.rb

@@ -46,6 +46,10 @@ module Recurly
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
+      # @!attribute dunning_campaign_id
+      #   @return [String] Unique ID to identify a dunning campaign. Available when the Dunning Campaigns feature is enabled. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
+      define_attribute :dunning_campaign_id, String
+
       # @!attribute hosted_pages
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages

data/lib/recurly/resources/subscription.rb

@@ -86,6 +86,10 @@ module Recurly
       #   @return [DateTime] Expires at
       define_attribute :expires_at, DateTime
 
+      # @!attribute gateway_code
+      #   @return [String] If present, this subscription's transactions will use the payment gateway with this code.
+      define_attribute :gateway_code, String
+
       # @!attribute id
       #   @return [String] Subscription ID
       define_attribute :id, String
@@ -146,10 +150,22 @@ module Recurly
       #   @return [Float] Estimated total, before tax.
       define_attribute :subtotal, Float
 
+      # @!attribute tax
+      #   @return [Float] Estimated tax
+      define_attribute :tax, Float
+
+      # @!attribute tax_info
+      #   @return [TaxInfo] Tax info
+      define_attribute :tax_info, :TaxInfo
+
       # @!attribute terms_and_conditions
       #   @return [String] Terms and conditions
       define_attribute :terms_and_conditions, String
 
+      # @!attribute total
+      #   @return [Float] Estimated total
+      define_attribute :total, Float
+
       # @!attribute total_billing_cycles
       #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.5.0"
+  VERSION = "4.9.0"
 end

data/openapi/api.yaml

@@ -219,6 +219,7 @@ x-tagGroups:
   - site
   - custom_field_definition
   - shipping_method
+  - dunning_campaigns
 tags:
 - name: site
   x-displayName: Site
@@ -332,6 +333,9 @@ tags:
 - name: automated_exports
   x-displayName: Automated Exports
   description: Automated exports of customer data.
+- name: dunning_campaigns
+  x-displayName: Dunning Campaigns
+  description: Settings used when attempting to dun customers whose payments are declined.
 paths:
   "/sites":
     get:
@@ -12434,6 +12438,43 @@ paths:
               schema:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
+  "/subscriptions/{subscription_id}/preview_renewal":
+    get:
+      tags:
+      - subscription
+      operationId: get_preview_renewal
+      summary: Fetch a preview of a subscription's renewal invoice(s)
+      description: The subscriptions's renewal invoice(s) will be returned if they
+        exist; if they don't (for example, if the subscription is not set to renew),
+        it will return an result with no invoices.
+      parameters:
+      - "$ref": "#/components/parameters/subscription_id"
+      responses:
+        '200':
+          description: A preview of the subscription's renewal invoice(s).
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/InvoiceCollection"
+        '400':
+          description: Invalid or unpermitted parameter.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site ID or subscription ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
   "/subscriptions/{subscription_id}/change":
     get:
       tags:
@@ -12570,7 +12611,16 @@ paths:
       - subscription_change
       operationId: create_subscription_change
       summary: Create a new subscription change
-      description: Calling this will overwrite an existing, pending subscription change.
+      description: |
+        Calling this will overwrite an existing, pending subscription change.
+
+        If a subscription has a pending change, and a change is submitted which matches
+        the subscription as it currently exists, the pending change will be deleted,
+        and you will receive a 204 No Content response.
+
+        If a subscription has no pending
+        change, and a change is submitted which matches the subscription as it currently
+        exists, a 422 Unprocessable Entity validation error will be returned.
       parameters:
       - "$ref": "#/components/parameters/subscription_id"
       requestBody:
@@ -12586,6 +12636,8 @@ paths:
             application/json:
               schema:
                 "$ref": "#/components/schemas/SubscriptionChange"
+        '204':
+          description: The previous pending change was reverted.
         '404':
           description: Incorrect site ID.
           content:
@@ -14395,6 +14447,107 @@ paths:
           err.(*recurly.Error); ok {\n\tfmt.Printf(\"Unexpected Recurly error: %v\",
           e)\n\treturn nil, err\n}\n\nfor _, file := range exportFiles.Files {\n\tfmt.Println(\"Export
           file download URL: \", file.Href)\n}"
+  "/dunning_campaigns":
+    get:
+      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.
+      parameters:
+      - "$ref": "#/components/parameters/sort_dates"
+      responses:
+        '200':
+          description: A list of the the dunning_campaigns on an account.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/DunningCampaignList"
+        '404':
+          description: Incorrect site.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/dunning_campaigns/{dunning_campaign_id}":
+    parameters:
+    - "$ref": "#/components/parameters/dunning_campaign_id"
+    get:
+      tags:
+      - dunning_campaigns
+      operationId: get_dunning_campaign
+      summary: Show the settings for a dunning campaign
+      responses:
+        '200':
+          description: Settings for a dunning campaign.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/DunningCampaign"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or campaign ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
+  "/dunning_campaigns/{dunning_campaign_id}/bulk_update":
+    put:
+      tags:
+      - dunning_campaigns
+      operationId: put_dunning_campaign_bulk_update
+      summary: Assign a dunning campaign to multiple plans
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/DunningCampaignsBulkUpdate"
+      responses:
+        '200':
+          description: A list of updated plans.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/DunningCampaignsBulkUpdateResponse"
+        '400':
+          description: Bad request; perhaps missing or invalid parameters.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        '404':
+          description: Incorrect site or campaign ID.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+        default:
+          description: Unexpected error.
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Error"
+      x-code-samples: []
 servers:
 - url: https://v3.recurly.com
 components:
@@ -14538,6 +14691,13 @@ components:
       required: true
       schema:
         type: string
+    dunning_campaign_id:
+      name: dunning_campaign_id
+      in: path
+      description: Dunning Campaign ID, e.g. `e28zov4fw0v2`.
+      required: true
+      schema:
+        type: string
     ids:
       name: ids
       in: query
@@ -15287,6 +15447,14 @@ components:
             created by this request. Supports 'moto' value, which is the acronym for
             mail order and telephone transactions.
           "$ref": "#/components/schemas/GatewayTransactionTypeEnum"
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Available when the
+            Dunning Campaigns feature is enabled. Used to specify if a non-default
+            dunning campaign should be assigned to this account. For sites without
+            multiple dunning campaigns enabled, the default dunning campaign will
+            always be used.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -15357,6 +15525,14 @@ components:
             specifically whether the account is self-paying or will rely on the parent
             account to pay.
           "$ref": "#/components/schemas/BillToEnum"
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Available when the
+            Dunning Campaigns feature is enabled. Used to specify if a non-default
+            dunning campaign should be assigned to this account. For sites without
+            multiple dunning campaigns enabled, the default dunning campaign will
+            always be used.
         address:
           "$ref": "#/components/schemas/Address"
         billing_info:
@@ -15422,6 +15598,14 @@ components:
         bill_to:
           type: string
           maxLength: 6
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Available when the
+            Dunning Campaigns feature is enabled. Used to specify if a non-default
+            dunning campaign should be assigned to this account. For sites without
+            multiple dunning campaigns enabled, the default dunning campaign will
+            always be used.
     AccountBalance:
       type: object
       properties:
@@ -17338,6 +17522,13 @@ components:
           format: date-time
           title: Closed at
           description: Date invoice was marked paid or failed.
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify the dunning campaign used when dunning
+            the invoice. Available when the Dunning Campaigns feature is enabled.
+            For sites without multiple dunning campaigns enabled, this will always
+            be the default dunning campaign.
     InvoiceCreate:
       type: object
       properties:
@@ -18250,6 +18441,14 @@ components:
             Used to determine whether items can be assigned as add-ons to individual subscriptions.
             If `true`, items can be assigned as add-ons to individual subscription add-ons.
             If `false`, only plan add-ons can be used.
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Available when the
+            Dunning Campaigns feature is enabled. Used to specify if a non-default
+            dunning campaign should be assigned to this plan. For sites without multiple
+            dunning campaigns enabled, the default dunning campaign will always be
+            used.
         created_at:
           type: string
           format: date-time
@@ -18406,6 +18605,14 @@ components:
             Used to determine whether items can be assigned as add-ons to individual subscriptions.
             If `true`, items can be assigned as add-ons to individual subscription add-ons.
             If `false`, only plan add-ons can be used.
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Available when the
+            Dunning Campaigns feature is enabled. Used to specify if a non-default
+            dunning campaign should be assigned to this plan. For sites without multiple
+            dunning campaigns enabled, the default dunning campaign will always be
+            used.
       required:
       - code
       - name
@@ -18582,6 +18789,14 @@ components:
             Used to determine whether items can be assigned as add-ons to individual subscriptions.
             If `true`, items can be assigned as add-ons to individual subscription add-ons.
             If `false`, only plan add-ons can be used.
+        dunning_campaign_id:
+          type: string
+          title: Dunning Campaign ID
+          description: Unique ID to identify a dunning campaign. Available when the
+            Dunning Campaigns feature is enabled. Used to specify if a non-default
+            dunning campaign should be assigned to this plan. For sites without multiple
+            dunning campaigns enabled, the default dunning campaign will always be
+            used.
     AddOnPricing:
       type: object
       properties:
@@ -19239,6 +19454,16 @@ components:
           format: float
           title: Estimated total, before tax.
           minimum: 0
+        tax:
+          type: number
+          format: float
+          title: Estimated tax
+        tax_info:
+          "$ref": "#/components/schemas/TaxInfo"
+        total:
+          type: number
+          format: float
+          title: Estimated total
         collection_method:
           title: Collection method
           default: automatic
@@ -19298,6 +19523,12 @@ components:
             set. This timestamp is used for alerting customers to reauthorize in 3
             years in accordance with NACHA rules. If a subscription becomes inactive
             or the billing info is no longer a bank account, this timestamp is cleared.
+        gateway_code:
+          type: string
+          title: Gateway Code
+          description: If present, this subscription's transactions will use the payment
+            gateway with this code.
+          maxLength: 13
         billing_info_id:
           type: string
           title: Billing Info ID
@@ -19618,6 +19849,9 @@ components:
           description: A token generated by Recurly.js after completing a 3-D Secure
             device fingerprinting or authentication challenge.
           maxLength: 22
+    SubscriptionChangeBillingInfoCreate:
+      allOf:
+      - "$ref": "#/components/schemas/SubscriptionChangeBillingInfo"
     SubscriptionChangeCreate:
       type: object
       properties:
@@ -19722,6 +19956,8 @@ components:
             created by this request. Supports 'moto' value, which is the acronym for
             mail order and telephone transactions.
           "$ref": "#/components/schemas/GatewayTransactionTypeEnum"
+        billing_info:
+          "$ref": "#/components/schemas/SubscriptionChangeBillingInfoCreate"
     SubscriptionChangeShippingCreate:
       type: object
       title: Shipping details that will be changed on a subscription
@@ -19747,6 +19983,13 @@ components:
           format: float
           title: Assigns the subscription's shipping cost. If this is greater than
             zero then a `method_id` or `method_code` is required.
+        address_id:
+          type: string
+          titpe: Shipping address ID
+          description: Assign a shipping address from the account's existing shipping
+            addresses. If this and address are both present, address will take precedence.
+        address:
+          "$ref": "#/components/schemas/ShippingAddressCreate"
     SubscriptionCreate:
       type: object
       properties:
@@ -20055,6 +20298,12 @@ components:
             at 31 days exactly.
           minimum: 0
           default: 0
+        gateway_code:
+          type: string
+          title: Gateway Code
+          description: If present, this subscription's transactions will use the payment
+            gateway with this code.
+          maxLength: 13
         shipping:
           "$ref": "#/components/schemas/SubscriptionShippingUpdate"
         billing_info_id:
@@ -20070,7 +20319,8 @@ components:
         remaining_pause_cycles:
           type: integer
           title: Remaining pause cycles
-          description: Number of billing cycles to pause the subscriptions.
+          description: Number of billing cycles to pause the subscriptions. A value
+            of 0 will cancel any pending pauses on the subscription.
       required:
       - remaining_pause_cycles
     SubscriptionShipping:
@@ -20760,6 +21010,150 @@ components:
       required:
       - currency
       - account
+    DunningCampaign:
+      type: object
+      description: Settings for a dunning campaign.
+      properties:
+        id:
+          type: string
+        object:
+          type: string
+          title: Object type
+        code:
+          type: string
+          description: Campaign code.
+        name:
+          type: string
+          description: Campaign name.
+        description:
+          type: string
+          description: Campaign description.
+        default_campaign:
+          type: boolean
+          description: Whether or not this is the default campaign for accounts or
+            plans without an assigned dunning campaign.
+        dunning_cycles:
+          type: array
+          description: Dunning Cycle settings.
+          items:
+            "$ref": "#/components/schemas/DunningCycle"
+        created_at:
+          type: string
+          format: date-time
+          description: When the current campaign was created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          description: When the current campaign was updated in Recurly.
+        deleted_at:
+          type: string
+          format: date-time
+          description: When the current campaign was deleted in Recurly.
+    DunningCampaignList:
+      type: object
+      properties:
+        object:
+          type: string
+          title: Object type
+          description: Will always be List.
+        has_more:
+          type: boolean
+          description: Indicates there are more results on subsequent pages.
+        next:
+          type: string
+          description: Path to subsequent page of results.
+        data:
+          type: array
+          items:
+            "$ref": "#/components/schemas/DunningCampaign"
+    DunningCycle:
+      type: object
+      properties:
+        type:
+          "$ref": "#/components/schemas/DunningCycleTypeEnum"
+        applies_to_manual_trial:
+          type: boolean
+          description: Whether the dunning settings will be applied to manual trials.
+            Only applies to trial cycles.
+        first_communication_interval:
+          type: integer
+          description: The number of days after a transaction failure before the first
+            dunning email is sent.
+        send_immediately_on_hard_decline:
+          type: boolean
+          description: Whether or not to send an extra email immediately to customers
+            whose initial payment attempt fails with either a hard decline or invalid
+            billing info.
+        intervals:
+          type: array
+          description: Dunning intervals.
+          items:
+            "$ref": "#/components/schemas/DunningInterval"
+        expire_subscription:
+          type: boolean
+          description: Whether the subscription(s) should be cancelled at the end
+            of the dunning cycle.
+        fail_invoice:
+          type: boolean
+          description: Whether the invoice should be failed at the end of the dunning
+            cycle.
+        total_dunning_days:
+          type: integer
+          description: The number of days between the first dunning email being sent
+            and the end of the dunning cycle.
+        total_recycling_days:
+          type: integer
+          description: The number of days between a transaction failure and the end
+            of the dunning cycle.
+        version:
+          type: integer
+          description: Current campaign version.
+        created_at:
+          type: string
+          format: date-time
+          description: When the current settings were created in Recurly.
+        updated_at:
+          type: string
+          format: date-time
+          description: When the current settings were updated in Recurly.
+    DunningInterval:
+      properties:
+        days:
+          type: integer
+          description: Number of days before sending the next email.
+        email_template:
+          type: string
+          description: Email template being used.
+    DunningCampaignsBulkUpdate:
+      properties:
+        plan_codes:
+          type: array
+          maxItems: 200
+          description: List of `plan_codes` associated with the Plans for which the
+            dunning campaign should be updated. Required unless `plan_ids` is present.
+          items:
+            type: string
+        plan_ids:
+          type: array
+          maxItems: 200
+          description: List of `plan_ids` associated with the Plans for which the
+            dunning campaign should be updated. Required unless `plan_codes` is present.
+          items:
+            type: string
+    DunningCampaignsBulkUpdateResponse:
+      properties:
+        object:
+          type: string
+          title: Object type
+          readOnly: true
+        plans:
+          type: array
+          title: Plans
+          description: An array containing all of the `Plan` resources that have been
+            updated.
+          maxItems: 200
+          items:
+            "$ref": "#/components/schemas/Plan"
     PaymentMethod:
       properties:
         object:
@@ -21399,6 +21793,7 @@ components:
       - Union Pay
       - Unknown
       - Visa
+      - Tarjeta Naranja
     AccountTypeEnum:
       type: string
       enum:
@@ -21612,3 +22007,10 @@ components:
       enum:
       - cpf
       - cuit
+    DunningCycleTypeEnum:
+      type: string
+      description: The type of invoice this cycle applies to.
+      enum:
+      - automatic
+      - manual
+      - trial

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - lib/recurly/requests/coupon_redemption_create.rb
 - lib/recurly/requests/coupon_update.rb
 - lib/recurly/requests/custom_field.rb
+- lib/recurly/requests/dunning_campaigns_bulk_update.rb
 - lib/recurly/requests/external_refund.rb
 - lib/recurly/requests/external_transaction.rb
 - lib/recurly/requests/invoice_address.rb
@@ -191,6 +192,7 @@ files:
 - lib/recurly/requests/subscription_add_on_tier.rb
 - lib/recurly/requests/subscription_add_on_update.rb
 - lib/recurly/requests/subscription_cancel.rb
+- lib/recurly/requests/subscription_change_billing_info_create.rb
 - lib/recurly/requests/subscription_change_create.rb
 - lib/recurly/requests/subscription_change_shipping_create.rb
 - lib/recurly/requests/subscription_create.rb
@@ -230,6 +232,10 @@ files:
 - lib/recurly/resources/credit_payment.rb
 - lib/recurly/resources/custom_field.rb
 - lib/recurly/resources/custom_field_definition.rb
+- lib/recurly/resources/dunning_campaign.rb
+- lib/recurly/resources/dunning_campaigns_bulk_update_response.rb
+- lib/recurly/resources/dunning_cycle.rb
+- lib/recurly/resources/dunning_interval.rb
 - lib/recurly/resources/error.rb
 - lib/recurly/resources/error_may_have_transaction.rb
 - lib/recurly/resources/export_dates.rb
@@ -296,7 +302,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.5.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.9.0
 post_install_message: 
 rdoc_options: []
 require_paths: