maxio-advanced-billing-sdk 5.1.0 → 6.0.0

data/lib/advanced_billing/models/component_price_point_assignment.rb

@@ -40,13 +40,13 @@ module AdvancedBilling
 
     def initialize(component_id: SKIP, price_point: SKIP,
                    additional_properties: {})
-      @component_id = component_id unless component_id == SKIP
-      @price_point = price_point unless price_point == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @component_id = component_id unless component_id == SKIP
+      @price_point = price_point unless price_point == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -60,12 +60,12 @@ module AdvancedBilling
       ) : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ComponentPricePointAssignment.new(component_id: component_id,
                                         price_point: price_point,
-                                        additional_properties: hash)
+                                        additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/component_price_point_error_item.rb

@@ -46,14 +46,14 @@ module AdvancedBilling
 
     def initialize(component_id: SKIP, message: SKIP, price_point: SKIP,
                    additional_properties: {})
-      @component_id = component_id unless component_id == SKIP
-      @message = message unless message == SKIP
-      @price_point = price_point unless price_point == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @component_id = component_id unless component_id == SKIP
+      @message = message unless message == SKIP
+      @price_point = price_point unless price_point == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -66,13 +66,13 @@ module AdvancedBilling
       price_point = hash.key?('price_point') ? hash['price_point'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ComponentPricePointErrorItem.new(component_id: component_id,
                                        message: message,
                                        price_point: price_point,
-                                       additional_properties: hash)
+                                       additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/component_price_point_item.rb

@@ -76,17 +76,17 @@ module AdvancedBilling
     def initialize(name: SKIP, handle: SKIP, pricing_scheme: SKIP,
                    interval: SKIP, interval_unit: SKIP, prices: SKIP,
                    additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @name = name unless name == SKIP
       @handle = handle unless handle == SKIP
       @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == SKIP
       @prices = prices unless prices == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
     end
 
     # Creates an instance of the object from a hash.
@@ -112,7 +112,7 @@ module AdvancedBilling
       prices = SKIP unless hash.key?('prices')
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ComponentPricePointItem.new(name: name,
@@ -121,7 +121,7 @@ module AdvancedBilling
                                   interval: interval,
                                   interval_unit: interval_unit,
                                   prices: prices,
-                                  additional_properties: hash)
+                                  additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/component_price_point_response.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(price_point:, additional_properties: {})
-      @price_point = price_point
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @price_point = price_point
     end
 
     # Creates an instance of the object from a hash.
@@ -47,11 +47,11 @@ module AdvancedBilling
       price_point = ComponentPricePoint.from_hash(hash['price_point']) if hash['price_point']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ComponentPricePointResponse.new(price_point: price_point,
-                                      additional_properties: hash)
+                                      additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/component_price_points_response.rb

@@ -39,13 +39,13 @@ module AdvancedBilling
     end
 
     def initialize(price_points: SKIP, meta: SKIP, additional_properties: {})
-      @price_points = price_points unless price_points == SKIP
-      @meta = meta unless meta == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @price_points = price_points unless price_points == SKIP
+      @meta = meta unless meta == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -66,12 +66,12 @@ module AdvancedBilling
       meta = ListPublicKeysMeta.from_hash(hash['meta']) if hash['meta']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ComponentPricePointsResponse.new(price_points: price_points,
                                        meta: meta,
-                                       additional_properties: hash)
+                                       additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/component_response.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(component:, additional_properties: {})
-      @component = component
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @component = component
     end
 
     # Creates an instance of the object from a hash.
@@ -47,11 +47,11 @@ module AdvancedBilling
       component = Component.from_hash(hash['component']) if hash['component']
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ComponentResponse.new(component: component,
-                            additional_properties: hash)
+                            additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/compounding_strategy.rb

@@ -4,7 +4,11 @@
 # ( https://apimatic.io ).
 
 module AdvancedBilling
-  # Compounding Strategy.
+  # Applicable only to stackable coupons. For `compound`, Percentage-based
+  # discounts will be calculated against the remaining price, after prior
+  # discounts have been calculated. For `full-price`, Percentage-based discounts
+  # will always be calculated against the original item price, before other
+  # discounts are applied.
   class CompoundingStrategy
     COMPOUNDING_STRATEGY = [
       # TODO: Write general description for COMPOUND

data/lib/advanced_billing/models/consolidated_invoice.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(invoices: SKIP, additional_properties: {})
-      @invoices = invoices unless invoices == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @invoices = invoices unless invoices == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -58,11 +58,11 @@ module AdvancedBilling
       invoices = SKIP unless hash.key?('invoices')
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       ConsolidatedInvoice.new(invoices: invoices,
-                              additional_properties: hash)
+                              additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/count_response.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(count: SKIP, additional_properties: {})
-      @count = count unless count == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @count = count unless count == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       count = hash.key?('count') ? hash['count'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CountResponse.new(count: count,
-                        additional_properties: hash)
+                        additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon.rb

@@ -46,90 +46,150 @@ module AdvancedBilling
     # @return [DateTime]
     attr_accessor :start_date
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [DateTime]
     attr_accessor :end_date
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [String]
     attr_accessor :percentage
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [TrueClass | FalseClass]
     attr_accessor :recurring
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [RecurringScheme]
     attr_accessor :recurring_scheme
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [Integer]
     attr_accessor :duration_period_count
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [Integer]
     attr_accessor :duration_interval
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [String]
     attr_accessor :duration_interval_unit
 
-    # TODO: Write general description for this method
+    # After the given time, this coupon code will be invalid for new signups.
+    # Recurring discounts started before this date will continue to recur even
+    # after this date.
     # @return [String]
     attr_accessor :duration_interval_span
 
-    # TODO: Write general description for this method
+    # If set to true, discount is not limited (credits will carry forward to
+    # next billing).
     # @return [TrueClass | FalseClass]
     attr_accessor :allow_negative_balance
 
-    # TODO: Write general description for this method
+    # If set to true, discount is not limited (credits will carry forward to
+    # next billing).
     # @return [DateTime]
     attr_accessor :archived_at
 
-    # TODO: Write general description for this method
+    # If set to true, discount is not limited (credits will carry forward to
+    # next billing).
     # @return [String]
     attr_accessor :conversion_limit
 
-    # TODO: Write general description for this method
+    # A stackable coupon can be combined with other coupons on a Subscription.
     # @return [TrueClass | FalseClass]
     attr_accessor :stackable
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [CompoundingStrategy]
     attr_accessor :compounding_strategy
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [TrueClass | FalseClass]
     attr_accessor :use_site_exchange_rate
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [DateTime]
     attr_accessor :created_at
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [DateTime]
     attr_accessor :updated_at
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [DiscountType]
     attr_accessor :discount_type
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [TrueClass | FalseClass]
     attr_accessor :exclude_mid_period_allocations
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [TrueClass | FalseClass]
     attr_accessor :apply_on_cancel_at_end_of_period
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [TrueClass | FalseClass]
     attr_accessor :apply_on_subscription_expiration
 
-    # TODO: Write general description for this method
+    # Applicable only to stackable coupons. For `compound`, Percentage-based
+    # discounts will be calculated against the remaining price, after prior
+    # discounts have been calculated. For `full-price`, Percentage-based
+    # discounts will always be calculated against the original item price,
+    # before other discounts are applied.
     # @return [Array[CouponRestriction]]
     attr_accessor :coupon_restrictions
 
+    # Returned in read, find, and list endpoints if the query parameter is
+    # provided.
+    # @return [Array[CouponCurrency]]
+    attr_accessor :currency_prices
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -166,6 +226,7 @@ module AdvancedBilling
       @_hash['apply_on_subscription_expiration'] =
         'apply_on_subscription_expiration'
       @_hash['coupon_restrictions'] = 'coupon_restrictions'
+      @_hash['currency_prices'] = 'currency_prices'
       @_hash
     end
 
@@ -202,6 +263,7 @@ module AdvancedBilling
         apply_on_cancel_at_end_of_period
         apply_on_subscription_expiration
         coupon_restrictions
+        currency_prices
       ]
     end
 
@@ -236,7 +298,13 @@ module AdvancedBilling
                    exclude_mid_period_allocations: SKIP,
                    apply_on_cancel_at_end_of_period: SKIP,
                    apply_on_subscription_expiration: SKIP,
-                   coupon_restrictions: SKIP, additional_properties: {})
+                   coupon_restrictions: SKIP, currency_prices: SKIP,
+                   additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id unless id == SKIP
       @name = name unless name == SKIP
       @code = code unless code == SKIP
@@ -276,11 +344,7 @@ module AdvancedBilling
           apply_on_subscription_expiration
       end
       @coupon_restrictions = coupon_restrictions unless coupon_restrictions == SKIP
-
-      # Add additional model properties to the instance.
-      additional_properties.each do |_name, _value|
-        instance_variable_set("@#{_name}", _value)
-      end
+      @currency_prices = currency_prices unless currency_prices == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -362,9 +426,19 @@ module AdvancedBilling
       end
 
       coupon_restrictions = SKIP unless hash.key?('coupon_restrictions')
+      # Parameter is an array, so we need to iterate through it
+      currency_prices = nil
+      unless hash['currency_prices'].nil?
+        currency_prices = []
+        hash['currency_prices'].each do |structure|
+          currency_prices << (CouponCurrency.from_hash(structure) if structure)
+        end
+      end
+
+      currency_prices = SKIP unless hash.key?('currency_prices')
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       Coupon.new(id: id,
@@ -397,7 +471,8 @@ module AdvancedBilling
                  apply_on_cancel_at_end_of_period: apply_on_cancel_at_end_of_period,
                  apply_on_subscription_expiration: apply_on_subscription_expiration,
                  coupon_restrictions: coupon_restrictions,
-                 additional_properties: hash)
+                 currency_prices: currency_prices,
+                 additional_properties: additional_properties)
     end
 
     def to_custom_start_date

data/lib/advanced_billing/models/coupon_currency.rb

@@ -18,7 +18,7 @@ module AdvancedBilling
     attr_accessor :currency
 
     # TODO: Write general description for this method
-    # @return [Integer]
+    # @return [Float]
     attr_accessor :price
 
     # TODO: Write general description for this method
@@ -47,20 +47,23 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        id
+        price
+      ]
     end
 
     def initialize(id: SKIP, currency: SKIP, price: SKIP, coupon_id: SKIP,
                    additional_properties: {})
-      @id = id unless id == SKIP
-      @currency = currency unless currency == SKIP
-      @price = price unless price == SKIP
-      @coupon_id = coupon_id unless coupon_id == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @id = id unless id == SKIP
+      @currency = currency unless currency == SKIP
+      @price = price unless price == SKIP
+      @coupon_id = coupon_id unless coupon_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -74,14 +77,14 @@ module AdvancedBilling
       coupon_id = hash.key?('coupon_id') ? hash['coupon_id'] : SKIP
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponCurrency.new(id: id,
                          currency: currency,
                          price: price,
                          coupon_id: coupon_id,
-                         additional_properties: hash)
+                         additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_currency_request.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(currency_prices:, additional_properties: {})
-      @currency_prices = currency_prices
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @currency_prices = currency_prices
     end
 
     # Creates an instance of the object from a hash.
@@ -56,11 +56,11 @@ module AdvancedBilling
       currency_prices = nil unless hash.key?('currency_prices')
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponCurrencyRequest.new(currency_prices: currency_prices,
-                                additional_properties: hash)
+                                additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/coupon_currency_response.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(currency_prices: SKIP, additional_properties: {})
-      @currency_prices = currency_prices unless currency_prices == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @currency_prices = currency_prices unless currency_prices == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -58,11 +58,11 @@ module AdvancedBilling
       currency_prices = SKIP unless hash.key?('currency_prices')
 
       # Clean out expected properties from Hash.
-      names.each_value { |k| hash.delete(k) }
+      additional_properties = hash.reject { |k, _| names.value?(k) }
 
       # Create object from extracted values.
       CouponCurrencyResponse.new(currency_prices: currency_prices,
-                                 additional_properties: hash)
+                                 additional_properties: additional_properties)
     end
   end
 end