xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/journal_line.rb

@@ -0,0 +1,201 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # JournalLine Model.
+  class JournalLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero identifier for Journal
+    # @return [UUID | String]
+    attr_accessor :journal_line_id
+
+    # See Accounts
+    # @return [UUID | String]
+    attr_accessor :account_id
+
+    # See Accounts
+    # @return [String]
+    attr_accessor :account_code
+
+    # See Account Types
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # See AccountCodes
+    # @return [String]
+    attr_accessor :account_name
+
+    # The description from the source transaction line item. Only returned if
+    # populated.
+    # @return [String]
+    attr_accessor :description
+
+    # Net amount of journal line. This will be a positive value for a debit and
+    # negative for a credit
+    # @return [Float]
+    attr_accessor :net_amount
+
+    # Gross amount of journal line (NetAmount + TaxAmount).
+    # @return [Float]
+    attr_accessor :gross_amount
+
+    # Total tax on a journal line
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # The tax type from taxRates
+    # @return [String]
+    attr_accessor :tax_type
+
+    # see TaxRates
+    # @return [String]
+    attr_accessor :tax_name
+
+    # Optional Tracking Category – see Tracking. Any JournalLine can have a
+    # maximum of 2 <TrackingCategory> elements.
+    # @return [Array[TrackingCategory]]
+    attr_accessor :tracking_categories
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['journal_line_id'] = 'JournalLineID'
+      @_hash['account_id'] = 'AccountID'
+      @_hash['account_code'] = 'AccountCode'
+      @_hash['account_type'] = 'AccountType'
+      @_hash['account_name'] = 'AccountName'
+      @_hash['description'] = 'Description'
+      @_hash['net_amount'] = 'NetAmount'
+      @_hash['gross_amount'] = 'GrossAmount'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['tax_type'] = 'TaxType'
+      @_hash['tax_name'] = 'TaxName'
+      @_hash['tracking_categories'] = 'TrackingCategories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        journal_line_id
+        account_id
+        account_code
+        account_type
+        account_name
+        description
+        net_amount
+        gross_amount
+        tax_amount
+        tax_type
+        tax_name
+        tracking_categories
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(journal_line_id: SKIP, account_id: SKIP, account_code: SKIP,
+                   account_type: SKIP, account_name: SKIP, description: SKIP,
+                   net_amount: SKIP, gross_amount: SKIP, tax_amount: SKIP,
+                   tax_type: SKIP, tax_name: SKIP, tracking_categories: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @journal_line_id = journal_line_id unless journal_line_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_code = account_code unless account_code == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @description = description unless description == SKIP
+      @net_amount = net_amount unless net_amount == SKIP
+      @gross_amount = gross_amount unless gross_amount == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @tax_type = tax_type unless tax_type == SKIP
+      @tax_name = tax_name unless tax_name == SKIP
+      @tracking_categories = tracking_categories unless tracking_categories == 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.
+      journal_line_id =
+        hash.key?('JournalLineID') ? hash['JournalLineID'] : SKIP
+      account_id = hash.key?('AccountID') ? hash['AccountID'] : SKIP
+      account_code = hash.key?('AccountCode') ? hash['AccountCode'] : SKIP
+      account_type = hash.key?('AccountType') ? hash['AccountType'] : SKIP
+      account_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      net_amount = hash.key?('NetAmount') ? hash['NetAmount'] : SKIP
+      gross_amount = hash.key?('GrossAmount') ? hash['GrossAmount'] : SKIP
+      tax_amount = hash.key?('TaxAmount') ? hash['TaxAmount'] : SKIP
+      tax_type = hash.key?('TaxType') ? hash['TaxType'] : SKIP
+      tax_name = hash.key?('TaxName') ? hash['TaxName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tracking_categories = nil
+      unless hash['TrackingCategories'].nil?
+        tracking_categories = []
+        hash['TrackingCategories'].each do |structure|
+          tracking_categories << (TrackingCategory.from_hash(structure) if structure)
+        end
+      end
+
+      tracking_categories = SKIP unless hash.key?('TrackingCategories')
+
+      # 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.
+      JournalLine.new(journal_line_id: journal_line_id,
+                      account_id: account_id,
+                      account_code: account_code,
+                      account_type: account_type,
+                      account_name: account_name,
+                      description: description,
+                      net_amount: net_amount,
+                      gross_amount: gross_amount,
+                      tax_amount: tax_amount,
+                      tax_type: tax_type,
+                      tax_name: tax_name,
+                      tracking_categories: tracking_categories,
+                      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} journal_line_id: #{@journal_line_id}, account_id: #{@account_id},"\
+      " account_code: #{@account_code}, account_type: #{@account_type}, account_name:"\
+      " #{@account_name}, description: #{@description}, net_amount: #{@net_amount}, gross_amount:"\
+      " #{@gross_amount}, tax_amount: #{@tax_amount}, tax_type: #{@tax_type}, tax_name:"\
+      " #{@tax_name}, tracking_categories: #{@tracking_categories}, 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} journal_line_id: #{@journal_line_id.inspect}, account_id:"\
+      " #{@account_id.inspect}, account_code: #{@account_code.inspect}, account_type:"\
+      " #{@account_type.inspect}, account_name: #{@account_name.inspect}, description:"\
+      " #{@description.inspect}, net_amount: #{@net_amount.inspect}, gross_amount:"\
+      " #{@gross_amount.inspect}, tax_amount: #{@tax_amount.inspect}, tax_type:"\
+      " #{@tax_type.inspect}, tax_name: #{@tax_name.inspect}, tracking_categories:"\
+      " #{@tracking_categories.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/journals.rb

@@ -0,0 +1,103 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Journals Model.
+  class Journals < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Displays array of warning messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :warnings
+
+    # Displays array of warning messages from the API
+    # @return [Array[Journal]]
+    attr_accessor :journals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['warnings'] = 'Warnings'
+      @_hash['journals'] = 'Journals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        warnings
+        journals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(warnings: SKIP, journals: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @warnings = warnings unless warnings == SKIP
+      @journals = journals unless journals == 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
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+      # Parameter is an array, so we need to iterate through it
+      journals = nil
+      unless hash['Journals'].nil?
+        journals = []
+        hash['Journals'].each do |structure|
+          journals << (Journal.from_hash(structure) if structure)
+        end
+      end
+
+      journals = SKIP unless hash.key?('Journals')
+
+      # 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.
+      Journals.new(warnings: warnings,
+                   journals: journals,
+                   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} warnings: #{@warnings}, journals: #{@journals}, 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} warnings: #{@warnings.inspect}, journals: #{@journals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/line_amount_types.rb

@@ -0,0 +1,41 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Line amounts are exclusive of tax by default if you don’t specify this
+  # element. See Line Amount Types
+  class LineAmountTypes
+    LINE_AMOUNT_TYPES = [
+      # TODO: Write general description for EXCLUSIVE
+      EXCLUSIVE = 'Exclusive'.freeze,
+
+      # TODO: Write general description for INCLUSIVE
+      INCLUSIVE = 'Inclusive'.freeze,
+
+      # TODO: Write general description for NOTAX
+      NOTAX = 'NoTax'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LINE_AMOUNT_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXCLUSIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'exclusive' then EXCLUSIVE
+      when 'inclusive' then INCLUSIVE
+      when 'notax' then NOTAX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/line_item.rb

@@ -0,0 +1,287 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # LineItem Model.
+  class LineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # LineItem unique ID
+    # @return [UUID | String]
+    attr_accessor :line_item_id
+
+    # Description needs to be at least 1 char long. A line item with just a
+    # description (i.e no unit amount or quantity) can be created by specifying
+    # just a <Description> element that contains at least 1 character
+    # @return [String]
+    attr_accessor :description
+
+    # LineItem Quantity
+    # @return [Float]
+    attr_accessor :quantity
+
+    # LineItem Unit Amount
+    # @return [Float]
+    attr_accessor :unit_amount
+
+    # See Items
+    # @return [String]
+    attr_accessor :item_code
+
+    # See Accounts
+    # @return [String]
+    attr_accessor :account_code
+
+    # The associated account ID related to this line item
+    # @return [UUID | String]
+    attr_accessor :account_id
+
+    # The tax type from TaxRates
+    # @return [String]
+    attr_accessor :tax_type
+
+    # The tax amount is auto calculated as a percentage of the line amount (see
+    # below) based on the tax rate. This value can be overriden if the
+    # calculated <TaxAmount> is not correct.
+    # @return [Float]
+    attr_accessor :tax_amount
+
+    # The tax amount is auto calculated as a percentage of the line amount (see
+    # below) based on the tax rate. This value can be overriden if the
+    # calculated <TaxAmount> is not correct.
+    # @return [LineItemItem]
+    attr_accessor :item
+
+    # If you wish to omit either the Quantity or UnitAmount you can provide a
+    # LineAmount and Xero will calculate the missing amount for you. The line
+    # amount reflects the discounted price if either a DiscountRate or
+    # DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount *
+    # ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) -
+    # DiscountAmount
+    # @return [Float]
+    attr_accessor :line_amount
+
+    # Optional Tracking Category – see Tracking.  Any LineItem can have a
+    # maximum of 2 <TrackingCategory> elements.
+    # @return [Array[LineItemTracking]]
+    attr_accessor :tracking
+
+    # Percentage discount being applied to a line item (only supported on
+    # ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support
+    # discounts
+    # @return [Float]
+    attr_accessor :discount_rate
+
+    # Discount amount being applied to a line item. Only supported on ACCREC
+    # invoices and quotes. ACCPAY invoices and credit notes in Xero do not
+    # support discounts.
+    # @return [Float]
+    attr_accessor :discount_amount
+
+    # The Xero identifier for a Repeating Invoice
+    # @return [UUID | String]
+    attr_accessor :repeating_invoice_id
+
+    # The type of taxability
+    # @return [Taxability]
+    attr_accessor :taxability
+
+    # The ID of the sales tax code
+    # @return [Float]
+    attr_accessor :sales_tax_code_id
+
+    # An array of tax components defined for this line item
+    # @return [Array[TaxBreakdownComponent]]
+    attr_accessor :tax_breakdown
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_item_id'] = 'LineItemID'
+      @_hash['description'] = 'Description'
+      @_hash['quantity'] = 'Quantity'
+      @_hash['unit_amount'] = 'UnitAmount'
+      @_hash['item_code'] = 'ItemCode'
+      @_hash['account_code'] = 'AccountCode'
+      @_hash['account_id'] = 'AccountID'
+      @_hash['tax_type'] = 'TaxType'
+      @_hash['tax_amount'] = 'TaxAmount'
+      @_hash['item'] = 'Item'
+      @_hash['line_amount'] = 'LineAmount'
+      @_hash['tracking'] = 'Tracking'
+      @_hash['discount_rate'] = 'DiscountRate'
+      @_hash['discount_amount'] = 'DiscountAmount'
+      @_hash['repeating_invoice_id'] = 'RepeatingInvoiceID'
+      @_hash['taxability'] = 'Taxability'
+      @_hash['sales_tax_code_id'] = 'SalesTaxCodeId'
+      @_hash['tax_breakdown'] = 'TaxBreakdown'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line_item_id
+        description
+        quantity
+        unit_amount
+        item_code
+        account_code
+        account_id
+        tax_type
+        tax_amount
+        item
+        line_amount
+        tracking
+        discount_rate
+        discount_amount
+        repeating_invoice_id
+        taxability
+        sales_tax_code_id
+        tax_breakdown
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_item_id: SKIP, description: SKIP, quantity: SKIP,
+                   unit_amount: SKIP, item_code: SKIP, account_code: SKIP,
+                   account_id: SKIP, tax_type: SKIP, tax_amount: SKIP,
+                   item: SKIP, line_amount: SKIP, tracking: SKIP,
+                   discount_rate: SKIP, discount_amount: SKIP,
+                   repeating_invoice_id: SKIP, taxability: SKIP,
+                   sales_tax_code_id: SKIP, tax_breakdown: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line_item_id = line_item_id unless line_item_id == SKIP
+      @description = description unless description == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @unit_amount = unit_amount unless unit_amount == SKIP
+      @item_code = item_code unless item_code == SKIP
+      @account_code = account_code unless account_code == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @tax_type = tax_type unless tax_type == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @item = item unless item == SKIP
+      @line_amount = line_amount unless line_amount == SKIP
+      @tracking = tracking unless tracking == SKIP
+      @discount_rate = discount_rate unless discount_rate == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @repeating_invoice_id = repeating_invoice_id unless repeating_invoice_id == SKIP
+      @taxability = taxability unless taxability == SKIP
+      @sales_tax_code_id = sales_tax_code_id unless sales_tax_code_id == SKIP
+      @tax_breakdown = tax_breakdown unless tax_breakdown == 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.
+      line_item_id = hash.key?('LineItemID') ? hash['LineItemID'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      quantity = hash.key?('Quantity') ? hash['Quantity'] : SKIP
+      unit_amount = hash.key?('UnitAmount') ? hash['UnitAmount'] : SKIP
+      item_code = hash.key?('ItemCode') ? hash['ItemCode'] : SKIP
+      account_code = hash.key?('AccountCode') ? hash['AccountCode'] : SKIP
+      account_id = hash.key?('AccountID') ? hash['AccountID'] : SKIP
+      tax_type = hash.key?('TaxType') ? hash['TaxType'] : SKIP
+      tax_amount = hash.key?('TaxAmount') ? hash['TaxAmount'] : SKIP
+      item = LineItemItem.from_hash(hash['Item']) if hash['Item']
+      line_amount = hash.key?('LineAmount') ? hash['LineAmount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tracking = nil
+      unless hash['Tracking'].nil?
+        tracking = []
+        hash['Tracking'].each do |structure|
+          tracking << (LineItemTracking.from_hash(structure) if structure)
+        end
+      end
+
+      tracking = SKIP unless hash.key?('Tracking')
+      discount_rate = hash.key?('DiscountRate') ? hash['DiscountRate'] : SKIP
+      discount_amount =
+        hash.key?('DiscountAmount') ? hash['DiscountAmount'] : SKIP
+      repeating_invoice_id =
+        hash.key?('RepeatingInvoiceID') ? hash['RepeatingInvoiceID'] : SKIP
+      taxability = hash.key?('Taxability') ? hash['Taxability'] : SKIP
+      sales_tax_code_id =
+        hash.key?('SalesTaxCodeId') ? hash['SalesTaxCodeId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      tax_breakdown = nil
+      unless hash['TaxBreakdown'].nil?
+        tax_breakdown = []
+        hash['TaxBreakdown'].each do |structure|
+          tax_breakdown << (TaxBreakdownComponent.from_hash(structure) if structure)
+        end
+      end
+
+      tax_breakdown = SKIP unless hash.key?('TaxBreakdown')
+
+      # 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.
+      LineItem.new(line_item_id: line_item_id,
+                   description: description,
+                   quantity: quantity,
+                   unit_amount: unit_amount,
+                   item_code: item_code,
+                   account_code: account_code,
+                   account_id: account_id,
+                   tax_type: tax_type,
+                   tax_amount: tax_amount,
+                   item: item,
+                   line_amount: line_amount,
+                   tracking: tracking,
+                   discount_rate: discount_rate,
+                   discount_amount: discount_amount,
+                   repeating_invoice_id: repeating_invoice_id,
+                   taxability: taxability,
+                   sales_tax_code_id: sales_tax_code_id,
+                   tax_breakdown: tax_breakdown,
+                   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} line_item_id: #{@line_item_id}, description: #{@description}, quantity:"\
+      " #{@quantity}, unit_amount: #{@unit_amount}, item_code: #{@item_code}, account_code:"\
+      " #{@account_code}, account_id: #{@account_id}, tax_type: #{@tax_type}, tax_amount:"\
+      " #{@tax_amount}, item: #{@item}, line_amount: #{@line_amount}, tracking: #{@tracking},"\
+      " discount_rate: #{@discount_rate}, discount_amount: #{@discount_amount},"\
+      " repeating_invoice_id: #{@repeating_invoice_id}, taxability: #{@taxability},"\
+      " sales_tax_code_id: #{@sales_tax_code_id}, tax_breakdown: #{@tax_breakdown},"\
+      " 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} line_item_id: #{@line_item_id.inspect}, description:"\
+      " #{@description.inspect}, quantity: #{@quantity.inspect}, unit_amount:"\
+      " #{@unit_amount.inspect}, item_code: #{@item_code.inspect}, account_code:"\
+      " #{@account_code.inspect}, account_id: #{@account_id.inspect}, tax_type:"\
+      " #{@tax_type.inspect}, tax_amount: #{@tax_amount.inspect}, item: #{@item.inspect},"\
+      " line_amount: #{@line_amount.inspect}, tracking: #{@tracking.inspect}, discount_rate:"\
+      " #{@discount_rate.inspect}, discount_amount: #{@discount_amount.inspect},"\
+      " repeating_invoice_id: #{@repeating_invoice_id.inspect}, taxability:"\
+      " #{@taxability.inspect}, sales_tax_code_id: #{@sales_tax_code_id.inspect}, tax_breakdown:"\
+      " #{@tax_breakdown.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end