maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/account_balance.rb

@@ -13,10 +13,20 @@ module AdvancedBilling
     # @return [Integer]
     attr_accessor :balance_in_cents
 
+    # The automatic balance in cents.
+    # @return [Integer]
+    attr_accessor :automatic_balance_in_cents
+
+    # The remittance balance in cents.
+    # @return [Integer]
+    attr_accessor :remittance_balance_in_cents
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['balance_in_cents'] = 'balance_in_cents'
+      @_hash['automatic_balance_in_cents'] = 'automatic_balance_in_cents'
+      @_hash['remittance_balance_in_cents'] = 'remittance_balance_in_cents'
       @_hash
     end
 
@@ -24,16 +34,37 @@ module AdvancedBilling
     def self.optionals
       %w[
         balance_in_cents
+        automatic_balance_in_cents
+        remittance_balance_in_cents
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        automatic_balance_in_cents
+        remittance_balance_in_cents
+      ]
     end
 
-    def initialize(balance_in_cents = SKIP)
+    def initialize(balance_in_cents = SKIP,
+                   automatic_balance_in_cents = SKIP,
+                   remittance_balance_in_cents = SKIP,
+                   additional_properties = {})
       @balance_in_cents = balance_in_cents unless balance_in_cents == SKIP
+      unless automatic_balance_in_cents == SKIP
+        @automatic_balance_in_cents =
+          automatic_balance_in_cents
+      end
+      unless remittance_balance_in_cents == SKIP
+        @remittance_balance_in_cents =
+          remittance_balance_in_cents
+      end
+
+      # 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.
@@ -43,9 +74,19 @@ module AdvancedBilling
       # Extract variables from the hash.
       balance_in_cents =
         hash.key?('balance_in_cents') ? hash['balance_in_cents'] : SKIP
+      automatic_balance_in_cents =
+        hash.key?('automatic_balance_in_cents') ? hash['automatic_balance_in_cents'] : SKIP
+      remittance_balance_in_cents =
+        hash.key?('remittance_balance_in_cents') ? hash['remittance_balance_in_cents'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      AccountBalance.new(balance_in_cents)
+      AccountBalance.new(balance_in_cents,
+                         automatic_balance_in_cents,
+                         remittance_balance_in_cents,
+                         hash)
     end
   end
 end

data/lib/advanced_billing/models/account_balances.rb

@@ -14,6 +14,11 @@ module AdvancedBilling
     # @return [AccountBalance]
     attr_accessor :open_invoices
 
+    # The balance, in cents, of the sum of the subscription's  pending, payable
+    # invoices.
+    # @return [AccountBalance]
+    attr_accessor :pending_invoices
+
     # The balance, in cents, of the subscription's Pending Discount account.
     # @return [AccountBalance]
     attr_accessor :pending_discounts
@@ -30,6 +35,7 @@ module AdvancedBilling
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['open_invoices'] = 'open_invoices'
+      @_hash['pending_invoices'] = 'pending_invoices'
       @_hash['pending_discounts'] = 'pending_discounts'
       @_hash['service_credits'] = 'service_credits'
       @_hash['prepayments'] = 'prepayments'
@@ -40,6 +46,7 @@ module AdvancedBilling
     def self.optionals
       %w[
         open_invoices
+        pending_invoices
         pending_discounts
         service_credits
         prepayments
@@ -52,13 +59,21 @@ module AdvancedBilling
     end
 
     def initialize(open_invoices = SKIP,
+                   pending_invoices = SKIP,
                    pending_discounts = SKIP,
                    service_credits = SKIP,
-                   prepayments = SKIP)
+                   prepayments = SKIP,
+                   additional_properties = {})
       @open_invoices = open_invoices unless open_invoices == SKIP
+      @pending_invoices = pending_invoices unless pending_invoices == SKIP
       @pending_discounts = pending_discounts unless pending_discounts == SKIP
       @service_credits = service_credits unless service_credits == SKIP
       @prepayments = prepayments unless prepayments == 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.
@@ -67,17 +82,24 @@ module AdvancedBilling
 
       # Extract variables from the hash.
       open_invoices = AccountBalance.from_hash(hash['open_invoices']) if hash['open_invoices']
+      pending_invoices = AccountBalance.from_hash(hash['pending_invoices']) if
+        hash['pending_invoices']
       pending_discounts = AccountBalance.from_hash(hash['pending_discounts']) if
         hash['pending_discounts']
       service_credits = AccountBalance.from_hash(hash['service_credits']) if
         hash['service_credits']
       prepayments = AccountBalance.from_hash(hash['prepayments']) if hash['prepayments']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       AccountBalances.new(open_invoices,
+                          pending_invoices,
                           pending_discounts,
                           service_credits,
-                          prepayments)
+                          prepayments,
+                          hash)
     end
   end
 end

data/lib/advanced_billing/models/ach_agreement.rb

@@ -58,11 +58,17 @@ module AdvancedBilling
     def initialize(agreement_terms = SKIP,
                    authorizer_first_name = SKIP,
                    authorizer_last_name = SKIP,
-                   ip_address = SKIP)
+                   ip_address = SKIP,
+                   additional_properties = {})
       @agreement_terms = agreement_terms unless agreement_terms == SKIP
       @authorizer_first_name = authorizer_first_name unless authorizer_first_name == SKIP
       @authorizer_last_name = authorizer_last_name unless authorizer_last_name == SKIP
       @ip_address = ip_address unless ip_address == 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.
@@ -78,11 +84,15 @@ module AdvancedBilling
         hash.key?('authorizer_last_name') ? hash['authorizer_last_name'] : SKIP
       ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ACHAgreement.new(agreement_terms,
                        authorizer_first_name,
                        authorizer_last_name,
-                       ip_address)
+                       ip_address,
+                       hash)
     end
   end
 end

data/lib/advanced_billing/models/activate_subscription_request.rb

@@ -38,8 +38,14 @@ module AdvancedBilling
       ]
     end
 
-    def initialize(revert_on_failure = SKIP)
+    def initialize(revert_on_failure = SKIP,
+                   additional_properties = {})
       @revert_on_failure = revert_on_failure unless revert_on_failure == 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.
@@ -50,8 +56,12 @@ module AdvancedBilling
       revert_on_failure =
         hash.key?('revert_on_failure') ? hash['revert_on_failure'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      ActivateSubscriptionRequest.new(revert_on_failure)
+      ActivateSubscriptionRequest.new(revert_on_failure,
+                                      hash)
     end
   end
 end

data/lib/advanced_billing/models/add_coupons_request.rb

@@ -32,8 +32,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(codes = SKIP)
+    def initialize(codes = SKIP,
+                   additional_properties = {})
       @codes = codes unless codes == 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.
@@ -43,8 +49,12 @@ module AdvancedBilling
       # Extract variables from the hash.
       codes = hash.key?('codes') ? hash['codes'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      AddCouponsRequest.new(codes)
+      AddCouponsRequest.new(codes,
+                            hash)
     end
   end
 end

data/lib/advanced_billing/models/add_subscription_to_a_group.rb

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

data/lib/advanced_billing/models/address_change.rb

@@ -36,9 +36,15 @@ module AdvancedBilling
     end
 
     def initialize(before = nil,
-                   after = nil)
+                   after = nil,
+                   additional_properties = {})
       @before = before
       @after = after
+
+      # 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.
@@ -49,9 +55,13 @@ module AdvancedBilling
       before = InvoiceAddress.from_hash(hash['before']) if hash['before']
       after = InvoiceAddress.from_hash(hash['after']) if hash['after']
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       AddressChange.new(before,
-                        after)
+                        after,
+                        hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/agreement_acceptance.rb

@@ -77,7 +77,8 @@ module AdvancedBilling
                    privacy_policy_url = SKIP,
                    return_refund_policy_url = SKIP,
                    delivery_policy_url = SKIP,
-                   secure_checkout_policy_url = SKIP)
+                   secure_checkout_policy_url = SKIP,
+                   additional_properties = {})
       @ip_address = ip_address unless ip_address == SKIP
       @terms_url = terms_url unless terms_url == SKIP
       @privacy_policy_url = privacy_policy_url unless privacy_policy_url == SKIP
@@ -87,6 +88,11 @@ module AdvancedBilling
         @secure_checkout_policy_url =
           secure_checkout_policy_url
       end
+
+      # 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.
@@ -105,13 +111,17 @@ module AdvancedBilling
       secure_checkout_policy_url =
         hash.key?('secure_checkout_policy_url') ? hash['secure_checkout_policy_url'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       AgreementAcceptance.new(ip_address,
                               terms_url,
                               privacy_policy_url,
                               return_refund_policy_url,
                               delivery_policy_url,
-                              secure_checkout_policy_url)
+                              secure_checkout_policy_url,
+                              hash)
     end
   end
 end

data/lib/advanced_billing/models/allocate_components.rb

@@ -91,7 +91,8 @@ module AdvancedBilling
                    upgrade_charge = SKIP,
                    downgrade_credit = SKIP,
                    payment_collection_method = SKIP,
-                   initiate_dunning = SKIP)
+                   initiate_dunning = SKIP,
+                   additional_properties = {})
       @proration_upgrade_scheme = proration_upgrade_scheme unless proration_upgrade_scheme == SKIP
       unless proration_downgrade_scheme == SKIP
         @proration_downgrade_scheme =
@@ -106,6 +107,11 @@ module AdvancedBilling
           payment_collection_method
       end
       @initiate_dunning = initiate_dunning unless initiate_dunning == 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.
@@ -137,6 +143,9 @@ module AdvancedBilling
       initiate_dunning =
         hash.key?('initiate_dunning') ? hash['initiate_dunning'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       AllocateComponents.new(proration_upgrade_scheme,
                              proration_downgrade_scheme,
@@ -145,7 +154,8 @@ module AdvancedBilling
                              upgrade_charge,
                              downgrade_credit,
                              payment_collection_method,
-                             initiate_dunning)
+                             initiate_dunning,
+                             hash)
     end
   end
 end

data/lib/advanced_billing/models/allocation.rb

@@ -125,6 +125,24 @@ module AdvancedBilling
     # @return [PaymentForAllocation]
     attr_accessor :payment
 
+    # The type of credit to be created when upgrading/downgrading. Defaults to
+    # the component and then site setting if one is not provided.
+    # Available values: `full`, `prorated`, `none`.
+    # @return [DateTime]
+    attr_accessor :expires_at
+
+    # The type of credit to be created when upgrading/downgrading. Defaults to
+    # the component and then site setting if one is not provided.
+    # Available values: `full`, `prorated`, `none`.
+    # @return [Integer]
+    attr_accessor :used_quantity
+
+    # The type of credit to be created when upgrading/downgrading. Defaults to
+    # the component and then site setting if one is not provided.
+    # Available values: `full`, `prorated`, `none`.
+    # @return [Integer]
+    attr_accessor :charge_id
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -150,6 +168,9 @@ module AdvancedBilling
       @_hash['upgrade_charge'] = 'upgrade_charge'
       @_hash['downgrade_credit'] = 'downgrade_credit'
       @_hash['payment'] = 'payment'
+      @_hash['expires_at'] = 'expires_at'
+      @_hash['used_quantity'] = 'used_quantity'
+      @_hash['charge_id'] = 'charge_id'
       @_hash
     end
 
@@ -178,6 +199,9 @@ module AdvancedBilling
         upgrade_charge
         downgrade_credit
         payment
+        expires_at
+        used_quantity
+        charge_id
       ]
     end
 
@@ -213,7 +237,11 @@ module AdvancedBilling
                    initiate_dunning = SKIP,
                    upgrade_charge = SKIP,
                    downgrade_credit = SKIP,
-                   payment = SKIP)
+                   payment = SKIP,
+                   expires_at = SKIP,
+                   used_quantity = SKIP,
+                   charge_id = SKIP,
+                   additional_properties = {})
       @allocation_id = allocation_id unless allocation_id == SKIP
       @component_id = component_id unless component_id == SKIP
       @component_handle = component_handle unless component_handle == SKIP
@@ -239,6 +267,14 @@ module AdvancedBilling
       @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
       @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
       @payment = payment unless payment == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @used_quantity = used_quantity unless used_quantity == SKIP
+      @charge_id = charge_id unless charge_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.
@@ -293,6 +329,16 @@ module AdvancedBilling
       payment = hash.key?('payment') ? APIHelper.deserialize_union_type(
         UnionTypeLookUp.get(:AllocationPayment), hash['payment']
       ) : SKIP
+      expires_at = if hash.key?('expires_at')
+                     (DateTimeHelper.from_rfc3339(hash['expires_at']) if hash['expires_at'])
+                   else
+                     SKIP
+                   end
+      used_quantity = hash.key?('used_quantity') ? hash['used_quantity'] : SKIP
+      charge_id = hash.key?('charge_id') ? hash['charge_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       Allocation.new(allocation_id,
@@ -316,7 +362,11 @@ module AdvancedBilling
                      initiate_dunning,
                      upgrade_charge,
                      downgrade_credit,
-                     payment)
+                     payment,
+                     expires_at,
+                     used_quantity,
+                     charge_id,
+                     hash)
     end
 
     def to_custom_timestamp
@@ -327,6 +377,10 @@ module AdvancedBilling
       DateTimeHelper.to_rfc3339(created_at)
     end
 
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
+    end
+
     # Validates an instance of the object from a given value.
     # @param [Allocation | Hash] The value against the validation is performed.
     def self.validate(value)

data/lib/advanced_billing/models/allocation_expiration_date.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # AllocationExpirationDate Model.
   class AllocationExpirationDate < BaseModel
@@ -10,7 +11,7 @@ module AdvancedBilling
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :expires_at
 
     # A mapping from model property names to API property names.
@@ -32,8 +33,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(expires_at = SKIP)
+    def initialize(expires_at = SKIP,
+                   additional_properties = {})
       @expires_at = expires_at unless expires_at == 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.
@@ -41,10 +48,22 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      expires_at = hash.key?('expires_at') ? hash['expires_at'] : SKIP
+      expires_at = if hash.key?('expires_at')
+                     (DateTimeHelper.from_rfc3339(hash['expires_at']) if hash['expires_at'])
+                   else
+                     SKIP
+                   end
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      AllocationExpirationDate.new(expires_at)
+      AllocationExpirationDate.new(expires_at,
+                                   hash)
+    end
+
+    def to_custom_expires_at
+      DateTimeHelper.to_rfc3339(expires_at)
     end
   end
 end

data/lib/advanced_billing/models/allocation_preview.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # AllocationPreview Model.
   class AllocationPreview < BaseModel
@@ -10,11 +11,11 @@ module AdvancedBilling
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :start_date
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :end_date
 
     # TODO: Write general description for this method
@@ -116,7 +117,8 @@ module AdvancedBilling
                    accrue_charge = SKIP,
                    allocations = SKIP,
                    period_type = SKIP,
-                   existing_balance_in_cents = SKIP)
+                   existing_balance_in_cents = SKIP,
+                   additional_properties = {})
       @start_date = start_date unless start_date == SKIP
       @end_date = end_date unless end_date == SKIP
       @subtotal_in_cents = subtotal_in_cents unless subtotal_in_cents == SKIP
@@ -133,6 +135,11 @@ module AdvancedBilling
         @existing_balance_in_cents =
           existing_balance_in_cents
       end
+
+      # 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.
@@ -140,8 +147,16 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
-      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
-      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   else
+                     SKIP
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 else
+                   SKIP
+                 end
       subtotal_in_cents =
         hash.key?('subtotal_in_cents') ? hash['subtotal_in_cents'] : SKIP
       total_tax_in_cents =
@@ -178,6 +193,9 @@ module AdvancedBilling
       existing_balance_in_cents =
         hash.key?('existing_balance_in_cents') ? hash['existing_balance_in_cents'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       AllocationPreview.new(start_date,
                             end_date,
@@ -191,7 +209,16 @@ module AdvancedBilling
                             accrue_charge,
                             allocations,
                             period_type,
-                            existing_balance_in_cents)
+                            existing_balance_in_cents,
+                            hash)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
     end
   end
 end