xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/asset_status.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Asset Status Codes.
+  class AssetStatus
+    ASSET_STATUS = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'Draft'.freeze,
+
+      # TODO: Write general description for REGISTERED
+      REGISTERED = 'Registered'.freeze,
+
+      # TODO: Write general description for DISPOSED
+      DISPOSED = 'Disposed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ASSET_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'registered' then REGISTERED
+      when 'disposed' then DISPOSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/asset_status_query_param.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Asset Status Codes.
+  class AssetStatusQueryParam
+    ASSET_STATUS_QUERY_PARAM = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'DRAFT'.freeze,
+
+      # TODO: Write general description for REGISTERED
+      REGISTERED = 'REGISTERED'.freeze,
+
+      # TODO: Write general description for DISPOSED
+      DISPOSED = 'DISPOSED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ASSET_STATUS_QUERY_PARAM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'registered' then REGISTERED
+      when 'disposed' then DISPOSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/asset_type.rb

@@ -0,0 +1,154 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # AssetType Model.
+  class AssetType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero generated unique identifier for asset types
+    # @return [UUID | String]
+    attr_accessor :asset_type_id
+
+    # The name of the asset type
+    # @return [String]
+    attr_accessor :asset_type_name
+
+    # The asset account for fixed assets of this type
+    # @return [UUID | String]
+    attr_accessor :fixed_asset_account_id
+
+    # The expense account for the depreciation of fixed assets of this type
+    # @return [UUID | String]
+    attr_accessor :depreciation_expense_account_id
+
+    # The account for accumulated depreciation of fixed assets of this type
+    # @return [UUID | String]
+    attr_accessor :accumulated_depreciation_account_id
+
+    # The account for accumulated depreciation of fixed assets of this type
+    # @return [BookDepreciationSetting]
+    attr_accessor :book_depreciation_setting
+
+    # All asset types that have accumulated depreciation for any assets that use
+    # them are deemed ‘locked’ and cannot be removed.
+    # @return [Integer]
+    attr_accessor :locks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_type_id'] = 'assetTypeId'
+      @_hash['asset_type_name'] = 'assetTypeName'
+      @_hash['fixed_asset_account_id'] = 'fixedAssetAccountId'
+      @_hash['depreciation_expense_account_id'] =
+        'depreciationExpenseAccountId'
+      @_hash['accumulated_depreciation_account_id'] =
+        'accumulatedDepreciationAccountId'
+      @_hash['book_depreciation_setting'] = 'bookDepreciationSetting'
+      @_hash['locks'] = 'locks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_type_id
+        fixed_asset_account_id
+        depreciation_expense_account_id
+        accumulated_depreciation_account_id
+        locks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_type_name:, book_depreciation_setting:,
+                   asset_type_id: SKIP, fixed_asset_account_id: SKIP,
+                   depreciation_expense_account_id: SKIP,
+                   accumulated_depreciation_account_id: SKIP, locks: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_type_id = asset_type_id unless asset_type_id == SKIP
+      @asset_type_name = asset_type_name
+      @fixed_asset_account_id = fixed_asset_account_id unless fixed_asset_account_id == SKIP
+      unless depreciation_expense_account_id == SKIP
+        @depreciation_expense_account_id =
+          depreciation_expense_account_id
+      end
+      unless accumulated_depreciation_account_id == SKIP
+        @accumulated_depreciation_account_id =
+          accumulated_depreciation_account_id
+      end
+      @book_depreciation_setting = book_depreciation_setting
+      @locks = locks unless locks == 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_type_name = hash.key?('assetTypeName') ? hash['assetTypeName'] : nil
+      if hash['bookDepreciationSetting']
+        book_depreciation_setting = BookDepreciationSetting.from_hash(hash['bookDepreciationSetting'])
+      end
+      asset_type_id = hash.key?('assetTypeId') ? hash['assetTypeId'] : SKIP
+      fixed_asset_account_id =
+        hash.key?('fixedAssetAccountId') ? hash['fixedAssetAccountId'] : SKIP
+      depreciation_expense_account_id =
+        hash.key?('depreciationExpenseAccountId') ? hash['depreciationExpenseAccountId'] : SKIP
+      accumulated_depreciation_account_id =
+        hash.key?('accumulatedDepreciationAccountId') ? hash['accumulatedDepreciationAccountId'] : SKIP
+      locks = hash.key?('locks') ? hash['locks'] : 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.
+      AssetType.new(asset_type_name: asset_type_name,
+                    book_depreciation_setting: book_depreciation_setting,
+                    asset_type_id: asset_type_id,
+                    fixed_asset_account_id: fixed_asset_account_id,
+                    depreciation_expense_account_id: depreciation_expense_account_id,
+                    accumulated_depreciation_account_id: accumulated_depreciation_account_id,
+                    locks: locks,
+                    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_type_id: #{@asset_type_id}, asset_type_name: #{@asset_type_name},"\
+      " fixed_asset_account_id: #{@fixed_asset_account_id}, depreciation_expense_account_id:"\
+      " #{@depreciation_expense_account_id}, accumulated_depreciation_account_id:"\
+      " #{@accumulated_depreciation_account_id}, book_depreciation_setting:"\
+      " #{@book_depreciation_setting}, locks: #{@locks}, 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_type_id: #{@asset_type_id.inspect}, asset_type_name:"\
+      " #{@asset_type_name.inspect}, fixed_asset_account_id: #{@fixed_asset_account_id.inspect},"\
+      " depreciation_expense_account_id: #{@depreciation_expense_account_id.inspect},"\
+      " accumulated_depreciation_account_id: #{@accumulated_depreciation_account_id.inspect},"\
+      " book_depreciation_setting: #{@book_depreciation_setting.inspect}, locks:"\
+      " #{@locks.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/assets.rb

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

data/lib/xero_ap_is/models/attachment.rb

@@ -0,0 +1,126 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Attachment Model.
+  class Attachment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID for the file
+    # @return [UUID | String]
+    attr_accessor :attachment_id
+
+    # Name of the file
+    # @return [String]
+    attr_accessor :file_name
+
+    # URL to the file on xero.com
+    # @return [String]
+    attr_accessor :url
+
+    # Type of file
+    # @return [String]
+    attr_accessor :mime_type
+
+    # Length of the file content
+    # @return [Integer]
+    attr_accessor :content_length
+
+    # Include the file with the online invoice
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_online
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attachment_id'] = 'AttachmentID'
+      @_hash['file_name'] = 'FileName'
+      @_hash['url'] = 'Url'
+      @_hash['mime_type'] = 'MimeType'
+      @_hash['content_length'] = 'ContentLength'
+      @_hash['include_online'] = 'IncludeOnline'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attachment_id
+        file_name
+        url
+        mime_type
+        content_length
+        include_online
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attachment_id: SKIP, file_name: SKIP, url: SKIP,
+                   mime_type: SKIP, content_length: SKIP, include_online: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @attachment_id = attachment_id unless attachment_id == SKIP
+      @file_name = file_name unless file_name == SKIP
+      @url = url unless url == SKIP
+      @mime_type = mime_type unless mime_type == SKIP
+      @content_length = content_length unless content_length == SKIP
+      @include_online = include_online unless include_online == 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.
+      attachment_id = hash.key?('AttachmentID') ? hash['AttachmentID'] : SKIP
+      file_name = hash.key?('FileName') ? hash['FileName'] : SKIP
+      url = hash.key?('Url') ? hash['Url'] : SKIP
+      mime_type = hash.key?('MimeType') ? hash['MimeType'] : SKIP
+      content_length = hash.key?('ContentLength') ? hash['ContentLength'] : SKIP
+      include_online = hash.key?('IncludeOnline') ? hash['IncludeOnline'] : 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.
+      Attachment.new(attachment_id: attachment_id,
+                     file_name: file_name,
+                     url: url,
+                     mime_type: mime_type,
+                     content_length: content_length,
+                     include_online: include_online,
+                     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} attachment_id: #{@attachment_id}, file_name: #{@file_name}, url: #{@url},"\
+      " mime_type: #{@mime_type}, content_length: #{@content_length}, include_online:"\
+      " #{@include_online}, 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} attachment_id: #{@attachment_id.inspect}, file_name: #{@file_name.inspect},"\
+      " url: #{@url.inspect}, mime_type: #{@mime_type.inspect}, content_length:"\
+      " #{@content_length.inspect}, include_online: #{@include_online.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/attachments.rb

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

data/lib/xero_ap_is/models/averaging_method.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # The method of averaging applied to this asset. See Averaging Methods
+  class AveragingMethod
+    AVERAGING_METHOD = [
+      # TODO: Write general description for FULLMONTH
+      FULLMONTH = 'FullMonth'.freeze,
+
+      # TODO: Write general description for ACTUALDAYS
+      ACTUALDAYS = 'ActualDays'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AVERAGING_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = FULLMONTH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fullmonth' then FULLMONTH
+      when 'actualdays' then ACTUALDAYS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/balance_details.rb

@@ -0,0 +1,98 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # An array to specify multiple currency balances of an account
+  class BalanceDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The opening balances of the account. Debits are positive, credits are
+    # negative values
+    # @return [Float]
+    attr_accessor :balance
+
+    # The currency of the balance (Not required for base currency)
+    # @return [String]
+    attr_accessor :currency_code
+
+    # (Optional) Exchange rate to base currency when money is spent or received.
+    # If not specified, XE rate for the day is applied
+    # @return [Float]
+    attr_accessor :currency_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balance'] = 'Balance'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['currency_rate'] = 'CurrencyRate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        balance
+        currency_code
+        currency_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(balance: SKIP, currency_code: SKIP, currency_rate: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @balance = balance unless balance == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_rate = currency_rate unless currency_rate == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      balance = hash.key?('Balance') ? hash['Balance'] : SKIP
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
+      currency_rate = hash.key?('CurrencyRate') ? hash['CurrencyRate'] : 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.
+      BalanceDetails.new(balance: balance,
+                         currency_code: currency_code,
+                         currency_rate: currency_rate,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balance: #{@balance}, currency_code: #{@currency_code}, currency_rate:"\
+      " #{@currency_rate}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balance: #{@balance.inspect}, currency_code: #{@currency_code.inspect},"\
+      " currency_rate: #{@currency_rate.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end