recurly 4.4.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78ae5aced00577f6e7c354c710b0624e439ac0cc036f28248ea3f3d4e648fe9f
-  data.tar.gz: 82616234dcb6b27a02ae189cfd114e0efcbd568f23935c1c3fa9a2a4485616f1
+  metadata.gz: 37656e729dc7f26fa5d3b76f5eb7df142c2e4cc1f8ff25d2d53a4ef0a3ab31a5
+  data.tar.gz: b09061036a53cd15415e8ec84d4e2153cf16351d5ff9570ca6b9c6e5b4616bce
 SHA512:
-  metadata.gz: d19bd177df130213c78cc8789fbe235ac836140eceaea7e62e4d4511ab99206f948e91ce4c60de0d133a959a301ce1428cdc4aea17273dc3dcb9761a9ca31605
-  data.tar.gz: 6ec907716dd89c09698714e2959511e11c461d1414b821e027e2b28616b9bb7b64043fb0d8f301a87971eab5bdea249f0e3b0b987bc83e841ba1e6e706321802
+  metadata.gz: e6871927fe2f08fd44758d19b2ddc134a63fe9db3bacbd6b4b2bb0145597c058f916cccfc65ffdca97211d153eb98c459daa031b453f30863ad5c689ec10eccb
+  data.tar.gz: 2b3a3d585b16dcaad4319c43534e2be85c294b8a10fddc9d7255fe3a6dc10740a4ec20d9242363a6724bcd3f783accb268b6b297f7111ce2304b27bf5b5357e6

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # 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)
+
+
+**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)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2021-02-25 [#714](https://github.com/recurly/recurly-client-ruby/pull/714) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [4.4.0](https://github.com/recurly/recurly-client-ruby/tree/4.4.0) (2021-06-15)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/4.3.0...4.4.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.4'
+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

@@ -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/address.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute phone

data/lib/recurly/requests/billing_info_create.rb

@@ -71,11 +71,11 @@ module Recurly
       define_attribute :primary_payment_method, :Boolean
 
       # @!attribute tax_identifier
-      #   @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil. This would be the customer's CPF, CPF is a Brazilian tax identifier for all tax paying residents.
+      #   @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
 
       # @!attribute tax_identifier_type
-      #   @return [String] this field and a value of 'cpf' are required if adding a billing info that is an elo or hipercard type in Brazil.
+      #   @return [String] This field and a value of `cpf` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
       define_attribute :tax_identifier_type, String
 
       # @!attribute three_d_secure_action_result_token_id

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

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute first_name

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

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute email

data/lib/recurly/requests/shipping_address_update.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :company, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute email

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_create.rb

@@ -99,7 +99,7 @@ module Recurly
       define_attribute :transaction_type, String
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount

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_purchase.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_ends_at
-      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount

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

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute phone

data/lib/recurly/resources/address_with_name.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :city, String
 
       # @!attribute country
-      #   @return [String] Country, 2-letter ISO code.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
       define_attribute :country, String
 
       # @!attribute first_name

data/lib/recurly/resources/billing_info_updated_by.rb

@@ -7,7 +7,7 @@ module Recurly
     class BillingInfoUpdatedBy < Resource
 
       # @!attribute country
-      #   @return [String] Country of IP address, if known by Recurly.
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code matching the origin IP address, if known by Recurly.
       define_attribute :country, String
 
       # @!attribute ip

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