xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/schedule.rb

@@ -0,0 +1,140 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Schedule Model.
+  class Schedule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
+    # @return [Integer]
+    attr_accessor :period
+
+    # One of the following - WEEKLY or MONTHLY
+    # @return [Unit]
+    attr_accessor :unit
+
+    # Integer used with due date type e.g 20 (of following month), 31 (of
+    # current month)
+    # @return [Integer]
+    attr_accessor :due_date
+
+    # the payment terms
+    # @return [DueDateType]
+    attr_accessor :due_date_type
+
+    # Date the first invoice of the current version of the repeating schedule
+    # was generated (changes when repeating invoice is edited)
+    # @return [String]
+    attr_accessor :start_date
+
+    # The calendar date of the next invoice in the schedule to be generated
+    # @return [String]
+    attr_accessor :next_scheduled_date
+
+    # Invoice end date – only returned if the template has an end date set
+    # @return [String]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['period'] = 'Period'
+      @_hash['unit'] = 'Unit'
+      @_hash['due_date'] = 'DueDate'
+      @_hash['due_date_type'] = 'DueDateType'
+      @_hash['start_date'] = 'StartDate'
+      @_hash['next_scheduled_date'] = 'NextScheduledDate'
+      @_hash['end_date'] = 'EndDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        period
+        unit
+        due_date
+        due_date_type
+        start_date
+        next_scheduled_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(period: SKIP, unit: SKIP, due_date: SKIP,
+                   due_date_type: SKIP, start_date: SKIP,
+                   next_scheduled_date: SKIP, end_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @period = period unless period == SKIP
+      @unit = unit unless unit == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @due_date_type = due_date_type unless due_date_type == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @next_scheduled_date = next_scheduled_date unless next_scheduled_date == SKIP
+      @end_date = end_date unless end_date == 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.
+      period = hash.key?('Period') ? hash['Period'] : SKIP
+      unit = hash.key?('Unit') ? hash['Unit'] : SKIP
+      due_date = hash.key?('DueDate') ? hash['DueDate'] : SKIP
+      due_date_type = hash.key?('DueDateType') ? hash['DueDateType'] : SKIP
+      start_date = hash.key?('StartDate') ? hash['StartDate'] : SKIP
+      next_scheduled_date =
+        hash.key?('NextScheduledDate') ? hash['NextScheduledDate'] : SKIP
+      end_date = hash.key?('EndDate') ? hash['EndDate'] : 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.
+      Schedule.new(period: period,
+                   unit: unit,
+                   due_date: due_date,
+                   due_date_type: due_date_type,
+                   start_date: start_date,
+                   next_scheduled_date: next_scheduled_date,
+                   end_date: end_date,
+                   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} period: #{@period}, unit: #{@unit}, due_date: #{@due_date}, due_date_type:"\
+      " #{@due_date_type}, start_date: #{@start_date}, next_scheduled_date:"\
+      " #{@next_scheduled_date}, end_date: #{@end_date}, 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} period: #{@period.inspect}, unit: #{@unit.inspect}, due_date:"\
+      " #{@due_date.inspect}, due_date_type: #{@due_date_type.inspect}, start_date:"\
+      " #{@start_date.inspect}, next_scheduled_date: #{@next_scheduled_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/setting.rb

@@ -0,0 +1,175 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Setting Model.
+  class Setting < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The prefix used for fixed asset numbers (“FA-” by default)
+    # @return [String]
+    attr_accessor :asset_number_prefix
+
+    # The next available sequence number
+    # @return [String]
+    attr_accessor :asset_number_sequence
+
+    # The date depreciation calculations started on registered fixed assets in
+    # Xero
+    # @return [Date]
+    attr_accessor :asset_start_date
+
+    # The last depreciation date
+    # @return [Date]
+    attr_accessor :last_depreciation_date
+
+    # Default account that gains are posted to
+    # @return [UUID | String]
+    attr_accessor :default_gain_on_disposal_account_id
+
+    # Default account that losses are posted to
+    # @return [UUID | String]
+    attr_accessor :default_loss_on_disposal_account_id
+
+    # Default account that capital gains are posted to
+    # @return [UUID | String]
+    attr_accessor :default_capital_gain_on_disposal_account_id
+
+    # opt in for tax calculation
+    # @return [TrueClass | FalseClass]
+    attr_accessor :opt_in_for_tax
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_number_prefix'] = 'assetNumberPrefix'
+      @_hash['asset_number_sequence'] = 'assetNumberSequence'
+      @_hash['asset_start_date'] = 'assetStartDate'
+      @_hash['last_depreciation_date'] = 'lastDepreciationDate'
+      @_hash['default_gain_on_disposal_account_id'] =
+        'defaultGainOnDisposalAccountId'
+      @_hash['default_loss_on_disposal_account_id'] =
+        'defaultLossOnDisposalAccountId'
+      @_hash['default_capital_gain_on_disposal_account_id'] =
+        'defaultCapitalGainOnDisposalAccountId'
+      @_hash['opt_in_for_tax'] = 'optInForTax'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_number_prefix
+        asset_number_sequence
+        asset_start_date
+        last_depreciation_date
+        default_gain_on_disposal_account_id
+        default_loss_on_disposal_account_id
+        default_capital_gain_on_disposal_account_id
+        opt_in_for_tax
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_number_prefix: SKIP, asset_number_sequence: SKIP,
+                   asset_start_date: SKIP, last_depreciation_date: SKIP,
+                   default_gain_on_disposal_account_id: SKIP,
+                   default_loss_on_disposal_account_id: SKIP,
+                   default_capital_gain_on_disposal_account_id: SKIP,
+                   opt_in_for_tax: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_number_prefix = asset_number_prefix unless asset_number_prefix == SKIP
+      @asset_number_sequence = asset_number_sequence unless asset_number_sequence == SKIP
+      @asset_start_date = asset_start_date unless asset_start_date == SKIP
+      @last_depreciation_date = last_depreciation_date unless last_depreciation_date == SKIP
+      unless default_gain_on_disposal_account_id == SKIP
+        @default_gain_on_disposal_account_id =
+          default_gain_on_disposal_account_id
+      end
+      unless default_loss_on_disposal_account_id == SKIP
+        @default_loss_on_disposal_account_id =
+          default_loss_on_disposal_account_id
+      end
+      unless default_capital_gain_on_disposal_account_id == SKIP
+        @default_capital_gain_on_disposal_account_id =
+          default_capital_gain_on_disposal_account_id
+      end
+      @opt_in_for_tax = opt_in_for_tax unless opt_in_for_tax == 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.
+      asset_number_prefix =
+        hash.key?('assetNumberPrefix') ? hash['assetNumberPrefix'] : SKIP
+      asset_number_sequence =
+        hash.key?('assetNumberSequence') ? hash['assetNumberSequence'] : SKIP
+      asset_start_date =
+        hash.key?('assetStartDate') ? hash['assetStartDate'] : SKIP
+      last_depreciation_date =
+        hash.key?('lastDepreciationDate') ? hash['lastDepreciationDate'] : SKIP
+      default_gain_on_disposal_account_id =
+        hash.key?('defaultGainOnDisposalAccountId') ? hash['defaultGainOnDisposalAccountId'] : SKIP
+      default_loss_on_disposal_account_id =
+        hash.key?('defaultLossOnDisposalAccountId') ? hash['defaultLossOnDisposalAccountId'] : SKIP
+      default_capital_gain_on_disposal_account_id =
+        hash.key?('defaultCapitalGainOnDisposalAccountId') ? hash['defaultCapitalGainOnDisposalAccountId'] : SKIP
+      opt_in_for_tax = hash.key?('optInForTax') ? hash['optInForTax'] : 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.
+      Setting.new(asset_number_prefix: asset_number_prefix,
+                  asset_number_sequence: asset_number_sequence,
+                  asset_start_date: asset_start_date,
+                  last_depreciation_date: last_depreciation_date,
+                  default_gain_on_disposal_account_id: default_gain_on_disposal_account_id,
+                  default_loss_on_disposal_account_id: default_loss_on_disposal_account_id,
+                  default_capital_gain_on_disposal_account_id: default_capital_gain_on_disposal_account_id,
+                  opt_in_for_tax: opt_in_for_tax,
+                  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} asset_number_prefix: #{@asset_number_prefix}, asset_number_sequence:"\
+      " #{@asset_number_sequence}, asset_start_date: #{@asset_start_date}, last_depreciation_date:"\
+      " #{@last_depreciation_date}, default_gain_on_disposal_account_id:"\
+      " #{@default_gain_on_disposal_account_id}, default_loss_on_disposal_account_id:"\
+      " #{@default_loss_on_disposal_account_id}, default_capital_gain_on_disposal_account_id:"\
+      " #{@default_capital_gain_on_disposal_account_id}, opt_in_for_tax: #{@opt_in_for_tax},"\
+      " 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} asset_number_prefix: #{@asset_number_prefix.inspect},"\
+      " asset_number_sequence: #{@asset_number_sequence.inspect}, asset_start_date:"\
+      " #{@asset_start_date.inspect}, last_depreciation_date: #{@last_depreciation_date.inspect},"\
+      " default_gain_on_disposal_account_id: #{@default_gain_on_disposal_account_id.inspect},"\
+      " default_loss_on_disposal_account_id: #{@default_loss_on_disposal_account_id.inspect},"\
+      ' default_capital_gain_on_disposal_account_id:'\
+      " #{@default_capital_gain_on_disposal_account_id.inspect}, opt_in_for_tax:"\
+      " #{@opt_in_for_tax.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/setup.rb

@@ -0,0 +1,117 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Setup Model.
+  class Setup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date when the organisation starts using Xero
+    # @return [ConversionDate]
+    attr_accessor :conversion_date
+
+    # Balance supplied for each account that has a value as at the conversion
+    # date.
+    # @return [Array[ConversionBalances]]
+    attr_accessor :conversion_balances
+
+    # Balance supplied for each account that has a value as at the conversion
+    # date.
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['conversion_date'] = 'ConversionDate'
+      @_hash['conversion_balances'] = 'ConversionBalances'
+      @_hash['accounts'] = 'Accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        conversion_date
+        conversion_balances
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(conversion_date: SKIP, conversion_balances: SKIP,
+                   accounts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @conversion_date = conversion_date unless conversion_date == SKIP
+      @conversion_balances = conversion_balances unless conversion_balances == SKIP
+      @accounts = accounts unless accounts == 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.
+      conversion_date = ConversionDate.from_hash(hash['ConversionDate']) if hash['ConversionDate']
+      # Parameter is an array, so we need to iterate through it
+      conversion_balances = nil
+      unless hash['ConversionBalances'].nil?
+        conversion_balances = []
+        hash['ConversionBalances'].each do |structure|
+          conversion_balances << (ConversionBalances.from_hash(structure) if structure)
+        end
+      end
+
+      conversion_balances = SKIP unless hash.key?('ConversionBalances')
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['Accounts'].nil?
+        accounts = []
+        hash['Accounts'].each do |structure|
+          accounts << (Account.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('Accounts')
+
+      # 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.
+      Setup.new(conversion_date: conversion_date,
+                conversion_balances: conversion_balances,
+                accounts: accounts,
+                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} conversion_date: #{@conversion_date}, conversion_balances:"\
+      " #{@conversion_balances}, accounts: #{@accounts}, 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} conversion_date: #{@conversion_date.inspect}, conversion_balances:"\
+      " #{@conversion_balances.inspect}, accounts: #{@accounts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/sort_direction.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # sortDirection.
+  class SortDirection
+    SORT_DIRECTION = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SORT_DIRECTION.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asc' then ASC
+      when 'desc' then DESC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/source_transaction_type_code.rb

@@ -0,0 +1,38 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The Type of the source tranasction. This will be ACCPAY if the linked
+  # transaction was created from an invoice and SPEND if it was created from a
+  # bank transaction.
+  class SourceTransactionTypeCode
+    SOURCE_TRANSACTION_TYPE_CODE = [
+      # TODO: Write general description for ACCPAY
+      ACCPAY = 'ACCPAY'.freeze,
+
+      # TODO: Write general description for SPEND
+      SPEND = 'SPEND'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SOURCE_TRANSACTION_TYPE_CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCPAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accpay' then ACCPAY
+      when 'spend' then SPEND
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/source_type.rb

@@ -0,0 +1,128 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The journal source type. The type of transaction that created the journal
+  class SourceType
+    SOURCE_TYPE = [
+      # TODO: Write general description for ACCREC
+      ACCREC = 'ACCREC'.freeze,
+
+      # TODO: Write general description for ACCPAY
+      ACCPAY = 'ACCPAY'.freeze,
+
+      # TODO: Write general description for ACCRECCREDIT
+      ACCRECCREDIT = 'ACCRECCREDIT'.freeze,
+
+      # TODO: Write general description for ACCPAYCREDIT
+      ACCPAYCREDIT = 'ACCPAYCREDIT'.freeze,
+
+      # TODO: Write general description for ACCRECPAYMENT
+      ACCRECPAYMENT = 'ACCRECPAYMENT'.freeze,
+
+      # TODO: Write general description for ACCPAYPAYMENT
+      ACCPAYPAYMENT = 'ACCPAYPAYMENT'.freeze,
+
+      # TODO: Write general description for ARCREDITPAYMENT
+      ARCREDITPAYMENT = 'ARCREDITPAYMENT'.freeze,
+
+      # TODO: Write general description for APCREDITPAYMENT
+      APCREDITPAYMENT = 'APCREDITPAYMENT'.freeze,
+
+      # TODO: Write general description for CASHREC
+      CASHREC = 'CASHREC'.freeze,
+
+      # TODO: Write general description for CASHPAID
+      CASHPAID = 'CASHPAID'.freeze,
+
+      # TODO: Write general description for TRANSFER
+      TRANSFER = 'TRANSFER'.freeze,
+
+      # TODO: Write general description for ARPREPAYMENT
+      ARPREPAYMENT = 'ARPREPAYMENT'.freeze,
+
+      # TODO: Write general description for APPREPAYMENT
+      APPREPAYMENT = 'APPREPAYMENT'.freeze,
+
+      # TODO: Write general description for AROVERPAYMENT
+      AROVERPAYMENT = 'AROVERPAYMENT'.freeze,
+
+      # TODO: Write general description for APOVERPAYMENT
+      APOVERPAYMENT = 'APOVERPAYMENT'.freeze,
+
+      # TODO: Write general description for EXPCLAIM
+      EXPCLAIM = 'EXPCLAIM'.freeze,
+
+      # TODO: Write general description for EXPPAYMENT
+      EXPPAYMENT = 'EXPPAYMENT'.freeze,
+
+      # TODO: Write general description for MANJOURNAL
+      MANJOURNAL = 'MANJOURNAL'.freeze,
+
+      # TODO: Write general description for PAYSLIP
+      PAYSLIP = 'PAYSLIP'.freeze,
+
+      # TODO: Write general description for WAGEPAYABLE
+      WAGEPAYABLE = 'WAGEPAYABLE'.freeze,
+
+      # TODO: Write general description for INTEGRATEDPAYROLLPE
+      INTEGRATEDPAYROLLPE = 'INTEGRATEDPAYROLLPE'.freeze,
+
+      # TODO: Write general description for INTEGRATEDPAYROLLPT
+      INTEGRATEDPAYROLLPT = 'INTEGRATEDPAYROLLPT'.freeze,
+
+      # TODO: Write general description for EXTERNALSPENDMONEY
+      EXTERNALSPENDMONEY = 'EXTERNALSPENDMONEY'.freeze,
+
+      # TODO: Write general description for INTEGRATEDPAYROLLPTPAYMENT
+      INTEGRATEDPAYROLLPTPAYMENT = 'INTEGRATEDPAYROLLPTPAYMENT'.freeze,
+
+      # TODO: Write general description for INTEGRATEDPAYROLLCN
+      INTEGRATEDPAYROLLCN = 'INTEGRATEDPAYROLLCN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SOURCE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCREC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accrec' then ACCREC
+      when 'accpay' then ACCPAY
+      when 'accreccredit' then ACCRECCREDIT
+      when 'accpaycredit' then ACCPAYCREDIT
+      when 'accrecpayment' then ACCRECPAYMENT
+      when 'accpaypayment' then ACCPAYPAYMENT
+      when 'arcreditpayment' then ARCREDITPAYMENT
+      when 'apcreditpayment' then APCREDITPAYMENT
+      when 'cashrec' then CASHREC
+      when 'cashpaid' then CASHPAID
+      when 'transfer' then TRANSFER
+      when 'arprepayment' then ARPREPAYMENT
+      when 'apprepayment' then APPREPAYMENT
+      when 'aroverpayment' then AROVERPAYMENT
+      when 'apoverpayment' then APOVERPAYMENT
+      when 'expclaim' then EXPCLAIM
+      when 'exppayment' then EXPPAYMENT
+      when 'manjournal' then MANJOURNAL
+      when 'payslip' then PAYSLIP
+      when 'wagepayable' then WAGEPAYABLE
+      when 'integratedpayrollpe' then INTEGRATEDPAYROLLPE
+      when 'integratedpayrollpt' then INTEGRATEDPAYROLLPT
+      when 'externalspendmoney' then EXTERNALSPENDMONEY
+      when 'integratedpayrollptpayment' then INTEGRATEDPAYROLLPTPAYMENT
+      when 'integratedpayrollcn' then INTEGRATEDPAYROLLCN
+      else
+        default_value
+      end
+    end
+  end
+end