maxio-advanced-billing-sdk 1.0.0 → 2.0.0

data/lib/advanced_billing/models/proforma_invoice_issued.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # ProformaInvoiceIssued Model.
   class ProformaInvoiceIssued < BaseModel
@@ -22,11 +23,11 @@ module AdvancedBilling
     attr_accessor :role
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [Date]
     attr_accessor :delivery_date
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :created_at
 
     # TODO: Write general description for this method
@@ -90,7 +91,8 @@ module AdvancedBilling
                    tax_amount = nil,
                    total_amount = nil,
                    product_name = nil,
-                   line_items = nil)
+                   line_items = nil,
+                   additional_properties = {})
       @uid = uid
       @number = number
       @role = role
@@ -102,6 +104,11 @@ module AdvancedBilling
       @total_amount = total_amount
       @product_name = product_name
       @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.
@@ -113,7 +120,9 @@ module AdvancedBilling
       number = hash.key?('number') ? hash['number'] : nil
       role = hash.key?('role') ? hash['role'] : nil
       delivery_date = hash.key?('delivery_date') ? hash['delivery_date'] : nil
-      created_at = hash.key?('created_at') ? hash['created_at'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
       due_amount = hash.key?('due_amount') ? hash['due_amount'] : nil
       paid_amount = hash.key?('paid_amount') ? hash['paid_amount'] : nil
       tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : nil
@@ -130,6 +139,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.
       ProformaInvoiceIssued.new(uid,
                                 number,
@@ -141,7 +153,12 @@ module AdvancedBilling
                                 tax_amount,
                                 total_amount,
                                 product_name,
-                                line_items)
+                                line_items,
+                                hash)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
     end
 
     # Validates an instance of the object from a given value.
@@ -158,7 +175,7 @@ module AdvancedBilling
             APIHelper.valid_type?(value.delivery_date,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.created_at,
-                                  ->(val) { val.instance_of? String }) and
+                                  ->(val) { val.instance_of? DateTime }) and
             APIHelper.valid_type?(value.due_amount,
                                   ->(val) { val.instance_of? String }) and
             APIHelper.valid_type?(value.paid_amount,

data/lib/advanced_billing/models/proforma_invoice_payment.rb

@@ -53,11 +53,17 @@ module AdvancedBilling
     def initialize(memo = SKIP,
                    original_amount = SKIP,
                    applied_amount = SKIP,
-                   prepayment = SKIP)
+                   prepayment = SKIP,
+                   additional_properties = {})
       @memo = memo unless memo == SKIP
       @original_amount = original_amount unless original_amount == SKIP
       @applied_amount = applied_amount unless applied_amount == SKIP
       @prepayment = prepayment unless prepayment == 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.
@@ -72,11 +78,15 @@ module AdvancedBilling
         hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
       prepayment = hash.key?('prepayment') ? hash['prepayment'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ProformaInvoicePayment.new(memo,
                                  original_amount,
                                  applied_amount,
-                                 prepayment)
+                                 prepayment,
+                                 hash)
     end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_role.rb

@@ -0,0 +1,30 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # 'proforma' value is deprecated in favor of proforma_adhoc and
+  # proforma_automatic
+  class ProformaInvoiceRole
+    PROFORMA_INVOICE_ROLE = [
+      # TODO: Write general description for UNSET
+      UNSET = 'unset'.freeze,
+
+      # TODO: Write general description for PROFORMA
+      PROFORMA = 'proforma'.freeze,
+
+      # TODO: Write general description for PROFORMA_ADHOC
+      PROFORMA_ADHOC = 'proforma_adhoc'.freeze,
+
+      # TODO: Write general description for PROFORMA_AUTOMATIC
+      PROFORMA_AUTOMATIC = 'proforma_automatic'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROFORMA_INVOICE_ROLE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/proforma_invoice_status.rb

@@ -0,0 +1,26 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Proforma Invoice Status.
+  class ProformaInvoiceStatus
+    PROFORMA_INVOICE_STATUS = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'voided'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'archived'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROFORMA_INVOICE_STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/proforma_invoice_tax.rb

@@ -18,7 +18,7 @@ module AdvancedBilling
     attr_accessor :title
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [ProformaInvoiceTaxSourceType]
     attr_accessor :source_type
 
     # TODO: Write general description for this method
@@ -34,7 +34,7 @@ module AdvancedBilling
     attr_accessor :tax_amount
 
     # TODO: Write general description for this method
-    # @return [Array[ProformaInvoiceTaxBreakout]]
+    # @return [Array[InvoiceTaxBreakout]]
     attr_accessor :line_item_breakouts
 
     # A mapping from model property names to API property names.
@@ -74,7 +74,8 @@ module AdvancedBilling
                    percentage = SKIP,
                    taxable_amount = SKIP,
                    tax_amount = SKIP,
-                   line_item_breakouts = SKIP)
+                   line_item_breakouts = SKIP,
+                   additional_properties = {})
       @uid = uid unless uid == SKIP
       @title = title unless title == SKIP
       @source_type = source_type unless source_type == SKIP
@@ -82,6 +83,11 @@ module AdvancedBilling
       @taxable_amount = taxable_amount unless taxable_amount == SKIP
       @tax_amount = tax_amount unless tax_amount == SKIP
       @line_item_breakouts = line_item_breakouts unless line_item_breakouts == 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.
@@ -101,12 +107,15 @@ module AdvancedBilling
       unless hash['line_item_breakouts'].nil?
         line_item_breakouts = []
         hash['line_item_breakouts'].each do |structure|
-          line_item_breakouts << (ProformaInvoiceTaxBreakout.from_hash(structure) if structure)
+          line_item_breakouts << (InvoiceTaxBreakout.from_hash(structure) if structure)
         end
       end
 
       line_item_breakouts = SKIP unless hash.key?('line_item_breakouts')
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ProformaInvoiceTax.new(uid,
                              title,
@@ -114,7 +123,8 @@ module AdvancedBilling
                              percentage,
                              taxable_amount,
                              tax_amount,
-                             line_item_breakouts)
+                             line_item_breakouts,
+                             hash)
     end
   end
 end

data/lib/advanced_billing/models/proforma_invoice_tax_source_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Proforma Invoice Tax Source Type.
+  class ProformaInvoiceTaxSourceType
+    PROFORMA_INVOICE_TAX_SOURCE_TYPE = [
+      # TODO: Write general description for TAX
+      TAX = 'Tax'.freeze,
+
+      # TODO: Write general description for AVALARA
+      AVALARA = 'Avalara'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROFORMA_INVOICE_TAX_SOURCE_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/proration.rb

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

data/lib/advanced_billing/models/public_key.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # PublicKey Model.
   class PublicKey < BaseModel
@@ -18,7 +19,7 @@ module AdvancedBilling
     attr_accessor :requires_security_token
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :created_at
 
     # A mapping from model property names to API property names.
@@ -46,10 +47,16 @@ module AdvancedBilling
 
     def initialize(public_key = SKIP,
                    requires_security_token = SKIP,
-                   created_at = SKIP)
+                   created_at = SKIP,
+                   additional_properties = {})
       @public_key = public_key unless public_key == SKIP
       @requires_security_token = requires_security_token unless requires_security_token == SKIP
       @created_at = created_at unless created_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.
@@ -60,12 +67,24 @@ module AdvancedBilling
       public_key = hash.key?('public_key') ? hash['public_key'] : SKIP
       requires_security_token =
         hash.key?('requires_security_token') ? hash['requires_security_token'] : SKIP
-      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
       PublicKey.new(public_key,
                     requires_security_token,
-                    created_at)
+                    created_at,
+                    hash)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
     end
   end
 end

data/lib/advanced_billing/models/public_signup_page.rb

@@ -57,11 +57,17 @@ module AdvancedBilling
     def initialize(id = SKIP,
                    return_url = SKIP,
                    return_params = SKIP,
-                   url = SKIP)
+                   url = SKIP,
+                   additional_properties = {})
       @id = id unless id == SKIP
       @return_url = return_url unless return_url == SKIP
       @return_params = return_params unless return_params == SKIP
       @url = url unless url == 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.
@@ -74,11 +80,15 @@ module AdvancedBilling
       return_params = hash.key?('return_params') ? hash['return_params'] : SKIP
       url = hash.key?('url') ? hash['url'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       PublicSignupPage.new(id,
                            return_url,
                            return_params,
-                           url)
+                           url,
+                           hash)
     end
   end
 end

data/lib/advanced_billing/models/quantity_based_component.rb

@@ -198,7 +198,8 @@ module AdvancedBilling
                    allow_fractional_quantities = SKIP,
                    public_signup_page_ids = SKIP,
                    interval = SKIP,
-                   interval_unit = SKIP)
+                   interval_unit = SKIP,
+                   additional_properties = {})
       @name = name
       @unit_name = unit_name
       @description = description unless description == SKIP
@@ -225,6 +226,11 @@ module AdvancedBilling
       @public_signup_page_ids = public_signup_page_ids unless public_signup_page_ids == SKIP
       @interval = interval unless interval == SKIP
       @interval_unit = interval_unit unless 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.
@@ -281,6 +287,9 @@ module AdvancedBilling
       interval = hash.key?('interval') ? hash['interval'] : SKIP
       interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       QuantityBasedComponent.new(name,
                                  unit_name,
@@ -301,7 +310,8 @@ module AdvancedBilling
                                  allow_fractional_quantities,
                                  public_signup_page_ids,
                                  interval,
-                                 interval_unit)
+                                 interval_unit,
+                                 hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/reactivate_subscription_group_request.rb

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

data/lib/advanced_billing/models/reactivate_subscription_group_response.rb

@@ -3,6 +3,7 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'date'
 module AdvancedBilling
   # ReactivateSubscriptionGroupResponse Model.
   class ReactivateSubscriptionGroupResponse < BaseModel
@@ -34,7 +35,7 @@ module AdvancedBilling
     attr_accessor :primary_subscription_id
 
     # TODO: Write general description for this method
-    # @return [String]
+    # @return [DateTime]
     attr_accessor :next_assessment_at
 
     # TODO: Write general description for this method
@@ -88,7 +89,8 @@ module AdvancedBilling
                    primary_subscription_id = SKIP,
                    next_assessment_at = SKIP,
                    state = SKIP,
-                   cancel_at_end_of_period = SKIP)
+                   cancel_at_end_of_period = SKIP,
+                   additional_properties = {})
       @uid = uid unless uid == SKIP
       @scheme = scheme unless scheme == SKIP
       @customer_id = customer_id unless customer_id == SKIP
@@ -98,6 +100,11 @@ module AdvancedBilling
       @next_assessment_at = next_assessment_at unless next_assessment_at == SKIP
       @state = state unless state == SKIP
       @cancel_at_end_of_period = cancel_at_end_of_period unless cancel_at_end_of_period == 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.
@@ -114,12 +121,18 @@ module AdvancedBilling
         hash.key?('subscription_ids') ? hash['subscription_ids'] : SKIP
       primary_subscription_id =
         hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
-      next_assessment_at =
-        hash.key?('next_assessment_at') ? hash['next_assessment_at'] : SKIP
+      next_assessment_at = if hash.key?('next_assessment_at')
+                             (DateTimeHelper.from_rfc3339(hash['next_assessment_at']) if hash['next_assessment_at'])
+                           else
+                             SKIP
+                           end
       state = hash.key?('state') ? hash['state'] : SKIP
       cancel_at_end_of_period =
         hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ReactivateSubscriptionGroupResponse.new(uid,
                                               scheme,
@@ -129,7 +142,12 @@ module AdvancedBilling
                                               primary_subscription_id,
                                               next_assessment_at,
                                               state,
-                                              cancel_at_end_of_period)
+                                              cancel_at_end_of_period,
+                                              hash)
+    end
+
+    def to_custom_next_assessment_at
+      DateTimeHelper.to_rfc3339(next_assessment_at)
     end
   end
 end

data/lib/advanced_billing/models/reactivate_subscription_request.rb

@@ -74,7 +74,8 @@ module AdvancedBilling
                    preserve_balance = SKIP,
                    coupon_code = SKIP,
                    use_credits_and_prepayments = SKIP,
-                   resume = SKIP)
+                   resume = SKIP,
+                   additional_properties = {})
       @calendar_billing = calendar_billing unless calendar_billing == SKIP
       @include_trial = include_trial unless include_trial == SKIP
       @preserve_balance = preserve_balance unless preserve_balance == SKIP
@@ -84,6 +85,11 @@ module AdvancedBilling
           use_credits_and_prepayments
       end
       @resume = resume unless resume == 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.
@@ -103,13 +109,17 @@ module AdvancedBilling
         UnionTypeLookUp.get(:ReactivateSubscriptionRequestResume), hash['resume']
       ) : SKIP
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
       ReactivateSubscriptionRequest.new(calendar_billing,
                                         include_trial,
                                         preserve_balance,
                                         coupon_code,
                                         use_credits_and_prepayments,
-                                        resume)
+                                        resume,
+                                        hash)
     end
 
     # Validates an instance of the object from a given value.

data/lib/advanced_billing/models/reactivation_billing.rb

@@ -37,8 +37,14 @@ module AdvancedBilling
       []
     end
 
-    def initialize(reactivation_charge = ReactivationCharge::PRORATED)
+    def initialize(reactivation_charge = ReactivationCharge::PRORATED,
+                   additional_properties = {})
       @reactivation_charge = reactivation_charge unless reactivation_charge == 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.
@@ -49,8 +55,12 @@ module AdvancedBilling
       reactivation_charge =
         hash['reactivation_charge'] ||= ReactivationCharge::PRORATED
 
+      # Clean out expected properties from Hash.
+      names.each_value { |k| hash.delete(k) }
+
       # Create object from extracted values.
-      ReactivationBilling.new(reactivation_charge)
+      ReactivationBilling.new(reactivation_charge,
+                              hash)
     end
   end
 end