maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/invoice_issued.rb

@@ -22,50 +22,50 @@ module AdvancedBilling
     attr_accessor :role
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [Date]
     attr_accessor :due_date
 
-    # TODO: Write general description for this method
+    # Invoice issue date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :issue_date
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :paid_date
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :due_amount
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :paid_amount
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :tax_amount
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :refund_amount
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :total_amount
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :status_amount
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :product_name
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [String]
     attr_accessor :consolidation_level
 
-    # TODO: Write general description for this method
+    # Paid date. Can be an empty string if value is missing.
     # @return [Array[InvoiceLineItemEventData]]
     attr_accessor :line_items
 
@@ -97,7 +97,9 @@ module AdvancedBilling
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        due_date
+      ]
     end
 
     def initialize(uid = nil,
@@ -114,7 +116,8 @@ module AdvancedBilling
                    status_amount = nil,
                    product_name = nil,
                    consolidation_level = nil,
-                   line_items = nil)
+                   line_items = nil,
+                   additional_properties = {})
       @uid = uid
       @number = number
       @role = role
@@ -130,6 +133,11 @@ module AdvancedBilling
       @product_name = product_name
       @consolidation_level = consolidation_level
       @line_items = line_items
+
+      # 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.
@@ -163,6 +171,9 @@ module AdvancedBilling
 
       line_items = nil unless hash.key?('line_items')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoiceIssued.new(uid,
                         number,
@@ -178,7 +189,8 @@ module AdvancedBilling
                         status_amount,
                         product_name,
                         consolidation_level,
-                        line_items)
+                        line_items,
+                        hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_line_item.rb

@@ -147,6 +147,10 @@ module AdvancedBilling
     # @return [TrueClass | FalseClass]
     attr_accessor :custom_item
 
+    # The price point ID of the line item's product
+    # @return [String]
+    attr_accessor :kind
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -171,6 +175,7 @@ module AdvancedBilling
       @_hash['component_cost_data'] = 'component_cost_data'
       @_hash['product_price_point_id'] = 'product_price_point_id'
       @_hash['custom_item'] = 'custom_item'
+      @_hash['kind'] = 'kind'
       @_hash
     end
 
@@ -198,6 +203,7 @@ module AdvancedBilling
         component_cost_data
         product_price_point_id
         custom_item
+        kind
       ]
     end
 
@@ -233,7 +239,9 @@ module AdvancedBilling
                    hide = SKIP,
                    component_cost_data = SKIP,
                    product_price_point_id = SKIP,
-                   custom_item = SKIP)
+                   custom_item = SKIP,
+                   kind = SKIP,
+                   additional_properties = {})
       @uid = uid unless uid == SKIP
       @title = title unless title == SKIP
       @description = description unless description == SKIP
@@ -255,6 +263,12 @@ module AdvancedBilling
       @component_cost_data = component_cost_data unless component_cost_data == SKIP
       @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
       @custom_item = custom_item unless custom_item == SKIP
+      @kind = kind unless kind == 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.
@@ -294,6 +308,10 @@ module AdvancedBilling
       product_price_point_id =
         hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
       custom_item = hash.key?('custom_item') ? hash['custom_item'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       InvoiceLineItem.new(uid,
@@ -316,7 +334,9 @@ module AdvancedBilling
                           hide,
                           component_cost_data,
                           product_price_point_id,
-                          custom_item)
+                          custom_item,
+                          kind,
+                          hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_line_item_component_cost_data.rb

@@ -32,8 +32,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(rates = SKIP)
+    def initialize(rates = SKIP,
+                   additional_properties = {})
       @rates = rates unless rates == 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.
@@ -52,8 +58,12 @@ module AdvancedBilling
 
       rates = SKIP unless hash.key?('rates')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      InvoiceLineItemComponentCostData.new(rates)
+      InvoiceLineItemComponentCostData.new(rates,
+                                           hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/invoice_line_item_event_data.rb

@@ -174,7 +174,8 @@ module AdvancedBilling
                    price_point_id = SKIP,
                    component_id = SKIP,
                    billing_schedule_item_id = SKIP,
-                   custom_item = SKIP)
+                   custom_item = SKIP,
+                   additional_properties = {})
       @uid = uid unless uid == SKIP
       @title = title unless title == SKIP
       @description = description unless description == SKIP
@@ -195,6 +196,11 @@ module AdvancedBilling
       @component_id = component_id unless component_id == SKIP
       @billing_schedule_item_id = billing_schedule_item_id unless billing_schedule_item_id == SKIP
       @custom_item = custom_item unless custom_item == 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.
@@ -240,6 +246,9 @@ module AdvancedBilling
         hash.key?('billing_schedule_item_id') ? hash['billing_schedule_item_id'] : SKIP
       custom_item = hash.key?('custom_item') ? hash['custom_item'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoiceLineItemEventData.new(uid,
                                    title,
@@ -260,7 +269,8 @@ module AdvancedBilling
                                    price_point_id,
                                    component_id,
                                    billing_schedule_item_id,
-                                   custom_item)
+                                   custom_item,
+                                   hash)
     end
   end
 end

data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb

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

data/lib/advanced_billing/models/invoice_payer.rb

@@ -70,13 +70,19 @@ module AdvancedBilling
                    last_name = SKIP,
                    organization = SKIP,
                    email = SKIP,
-                   vat_number = SKIP)
+                   vat_number = SKIP,
+                   additional_properties = {})
       @chargify_id = chargify_id unless chargify_id == SKIP
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
       @organization = organization unless organization == SKIP
       @email = email unless email == SKIP
       @vat_number = vat_number unless vat_number == 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.
@@ -91,13 +97,17 @@ module AdvancedBilling
       email = hash.key?('email') ? hash['email'] : SKIP
       vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePayer.new(chargify_id,
                        first_name,
                        last_name,
                        organization,
                        email,
-                       vat_number)
+                       vat_number,
+                       hash)
     end
   end
 end

data/lib/advanced_billing/models/invoice_payer_change.rb

@@ -53,11 +53,17 @@ module AdvancedBilling
     def initialize(first_name = SKIP,
                    last_name = SKIP,
                    organization = SKIP,
-                   email = SKIP)
+                   email = SKIP,
+                   additional_properties = {})
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
       @organization = organization unless organization == SKIP
       @email = email unless email == 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.
@@ -70,11 +76,15 @@ module AdvancedBilling
       organization = hash.key?('organization') ? hash['organization'] : SKIP
       email = hash.key?('email') ? hash['email'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePayerChange.new(first_name,
                              last_name,
                              organization,
-                             email)
+                             email,
+                             hash)
     end
   end
 end

data/lib/advanced_billing/models/invoice_payment.rb

@@ -99,7 +99,8 @@ module AdvancedBilling
                    prepayment = SKIP,
                    gateway_handle = SKIP,
                    gateway_used = SKIP,
-                   gateway_transaction_id = SKIP)
+                   gateway_transaction_id = SKIP,
+                   additional_properties = {})
       @transaction_time = transaction_time unless transaction_time == SKIP
       @memo = memo unless memo == SKIP
       @original_amount = original_amount unless original_amount == SKIP
@@ -110,6 +111,11 @@ module AdvancedBilling
       @gateway_handle = gateway_handle unless gateway_handle == SKIP
       @gateway_used = gateway_used unless gateway_used == SKIP
       @gateway_transaction_id = gateway_transaction_id unless gateway_transaction_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.
@@ -138,6 +144,9 @@ module AdvancedBilling
       gateway_transaction_id =
         hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePayment.new(transaction_time,
                          memo,
@@ -148,7 +157,8 @@ module AdvancedBilling
                          prepayment,
                          gateway_handle,
                          gateway_used,
-                         gateway_transaction_id)
+                         gateway_transaction_id,
+                         hash)
     end
 
     def to_custom_transaction_time

data/lib/advanced_billing/models/invoice_payment_application.rb

@@ -48,10 +48,16 @@ module AdvancedBilling
 
     def initialize(invoice_uid = SKIP,
                    application_uid = SKIP,
-                   applied_amount = SKIP)
+                   applied_amount = SKIP,
+                   additional_properties = {})
       @invoice_uid = invoice_uid unless invoice_uid == SKIP
       @application_uid = application_uid unless application_uid == SKIP
       @applied_amount = applied_amount unless applied_amount == 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.
@@ -65,10 +71,14 @@ module AdvancedBilling
       applied_amount =
         hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePaymentApplication.new(invoice_uid,
                                     application_uid,
-                                    applied_amount)
+                                    applied_amount,
+                                    hash)
     end
   end
 end

data/lib/advanced_billing/models/invoice_payment_method.rb

@@ -83,7 +83,8 @@ module AdvancedBilling
                    card_brand = SKIP,
                    card_expiration = SKIP,
                    last_four = SKIP,
-                   masked_card_number = SKIP)
+                   masked_card_number = SKIP,
+                   additional_properties = {})
       @details = details unless details == SKIP
       @kind = kind unless kind == SKIP
       @memo = memo unless memo == SKIP
@@ -92,6 +93,11 @@ module AdvancedBilling
       @card_expiration = card_expiration unless card_expiration == SKIP
       @last_four = last_four unless last_four == SKIP
       @masked_card_number = masked_card_number unless masked_card_number == 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.
@@ -110,6 +116,9 @@ module AdvancedBilling
       masked_card_number =
         hash.key?('masked_card_number') ? hash['masked_card_number'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePaymentMethod.new(details,
                                kind,
@@ -118,7 +127,8 @@ module AdvancedBilling
                                card_brand,
                                card_expiration,
                                last_four,
-                               masked_card_number)
+                               masked_card_number,
+                               hash)
     end
   end
 end

data/lib/advanced_billing/models/invoice_pre_payment.rb

@@ -10,17 +10,17 @@ module AdvancedBilling
     private_constant :SKIP
 
     # The subscription id for the prepayment account
-    # @return [String]
+    # @return [Integer]
     attr_accessor :subscription_id
 
     # The amount in cents of the prepayment that was created as a result of this
     # payment.
-    # @return [String]
+    # @return [Integer]
     attr_accessor :amount_in_cents
 
     # The total balance of the prepayment account for this subscription
     # including any prior prepayments
-    # @return [String]
+    # @return [Integer]
     attr_accessor :ending_balance_in_cents
 
     # A mapping from model property names to API property names.
@@ -48,10 +48,16 @@ module AdvancedBilling
 
     def initialize(subscription_id = SKIP,
                    amount_in_cents = SKIP,
-                   ending_balance_in_cents = SKIP)
+                   ending_balance_in_cents = SKIP,
+                   additional_properties = {})
       @subscription_id = subscription_id unless subscription_id == SKIP
       @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
       @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_in_cents == 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.
@@ -66,10 +72,24 @@ module AdvancedBilling
       ending_balance_in_cents =
         hash.key?('ending_balance_in_cents') ? hash['ending_balance_in_cents'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePrePayment.new(subscription_id,
                             amount_in_cents,
-                            ending_balance_in_cents)
+                            ending_balance_in_cents,
+                            hash)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoicePrePayment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
     end
   end
 end

data/lib/advanced_billing/models/invoice_previous_balance.rb

@@ -40,9 +40,15 @@ module AdvancedBilling
     end
 
     def initialize(captured_at = SKIP,
-                   invoices = SKIP)
+                   invoices = SKIP,
+                   additional_properties = {})
       @captured_at = captured_at unless captured_at == SKIP
       @invoices = invoices unless invoices == 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.
@@ -66,9 +72,13 @@ module AdvancedBilling
 
       invoices = SKIP unless hash.key?('invoices')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       InvoicePreviousBalance.new(captured_at,
-                                 invoices)
+                                 invoices,
+                                 hash)
     end
 
     def to_custom_captured_at

data/lib/advanced_billing/models/invoice_refund.rb

@@ -33,6 +33,14 @@ module AdvancedBilling
     # @return [String]
     attr_accessor :gateway_transaction_id
 
+    # The transaction ID for the refund as returned from the payment gateway
+    # @return [String]
+    attr_accessor :gateway_used
+
+    # The transaction ID for the refund as returned from the payment gateway
+    # @return [String]
+    attr_accessor :gateway_handle
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -42,6 +50,8 @@ module AdvancedBilling
       @_hash['original_amount'] = 'original_amount'
       @_hash['applied_amount'] = 'applied_amount'
       @_hash['gateway_transaction_id'] = 'gateway_transaction_id'
+      @_hash['gateway_used'] = 'gateway_used'
+      @_hash['gateway_handle'] = 'gateway_handle'
       @_hash
     end
 
@@ -54,6 +64,8 @@ module AdvancedBilling
         original_amount
         applied_amount
         gateway_transaction_id
+        gateway_used
+        gateway_handle
       ]
     end
 
@@ -61,6 +73,7 @@ module AdvancedBilling
     def self.nullables
       %w[
         gateway_transaction_id
+        gateway_handle
       ]
     end
 
@@ -69,13 +82,23 @@ module AdvancedBilling
                    memo = SKIP,
                    original_amount = SKIP,
                    applied_amount = SKIP,
-                   gateway_transaction_id = SKIP)
+                   gateway_transaction_id = SKIP,
+                   gateway_used = SKIP,
+                   gateway_handle = SKIP,
+                   additional_properties = {})
       @transaction_id = transaction_id unless transaction_id == SKIP
       @payment_id = payment_id unless payment_id == SKIP
       @memo = memo unless memo == SKIP
       @original_amount = original_amount unless original_amount == SKIP
       @applied_amount = applied_amount unless applied_amount == SKIP
       @gateway_transaction_id = gateway_transaction_id unless gateway_transaction_id == SKIP
+      @gateway_used = gateway_used unless gateway_used == SKIP
+      @gateway_handle = gateway_handle unless gateway_handle == 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.
@@ -93,6 +116,12 @@ module AdvancedBilling
         hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
       gateway_transaction_id =
         hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : SKIP
+      gateway_used = hash.key?('gateway_used') ? hash['gateway_used'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       InvoiceRefund.new(transaction_id,
@@ -100,7 +129,10 @@ module AdvancedBilling
                         memo,
                         original_amount,
                         applied_amount,
-                        gateway_transaction_id)
+                        gateway_transaction_id,
+                        gateway_used,
+                        gateway_handle,
+                        hash)
     end
   end
 end