xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/tax_rate.rb

@@ -0,0 +1,213 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TaxRate Model.
+  class TaxRate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of tax rate
+    # @return [String]
+    attr_accessor :name
+
+    # The tax type
+    # @return [String]
+    attr_accessor :tax_type
+
+    # See TaxComponents
+    # @return [Array[TaxComponent]]
+    attr_accessor :tax_components
+
+    # See Status Codes
+    # @return [Status19]
+    attr_accessor :status
+
+    # See ReportTaxTypes
+    # @return [ReportTaxType]
+    attr_accessor :report_tax_type
+
+    # Boolean to describe if tax rate can be used for asset accounts i.e.
+    # true,false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_apply_to_assets
+
+    # Boolean to describe if tax rate can be used for equity accounts i.e
+    # true,false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_apply_to_equity
+
+    # Boolean to describe if tax rate can be used for expense accounts  i.e.
+    # true,false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_apply_to_expenses
+
+    # Boolean to describe if tax rate can be used for liability accounts  i.e.
+    # true,false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_apply_to_liabilities
+
+    # Boolean to describe if tax rate can be used for revenue accounts i.e.
+    # true,false
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_apply_to_revenue
+
+    # Tax Rate (decimal to 4dp) e.g 12.5000
+    # @return [Float]
+    attr_accessor :display_tax_rate
+
+    # Effective Tax Rate (decimal to 4dp) e.g 12.5000
+    # @return [Float]
+    attr_accessor :effective_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'Name'
+      @_hash['tax_type'] = 'TaxType'
+      @_hash['tax_components'] = 'TaxComponents'
+      @_hash['status'] = 'Status'
+      @_hash['report_tax_type'] = 'ReportTaxType'
+      @_hash['can_apply_to_assets'] = 'CanApplyToAssets'
+      @_hash['can_apply_to_equity'] = 'CanApplyToEquity'
+      @_hash['can_apply_to_expenses'] = 'CanApplyToExpenses'
+      @_hash['can_apply_to_liabilities'] = 'CanApplyToLiabilities'
+      @_hash['can_apply_to_revenue'] = 'CanApplyToRevenue'
+      @_hash['display_tax_rate'] = 'DisplayTaxRate'
+      @_hash['effective_rate'] = 'EffectiveRate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        tax_type
+        tax_components
+        status
+        report_tax_type
+        can_apply_to_assets
+        can_apply_to_equity
+        can_apply_to_expenses
+        can_apply_to_liabilities
+        can_apply_to_revenue
+        display_tax_rate
+        effective_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, tax_type: SKIP, tax_components: SKIP,
+                   status: SKIP, report_tax_type: SKIP,
+                   can_apply_to_assets: SKIP, can_apply_to_equity: SKIP,
+                   can_apply_to_expenses: SKIP, can_apply_to_liabilities: SKIP,
+                   can_apply_to_revenue: SKIP, display_tax_rate: SKIP,
+                   effective_rate: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @tax_type = tax_type unless tax_type == SKIP
+      @tax_components = tax_components unless tax_components == SKIP
+      @status = status unless status == SKIP
+      @report_tax_type = report_tax_type unless report_tax_type == SKIP
+      @can_apply_to_assets = can_apply_to_assets unless can_apply_to_assets == SKIP
+      @can_apply_to_equity = can_apply_to_equity unless can_apply_to_equity == SKIP
+      @can_apply_to_expenses = can_apply_to_expenses unless can_apply_to_expenses == SKIP
+      @can_apply_to_liabilities = can_apply_to_liabilities unless can_apply_to_liabilities == SKIP
+      @can_apply_to_revenue = can_apply_to_revenue unless can_apply_to_revenue == SKIP
+      @display_tax_rate = display_tax_rate unless display_tax_rate == SKIP
+      @effective_rate = effective_rate unless effective_rate == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      tax_type = hash.key?('TaxType') ? hash['TaxType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tax_components = nil
+      unless hash['TaxComponents'].nil?
+        tax_components = []
+        hash['TaxComponents'].each do |structure|
+          tax_components << (TaxComponent.from_hash(structure) if structure)
+        end
+      end
+
+      tax_components = SKIP unless hash.key?('TaxComponents')
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      report_tax_type =
+        hash.key?('ReportTaxType') ? hash['ReportTaxType'] : SKIP
+      can_apply_to_assets =
+        hash.key?('CanApplyToAssets') ? hash['CanApplyToAssets'] : SKIP
+      can_apply_to_equity =
+        hash.key?('CanApplyToEquity') ? hash['CanApplyToEquity'] : SKIP
+      can_apply_to_expenses =
+        hash.key?('CanApplyToExpenses') ? hash['CanApplyToExpenses'] : SKIP
+      can_apply_to_liabilities =
+        hash.key?('CanApplyToLiabilities') ? hash['CanApplyToLiabilities'] : SKIP
+      can_apply_to_revenue =
+        hash.key?('CanApplyToRevenue') ? hash['CanApplyToRevenue'] : SKIP
+      display_tax_rate =
+        hash.key?('DisplayTaxRate') ? hash['DisplayTaxRate'] : SKIP
+      effective_rate = hash.key?('EffectiveRate') ? hash['EffectiveRate'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TaxRate.new(name: name,
+                  tax_type: tax_type,
+                  tax_components: tax_components,
+                  status: status,
+                  report_tax_type: report_tax_type,
+                  can_apply_to_assets: can_apply_to_assets,
+                  can_apply_to_equity: can_apply_to_equity,
+                  can_apply_to_expenses: can_apply_to_expenses,
+                  can_apply_to_liabilities: can_apply_to_liabilities,
+                  can_apply_to_revenue: can_apply_to_revenue,
+                  display_tax_rate: display_tax_rate,
+                  effective_rate: effective_rate,
+                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, tax_type: #{@tax_type}, tax_components: #{@tax_components},"\
+      " status: #{@status}, report_tax_type: #{@report_tax_type}, can_apply_to_assets:"\
+      " #{@can_apply_to_assets}, can_apply_to_equity: #{@can_apply_to_equity},"\
+      " can_apply_to_expenses: #{@can_apply_to_expenses}, can_apply_to_liabilities:"\
+      " #{@can_apply_to_liabilities}, can_apply_to_revenue: #{@can_apply_to_revenue},"\
+      " display_tax_rate: #{@display_tax_rate}, effective_rate: #{@effective_rate},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, tax_type: #{@tax_type.inspect}, tax_components:"\
+      " #{@tax_components.inspect}, status: #{@status.inspect}, report_tax_type:"\
+      " #{@report_tax_type.inspect}, can_apply_to_assets: #{@can_apply_to_assets.inspect},"\
+      " can_apply_to_equity: #{@can_apply_to_equity.inspect}, can_apply_to_expenses:"\
+      " #{@can_apply_to_expenses.inspect}, can_apply_to_liabilities:"\
+      " #{@can_apply_to_liabilities.inspect}, can_apply_to_revenue:"\
+      " #{@can_apply_to_revenue.inspect}, display_tax_rate: #{@display_tax_rate.inspect},"\
+      " effective_rate: #{@effective_rate.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/tax_rates.rb

@@ -0,0 +1,85 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TaxRates Model.
+  class TaxRates < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TaxRate]]
+    attr_accessor :tax_rates
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_rates'] = 'TaxRates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_rates
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_rates: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_rates = tax_rates unless tax_rates == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      tax_rates = nil
+      unless hash['TaxRates'].nil?
+        tax_rates = []
+        hash['TaxRates'].each do |structure|
+          tax_rates << (TaxRate.from_hash(structure) if structure)
+        end
+      end
+
+      tax_rates = SKIP unless hash.key?('TaxRates')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TaxRates.new(tax_rates: tax_rates,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_rates: #{@tax_rates}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_rates: #{@tax_rates.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end