recurly 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e93393e1aee1ef2ace7f7df79d0f815b9ab54a99189807f92070b327d940307
-  data.tar.gz: 2ea549f2a93dda275202ce603c6a53e8b00a88c2eda91d212f473c66a0bea981
+  metadata.gz: 37656e729dc7f26fa5d3b76f5eb7df142c2e4cc1f8ff25d2d53a4ef0a3ab31a5
+  data.tar.gz: b09061036a53cd15415e8ec84d4e2153cf16351d5ff9570ca6b9c6e5b4616bce
 SHA512:
-  metadata.gz: e64f85ad01d99cb0001717137bfe8011c06cee11e5ac932d26042f297261d50d8ab54dfbf926c8811ae5f370c12609410fcaac082fa40c1abca3b99de7eaacd5
-  data.tar.gz: de50a1d18e695ce700b0f1125a68045c07e212c919236a485df2dcb21ed7e16b035cafde525c07c43275629c8fc64640565c605fb2d9c86ed5b41d70e4e3e0c7
+  metadata.gz: e6871927fe2f08fd44758d19b2ddc134a63fe9db3bacbd6b4b2bb0145597c058f916cccfc65ffdca97211d153eb98c459daa031b453f30863ad5c689ec10eccb
+  data.tar.gz: 2b3a3d585b16dcaad4319c43534e2be85c294b8a10fddc9d7255fe3a6dc10740a4ec20d9242363a6724bcd3f783accb268b6b297f7111ce2304b27bf5b5357e6

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [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)

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

@@ -3903,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/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/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.7.0"
+  VERSION = "4.8.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:
@@ -14432,6 +14436,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:
@@ -14575,6 +14680,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
@@ -15324,6 +15436,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:
@@ -15394,6 +15514,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:
@@ -15459,6 +15587,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:
@@ -17375,6 +17511,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:
@@ -18287,6 +18430,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
@@ -18443,6 +18594,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
@@ -18619,6 +18778,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:
@@ -20803,6 +20970,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:
@@ -21442,6 +21753,7 @@ components:
       - Union Pay
       - Unknown
       - Visa
+      - Tarjeta Naranja
     AccountTypeEnum:
       type: string
       enum:
@@ -21655,3 +21967,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.7.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-01 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
@@ -231,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
@@ -297,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.7.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/4.8.0
 post_install_message: 
 rdoc_options: []
 require_paths: