maxio-advanced-billing-sdk 5.2.0 → 6.1.0

data/lib/advanced_billing/models/component_price_point.rb

@@ -110,6 +110,39 @@ module AdvancedBilling
     # @return [Array[ComponentCurrencyPrice]]
     attr_accessor :currency_prices
 
+    # Applicable only to prepaid usage components. An array of overage price
+    # brackets.
+    # @return [Array[ComponentPrice]]
+    attr_accessor :overage_prices
+
+    # Applicable only to prepaid usage components. Pricing scheme for overage
+    # pricing.
+    # @return [PricingScheme]
+    attr_accessor :overage_pricing_scheme
+
+    # Applicable only to prepaid usage components. Boolean which controls
+    # whether or not the allocated quantity should be renewed at the beginning
+    # of each period.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :renew_prepaid_allocation
+
+    # Applicable only to prepaid usage components. Boolean which controls
+    # whether or not remaining units should be rolled over to the next period.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :rollover_prepaid_remainder
+
+    # Applicable only to prepaid usage components where
+    # rollover_prepaid_remainder is true. The number of
+    # `expiration_interval_unit`s after which rollover amounts should expire.
+    # @return [Integer]
+    attr_accessor :expiration_interval
+
+    # Applicable only to prepaid usage components where
+    # rollover_prepaid_remainder is true. A string representing the expiration
+    # interval unit for this component, either month or day.
+    # @return [ExpirationIntervalUnit]
+    attr_accessor :expiration_interval_unit
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -130,6 +163,12 @@ module AdvancedBilling
       @_hash['interval'] = 'interval'
       @_hash['interval_unit'] = 'interval_unit'
       @_hash['currency_prices'] = 'currency_prices'
+      @_hash['overage_prices'] = 'overage_prices'
+      @_hash['overage_pricing_scheme'] = 'overage_pricing_scheme'
+      @_hash['renew_prepaid_allocation'] = 'renew_prepaid_allocation'
+      @_hash['rollover_prepaid_remainder'] = 'rollover_prepaid_remainder'
+      @_hash['expiration_interval'] = 'expiration_interval'
+      @_hash['expiration_interval_unit'] = 'expiration_interval_unit'
       @_hash
     end
 
@@ -153,6 +192,12 @@ module AdvancedBilling
         interval
         interval_unit
         currency_prices
+        overage_prices
+        overage_pricing_scheme
+        renew_prepaid_allocation
+        rollover_prepaid_remainder
+        expiration_interval
+        expiration_interval_unit
       ]
     end
 
@@ -163,6 +208,8 @@ module AdvancedBilling
         archived_at
         interval
         interval_unit
+        expiration_interval
+        expiration_interval_unit
       ]
     end
 
@@ -172,7 +219,15 @@ module AdvancedBilling
                    prices: SKIP, use_site_exchange_rate: SKIP,
                    subscription_id: SKIP, tax_included: SKIP, interval: SKIP,
                    interval_unit: SKIP, currency_prices: SKIP,
-                   additional_properties: {})
+                   overage_prices: SKIP, overage_pricing_scheme: SKIP,
+                   renew_prepaid_allocation: SKIP,
+                   rollover_prepaid_remainder: SKIP, expiration_interval: SKIP,
+                   expiration_interval_unit: 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
       @type = type unless type == SKIP
       @default = default unless default == SKIP
@@ -190,11 +245,15 @@ module AdvancedBilling
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless interval_unit == SKIP
       @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)
+      @overage_prices = overage_prices unless overage_prices == SKIP
+      @overage_pricing_scheme = overage_pricing_scheme unless overage_pricing_scheme == SKIP
+      @renew_prepaid_allocation = renew_prepaid_allocation unless renew_prepaid_allocation == SKIP
+      unless rollover_prepaid_remainder == SKIP
+        @rollover_prepaid_remainder =
+          rollover_prepaid_remainder
       end
+      @expiration_interval = expiration_interval unless expiration_interval == SKIP
+      @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -252,9 +311,29 @@ module AdvancedBilling
       end
 
       currency_prices = SKIP unless hash.key?('currency_prices')
+      # Parameter is an array, so we need to iterate through it
+      overage_prices = nil
+      unless hash['overage_prices'].nil?
+        overage_prices = []
+        hash['overage_prices'].each do |structure|
+          overage_prices << (ComponentPrice.from_hash(structure) if structure)
+        end
+      end
+
+      overage_prices = SKIP unless hash.key?('overage_prices')
+      overage_pricing_scheme =
+        hash.key?('overage_pricing_scheme') ? hash['overage_pricing_scheme'] : SKIP
+      renew_prepaid_allocation =
+        hash.key?('renew_prepaid_allocation') ? hash['renew_prepaid_allocation'] : SKIP
+      rollover_prepaid_remainder =
+        hash.key?('rollover_prepaid_remainder') ? hash['rollover_prepaid_remainder'] : SKIP
+      expiration_interval =
+        hash.key?('expiration_interval') ? hash['expiration_interval'] : SKIP
+      expiration_interval_unit =
+        hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : 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.
       ComponentPricePoint.new(id: id,
@@ -274,7 +353,13 @@ module AdvancedBilling
                               interval: interval,
                               interval_unit: interval_unit,
                               currency_prices: currency_prices,
-                              additional_properties: hash)
+                              overage_prices: overage_prices,
+                              overage_pricing_scheme: overage_pricing_scheme,
+                              renew_prepaid_allocation: renew_prepaid_allocation,
+                              rollover_prepaid_remainder: rollover_prepaid_remainder,
+                              expiration_interval: expiration_interval,
+                              expiration_interval_unit: expiration_interval_unit,
+                              additional_properties: additional_properties)
     end
 
     def to_custom_archived_at
@@ -288,5 +373,40 @@ module AdvancedBilling
     def to_custom_updated_at
       DateTimeHelper.to_rfc3339(updated_at)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, type: #{@type}, default: #{@default}, name: #{@name},"\
+      " pricing_scheme: #{@pricing_scheme}, component_id: #{@component_id}, handle: #{@handle},"\
+      " archived_at: #{@archived_at}, created_at: #{@created_at}, updated_at: #{@updated_at},"\
+      " prices: #{@prices}, use_site_exchange_rate: #{@use_site_exchange_rate}, subscription_id:"\
+      " #{@subscription_id}, tax_included: #{@tax_included}, interval: #{@interval},"\
+      " interval_unit: #{@interval_unit}, currency_prices: #{@currency_prices}, overage_prices:"\
+      " #{@overage_prices}, overage_pricing_scheme: #{@overage_pricing_scheme},"\
+      " renew_prepaid_allocation: #{@renew_prepaid_allocation}, rollover_prepaid_remainder:"\
+      " #{@rollover_prepaid_remainder}, expiration_interval: #{@expiration_interval},"\
+      " expiration_interval_unit: #{@expiration_interval_unit}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, type: #{@type.inspect}, default: #{@default.inspect},"\
+      " name: #{@name.inspect}, pricing_scheme: #{@pricing_scheme.inspect}, component_id:"\
+      " #{@component_id.inspect}, handle: #{@handle.inspect}, archived_at:"\
+      " #{@archived_at.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, prices: #{@prices.inspect}, use_site_exchange_rate:"\
+      " #{@use_site_exchange_rate.inspect}, subscription_id: #{@subscription_id.inspect},"\
+      " tax_included: #{@tax_included.inspect}, interval: #{@interval.inspect}, interval_unit:"\
+      " #{@interval_unit.inspect}, currency_prices: #{@currency_prices.inspect}, overage_prices:"\
+      " #{@overage_prices.inspect}, overage_pricing_scheme: #{@overage_pricing_scheme.inspect},"\
+      " renew_prepaid_allocation: #{@renew_prepaid_allocation.inspect},"\
+      " rollover_prepaid_remainder: #{@rollover_prepaid_remainder.inspect}, expiration_interval:"\
+      " #{@expiration_interval.inspect}, expiration_interval_unit:"\
+      " #{@expiration_interval_unit.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
   end
 end

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.
@@ -77,5 +77,19 @@ module AdvancedBilling
 
       true
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} component_id: #{@component_id}, price_point: #{@price_point},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} component_id: #{@component_id.inspect}, price_point:"\
+      " #{@price_point.inspect}, additional_properties: #{get_additional_properties}>"
+    end
   end
 end

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,28 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} component_id: #{@component_id}, message: #{@message}, price_point:"\
+      " #{@price_point}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} component_id: #{@component_id.inspect}, message: #{@message.inspect},"\
+      " price_point: #{@price_point.inspect}, additional_properties:"\
+      " #{get_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.
@@ -133,5 +133,22 @@ module AdvancedBilling
 
       true
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, handle: #{@handle}, pricing_scheme: #{@pricing_scheme},"\
+      " interval: #{@interval}, interval_unit: #{@interval_unit}, prices: #{@prices},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, handle: #{@handle.inspect}, pricing_scheme:"\
+      " #{@pricing_scheme.inspect}, interval: #{@interval.inspect}, interval_unit:"\
+      " #{@interval_unit.inspect}, prices: #{@prices.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
   end
 end

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,25 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_point: #{@price_point}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_point: #{@price_point.inspect}, additional_properties:"\
+      " #{get_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,26 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_points: #{@price_points}, meta: #{@meta}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_points: #{@price_points.inspect}, meta: #{@meta.inspect},"\
+      " additional_properties: #{get_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,25 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} component: #{@component}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} component: #{@component.inspect}, additional_properties:"\
+      " #{get_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,25 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} invoices: #{@invoices}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} invoices: #{@invoices.inspect}, additional_properties:"\
+      " #{get_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,24 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} count: #{@count.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
     end
   end
 end