xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/xero_ap_is/models/access_token.rb

@@ -0,0 +1,116 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # AccessToken Model.
+  class AccessToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero unique identifier
+    # @return [String]
+    attr_accessor :id_token
+
+    # access token provided during authentication flow
+    # @return [String]
+    attr_accessor :access_token
+
+    # time in seconds until access token expires.
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # type of token i.e. Bearer
+    # @return [String]
+    attr_accessor :token_type
+
+    # token used to refresh an expired access token
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id_token'] = 'id_token'
+      @_hash['access_token'] = 'access_token'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['token_type'] = 'token_type'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id_token
+        access_token
+        expires_in
+        token_type
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id_token: SKIP, access_token: SKIP, expires_in: SKIP,
+                   token_type: SKIP, refresh_token: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id_token = id_token unless id_token == SKIP
+      @access_token = access_token unless access_token == SKIP
+      @expires_in = expires_in unless expires_in == SKIP
+      @token_type = token_type unless token_type == SKIP
+      @refresh_token = refresh_token unless refresh_token == 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.
+      id_token = hash.key?('id_token') ? hash['id_token'] : SKIP
+      access_token = hash.key?('access_token') ? hash['access_token'] : SKIP
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      token_type = hash.key?('token_type') ? hash['token_type'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : 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.
+      AccessToken.new(id_token: id_token,
+                      access_token: access_token,
+                      expires_in: expires_in,
+                      token_type: token_type,
+                      refresh_token: refresh_token,
+                      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} id_token: #{@id_token}, access_token: #{@access_token}, expires_in:"\
+      " #{@expires_in}, token_type: #{@token_type}, refresh_token: #{@refresh_token},"\
+      " 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} id_token: #{@id_token.inspect}, access_token: #{@access_token.inspect},"\
+      " expires_in: #{@expires_in.inspect}, token_type: #{@token_type.inspect}, refresh_token:"\
+      " #{@refresh_token.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/account.rb

@@ -0,0 +1,300 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Account Model.
+  class Account < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customer defined alpha numeric account code e.g 200 or SALES (max length =
+    # 10)
+    # @return [String]
+    attr_accessor :code
+
+    # Name of account (max length = 150)
+    # @return [String]
+    attr_accessor :name
+
+    # The Xero identifier for an account – specified as a string following  the
+    # endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
+    # @return [UUID | String]
+    attr_accessor :account_id
+
+    # See Account Types
+    # @return [AccountType]
+    attr_accessor :type
+
+    # For bank accounts only (Account Type BANK)
+    # @return [String]
+    attr_accessor :bank_account_number
+
+    # Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account
+    # Status Codes
+    # @return [Status]
+    attr_accessor :status
+
+    # Description of the Account. Valid for all types of accounts except bank
+    # accounts (max length = 4000)
+    # @return [String]
+    attr_accessor :description
+
+    # For bank accounts only. See Bank Account types
+    # @return [BankAccountType]
+    attr_accessor :bank_account_type
+
+    # 3 letter alpha code for the currency – see list of currency codes
+    # @return [CurrencyCode]
+    attr_accessor :currency_code
+
+    # The tax type from taxRates
+    # @return [String]
+    attr_accessor :tax_type
+
+    # Boolean – describes whether account can have payments applied to it
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_payments_to_account
+
+    # Boolean – describes whether account code is available for use with expense
+    # claims
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_in_expense_claims
+
+    # See Account Class Types
+    # @return [Class]
+    attr_accessor :mclass
+
+    # If this is a system account then this element is returned. See System
+    # Account types. Note that non-system accounts may have this element set as
+    # either “” or null.
+    # @return [SystemAccount]
+    attr_accessor :system_account
+
+    # Shown if set
+    # @return [String]
+    attr_accessor :reporting_code
+
+    # Shown if set
+    # @return [String]
+    attr_accessor :reporting_code_name
+
+    # boolean to indicate if an account has an attachment (read only)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_attachments
+
+    # Last modified date UTC format
+    # @return [String]
+    attr_accessor :updated_date_utc
+
+    # Boolean – describes whether the account is shown in the watchlist widget
+    # on the dashboard
+    # @return [TrueClass | FalseClass]
+    attr_accessor :add_to_watchlist
+
+    # 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['code'] = 'Code'
+      @_hash['name'] = 'Name'
+      @_hash['account_id'] = 'AccountID'
+      @_hash['type'] = 'Type'
+      @_hash['bank_account_number'] = 'BankAccountNumber'
+      @_hash['status'] = 'Status'
+      @_hash['description'] = 'Description'
+      @_hash['bank_account_type'] = 'BankAccountType'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['tax_type'] = 'TaxType'
+      @_hash['enable_payments_to_account'] = 'EnablePaymentsToAccount'
+      @_hash['show_in_expense_claims'] = 'ShowInExpenseClaims'
+      @_hash['mclass'] = 'Class'
+      @_hash['system_account'] = 'SystemAccount'
+      @_hash['reporting_code'] = 'ReportingCode'
+      @_hash['reporting_code_name'] = 'ReportingCodeName'
+      @_hash['has_attachments'] = 'HasAttachments'
+      @_hash['updated_date_utc'] = 'UpdatedDateUTC'
+      @_hash['add_to_watchlist'] = 'AddToWatchlist'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        name
+        account_id
+        type
+        bank_account_number
+        status
+        description
+        bank_account_type
+        currency_code
+        tax_type
+        enable_payments_to_account
+        show_in_expense_claims
+        mclass
+        system_account
+        reporting_code
+        reporting_code_name
+        has_attachments
+        updated_date_utc
+        add_to_watchlist
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, name: SKIP, account_id: SKIP, type: SKIP,
+                   bank_account_number: SKIP, status: SKIP, description: SKIP,
+                   bank_account_type: SKIP, currency_code: SKIP, tax_type: SKIP,
+                   enable_payments_to_account: SKIP,
+                   show_in_expense_claims: SKIP, mclass: SKIP,
+                   system_account: SKIP, reporting_code: SKIP,
+                   reporting_code_name: SKIP, has_attachments: false,
+                   updated_date_utc: SKIP, add_to_watchlist: SKIP,
+                   validation_errors: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @name = name unless name == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @type = type unless type == SKIP
+      @bank_account_number = bank_account_number unless bank_account_number == SKIP
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @bank_account_type = bank_account_type unless bank_account_type == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @tax_type = tax_type unless tax_type == SKIP
+      unless enable_payments_to_account == SKIP
+        @enable_payments_to_account =
+          enable_payments_to_account
+      end
+      @show_in_expense_claims = show_in_expense_claims unless show_in_expense_claims == SKIP
+      @mclass = mclass unless mclass == SKIP
+      @system_account = system_account unless system_account == SKIP
+      @reporting_code = reporting_code unless reporting_code == SKIP
+      @reporting_code_name = reporting_code_name unless reporting_code_name == SKIP
+      @has_attachments = has_attachments unless has_attachments == SKIP
+      @updated_date_utc = updated_date_utc unless updated_date_utc == SKIP
+      @add_to_watchlist = add_to_watchlist unless add_to_watchlist == 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.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      account_id = hash.key?('AccountID') ? hash['AccountID'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      bank_account_number =
+        hash.key?('BankAccountNumber') ? hash['BankAccountNumber'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      bank_account_type =
+        hash.key?('BankAccountType') ? hash['BankAccountType'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      tax_type = hash.key?('TaxType') ? hash['TaxType'] : SKIP
+      enable_payments_to_account =
+        hash.key?('EnablePaymentsToAccount') ? hash['EnablePaymentsToAccount'] : SKIP
+      show_in_expense_claims =
+        hash.key?('ShowInExpenseClaims') ? hash['ShowInExpenseClaims'] : SKIP
+      mclass = hash.key?('Class') ? hash['Class'] : SKIP
+      system_account = hash.key?('SystemAccount') ? hash['SystemAccount'] : SKIP
+      reporting_code = hash.key?('ReportingCode') ? hash['ReportingCode'] : SKIP
+      reporting_code_name =
+        hash.key?('ReportingCodeName') ? hash['ReportingCodeName'] : SKIP
+      has_attachments = hash['HasAttachments'] ||= false
+      updated_date_utc =
+        hash.key?('UpdatedDateUTC') ? hash['UpdatedDateUTC'] : SKIP
+      add_to_watchlist =
+        hash.key?('AddToWatchlist') ? hash['AddToWatchlist'] : 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.
+      Account.new(code: code,
+                  name: name,
+                  account_id: account_id,
+                  type: type,
+                  bank_account_number: bank_account_number,
+                  status: status,
+                  description: description,
+                  bank_account_type: bank_account_type,
+                  currency_code: currency_code,
+                  tax_type: tax_type,
+                  enable_payments_to_account: enable_payments_to_account,
+                  show_in_expense_claims: show_in_expense_claims,
+                  mclass: mclass,
+                  system_account: system_account,
+                  reporting_code: reporting_code,
+                  reporting_code_name: reporting_code_name,
+                  has_attachments: has_attachments,
+                  updated_date_utc: updated_date_utc,
+                  add_to_watchlist: add_to_watchlist,
+                  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} code: #{@code}, name: #{@name}, account_id: #{@account_id}, type: #{@type},"\
+      " bank_account_number: #{@bank_account_number}, status: #{@status}, description:"\
+      " #{@description}, bank_account_type: #{@bank_account_type}, currency_code:"\
+      " #{@currency_code}, tax_type: #{@tax_type}, enable_payments_to_account:"\
+      " #{@enable_payments_to_account}, show_in_expense_claims: #{@show_in_expense_claims},"\
+      " mclass: #{@mclass}, system_account: #{@system_account}, reporting_code:"\
+      " #{@reporting_code}, reporting_code_name: #{@reporting_code_name}, has_attachments:"\
+      " #{@has_attachments}, updated_date_utc: #{@updated_date_utc}, add_to_watchlist:"\
+      " #{@add_to_watchlist}, 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} code: #{@code.inspect}, name: #{@name.inspect}, account_id:"\
+      " #{@account_id.inspect}, type: #{@type.inspect}, bank_account_number:"\
+      " #{@bank_account_number.inspect}, status: #{@status.inspect}, description:"\
+      " #{@description.inspect}, bank_account_type: #{@bank_account_type.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, tax_type: #{@tax_type.inspect}, enable_payments_to_account:"\
+      " #{@enable_payments_to_account.inspect}, show_in_expense_claims:"\
+      " #{@show_in_expense_claims.inspect}, mclass: #{@mclass.inspect}, system_account:"\
+      " #{@system_account.inspect}, reporting_code: #{@reporting_code.inspect},"\
+      " reporting_code_name: #{@reporting_code_name.inspect}, has_attachments:"\
+      " #{@has_attachments.inspect}, updated_date_utc: #{@updated_date_utc.inspect},"\
+      " add_to_watchlist: #{@add_to_watchlist.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/account_type.rb

@@ -0,0 +1,100 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Account Types
+  class AccountType
+    ACCOUNT_TYPE = [
+      # TODO: Write general description for BANK
+      BANK = 'BANK'.freeze,
+
+      # TODO: Write general description for CURRENT
+      CURRENT = 'CURRENT'.freeze,
+
+      # TODO: Write general description for CURRLIAB
+      CURRLIAB = 'CURRLIAB'.freeze,
+
+      # TODO: Write general description for DEPRECIATN
+      DEPRECIATN = 'DEPRECIATN'.freeze,
+
+      # TODO: Write general description for DIRECTCOSTS
+      DIRECTCOSTS = 'DIRECTCOSTS'.freeze,
+
+      # TODO: Write general description for EQUITY
+      EQUITY = 'EQUITY'.freeze,
+
+      # TODO: Write general description for EXPENSE
+      EXPENSE = 'EXPENSE'.freeze,
+
+      # TODO: Write general description for FIXED
+      FIXED = 'FIXED'.freeze,
+
+      # TODO: Write general description for INVENTORY
+      INVENTORY = 'INVENTORY'.freeze,
+
+      # TODO: Write general description for LIABILITY
+      LIABILITY = 'LIABILITY'.freeze,
+
+      # TODO: Write general description for NONCURRENT
+      NONCURRENT = 'NONCURRENT'.freeze,
+
+      # TODO: Write general description for OTHERINCOME
+      OTHERINCOME = 'OTHERINCOME'.freeze,
+
+      # TODO: Write general description for OVERHEADS
+      OVERHEADS = 'OVERHEADS'.freeze,
+
+      # TODO: Write general description for PREPAYMENT
+      PREPAYMENT = 'PREPAYMENT'.freeze,
+
+      # TODO: Write general description for REVENUE
+      REVENUE = 'REVENUE'.freeze,
+
+      # TODO: Write general description for SALES
+      SALES = 'SALES'.freeze,
+
+      # TODO: Write general description for TERMLIAB
+      TERMLIAB = 'TERMLIAB'.freeze,
+
+      # TODO: Write general description for PAYG
+      PAYG = 'PAYG'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      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 'current' then CURRENT
+      when 'currliab' then CURRLIAB
+      when 'depreciatn' then DEPRECIATN
+      when 'directcosts' then DIRECTCOSTS
+      when 'equity' then EQUITY
+      when 'expense' then EXPENSE
+      when 'fixed' then FIXED
+      when 'inventory' then INVENTORY
+      when 'liability' then LIABILITY
+      when 'noncurrent' then NONCURRENT
+      when 'otherincome' then OTHERINCOME
+      when 'overheads' then OVERHEADS
+      when 'prepayment' then PREPAYMENT
+      when 'revenue' then REVENUE
+      when 'sales' then SALES
+      when 'termliab' then TERMLIAB
+      when 'payg' then PAYG
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/account_type1.rb

@@ -0,0 +1,37 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # High level bank account type - BANK CREDITCARD BANK encompasses all bank
+  # account types other than credit cards.
+  class AccountType1
+    ACCOUNT_TYPE1 = [
+      # TODO: Write general description for BANK
+      BANK = 'BANK'.freeze,
+
+      # TODO: Write general description for CREDITCARD
+      CREDITCARD = 'CREDITCARD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE1.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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/accounts.rb

@@ -0,0 +1,84 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Accounts Model.
+  class Accounts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accounts'] = 'Accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accounts: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      # 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.
+      Accounts.new(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} 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} accounts: #{@accounts.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end