maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/create_or_update_product.rb

@@ -45,8 +45,39 @@ module AdvancedBilling
     # @return [IntervalUnit]
     attr_accessor :interval_unit
 
-    # A string representing the interval unit for this product, either month or
-    # day
+    # The product trial price, in integer cents
+    # @return [Integer]
+    attr_accessor :trial_price_in_cents
+
+    # The numerical trial interval. i.e. an interval of ‘30’ coupled with a
+    # trial_interval_unit of day would mean this product trial would last 30
+    # days.
+    # @return [Integer]
+    attr_accessor :trial_interval
+
+    # A string representing the trial interval unit for this product, either
+    # month or day
+    # @return [IntervalUnit]
+    attr_accessor :trial_interval_unit
+
+    # A string representing the trial interval unit for this product, either
+    # month or day
+    # @return [String]
+    attr_accessor :trial_type
+
+    # The numerical expiration interval. i.e. an expiration_interval of ‘30’
+    # coupled with an expiration_interval_unit of day would mean this product
+    # would expire after 30 days.
+    # @return [Integer]
+    attr_accessor :expiration_interval
+
+    # A string representing the expiration interval unit for this product,
+    # either month or day
+    # @return [IntervalUnit]
+    attr_accessor :expiration_interval_unit
+
+    # A string representing the expiration interval unit for this product,
+    # either month or day
     # @return [TrueClass | FalseClass]
     attr_accessor :auto_create_signup_page
 
@@ -67,6 +98,12 @@ module AdvancedBilling
       @_hash['price_in_cents'] = 'price_in_cents'
       @_hash['interval'] = 'interval'
       @_hash['interval_unit'] = 'interval_unit'
+      @_hash['trial_price_in_cents'] = 'trial_price_in_cents'
+      @_hash['trial_interval'] = 'trial_interval'
+      @_hash['trial_interval_unit'] = 'trial_interval_unit'
+      @_hash['trial_type'] = 'trial_type'
+      @_hash['expiration_interval'] = 'expiration_interval'
+      @_hash['expiration_interval_unit'] = 'expiration_interval_unit'
       @_hash['auto_create_signup_page'] = 'auto_create_signup_page'
       @_hash['tax_code'] = 'tax_code'
       @_hash
@@ -78,6 +115,12 @@ module AdvancedBilling
         handle
         accounting_code
         require_credit_card
+        trial_price_in_cents
+        trial_interval
+        trial_interval_unit
+        trial_type
+        expiration_interval
+        expiration_interval_unit
         auto_create_signup_page
         tax_code
       ]
@@ -96,8 +139,15 @@ module AdvancedBilling
                    handle = SKIP,
                    accounting_code = SKIP,
                    require_credit_card = SKIP,
+                   trial_price_in_cents = SKIP,
+                   trial_interval = SKIP,
+                   trial_interval_unit = SKIP,
+                   trial_type = SKIP,
+                   expiration_interval = SKIP,
+                   expiration_interval_unit = SKIP,
                    auto_create_signup_page = SKIP,
-                   tax_code = SKIP)
+                   tax_code = SKIP,
+                   additional_properties = {})
       @name = name
       @handle = handle unless handle == SKIP
       @description = description
@@ -106,8 +156,19 @@ module AdvancedBilling
       @price_in_cents = price_in_cents
       @interval = interval
       @interval_unit = interval_unit
+      @trial_price_in_cents = trial_price_in_cents unless trial_price_in_cents == SKIP
+      @trial_interval = trial_interval unless trial_interval == SKIP
+      @trial_interval_unit = trial_interval_unit unless trial_interval_unit == SKIP
+      @trial_type = trial_type unless trial_type == SKIP
+      @expiration_interval = expiration_interval unless expiration_interval == SKIP
+      @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == SKIP
       @auto_create_signup_page = auto_create_signup_page unless auto_create_signup_page == SKIP
       @tax_code = tax_code unless tax_code == 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.
@@ -126,10 +187,24 @@ module AdvancedBilling
         hash.key?('accounting_code') ? hash['accounting_code'] : SKIP
       require_credit_card =
         hash.key?('require_credit_card') ? hash['require_credit_card'] : SKIP
+      trial_price_in_cents =
+        hash.key?('trial_price_in_cents') ? hash['trial_price_in_cents'] : SKIP
+      trial_interval =
+        hash.key?('trial_interval') ? hash['trial_interval'] : SKIP
+      trial_interval_unit =
+        hash.key?('trial_interval_unit') ? hash['trial_interval_unit'] : SKIP
+      trial_type = hash.key?('trial_type') ? hash['trial_type'] : SKIP
+      expiration_interval =
+        hash.key?('expiration_interval') ? hash['expiration_interval'] : SKIP
+      expiration_interval_unit =
+        hash.key?('expiration_interval_unit') ? hash['expiration_interval_unit'] : SKIP
       auto_create_signup_page =
         hash.key?('auto_create_signup_page') ? hash['auto_create_signup_page'] : SKIP
       tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateOrUpdateProduct.new(name,
                                 description,
@@ -139,8 +214,15 @@ module AdvancedBilling
                                 handle,
                                 accounting_code,
                                 require_credit_card,
+                                trial_price_in_cents,
+                                trial_interval,
+                                trial_interval_unit,
+                                trial_type,
+                                expiration_interval,
+                                expiration_interval_unit,
                                 auto_create_signup_page,
-                                tax_code)
+                                tax_code,
+                                hash)
     end
   end
 end

data/lib/advanced_billing/models/create_or_update_product_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(product = nil)
+    def initialize(product = nil,
+                   additional_properties = {})
       @product = product
+
+      # 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.
@@ -41,8 +47,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       product = CreateOrUpdateProduct.from_hash(hash['product']) if hash['product']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateOrUpdateProductRequest.new(product)
+      CreateOrUpdateProductRequest.new(product,
+                                       hash)
     end
   end
 end

data/lib/advanced_billing/models/create_or_update_segment_price.rb

@@ -46,10 +46,16 @@ module AdvancedBilling
 
     def initialize(unit_price = nil,
                    starting_quantity = SKIP,
-                   ending_quantity = SKIP)
+                   ending_quantity = SKIP,
+                   additional_properties = {})
       @starting_quantity = starting_quantity unless starting_quantity == SKIP
       @ending_quantity = ending_quantity unless ending_quantity == SKIP
       @unit_price = unit_price
+
+      # 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.
@@ -65,10 +71,14 @@ module AdvancedBilling
       ending_quantity =
         hash.key?('ending_quantity') ? hash['ending_quantity'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateOrUpdateSegmentPrice.new(unit_price,
                                      starting_quantity,
-                                     ending_quantity)
+                                     ending_quantity,
+                                     hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_payment.rb

@@ -21,8 +21,8 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :payment_details
 
-    # TODO: Write general description for this method
-    # @return [String]
+    # The type of payment method used. Defaults to other.
+    # @return [InvoicePaymentMethodType]
     attr_accessor :payment_method
 
     # A mapping from model property names to API property names.
@@ -48,11 +48,17 @@ module AdvancedBilling
     def initialize(amount = nil,
                    memo = nil,
                    payment_details = nil,
-                   payment_method = nil)
+                   payment_method = nil,
+                   additional_properties = {})
       @amount = amount
       @memo = memo
       @payment_details = payment_details
       @payment_method = payment_method
+
+      # 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.
@@ -67,11 +73,15 @@ module AdvancedBilling
       payment_method =
         hash.key?('payment_method') ? hash['payment_method'] : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreatePayment.new(amount,
                         memo,
                         payment_details,
-                        payment_method)
+                        payment_method,
+                        hash)
     end
   end
 end

data/lib/advanced_billing/models/create_payment_profile.rb

@@ -292,7 +292,8 @@ module AdvancedBilling
                    bank_branch_code = SKIP,
                    bank_account_type = SKIP,
                    bank_account_holder_type = SKIP,
-                   last_four = SKIP)
+                   last_four = SKIP,
+                   additional_properties = {})
       @chargify_token = chargify_token unless chargify_token == SKIP
       @id = id unless id == SKIP
       @payment_type = payment_type unless payment_type == SKIP
@@ -325,6 +326,11 @@ module AdvancedBilling
       @bank_account_type = bank_account_type unless bank_account_type == SKIP
       @bank_account_holder_type = bank_account_holder_type unless bank_account_holder_type == SKIP
       @last_four = last_four unless last_four == 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.
@@ -382,6 +388,9 @@ module AdvancedBilling
         hash.key?('bank_account_holder_type') ? hash['bank_account_holder_type'] : SKIP
       last_four = hash.key?('last_four') ? hash['last_four'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreatePaymentProfile.new(chargify_token,
                                id,
@@ -414,7 +423,8 @@ module AdvancedBilling
                                bank_branch_code,
                                bank_account_type,
                                bank_account_holder_type,
-                               last_four)
+                               last_four,
+                               hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_payment_profile_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(payment_profile = nil)
+    def initialize(payment_profile = nil,
+                   additional_properties = {})
       @payment_profile = payment_profile
+
+      # 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.
@@ -42,8 +48,12 @@ module AdvancedBilling
       payment_profile = CreatePaymentProfile.from_hash(hash['payment_profile']) if
         hash['payment_profile']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreatePaymentProfileRequest.new(payment_profile)
+      CreatePaymentProfileRequest.new(payment_profile,
+                                      hash)
     end
   end
 end

data/lib/advanced_billing/models/create_prepaid_component.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(prepaid_usage_component = nil)
+    def initialize(prepaid_usage_component = nil,
+                   additional_properties = {})
       @prepaid_usage_component = prepaid_usage_component
+
+      # 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.
@@ -42,8 +48,12 @@ module AdvancedBilling
       prepaid_usage_component = PrepaidUsageComponent.from_hash(hash['prepaid_usage_component']) if
         hash['prepaid_usage_component']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreatePrepaidComponent.new(prepaid_usage_component)
+      CreatePrepaidComponent.new(prepaid_usage_component,
+                                 hash)
     end
   end
 end

data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb

@@ -104,7 +104,8 @@ module AdvancedBilling
                    rollover_prepaid_remainder = SKIP,
                    renew_prepaid_allocation = SKIP,
                    expiration_interval = SKIP,
-                   expiration_interval_unit = SKIP)
+                   expiration_interval_unit = SKIP,
+                   additional_properties = {})
       @name = name
       @handle = handle unless handle == SKIP
       @pricing_scheme = pricing_scheme
@@ -118,6 +119,11 @@ module AdvancedBilling
       @renew_prepaid_allocation = renew_prepaid_allocation unless renew_prepaid_allocation == SKIP
       @expiration_interval = expiration_interval unless expiration_interval == SKIP
       @expiration_interval_unit = expiration_interval_unit unless expiration_interval_unit == 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.
@@ -151,6 +157,9 @@ module AdvancedBilling
       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) }
+
       # Create object from extracted values.
       CreatePrepaidUsageComponentPricePoint.new(name,
                                                 pricing_scheme,
@@ -161,7 +170,8 @@ module AdvancedBilling
                                                 rollover_prepaid_remainder,
                                                 renew_prepaid_allocation,
                                                 expiration_interval,
-                                                expiration_interval_unit)
+                                                expiration_interval_unit,
+                                                hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/create_prepayment.rb

@@ -25,7 +25,7 @@ module AdvancedBilling
     # amount will be collected using the default credit card payment profile and
     # applied to the prepayment account balance. This is especially useful for
     # manual replenishment of prepaid subscriptions.
-    # @return [PrepaymentMethod]
+    # @return [CreatePrepaymentMethod]
     attr_accessor :method
 
     # :- When the `method` specified is `"credit_card_on_file"`, the prepayment
@@ -62,12 +62,18 @@ module AdvancedBilling
                    details = nil,
                    memo = nil,
                    method = nil,
-                   payment_profile_id = SKIP)
+                   payment_profile_id = SKIP,
+                   additional_properties = {})
       @amount = amount
       @details = details
       @memo = memo
       @method = method
       @payment_profile_id = payment_profile_id unless payment_profile_id == 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.
@@ -82,12 +88,16 @@ module AdvancedBilling
       payment_profile_id =
         hash.key?('payment_profile_id') ? hash['payment_profile_id'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreatePrepayment.new(amount,
                            details,
                            memo,
                            method,
-                           payment_profile_id)
+                           payment_profile_id,
+                           hash)
     end
   end
 end

data/lib/advanced_billing/models/create_prepayment_method.rb

@@ -0,0 +1,44 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # :- When the `method` specified is `"credit_card_on_file"`, the prepayment
+  # amount will be collected using the default credit card payment profile and
+  # applied to the prepayment account balance. This is especially useful for
+  # manual replenishment of prepaid subscriptions.
+  class CreatePrepaymentMethod
+    CREATE_PREPAYMENT_METHOD = [
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for MONEY_ORDER
+      MONEY_ORDER = 'money_order'.freeze,
+
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for PAYPAL_ACCOUNT
+      PAYPAL_ACCOUNT = 'paypal_account'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'credit_card'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD_ON_FILE
+      CREDIT_CARD_ON_FILE = 'credit_card_on_file'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREATE_PREPAYMENT_METHOD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/create_prepayment_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(prepayment = nil)
+    def initialize(prepayment = nil,
+                   additional_properties = {})
       @prepayment = prepayment
+
+      # 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.
@@ -41,8 +47,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       prepayment = CreatePrepayment.from_hash(hash['prepayment']) if hash['prepayment']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreatePrepaymentRequest.new(prepayment)
+      CreatePrepaymentRequest.new(prepayment,
+                                  hash)
     end
   end
 end

data/lib/advanced_billing/models/create_prepayment_response.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(prepayment = nil)
+    def initialize(prepayment = nil,
+                   additional_properties = {})
       @prepayment = prepayment
+
+      # 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.
@@ -41,8 +47,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       prepayment = CreatedPrepayment.from_hash(hash['prepayment']) if hash['prepayment']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreatePrepaymentResponse.new(prepayment)
+      CreatePrepaymentResponse.new(prepayment,
+                                   hash)
     end
   end
 end

data/lib/advanced_billing/models/create_product_currency_price.rb

@@ -42,10 +42,16 @@ module AdvancedBilling
 
     def initialize(currency = nil,
                    price = nil,
-                   role = nil)
+                   role = nil,
+                   additional_properties = {})
       @currency = currency
       @price = price
       @role = role
+
+      # 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.
@@ -57,10 +63,14 @@ module AdvancedBilling
       price = hash.key?('price') ? hash['price'] : nil
       role = hash.key?('role') ? hash['role'] : nil
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateProductCurrencyPrice.new(currency,
                                      price,
-                                     role)
+                                     role,
+                                     hash)
     end
   end
 end

data/lib/advanced_billing/models/create_product_currency_prices_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(currency_prices = nil)
+    def initialize(currency_prices = nil,
+                   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
     end
 
     # Creates an instance of the object from a hash.
@@ -50,8 +56,12 @@ module AdvancedBilling
 
       currency_prices = nil unless hash.key?('currency_prices')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateProductCurrencyPricesRequest.new(currency_prices)
+      CreateProductCurrencyPricesRequest.new(currency_prices,
+                                             hash)
     end
   end
 end

data/lib/advanced_billing/models/create_product_family.rb

@@ -41,9 +41,15 @@ module AdvancedBilling
     end
 
     def initialize(name = SKIP,
-                   description = SKIP)
+                   description = SKIP,
+                   additional_properties = {})
       @name = name unless name == SKIP
       @description = description unless description == 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.
@@ -54,9 +60,13 @@ module AdvancedBilling
       name = hash.key?('name') ? hash['name'] : SKIP
       description = hash.key?('description') ? hash['description'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       CreateProductFamily.new(name,
-                              description)
+                              description,
+                              hash)
     end
   end
 end

data/lib/advanced_billing/models/create_product_family_request.rb

@@ -30,8 +30,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(product_family = nil)
+    def initialize(product_family = nil,
+                   additional_properties = {})
       @product_family = product_family
+
+      # 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.
@@ -42,8 +48,12 @@ module AdvancedBilling
       product_family = CreateProductFamily.from_hash(hash['product_family']) if
         hash['product_family']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      CreateProductFamilyRequest.new(product_family)
+      CreateProductFamilyRequest.new(product_family,
+                                     hash)
     end
   end
 end