lib/recurly/requests/line_item_refund.rb in recurly-4.53.0 vs lib/recurly/requests/line_item_refund.rb in recurly-4.54.0

@@ -4,23 +4,31 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Requests
     class LineItemRefund < Request
 
+      # @!attribute amount
+      #   @return [Float] The specific amount to be refunded from the adjustment. Must be less than or equal to the adjustment's remaining balance. If `quantity`, `quantity_decimal` and `percentage` are not present, `amount` is required. If `quantity`, `quantity_decimal`, or `percentage` is present, `amount` must be absent.
+      define_attribute :amount, Float
+
       # @!attribute id
       #   @return [String] Line item ID
       define_attribute :id, String
 
+      # @!attribute percentage
+      #   @return [Integer] The percentage of the adjustment's remaining balance to refund. If `quantity`, `quantity_decimal` and `amount_in_cents` are not present, `percentage` is required. If `quantity`, `quantity_decimal` or `amount_in_cents` is present, `percentage` must be absent.
+      define_attribute :percentage, Integer
+
       # @!attribute prorate
       #   @return [Boolean] Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.
       define_attribute :prorate, :Boolean
 
       # @!attribute quantity
-      #   @return [Integer] Line item quantity to be refunded.
+      #   @return [Integer] Line item quantity to be refunded. Must be less than or equal to the `quantity_remaining`. If `quantity_decimal`, `amount`, and `percentage` are not present, `quantity` is required. If `amount` or `percentage` is present, `quantity` must be absent.
       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.
+      #   @return [String] Decimal quantity to refund. The `quantity_decimal` will be used to refund charges that has a NOT null quantity decimal. Must be less than or equal to the `quantity_decimal_remaining`. If `quantity`, `amount`, and `percentage` are not present, `quantity_decimal` is required. If `amount` or `percentage` is present, `quantity_decimal` must be absent. The Decimal Quantity feature must be enabled to utilize this field.
       define_attribute :quantity_decimal, String
     end
   end
 end