recurly 3.21.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9218a6c207426f02771031f66b2f5def8e22805b4dd7e0d565909a943404bff
-  data.tar.gz: 3269a3003e8446cabf915d742a554eb94af0f3e6fe5511de6f602b6adf41e287
+  metadata.gz: 66774f5d5a08c4cd26758c2dd4c073c8b9515129caf340a76756f3f5ed55e712
+  data.tar.gz: 529eec421b40a5c80bd143338786871325deeb19a9818aaca8bd1e673075461f
 SHA512:
-  metadata.gz: f0dfe2d431ebbcacc24aa32c9bed1477e0ecec23235c6ed63bcfd94a2640508da40d635b30b205515c88f14d4f51f7b2e00a39f0c0fb6d36bab56730285885b5
-  data.tar.gz: 0b76576ac5143019670a2c69320c801ac7c47df22661b703ee393313dbac7a3b542c46e2ff5dbfb0a9a04136f0389ab934957b0d9e3427838c60ffe6b44dd5ba
+  metadata.gz: d90a2cb844beef990fb9537c1e6e294a0868bab10854ebaf45151b552ed6025a79423b687ad24844ff10af555a181b46b0d6496e7ecedaa227aac6b8570fd4c7
+  data.tar.gz: 9a2e29e819378925cf72c9d4959fa02b9120e02af32c7f45f054cce93b827b5796e13784288ead5694514047b479eb39cb3ce5444ac7511de117cb3de18bd5d1

data/.bumpversion.cfg

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [3.22.0](https://github.com/recurly/recurly-client-ruby/tree/3.22.0) (2022-10-21)
+
+[Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.21.0...3.22.0)
+
+
+**Merged Pull Requests**
+
+- Generated Latest Changes for v2019-10-10(Decimal Usage and Quantities) [#800](https://github.com/recurly/recurly-client-ruby/pull/800) ([recurly-integrations](https://github.com/recurly-integrations))
+
+
+
 ## [3.21.0](https://github.com/recurly/recurly-client-ruby/tree/3.21.0) (2022-08-03)
 
 [Full Changelog](https://github.com/recurly/recurly-client-ruby/compare/3.20.0...3.21.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', '~> 3.21'
+gem 'recurly', '~> 3.22'
 ```
 
 > *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

@@ -3841,12 +3841,13 @@ module Recurly
     #
     # {https://developers.recurly.com/api/v2019-10-10#operation/put_dunning_campaign_bulk_update put_dunning_campaign_bulk_update api documentation}
     #
+    # @param dunning_campaign_id [String] Dunning Campaign ID, e.g. +e28zov4fw0v2+.
     # @param body [Requests::DunningCampaignsBulkUpdate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::DunningCampaignsBulkUpdate}
     #
     # @return [Resources::DunningCampaignsBulkUpdateResponse] A list of updated plans.
     #
-    def put_dunning_campaign_bulk_update(body:)
-      path = "/dunning_campaigns/{dunning_campaign_id}/bulk_update"
+    def put_dunning_campaign_bulk_update(dunning_campaign_id:, body:)
+      path = interpolate_path("/dunning_campaigns/{dunning_campaign_id}/bulk_update", dunning_campaign_id: dunning_campaign_id)
       put(path, body, Requests::DunningCampaignsBulkUpdate)
     end
   end

data/lib/recurly/requests/line_item_refund.rb

@@ -17,6 +17,10 @@ module Recurly
       # @!attribute quantity
       #   @return [Integer] Line item quantity to be refunded.
       define_attribute :quantity, Integer
+
+      # @!attribute quantity_decimal
+      #   @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+      define_attribute :quantity_decimal, String
     end
   end
 end

data/lib/recurly/requests/plan_ramp_interval.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
 
       # @!attribute starting_billing_cycle
-      #   @return [Integer] Represents the first billing cycle of a ramp.
+      #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
     end
   end

data/lib/recurly/requests/subscription_ramp_interval.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionRampInterval < Request
 
       # @!attribute starting_billing_cycle
-      #   @return [Integer] Represents how many billing cycles are included in a ramp interval.
+      #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
 
       # @!attribute unit_amount

data/lib/recurly/requests/usage_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class UsageCreate < Request
 
       # @!attribute amount
-      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places.  Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
       define_attribute :amount, Float
 
       # @!attribute merchant_tag

data/lib/recurly/resources/line_item.rb

@@ -130,6 +130,10 @@ module Recurly
       #   @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
       define_attribute :quantity, Integer
 
+      # @!attribute quantity_decimal
+      #   @return [String] A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.
+      define_attribute :quantity_decimal, String
+
       # @!attribute refund
       #   @return [Boolean] Refund?
       define_attribute :refund, :Boolean
@@ -138,6 +142,10 @@ module Recurly
       #   @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
       define_attribute :refunded_quantity, Integer
 
+      # @!attribute refunded_quantity_decimal
+      #   @return [String] A floating-point alternative to Refunded Quantity. For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds). The Decimal Quantity feature must be enabled to utilize this field.
+      define_attribute :refunded_quantity_decimal, String
+
       # @!attribute revenue_schedule_type
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String

data/lib/recurly/resources/plan_ramp_interval.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :currencies, Array, { :item_type => :PlanRampPricing }
 
       # @!attribute starting_billing_cycle
-      #   @return [Integer] Represents the first billing cycle of a ramp.
+      #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
     end
   end

data/lib/recurly/resources/subscription_ramp_interval_response.rb

@@ -11,7 +11,7 @@ module Recurly
       define_attribute :remaining_billing_cycles, Integer
 
       # @!attribute starting_billing_cycle
-      #   @return [Integer] Represents how many billing cycles are included in a ramp interval.
+      #   @return [Integer] Represents the billing cycle where a ramp interval starts.
       define_attribute :starting_billing_cycle, Integer
 
       # @!attribute unit_amount

data/lib/recurly/resources/usage.rb

@@ -7,7 +7,7 @@ module Recurly
     class Usage < Resource
 
       # @!attribute amount
-      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places.  Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
       define_attribute :amount, Float
 
       # @!attribute billed_at

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.21.0"
+  VERSION = "3.22.0"
 end

data/openapi/api.yaml

@@ -14463,6 +14463,8 @@ paths:
                 "$ref": "#/components/schemas/Error"
       x-code-samples: []
   "/dunning_campaigns/{dunning_campaign_id}/bulk_update":
+    parameters:
+    - "$ref": "#/components/parameters/dunning_campaign_id"
     put:
       tags:
       - dunning_campaigns
@@ -18423,6 +18425,14 @@ components:
           description: This number will be multiplied by the unit amount to compute
             the subtotal before any discounts or taxes.
           default: 1
+        quantity_decimal:
+          type: string
+          title: Quantity Decimal
+          description: A floating-point alternative to Quantity. If this value is
+            present, it will be used in place of Quantity for calculations, and Quantity
+            will be the rounded integer value of this number. This field supports
+            up to 9 decimal places. The Decimal Quantity feature must be enabled to
+            utilize this field.
         unit_amount:
           type: number
           format: float
@@ -18503,6 +18513,13 @@ components:
           title: Refunded Quantity
           description: For refund charges, the quantity being refunded. For non-refund
             charges, the total quantity refunded (possibly over multiple refunds).
+        refunded_quantity_decimal:
+          type: string
+          title: Refunded Quantity Decimal
+          description: A floating-point alternative to Refunded Quantity. For refund
+            charges, the quantity being refunded. For non-refund charges, the total
+            quantity refunded (possibly over multiple refunds). The Decimal Quantity
+            feature must be enabled to utilize this field.
         credit_applied:
           type: number
           format: float
@@ -18544,6 +18561,14 @@ components:
           type: integer
           title: Quantity
           description: Line item quantity to be refunded.
+        quantity_decimal:
+          type: string
+          title: Quantity Decimal
+          description: A floating-point alternative to Quantity. If this value is
+            present, it will be used in place of Quantity for calculations, and Quantity
+            will be the rounded integer value of this number. This field supports
+            up to 9 decimal places. The Decimal Quantity feature must be enabled to
+            utilize this field.
         prorate:
           type: boolean
           title: Prorate
@@ -19335,7 +19360,7 @@ components:
       properties:
         starting_billing_cycle:
           type: integer
-          description: Represents the first billing cycle of a ramp.
+          description: Represents the billing cycle where a ramp interval starts.
           default: 1
         currencies:
           type: array
@@ -21093,7 +21118,7 @@ components:
       properties:
         starting_billing_cycle:
           type: integer
-          description: Represents how many billing cycles are included in a ramp interval.
+          description: Represents the billing cycle where a ramp interval starts.
           default: 1
         unit_amount:
           type: integer
@@ -21104,7 +21129,7 @@ components:
       properties:
         starting_billing_cycle:
           type: integer
-          description: Represents how many billing cycles are included in a ramp interval.
+          description: Represents the billing cycle where a ramp interval starts.
         remaining_billing_cycles:
           type: integer
           description: Represents how many billing cycles are left in a ramp interval.
@@ -21533,10 +21558,11 @@ components:
         amount:
           type: number
           format: float
-          description: The amount of usage. Can be positive, negative, or 0. No decimals
-            allowed, we will strip them. If the usage-based add-on is billed with
-            a percentage, your usage will be a monetary amount you will want to format
-            in cents. (e.g., $5.00 is "500").
+          description: The amount of usage. Can be positive, negative, or 0. If the
+            Decimal Quantity feature is enabled, this value will be rounded to nine
+            decimal places.  Otherwise, all digits after the decimal will be stripped.
+            If the usage-based add-on is billed with a percentage, your usage should
+            be a monetary amount formatted in cents (e.g., $5.00 is "500").
         usage_type:
           type: string
           enum:
@@ -21609,10 +21635,11 @@ components:
         amount:
           type: number
           format: float
-          description: The amount of usage. Can be positive, negative, or 0. No decimals
-            allowed, we will strip them. If the usage-based add-on is billed with
-            a percentage, your usage will be a monetary amount you will want to format
-            in cents. (e.g., $5.00 is "500").
+          description: The amount of usage. Can be positive, negative, or 0. If the
+            Decimal Quantity feature is enabled, this value will be rounded to nine
+            decimal places.  Otherwise, all digits after the decimal will be stripped.
+            If the usage-based add-on is billed with a percentage, your usage should
+            be a monetary amount formatted in cents (e.g., $5.00 is "500").
         recording_timestamp:
           type: string
           format: date-time

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.21.0
+  version: 3.22.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -306,7 +306,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/3.21.0
+  source_code_uri: https://github.com/recurly/recurly-client-ruby/tree/3.22.0
 post_install_message: 
 rdoc_options: []
 require_paths: