maxio-advanced-billing-sdk 5.2.0 → 6.1.0

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
@@ -419,5 +494,51 @@ 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}, name: #{@name}, code: #{@code}, description: #{@description},"\
+      " amount: #{@amount}, amount_in_cents: #{@amount_in_cents}, product_family_id:"\
+      " #{@product_family_id}, product_family_name: #{@product_family_name}, start_date:"\
+      " #{@start_date}, end_date: #{@end_date}, percentage: #{@percentage}, recurring:"\
+      " #{@recurring}, recurring_scheme: #{@recurring_scheme}, duration_period_count:"\
+      " #{@duration_period_count}, duration_interval: #{@duration_interval},"\
+      " duration_interval_unit: #{@duration_interval_unit}, duration_interval_span:"\
+      " #{@duration_interval_span}, allow_negative_balance: #{@allow_negative_balance},"\
+      " archived_at: #{@archived_at}, conversion_limit: #{@conversion_limit}, stackable:"\
+      " #{@stackable}, compounding_strategy: #{@compounding_strategy}, use_site_exchange_rate:"\
+      " #{@use_site_exchange_rate}, created_at: #{@created_at}, updated_at: #{@updated_at},"\
+      " discount_type: #{@discount_type}, exclude_mid_period_allocations:"\
+      " #{@exclude_mid_period_allocations}, 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},"\
+      " currency_prices: #{@currency_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} id: #{@id.inspect}, name: #{@name.inspect}, code: #{@code.inspect},"\
+      " description: #{@description.inspect}, amount: #{@amount.inspect}, amount_in_cents:"\
+      " #{@amount_in_cents.inspect}, product_family_id: #{@product_family_id.inspect},"\
+      " product_family_name: #{@product_family_name.inspect}, start_date: #{@start_date.inspect},"\
+      " end_date: #{@end_date.inspect}, percentage: #{@percentage.inspect}, recurring:"\
+      " #{@recurring.inspect}, recurring_scheme: #{@recurring_scheme.inspect},"\
+      " duration_period_count: #{@duration_period_count.inspect}, duration_interval:"\
+      " #{@duration_interval.inspect}, duration_interval_unit: #{@duration_interval_unit.inspect},"\
+      " duration_interval_span: #{@duration_interval_span.inspect}, allow_negative_balance:"\
+      " #{@allow_negative_balance.inspect}, archived_at: #{@archived_at.inspect},"\
+      " conversion_limit: #{@conversion_limit.inspect}, stackable: #{@stackable.inspect},"\
+      " compounding_strategy: #{@compounding_strategy.inspect}, use_site_exchange_rate:"\
+      " #{@use_site_exchange_rate.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, discount_type: #{@discount_type.inspect},"\
+      " exclude_mid_period_allocations: #{@exclude_mid_period_allocations.inspect},"\
+      " apply_on_cancel_at_end_of_period: #{@apply_on_cancel_at_end_of_period.inspect},"\
+      " apply_on_subscription_expiration: #{@apply_on_subscription_expiration.inspect},"\
+      " coupon_restrictions: #{@coupon_restrictions.inspect}, currency_prices:"\
+      " #{@currency_prices.inspect}, additional_properties: #{get_additional_properties}>"
+    end
   end
 end

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,29 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, currency: #{@currency}, price: #{@price}, coupon_id:"\
+      " #{@coupon_id}, 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}, currency: #{@currency.inspect}, price:"\
+      " #{@price.inspect}, coupon_id: #{@coupon_id.inspect}, additional_properties:"\
+      " #{get_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,25 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_prices: #{@currency_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} currency_prices: #{@currency_prices.inspect}, additional_properties:"\
+      " #{get_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,25 @@ 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
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency_prices: #{@currency_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} currency_prices: #{@currency_prices.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
     end
   end
 end