recurly 4.82.0 → 4.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18ba4644a7a18b9af8bf1d8e2105b618e4b72c60ffece627e9ce0ac5c975df3
-  data.tar.gz: af4b805af51738af015cc8b3b75366b626e06c8cb4216b63e13c61b1c4da5d80
+  metadata.gz: fec1aaa67f020f5a9cd072cd4f1180cc7f7b5a96bc32221d829fe2920e30f666
+  data.tar.gz: b635eaa0fa48c04716eff5859ea0109a05b437cc96759afcd0eb0f2c1a054275
 SHA512:
-  metadata.gz: 4b775860b96876758f1f5d80bde246d290816a2ac5363543c33092de01dfc11feb9c8392bac719fd62a7e86950565f0f33bc4af931683f8dfad859607984e504
-  data.tar.gz: 283ad6f4743597ffd73bfec1bef644896c9d557fe255b0cf270ed1838a393ae5de245be001f8dc0d5b7d489675dab409966c7eff9383e2a3b16eedb9c2bad9d5
+  metadata.gz: ce2ad66f06fbc6a7686fa285337d0c6abe9ae6ca5f83e4e83ade831fe4f1fa9a3d0b07c14c3e358c1a934b5ffea2ce8d29e0683c008599bf16f281447ddc347a
+  data.tar.gz: 6bf91f57a09fa0a89a643714dd66d59a7599b0bc3403b9003cf53f2479ed192b76afdc43438279e6853cdd27fe483e689d49c94f122f39796e24de860ec6bd57

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [4.84.0](https://github.com/recurly/recurly-client-ruby/tree/4.84.0) (2026-10-08)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.83.0...4.84.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#972](https://github.com/recurly/recurly-client-ruby/pull/972) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
+## [4.83.0](https://github.com/recurly/recurly-client-ruby/tree/4.83.0) (2026-09-18)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.82.0...4.83.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#971](https://github.com/recurly/recurly-client-ruby/pull/971) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.82.0](https://github.com/recurly/recurly-client-ruby/tree/4.82.0) (2026-09-15)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.81.0...4.82.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.82'
+gem 'recurly', '~> 4.84'
 ```
 
 > *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

@@ -4738,6 +4738,20 @@ module Recurly
       pager(path, **options)
     end
 
+    # Create a new dunning campaign
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/create_dunning_campaign create_dunning_campaign api documentation}
+    #
+    # @param body [Requests::DunningCampaignCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignCreate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::DunningCampaign] A new dunning campaign.
+    #
+    def create_dunning_campaign(body:, **options)
+      path = "/dunning_campaigns"
+      post(path, body, Requests::DunningCampaignCreate, **options)
+    end
+
     # Fetch a dunning campaign
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation}
@@ -4752,6 +4766,48 @@ module Recurly
       get(path, **options)
     end
 
+    # Update a dunning campaign
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/update_dunning_campaign update_dunning_campaign api documentation}
+    #
+    # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
+    # @param body [Requests::DunningCampaignUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignUpdate}
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::DunningCampaign] The updated dunning campaign.
+    #
+    def update_dunning_campaign(dunning_campaign_id:, body:, **options)
+      path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
+      put(path, body, Requests::DunningCampaignUpdate, **options)
+    end
+
+    # Deactivate a dunning campaign
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/deactivate_dunning_campaign deactivate_dunning_campaign api documentation}
+    #
+    # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Resources::DunningCampaign] The deactivated dunning campaign.
+    #
+    def deactivate_dunning_campaign(dunning_campaign_id:, **options)
+      path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}", dunning_campaign_id: dunning_campaign_id)
+      delete(path, **options)
+    end
+
+    # List the custom email templates assignable to a dunning campaign interval
+    #
+    # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaign_email_templates list_dunning_campaign_email_templates api documentation}
+    #
+    # @param params [Hash] Optional query string parameters:
+    #
+    # @return [Pager<Resources::DunningCampaignEmailTemplate>] A list of the site's assignable custom email templates.
+    #
+    def list_dunning_campaign_email_templates(**options)
+      path = "/dunning_campaigns/email_templates"
+      pager(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 documentation}

data/lib/recurly/requests/dunning_campaign_create.rb

@@ -0,0 +1,26 @@
+# 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 DunningCampaignCreate < Request
+
+      # @!attribute code
+      #   @return [String] Campaign code.
+      define_attribute :code, String
+
+      # @!attribute description
+      #   @return [String] Campaign description.
+      define_attribute :description, String
+
+      # @!attribute dunning_cycles
+      #   @return [Array[DunningCycleCreate]] Dunning Cycle settings. One entry per collection method (`automatic`, `manual`, `trial`); each type may appear at most once.
+      define_attribute :dunning_cycles, Array, { :item_type => :DunningCycleCreate }
+
+      # @!attribute name
+      #   @return [String] Campaign name.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/requests/dunning_campaign_update.rb

@@ -0,0 +1,30 @@
+# 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 DunningCampaignUpdate < Request
+
+      # @!attribute code
+      #   @return [String] Campaign code.
+      define_attribute :code, String
+
+      # @!attribute default_campaign
+      #   @return [Boolean] Set to `true` to make this the default campaign for accounts or plans without an assigned dunning campaign. Cannot be set on an inactive campaign, and cannot be unset directly—assign a different campaign as the default instead.
+      define_attribute :default_campaign, :Boolean
+
+      # @!attribute description
+      #   @return [String] Campaign description.
+      define_attribute :description, String
+
+      # @!attribute dunning_cycles
+      #   @return [Array[DunningCycleCreate]] Dunning Cycle settings. One entry per collection method (`automatic`, `manual`, `trial`); each type may appear at most once. Each cycle write fully replaces that cycle's current settings version.
+      define_attribute :dunning_cycles, Array, { :item_type => :DunningCycleCreate }
+
+      # @!attribute name
+      #   @return [String] Campaign name.
+      define_attribute :name, String
+    end
+  end
+end

data/lib/recurly/requests/dunning_cycle_create.rb

@@ -0,0 +1,42 @@
+# 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 DunningCycleCreate < Request
+
+      # @!attribute active
+      #   @return [Boolean] Only meaningful on the `trial` cycle, where sending `false` removes it. Other cycle types cannot be deactivated.
+      define_attribute :active, :Boolean
+
+      # @!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 expire_subscription
+      #   @return [Boolean] Whether the subscription(s) should be cancelled at the end of the dunning cycle.
+      define_attribute :expire_subscription, :Boolean
+
+      # @!attribute external_payment_recovery_extension_days
+      #   @return [Integer] Number of days to extend external payment recovery. Only available when the site has external payment retries enabled.
+      define_attribute :external_payment_recovery_extension_days, Integer
+
+      # @!attribute fail_invoice
+      #   @return [Boolean] Whether the invoice should be failed at the end of the dunning cycle.
+      define_attribute :fail_invoice, :Boolean
+
+      # @!attribute intervals
+      #   @return [Array[DunningIntervalCreate]] Dunning intervals. Required unless `active` is `false`.
+      define_attribute :intervals, Array, { :item_type => :DunningIntervalCreate }
+
+      # @!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 type
+      #   @return [String] The type of invoice this cycle applies to.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/requests/dunning_interval_create.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 DunningIntervalCreate < Request
+
+      # @!attribute days
+      #   @return [Integer] Number of days before sending the next email.
+      define_attribute :days, Integer
+
+      # @!attribute email_template_id
+      #   @return [String] The id of the custom email template to assign to this interval, from `GET /dunning_campaigns/email_templates`. `null` uses the system default template for this interval.
+      define_attribute :email_template_id, String
+    end
+  end
+end

data/lib/recurly/resources/dunning_campaign_email_template.rb

@@ -0,0 +1,22 @@
+# 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 DunningCampaignEmailTemplate < Resource
+
+      # @!attribute id
+      #   @return [String] The id to assign under `intervals[].email_template_id`.
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Template name.
+      define_attribute :name, String
+
+      # @!attribute type
+      #   @return [String] The root template this custom template replaces, e.g. `payment_declined`, `invoice_past_due`, `post_trial_payment_declined`, `subscription_canceled_nonpayment`.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/dunning_interval.rb

@@ -13,6 +13,10 @@ module Recurly
       # @!attribute email_template
       #   @return [String] Email template being used.
       define_attribute :email_template, String
+
+      # @!attribute email_template_id
+      #   @return [String] The id of the custom email template assigned to this interval, from `GET /dunning_campaigns/email_templates`. `null` means the system default template for this interval. Accepted on write; round-tripped on read.
+      define_attribute :email_template_id, String
     end
   end
 end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.82.0"
+  VERSION = "4.84.0"
 end