recurly 4.6.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b355c5446a85f7911c3f383a4c4a5f54ab5153fc2764680c4bd739aba9b3bc9
-  data.tar.gz: 1fa2e60c2bf6970b0d6187ae18130c0813551ccec839b9ee4e80e6e4a5e1a77c
+  metadata.gz: d58a4d771c61445679b271441c64f1341a58f0c39d768b5abebe635be7fc1b7f
+  data.tar.gz: 238128901760f8f548091ee71778a17d8599db24f746a88deb8d55eb8d224de7
 SHA512:
-  metadata.gz: 3a71c147eb618bd49ef0350bf6492f1c8d0d0cafedfd6aebaf6a3ac35b9e13f11fa3ad7133baae2ec11b8e5ac7994e77ea768eceeaf90d2681e6c189e3723ced
-  data.tar.gz: 7dba56f22aacea3aad801bd5a5fd3d7f26a72b2d0a5aab7f1418865cbaf8d56da51d6682514a2752989b49b7e3bf04cb06d75aecd00f13fc3880317aee2f1915
+  metadata.gz: 699d6dadd3afa732926744cd611e11deb5e0d592edf497a31249e5af4d012f5c02adbe1cc3aed8f1066b9254098ae74e92b8910c977aa5dd41c223b7a8adfb98
+  data.tar.gz: 120cda82a9e8993f3f4325ac50a3204f6d211b664f7fac160794e92eec51ccef15ec433412d286cd91d6a79f253eff83eb701ae82702144e8facdf02e4338a59

data/.bumpversion.cfg

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

data/.travis.yml

@@ -8,7 +8,9 @@ rvm:
   - 3.0
 bundler_args: --binstubs
 before_install:
+  - sudo apt-get update && sudo apt-get install apt-transport-https ca-certificates -y && sudo update-ca-certificates
   - gem update --system
   - gem install bundler
+dist: focal
 script:
-  - ./scripts/test
+  - ./scripts/test

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [4.10.0](https://github.com/recurly/recurly-client-ruby/tree/4.10.0) (2021-11-22)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.9.0...4.10.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#739](https://github.com/recurly/recurly-client-ruby/pull/739) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#736](https://github.com/recurly/recurly-client-ruby/pull/736) ([recurly-integrations](https://github.com/recurly-integrations))
+- Allow API base url configuration [#735](https://github.com/recurly/recurly-client-ruby/pull/735) ([cbarton](https://github.com/cbarton))
+- Generated Latest Changes for v2021-02-25 [#734](https://github.com/recurly/recurly-client-ruby/pull/734) ([recurly-integrations](https://github.com/recurly-integrations))
+- Generated Latest Changes for v2021-02-25 [#728](https://github.com/recurly/recurly-client-ruby/pull/728) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [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)

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.6'
+gem 'recurly', '~> 4.10'
 ```
 
 > *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/client.rb

@@ -3,6 +3,7 @@ require "erb"
 require "net/https"
 require "base64"
 require "securerandom"
+require "uri"
 require_relative "./schema/json_parser"
 require_relative "./schema/file_parser"
 
@@ -10,8 +11,7 @@ module Recurly
   class Client
     require_relative "./client/operations"
 
-    BASE_HOST = "v3.recurly.com"
-    BASE_PORT = 443
+    BASE_URL = "https://v3.recurly.com"
     CA_FILE = File.join(File.dirname(__FILE__), "../data/ca-certificates.crt")
     BINARY_TYPES = [
       "application/pdf",
@@ -52,12 +52,15 @@ module Recurly
     #   client = Recurly::Client.new(api_key: API_KEY2)
     #   sub = client.get_subscription(subscription_id: 'uuid-abcd7890')
     #
+    # @param base_url [String] The base URL for the API. Defaults to "https://v3.recurly.com"
+    # @param ca_file [String] The CA bundle to use when connecting to the API. Defaults to "data/ca-certificates.crt"
     # @param api_key [String] The private API key
     # @param logger [Logger] A logger to use. Defaults to creating a new STDOUT logger with level WARN.
-    def initialize(api_key:, logger: nil)
+    def initialize(base_url: BASE_URL, ca_file: CA_FILE, api_key:, logger: nil)
       raise ArgumentError, "'api_key' must be set to a non-nil value" if api_key.nil?
 
       set_api_key(api_key)
+      set_connection_options(base_url, ca_file)
 
       if logger.nil?
         @logger = Logger.new(STDOUT).tap do |l|
@@ -158,7 +161,7 @@ module Recurly
     end
 
     def run_request(request, options = {})
-      self.class.connection_pool.with_connection do |http|
+      self.class.connection_pool.with_connection(uri: @base_uri, ca_file: @ca_file) do |http|
         set_http_options(http, options)
 
         retries = 0
@@ -338,6 +341,11 @@ module Recurly
       @api_key = api_key.to_s
     end
 
+    def set_connection_options(base_url, ca_file)
+      @base_uri = URI.parse(base_url)
+      @ca_file = ca_file
+    end
+
     def build_url(path, options)
       path = scope_by_site(path, options)
       query_params = map_array_params(options.fetch(:params, {}))

data/lib/recurly/connection_pool.rb

@@ -1,36 +1,38 @@
+# frozen_string_literal: true
+
 require "net/https"
 
 module Recurly
   class ConnectionPool
     def initialize
       @mutex = Mutex.new
-      @pool = []
+      @pool = Hash.new { |h, k| h[k] = [] }
     end
 
-    def with_connection
+    def with_connection(uri:, ca_file: nil)
       http = nil
       @mutex.synchronize do
-        http = @pool.pop
+        http = @pool[[uri.host, uri.port]].pop
       end
 
       # create connection if the pool was empty
-      http ||= init_http_connection
+      http ||= init_http_connection(uri, ca_file)
 
       response = yield http
 
       if http.started?
         @mutex.synchronize do
-          @pool.push(http)
+          @pool[[uri.host, uri.port]].push(http)
         end
       end
 
       response
     end
 
-    def init_http_connection
-      http = Net::HTTP.new(Client::BASE_HOST, Client::BASE_PORT)
-      http.use_ssl = true
-      http.ca_file = Client::CA_FILE
+    def init_http_connection(uri, ca_file)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.ca_file = ca_file
       http.verify_mode = OpenSSL::SSL::VERIFY_PEER
       http.keep_alive_timeout = 600
 

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

@@ -6,6 +6,14 @@ module Recurly
   module Requests
     class BillingInfoCreate < Request
 
+      # @!attribute account_number
+      #   @return [String] The bank account number. (ACH, Bacs only)
+      define_attribute :account_number, String
+
+      # @!attribute account_type
+      #   @return [String] The bank account type. (ACH only)
+      define_attribute :account_type, String
+
       # @!attribute address
       #   @return [Address]
       define_attribute :address, :Address
@@ -58,6 +66,10 @@ module Recurly
       #   @return [String] Expiration month
       define_attribute :month, String
 
+      # @!attribute name_on_account
+      #   @return [String] The name associated with the bank account (ACH, SEPA, Bacs only)
+      define_attribute :name_on_account, String
+
       # @!attribute number
       #   @return [String] Credit card number, spaces and dashes are accepted.
       define_attribute :number, String
@@ -70,6 +82,14 @@ module Recurly
       #   @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
       define_attribute :primary_payment_method, :Boolean
 
+      # @!attribute routing_number
+      #   @return [String] The bank's rounting number. (ACH only)
+      define_attribute :routing_number, String
+
+      # @!attribute sort_code
+      #   @return [String] Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
+      define_attribute :sort_code, String
+
       # @!attribute tax_identifier
       #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF (Brazil) and CUIT (Argentina). CPF and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
       define_attribute :tax_identifier, String
@@ -90,6 +110,10 @@ module Recurly
       #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
       define_attribute :transaction_type, String
 
+      # @!attribute type
+      #   @return [String] The payment method type for a non-credit card based billing info. The value of `bacs` is the only accepted value (Bacs only)
+      define_attribute :type, String
+
       # @!attribute vat_number
       #   @return [String] VAT number
       define_attribute :vat_number, 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_create.rb

@@ -51,7 +51,7 @@ module Recurly
       define_attribute :revenue_schedule_type, String
 
       # @!attribute shipping
-      #   @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
+      #   @return [SubscriptionChangeShippingCreate] Shipping addresses are tied to a customer's account. Each account can have up to 20 different shipping addresses, and if you have enabled multiple subscriptions per account, you can associate different shipping addresses to each subscription.
       define_attribute :shipping, :SubscriptionChangeShippingCreate
 
       # @!attribute timeframe

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