xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/balances.rb

@@ -0,0 +1,89 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The raw AccountsReceivable(sales invoices) and AccountsPayable(bills)
+  # outstanding and overdue amounts, not converted to base currency (read only)
+  class Balances < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountsReceivable]
+    attr_accessor :accounts_receivable
+
+    # TODO: Write general description for this method
+    # @return [AccountsPayable]
+    attr_accessor :accounts_payable
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accounts_receivable'] = 'AccountsReceivable'
+      @_hash['accounts_payable'] = 'AccountsPayable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accounts_receivable
+        accounts_payable
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accounts_receivable: SKIP, accounts_payable: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts_receivable = accounts_receivable unless accounts_receivable == SKIP
+      @accounts_payable = accounts_payable unless accounts_payable == 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.
+      accounts_receivable = AccountsReceivable.from_hash(hash['AccountsReceivable']) if
+        hash['AccountsReceivable']
+      accounts_payable = AccountsPayable.from_hash(hash['AccountsPayable']) if
+        hash['AccountsPayable']
+
+      # 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.
+      Balances.new(accounts_receivable: accounts_receivable,
+                   accounts_payable: accounts_payable,
+                   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} accounts_receivable: #{@accounts_receivable}, accounts_payable:"\
+      " #{@accounts_payable}, 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} accounts_receivable: #{@accounts_receivable.inspect}, accounts_payable:"\
+      " #{@accounts_payable.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/bank_account_type.rb

@@ -0,0 +1,44 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # For bank accounts only. See Bank Account types
+  class BankAccountType
+    BANK_ACCOUNT_TYPE = [
+      # TODO: Write general description for BANK
+      BANK = 'BANK'.freeze,
+
+      # TODO: Write general description for CREDITCARD
+      CREDITCARD = 'CREDITCARD'.freeze,
+
+      # TODO: Write general description for PAYPAL
+      PAYPAL = 'PAYPAL'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_ACCOUNT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = BANK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bank' then BANK
+      when 'creditcard' then CREDITCARD
+      when 'paypal' then PAYPAL
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/bank_transaction.rb

@@ -0,0 +1,319 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # BankTransaction Model.
+  class BankTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # See Bank Transaction Types
+    # @return [Type]
+    attr_accessor :type
+
+    # See Bank Transaction Types
+    # @return [Contact]
+    attr_accessor :contact
+
+    # See LineItems
+    # @return [Array[LineItem]]
+    attr_accessor :line_items
+
+    # See LineItems
+    # @return [Account]
+    attr_accessor :bank_account
+
+    # Boolean to show if transaction is reconciled
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_reconciled
+
+    # Date of transaction – YYYY-MM-DD
+    # @return [String]
+    attr_accessor :date
+
+    # Reference for the transaction. Only supported for SPEND and RECEIVE
+    # transactions.
+    # @return [String]
+    attr_accessor :reference
+
+    # 3 letter alpha code for the currency – see list of currency codes
+    # @return [CurrencyCode]
+    attr_accessor :currency_code
+
+    # Exchange rate to base currency when money is spent or received. e.g.0.7500
+    # Only used for bank transactions in non base currency. If this isn’t
+    # specified for non base currency accounts then either the user-defined rate
+    # (preference) or the XE.com day rate will be used. Setting currency is only
+    # supported on overpayments.
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # URL link to a source document – shown as “Go to App Name”
+    # @return [String]
+    attr_accessor :url
+
+    # See Bank Transaction Status Codes
+    # @return [Status2]
+    attr_accessor :status
+
+    # Line amounts are exclusive of tax by default if you don’t specify this
+    # element. See Line Amount Types
+    # @return [LineAmountTypes]
+    attr_accessor :line_amount_types
+
+    # Total of bank transaction excluding taxes
+    # @return [Float]
+    attr_accessor :sub_total
+
+    # Total tax on bank transaction
+    # @return [Float]
+    attr_accessor :total_tax
+
+    # Total of bank transaction tax inclusive
+    # @return [Float]
+    attr_accessor :total
+
+    # Xero generated unique identifier for bank transaction
+    # @return [UUID | String]
+    attr_accessor :bank_transaction_id
+
+    # Xero generated unique identifier for a Prepayment. This will be returned
+    # on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
+    # @return [UUID | String]
+    attr_accessor :prepayment_id
+
+    # Xero generated unique identifier for an Overpayment. This will be returned
+    # on BankTransactions with a Type of SPEND-OVERPAYMENT or
+    # RECEIVE-OVERPAYMENT
+    # @return [UUID | String]
+    attr_accessor :overpayment_id
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # Boolean to indicate if a bank transaction has an attachment
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # A string to indicate if a invoice status
+    # @return [String]
+    attr_accessor :status_attribute_string
+
+    # Displays array of validation error messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :validation_errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'Type'
+      @_hash['contact'] = 'Contact'
+      @_hash['line_items'] = 'LineItems'
+      @_hash['bank_account'] = 'BankAccount'
+      @_hash['is_reconciled'] = 'IsReconciled'
+      @_hash['date'] = 'Date'
+      @_hash['reference'] = 'Reference'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_rate'] = 'CurrencyRate'
+      @_hash['url'] = 'Url'
+      @_hash['status'] = 'Status'
+      @_hash['line_amount_types'] = 'LineAmountTypes'
+      @_hash['sub_total'] = 'SubTotal'
+      @_hash['total_tax'] = 'TotalTax'
+      @_hash['total'] = 'Total'
+      @_hash['bank_transaction_id'] = 'BankTransactionID'
+      @_hash['prepayment_id'] = 'PrepaymentID'
+      @_hash['overpayment_id'] = 'OverpaymentID'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact
+        is_reconciled
+        date
+        reference
+        currency_code
+        currency_rate
+        url
+        status
+        line_amount_types
+        sub_total
+        total_tax
+        total
+        bank_transaction_id
+        prepayment_id
+        overpayment_id
+        updated_date_utc
+        has_attachments
+        status_attribute_string
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, line_items:, bank_account:, contact: SKIP,
+                   is_reconciled: SKIP, date: SKIP, reference: SKIP,
+                   currency_code: SKIP, currency_rate: SKIP, url: SKIP,
+                   status: SKIP, line_amount_types: SKIP, sub_total: SKIP,
+                   total_tax: SKIP, total: SKIP, bank_transaction_id: SKIP,
+                   prepayment_id: SKIP, overpayment_id: SKIP,
+                   updated_date_utc: SKIP, has_attachments: false,
+                   status_attribute_string: SKIP, validation_errors: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @contact = contact unless contact == SKIP
+      @line_items = line_items
+      @bank_account = bank_account
+      @is_reconciled = is_reconciled unless is_reconciled == SKIP
+      @date = date unless date == SKIP
+      @reference = reference unless reference == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_rate = currency_rate unless currency_rate == SKIP
+      @url = url unless url == SKIP
+      @status = status unless status == SKIP
+      @line_amount_types = line_amount_types unless line_amount_types == SKIP
+      @sub_total = sub_total unless sub_total == SKIP
+      @total_tax = total_tax unless total_tax == SKIP
+      @total = total unless total == SKIP
+      @bank_transaction_id = bank_transaction_id unless bank_transaction_id == SKIP
+      @prepayment_id = prepayment_id unless prepayment_id == SKIP
+      @overpayment_id = overpayment_id unless overpayment_id == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @status_attribute_string = status_attribute_string unless status_attribute_string == SKIP
+      @validation_errors = validation_errors unless validation_errors == 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.
+      type = hash.key?('Type') ? hash['Type'] : nil
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['LineItems'].nil?
+        line_items = []
+        hash['LineItems'].each do |structure|
+          line_items << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('LineItems')
+      bank_account = Account.from_hash(hash['BankAccount']) if hash['BankAccount']
+      contact = Contact.from_hash(hash['Contact']) if hash['Contact']
+      is_reconciled = hash.key?('IsReconciled') ? hash['IsReconciled'] : SKIP
+      date = hash.key?('Date') ? hash['Date'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_rate = hash.key?('CurrencyRate') ? hash['CurrencyRate'] : SKIP
+      url = hash.key?('Url') ? hash['Url'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      line_amount_types =
+        hash.key?('LineAmountTypes') ? hash['LineAmountTypes'] : SKIP
+      sub_total = hash.key?('SubTotal') ? hash['SubTotal'] : SKIP
+      total_tax = hash.key?('TotalTax') ? hash['TotalTax'] : SKIP
+      total = hash.key?('Total') ? hash['Total'] : SKIP
+      bank_transaction_id =
+        hash.key?('BankTransactionID') ? hash['BankTransactionID'] : SKIP
+      prepayment_id = hash.key?('PrepaymentID') ? hash['PrepaymentID'] : SKIP
+      overpayment_id = hash.key?('OverpaymentID') ? hash['OverpaymentID'] : SKIP
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      has_attachments = hash['HasAttachments'] ||= false
+      status_attribute_string =
+        hash.key?('StatusAttributeString') ? hash['StatusAttributeString'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      validation_errors = nil
+      unless hash['ValidationErrors'].nil?
+        validation_errors = []
+        hash['ValidationErrors'].each do |structure|
+          validation_errors << (ValidationError.from_hash(structure) if structure)
+        end
+      end
+
+      validation_errors = SKIP unless hash.key?('ValidationErrors')
+
+      # 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.
+      BankTransaction.new(type: type,
+                          line_items: line_items,
+                          bank_account: bank_account,
+                          contact: contact,
+                          is_reconciled: is_reconciled,
+                          date: date,
+                          reference: reference,
+                          currency_code: currency_code,
+                          currency_rate: currency_rate,
+                          url: url,
+                          status: status,
+                          line_amount_types: line_amount_types,
+                          sub_total: sub_total,
+                          total_tax: total_tax,
+                          total: total,
+                          bank_transaction_id: bank_transaction_id,
+                          prepayment_id: prepayment_id,
+                          overpayment_id: overpayment_id,
+                          updated_date_utc: updated_date_utc,
+                          has_attachments: has_attachments,
+                          status_attribute_string: status_attribute_string,
+                          validation_errors: validation_errors,
+                          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} type: #{@type}, contact: #{@contact}, line_items: #{@line_items},"\
+      " bank_account: #{@bank_account}, is_reconciled: #{@is_reconciled}, date: #{@date},"\
+      " reference: #{@reference}, currency_code: #{@currency_code}, currency_rate:"\
+      " #{@currency_rate}, url: #{@url}, status: #{@status}, line_amount_types:"\
+      " #{@line_amount_types}, sub_total: #{@sub_total}, total_tax: #{@total_tax}, total:"\
+      " #{@total}, bank_transaction_id: #{@bank_transaction_id}, prepayment_id: #{@prepayment_id},"\
+      " overpayment_id: #{@overpayment_id}, updated_date_utc: #{@updated_date_utc},"\
+      " has_attachments: #{@has_attachments}, status_attribute_string:"\
+      " #{@status_attribute_string}, validation_errors: #{@validation_errors},"\
+      " 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} type: #{@type.inspect}, contact: #{@contact.inspect}, line_items:"\
+      " #{@line_items.inspect}, bank_account: #{@bank_account.inspect}, is_reconciled:"\
+      " #{@is_reconciled.inspect}, date: #{@date.inspect}, reference: #{@reference.inspect},"\
+      " currency_code: #{@currency_code.inspect}, currency_rate: #{@currency_rate.inspect}, url:"\
+      " #{@url.inspect}, status: #{@status.inspect}, line_amount_types:"\
+      " #{@line_amount_types.inspect}, sub_total: #{@sub_total.inspect}, total_tax:"\
+      " #{@total_tax.inspect}, total: #{@total.inspect}, bank_transaction_id:"\
+      " #{@bank_transaction_id.inspect}, prepayment_id: #{@prepayment_id.inspect}, overpayment_id:"\
+      " #{@overpayment_id.inspect}, updated_date_utc: #{@updated_date_utc.inspect},"\
+      " has_attachments: #{@has_attachments.inspect}, status_attribute_string:"\
+      " #{@status_attribute_string.inspect}, validation_errors: #{@validation_errors.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/bank_transactions.rb

@@ -0,0 +1,114 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # BankTransactions Model.
+  class BankTransactions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Pagination]
+    attr_accessor :pagination
+
+    # Displays array of warning messages from the API
+    # @return [Array[ValidationError]]
+    attr_accessor :warnings
+
+    # Displays array of warning messages from the API
+    # @return [Array[BankTransaction]]
+    attr_accessor :bank_transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pagination'] = 'pagination'
+      @_hash['warnings'] = 'Warnings'
+      @_hash['bank_transactions'] = 'BankTransactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pagination
+        warnings
+        bank_transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pagination: SKIP, warnings: SKIP, bank_transactions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @pagination = pagination unless pagination == SKIP
+      @warnings = warnings unless warnings == SKIP
+      @bank_transactions = bank_transactions unless bank_transactions == 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.
+      pagination = Pagination.from_hash(hash['pagination']) if hash['pagination']
+      # 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
+      bank_transactions = nil
+      unless hash['BankTransactions'].nil?
+        bank_transactions = []
+        hash['BankTransactions'].each do |structure|
+          bank_transactions << (BankTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      bank_transactions = SKIP unless hash.key?('BankTransactions')
+
+      # 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.
+      BankTransactions.new(pagination: pagination,
+                           warnings: warnings,
+                           bank_transactions: bank_transactions,
+                           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} pagination: #{@pagination}, warnings: #{@warnings}, bank_transactions:"\
+      " #{@bank_transactions}, 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} pagination: #{@pagination.inspect}, warnings: #{@warnings.inspect},"\
+      " bank_transactions: #{@bank_transactions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end