maxio-advanced-billing-sdk 5.2.0 → 6.0.0

data/lib/advanced_billing/models/apply_debit_note_event.rb

@@ -54,16 +54,16 @@ module AdvancedBilling
     def initialize(id:, timestamp:, invoice:,
                    event_type: InvoiceEventType::APPLY_DEBIT_NOTE, event_data:,
                    additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id
       @timestamp = timestamp
       @invoice = invoice
       @event_type = event_type
       @event_data = event_data
-
-      # 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.
@@ -80,7 +80,7 @@ module AdvancedBilling
       event_data = ApplyDebitNoteEventData.from_hash(hash['event_data']) if hash['event_data']
 
       # 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.
       ApplyDebitNoteEvent.new(id: id,
@@ -88,7 +88,7 @@ module AdvancedBilling
                               invoice: invoice,
                               event_type: event_type,
                               event_data: event_data,
-                              additional_properties: hash)
+                              additional_properties: additional_properties)
     end
 
     def to_custom_timestamp

data/lib/advanced_billing/models/apply_debit_note_event_data.rb

@@ -68,17 +68,17 @@ module AdvancedBilling
     def initialize(debit_note_number:, debit_note_uid:, original_amount:,
                    applied_amount:, memo: SKIP, transaction_time: SKIP,
                    additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @debit_note_number = debit_note_number
       @debit_note_uid = debit_note_uid
       @original_amount = original_amount
       @applied_amount = applied_amount
       @memo = memo unless memo == SKIP
       @transaction_time = transaction_time unless transaction_time == 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.
@@ -102,7 +102,7 @@ module AdvancedBilling
                          end
 
       # 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.
       ApplyDebitNoteEventData.new(debit_note_number: debit_note_number,
@@ -111,7 +111,7 @@ module AdvancedBilling
                                   applied_amount: applied_amount,
                                   memo: memo,
                                   transaction_time: transaction_time,
-                                  additional_properties: hash)
+                                  additional_properties: additional_properties)
     end
 
     def to_custom_transaction_time

data/lib/advanced_billing/models/apply_payment_event.rb

@@ -54,16 +54,16 @@ module AdvancedBilling
     def initialize(id:, timestamp:, invoice:,
                    event_type: InvoiceEventType::APPLY_PAYMENT, event_data:,
                    additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id
       @timestamp = timestamp
       @invoice = invoice
       @event_type = event_type
       @event_data = event_data
-
-      # 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.
@@ -80,7 +80,7 @@ module AdvancedBilling
       event_data = ApplyPaymentEventData.from_hash(hash['event_data']) if hash['event_data']
 
       # 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.
       ApplyPaymentEvent.new(id: id,
@@ -88,7 +88,7 @@ module AdvancedBilling
                             invoice: invoice,
                             event_type: event_type,
                             event_data: event_data,
-                            additional_properties: hash)
+                            additional_properties: additional_properties)
     end
 
     def to_custom_timestamp

data/lib/advanced_billing/models/apply_payment_event_data.rb

@@ -104,6 +104,11 @@ module AdvancedBilling
                    transaction_id: SKIP, parent_invoice_number: SKIP,
                    remaining_prepayment_amount: SKIP, prepayment: SKIP,
                    external: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @consolidation_level = consolidation_level
       @memo = memo
       @original_amount = original_amount
@@ -118,11 +123,6 @@ module AdvancedBilling
       end
       @prepayment = prepayment unless prepayment == SKIP
       @external = external unless external == 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.
@@ -153,7 +153,7 @@ module AdvancedBilling
       external = hash.key?('external') ? hash['external'] : 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.
       ApplyPaymentEventData.new(consolidation_level: consolidation_level,
@@ -167,7 +167,7 @@ module AdvancedBilling
                                 remaining_prepayment_amount: remaining_prepayment_amount,
                                 prepayment: prepayment,
                                 external: external,
-                                additional_properties: hash)
+                                additional_properties: additional_properties)
     end
 
     def to_custom_transaction_time

data/lib/advanced_billing/models/attribute_error.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(attribute:, additional_properties: {})
-      @attribute = attribute
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @attribute = attribute
     end
 
     # Creates an instance of the object from a hash.
@@ -47,11 +47,11 @@ module AdvancedBilling
       attribute = hash.key?('attribute') ? hash['attribute'] : nil
 
       # 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.
       AttributeError.new(attribute: attribute,
-                         additional_properties: hash)
+                         additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/auto_resume.rb

@@ -36,12 +36,12 @@ module AdvancedBilling
     end
 
     def initialize(automatically_resume_at: SKIP, additional_properties: {})
-      @automatically_resume_at = automatically_resume_at unless automatically_resume_at == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @automatically_resume_at = automatically_resume_at unless automatically_resume_at == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -56,11 +56,11 @@ module AdvancedBilling
                                 end
 
       # 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.
       AutoResume.new(automatically_resume_at: automatically_resume_at,
-                     additional_properties: hash)
+                     additional_properties: additional_properties)
     end
 
     def to_custom_automatically_resume_at

data/lib/advanced_billing/models/backport_invoice_event.rb

@@ -54,16 +54,16 @@ module AdvancedBilling
     def initialize(id:, timestamp:, invoice:,
                    event_type: InvoiceEventType::BACKPORT_INVOICE, event_data:,
                    additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @id = id
       @timestamp = timestamp
       @invoice = invoice
       @event_type = event_type
       @event_data = event_data
-
-      # 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.
@@ -80,7 +80,7 @@ module AdvancedBilling
       event_data = Invoice.from_hash(hash['event_data']) if hash['event_data']
 
       # 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.
       BackportInvoiceEvent.new(id: id,
@@ -88,7 +88,7 @@ module AdvancedBilling
                                invoice: invoice,
                                event_type: event_type,
                                event_data: event_data,
-                               additional_properties: hash)
+                               additional_properties: additional_properties)
     end
 
     def to_custom_timestamp

data/lib/advanced_billing/models/bank_account_attributes.rb

@@ -114,6 +114,11 @@ module AdvancedBilling
                    bank_iban: SKIP, bank_account_holder_type: SKIP,
                    payment_type: SKIP, current_vault: SKIP, vault_token: SKIP,
                    customer_vault_token: SKIP, additional_properties: {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
       @chargify_token = chargify_token unless chargify_token == SKIP
       @bank_name = bank_name unless bank_name == SKIP
       @bank_routing_number = bank_routing_number unless bank_routing_number == SKIP
@@ -126,11 +131,6 @@ module AdvancedBilling
       @current_vault = current_vault unless current_vault == SKIP
       @vault_token = vault_token unless vault_token == SKIP
       @customer_vault_token = customer_vault_token unless customer_vault_token == 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.
@@ -159,7 +159,7 @@ module AdvancedBilling
         hash.key?('customer_vault_token') ? hash['customer_vault_token'] : 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.
       BankAccountAttributes.new(chargify_token: chargify_token,
@@ -174,7 +174,7 @@ module AdvancedBilling
                                 current_vault: current_vault,
                                 vault_token: vault_token,
                                 customer_vault_token: customer_vault_token,
-                                additional_properties: hash)
+                                additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/bank_account_payment_profile.rb

@@ -190,6 +190,11 @@ module AdvancedBilling
                    bank_account_holder_type: SKIP, verified: false,
                    site_gateway_setting_id: SKIP, gateway_handle: 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
       @first_name = first_name unless first_name == SKIP
       @last_name = last_name unless last_name == SKIP
@@ -215,11 +220,6 @@ module AdvancedBilling
       @verified = verified unless verified == SKIP
       @site_gateway_setting_id = site_gateway_setting_id unless site_gateway_setting_id == 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.
@@ -261,7 +261,7 @@ module AdvancedBilling
         hash.key?('gateway_handle') ? hash['gateway_handle'] : 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.
       BankAccountPaymentProfile.new(masked_bank_account_number: masked_bank_account_number,
@@ -286,7 +286,7 @@ module AdvancedBilling
                                     verified: verified,
                                     site_gateway_setting_id: site_gateway_setting_id,
                                     gateway_handle: gateway_handle,
-                                    additional_properties: hash)
+                                    additional_properties: additional_properties)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/bank_account_response.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(payment_profile:, 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
+
+      @payment_profile = payment_profile
     end
 
     # Creates an instance of the object from a hash.
@@ -48,11 +48,11 @@ module AdvancedBilling
         hash['payment_profile']
 
       # 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.
       BankAccountResponse.new(payment_profile: payment_profile,
-                              additional_properties: hash)
+                              additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/bank_account_verification.rb

@@ -40,13 +40,13 @@ module AdvancedBilling
 
     def initialize(deposit_1_in_cents: SKIP, deposit_2_in_cents: SKIP,
                    additional_properties: {})
-      @deposit_1_in_cents = deposit_1_in_cents unless deposit_1_in_cents == SKIP
-      @deposit_2_in_cents = deposit_2_in_cents unless deposit_2_in_cents == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @deposit_1_in_cents = deposit_1_in_cents unless deposit_1_in_cents == SKIP
+      @deposit_2_in_cents = deposit_2_in_cents unless deposit_2_in_cents == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -60,12 +60,12 @@ module AdvancedBilling
         hash.key?('deposit_2_in_cents') ? hash['deposit_2_in_cents'] : 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.
       BankAccountVerification.new(deposit_1_in_cents: deposit_1_in_cents,
                                   deposit_2_in_cents: deposit_2_in_cents,
-                                  additional_properties: hash)
+                                  additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/bank_account_verification_request.rb

@@ -31,12 +31,12 @@ module AdvancedBilling
     end
 
     def initialize(bank_account_verification:, additional_properties: {})
-      @bank_account_verification = bank_account_verification
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @bank_account_verification = bank_account_verification
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       end
 
       # 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.
       BankAccountVerificationRequest.new(bank_account_verification: bank_account_verification,
-                                         additional_properties: hash)
+                                         additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/base_model.rb

@@ -5,6 +5,7 @@
 
 module AdvancedBilling
   # Base model.
+  # rubocop:disable all
   class BaseModel < CoreLibrary::BaseModel
     # Returns a Hash representation of the current object.
     def to_hash
@@ -15,48 +16,95 @@ module AdvancedBilling
       instance_variables.each do |name|
         value = instance_variable_get(name)
         name = name[1..]
-        key = self.class.names.key?(name) ? self.class.names[name] : name
-        optional_fields = self.class.optionals
-        nullable_fields = self.class.nullables
-        if value.nil?
-          next unless nullable_fields.include?(name)
-
-          if !optional_fields.include?(name) && !nullable_fields.include?(name)
-            raise ArgumentError,
-                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
           end
-        end
 
-        hash[key] = nil
-        unless value.nil?
-          if respond_to?("to_custom_#{name}")
-            if (value.instance_of? Array) || (value.instance_of? Hash)
-              params = [hash, key]
-              hash[key] = send("to_custom_#{name}", *params)
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
             else
-              hash[key] = send("to_custom_#{name}")
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
             end
-          elsif respond_to?("to_union_type_#{name}")
-            hash[key] = send("to_union_type_#{name}")
-          elsif value.instance_of? Array
-            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-          elsif value.instance_of? Hash
-            hash[key] = {}
-            value.each do |k, v|
-              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
-            end
-          else
-            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
           end
         end
       end
       hash
     end
 
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
     # Returns a JSON representation of the curent object.
     def to_json(options = {})
       hash = to_hash
       hash.to_json(options)
     end
   end
+  # rubocop:enable all
 end

data/lib/advanced_billing/models/base_refund_error.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(base: SKIP, additional_properties: {})
-      @base = base unless base == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @base = base unless base == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       base = hash.key?('base') ? hash['base'] : 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.
       BaseRefundError.new(base: base,
-                          additional_properties: hash)
+                          additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/base_string_error.rb

@@ -33,12 +33,12 @@ module AdvancedBilling
     end
 
     def initialize(base: SKIP, additional_properties: {})
-      @base = base unless base == SKIP
-
       # Add additional model properties to the instance.
       additional_properties.each do |_name, _value|
         instance_variable_set("@#{_name}", _value)
       end
+
+      @base = base unless base == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -49,11 +49,11 @@ module AdvancedBilling
       base = hash.key?('base') ? hash['base'] : 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.
       BaseStringError.new(base: base,
-                          additional_properties: hash)
+                          additional_properties: additional_properties)
     end
   end
 end

data/lib/advanced_billing/models/batch_job.rb

@@ -63,16 +63,16 @@ module AdvancedBilling
 
     def initialize(id: SKIP, finished_at: SKIP, row_count: SKIP,
                    created_at: SKIP, completed: 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
       @finished_at = finished_at unless finished_at == SKIP
       @row_count = row_count unless row_count == SKIP
       @created_at = created_at unless created_at == SKIP
       @completed = completed unless completed == 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.
@@ -95,7 +95,7 @@ module AdvancedBilling
       completed = hash.key?('completed') ? hash['completed'] : 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.
       BatchJob.new(id: id,
@@ -103,7 +103,7 @@ module AdvancedBilling
                    row_count: row_count,
                    created_at: created_at,
                    completed: completed,
-                   additional_properties: hash)
+                   additional_properties: additional_properties)
     end
 
     def to_custom_finished_at