xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/address_type.rb

@@ -0,0 +1,40 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # define the type of address
+  class AddressType
+    ADDRESS_TYPE = [
+      # TODO: Write general description for POBOX
+      POBOX = 'POBOX'.freeze,
+
+      # TODO: Write general description for STREET
+      STREET = 'STREET'.freeze,
+
+      # TODO: Write general description for DELIVERY
+      DELIVERY = 'DELIVERY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = POBOX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pobox' then POBOX
+      when 'street' then STREET
+      when 'delivery' then DELIVERY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/address_type1.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # define the type of address
+  class AddressType1
+    ADDRESS_TYPE1 = [
+      # TODO: Write general description for POBOX
+      POBOX = 'POBOX'.freeze,
+
+      # TODO: Write general description for STREET
+      STREET = 'STREET'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = POBOX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pobox' then POBOX
+      when 'street' then STREET
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/allocation.rb

@@ -0,0 +1,174 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Allocation Model.
+  class Allocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Xero generated unique identifier
+    # @return [UUID | String]
+    attr_accessor :allocation_id
+
+    # Xero generated unique identifier
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # Xero generated unique identifier
+    # @return [Overpayment]
+    attr_accessor :overpayment
+
+    # Xero generated unique identifier
+    # @return [Prepayment]
+    attr_accessor :prepayment
+
+    # Xero generated unique identifier
+    # @return [CreditNote]
+    attr_accessor :credit_note
+
+    # the amount being applied to the invoice
+    # @return [Float]
+    attr_accessor :amount
+
+    # the date the allocation is applied YYYY-MM-DD.
+    # @return [String]
+    attr_accessor :date
+
+    # A flag that returns true when the allocation is succesfully deleted
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_deleted
+
+    # 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['allocation_id'] = 'AllocationID'
+      @_hash['invoice'] = 'Invoice'
+      @_hash['overpayment'] = 'Overpayment'
+      @_hash['prepayment'] = 'Prepayment'
+      @_hash['credit_note'] = 'CreditNote'
+      @_hash['amount'] = 'Amount'
+      @_hash['date'] = 'Date'
+      @_hash['is_deleted'] = 'IsDeleted'
+      @_hash['status_attribute_string'] = 'StatusAttributeString'
+      @_hash['validation_errors'] = 'ValidationErrors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        allocation_id
+        overpayment
+        prepayment
+        credit_note
+        is_deleted
+        status_attribute_string
+        validation_errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice:, amount:, date:, allocation_id: SKIP,
+                   overpayment: SKIP, prepayment: SKIP, credit_note: SKIP,
+                   is_deleted: SKIP, status_attribute_string: SKIP,
+                   validation_errors: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @allocation_id = allocation_id unless allocation_id == SKIP
+      @invoice = invoice
+      @overpayment = overpayment unless overpayment == SKIP
+      @prepayment = prepayment unless prepayment == SKIP
+      @credit_note = credit_note unless credit_note == SKIP
+      @amount = amount
+      @date = date
+      @is_deleted = is_deleted unless is_deleted == 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.
+      invoice = Invoice.from_hash(hash['Invoice']) if hash['Invoice']
+      amount = hash.key?('Amount') ? hash['Amount'] : nil
+      date = hash.key?('Date') ? hash['Date'] : nil
+      allocation_id = hash.key?('AllocationID') ? hash['AllocationID'] : SKIP
+      overpayment = Overpayment.from_hash(hash['Overpayment']) if hash['Overpayment']
+      prepayment = Prepayment.from_hash(hash['Prepayment']) if hash['Prepayment']
+      credit_note = CreditNote.from_hash(hash['CreditNote']) if hash['CreditNote']
+      is_deleted = hash.key?('IsDeleted') ? hash['IsDeleted'] : SKIP
+      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.
+      Allocation.new(invoice: invoice,
+                     amount: amount,
+                     date: date,
+                     allocation_id: allocation_id,
+                     overpayment: overpayment,
+                     prepayment: prepayment,
+                     credit_note: credit_note,
+                     is_deleted: is_deleted,
+                     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} allocation_id: #{@allocation_id}, invoice: #{@invoice}, overpayment:"\
+      " #{@overpayment}, prepayment: #{@prepayment}, credit_note: #{@credit_note}, amount:"\
+      " #{@amount}, date: #{@date}, is_deleted: #{@is_deleted}, 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} allocation_id: #{@allocation_id.inspect}, invoice: #{@invoice.inspect},"\
+      " overpayment: #{@overpayment.inspect}, prepayment: #{@prepayment.inspect}, credit_note:"\
+      " #{@credit_note.inspect}, amount: #{@amount.inspect}, date: #{@date.inspect}, is_deleted:"\
+      " #{@is_deleted.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/allocations.rb

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

data/lib/xero_ap_is/models/amount.rb

@@ -0,0 +1,85 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Amount Model.
+  class Amount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 3 letter alpha code for the ISO-4217 currency code, e.g. USD, AUD.
+    # @return [CurrencyCode1]
+    attr_accessor :currency
+
+    # 3 letter alpha code for the ISO-4217 currency code, e.g. USD, AUD.
+    # @return [Float]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency: SKIP, value: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency unless currency == SKIP
+      @value = value unless value == 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.
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      value = hash.key?('value') ? hash['value'] : 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.
+      Amount.new(currency: currency,
+                 value: value,
+                 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} currency: #{@currency}, value: #{@value}, 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} currency: #{@currency.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/asset.rb

@@ -0,0 +1,249 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Asset Model.
+  class Asset < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Xero-generated Id for the asset
+    # @return [UUID | String]
+    attr_accessor :asset_id
+
+    # The name of the asset
+    # @return [String]
+    attr_accessor :asset_name
+
+    # The Xero-generated Id for the asset type
+    # @return [UUID | String]
+    attr_accessor :asset_type_id
+
+    # Must be unique.
+    # @return [String]
+    attr_accessor :asset_number
+
+    # The date the asset was purchased YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :purchase_date
+
+    # The purchase price of the asset
+    # @return [Float]
+    attr_accessor :purchase_price
+
+    # The date the asset was disposed
+    # @return [Date]
+    attr_accessor :disposal_date
+
+    # The price the asset was disposed at
+    # @return [Float]
+    attr_accessor :disposal_price
+
+    # See Asset Status Codes.
+    # @return [AssetStatus]
+    attr_accessor :asset_status
+
+    # The date the asset’s warranty expires (if needed) YYYY-MM-DD
+    # @return [String]
+    attr_accessor :warranty_expiry_date
+
+    # The asset's serial number
+    # @return [String]
+    attr_accessor :serial_number
+
+    # The asset's serial number
+    # @return [BookDepreciationSetting]
+    attr_accessor :book_depreciation_setting
+
+    # The asset's serial number
+    # @return [BookDepreciationDetail]
+    attr_accessor :book_depreciation_detail
+
+    # Boolean to indicate whether depreciation can be rolled back for this asset
+    # individually. This is true if it doesn't have 'legacy' journal entries and
+    # if there is no lock period that would prevent this asset from rolling
+    # back.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_rollback
+
+    # The accounting value of the asset
+    # @return [Float]
+    attr_accessor :accounting_book_value
+
+    # Boolean to indicate whether delete is enabled
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_delete_enabled_for_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_id'] = 'assetId'
+      @_hash['asset_name'] = 'assetName'
+      @_hash['asset_type_id'] = 'assetTypeId'
+      @_hash['asset_number'] = 'assetNumber'
+      @_hash['purchase_date'] = 'purchaseDate'
+      @_hash['purchase_price'] = 'purchasePrice'
+      @_hash['disposal_date'] = 'disposalDate'
+      @_hash['disposal_price'] = 'disposalPrice'
+      @_hash['asset_status'] = 'assetStatus'
+      @_hash['warranty_expiry_date'] = 'warrantyExpiryDate'
+      @_hash['serial_number'] = 'serialNumber'
+      @_hash['book_depreciation_setting'] = 'bookDepreciationSetting'
+      @_hash['book_depreciation_detail'] = 'bookDepreciationDetail'
+      @_hash['can_rollback'] = 'canRollback'
+      @_hash['accounting_book_value'] = 'accountingBookValue'
+      @_hash['is_delete_enabled_for_date'] = 'isDeleteEnabledForDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_id
+        asset_type_id
+        asset_number
+        purchase_date
+        purchase_price
+        disposal_date
+        disposal_price
+        asset_status
+        warranty_expiry_date
+        serial_number
+        book_depreciation_setting
+        book_depreciation_detail
+        can_rollback
+        accounting_book_value
+        is_delete_enabled_for_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_name:, asset_id: SKIP, asset_type_id: SKIP,
+                   asset_number: SKIP, purchase_date: SKIP,
+                   purchase_price: SKIP, disposal_date: SKIP,
+                   disposal_price: SKIP, asset_status: SKIP,
+                   warranty_expiry_date: SKIP, serial_number: SKIP,
+                   book_depreciation_setting: SKIP,
+                   book_depreciation_detail: SKIP, can_rollback: SKIP,
+                   accounting_book_value: SKIP,
+                   is_delete_enabled_for_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_id = asset_id unless asset_id == SKIP
+      @asset_name = asset_name
+      @asset_type_id = asset_type_id unless asset_type_id == SKIP
+      @asset_number = asset_number unless asset_number == SKIP
+      @purchase_date = purchase_date unless purchase_date == SKIP
+      @purchase_price = purchase_price unless purchase_price == SKIP
+      @disposal_date = disposal_date unless disposal_date == SKIP
+      @disposal_price = disposal_price unless disposal_price == SKIP
+      @asset_status = asset_status unless asset_status == SKIP
+      @warranty_expiry_date = warranty_expiry_date unless warranty_expiry_date == SKIP
+      @serial_number = serial_number unless serial_number == SKIP
+      unless book_depreciation_setting == SKIP
+        @book_depreciation_setting =
+          book_depreciation_setting
+      end
+      @book_depreciation_detail = book_depreciation_detail unless book_depreciation_detail == SKIP
+      @can_rollback = can_rollback unless can_rollback == SKIP
+      @accounting_book_value = accounting_book_value unless accounting_book_value == SKIP
+      unless is_delete_enabled_for_date == SKIP
+        @is_delete_enabled_for_date =
+          is_delete_enabled_for_date
+      end
+      @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_name = hash.key?('assetName') ? hash['assetName'] : nil
+      asset_id = hash.key?('assetId') ? hash['assetId'] : SKIP
+      asset_type_id = hash.key?('assetTypeId') ? hash['assetTypeId'] : SKIP
+      asset_number = hash.key?('assetNumber') ? hash['assetNumber'] : SKIP
+      purchase_date = hash.key?('purchaseDate') ? hash['purchaseDate'] : SKIP
+      purchase_price = hash.key?('purchasePrice') ? hash['purchasePrice'] : SKIP
+      disposal_date = hash.key?('disposalDate') ? hash['disposalDate'] : SKIP
+      disposal_price = hash.key?('disposalPrice') ? hash['disposalPrice'] : SKIP
+      asset_status = hash.key?('assetStatus') ? hash['assetStatus'] : SKIP
+      warranty_expiry_date =
+        hash.key?('warrantyExpiryDate') ? hash['warrantyExpiryDate'] : SKIP
+      serial_number = hash.key?('serialNumber') ? hash['serialNumber'] : SKIP
+      if hash['bookDepreciationSetting']
+        book_depreciation_setting = BookDepreciationSetting.from_hash(hash['bookDepreciationSetting'])
+      end
+      book_depreciation_detail = BookDepreciationDetail.from_hash(hash['bookDepreciationDetail']) if
+        hash['bookDepreciationDetail']
+      can_rollback = hash.key?('canRollback') ? hash['canRollback'] : SKIP
+      accounting_book_value =
+        hash.key?('accountingBookValue') ? hash['accountingBookValue'] : SKIP
+      is_delete_enabled_for_date =
+        hash.key?('isDeleteEnabledForDate') ? hash['isDeleteEnabledForDate'] : 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.
+      Asset.new(asset_name: asset_name,
+                asset_id: asset_id,
+                asset_type_id: asset_type_id,
+                asset_number: asset_number,
+                purchase_date: purchase_date,
+                purchase_price: purchase_price,
+                disposal_date: disposal_date,
+                disposal_price: disposal_price,
+                asset_status: asset_status,
+                warranty_expiry_date: warranty_expiry_date,
+                serial_number: serial_number,
+                book_depreciation_setting: book_depreciation_setting,
+                book_depreciation_detail: book_depreciation_detail,
+                can_rollback: can_rollback,
+                accounting_book_value: accounting_book_value,
+                is_delete_enabled_for_date: is_delete_enabled_for_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} asset_id: #{@asset_id}, asset_name: #{@asset_name}, asset_type_id:"\
+      " #{@asset_type_id}, asset_number: #{@asset_number}, purchase_date: #{@purchase_date},"\
+      " purchase_price: #{@purchase_price}, disposal_date: #{@disposal_date}, disposal_price:"\
+      " #{@disposal_price}, asset_status: #{@asset_status}, warranty_expiry_date:"\
+      " #{@warranty_expiry_date}, serial_number: #{@serial_number}, book_depreciation_setting:"\
+      " #{@book_depreciation_setting}, book_depreciation_detail: #{@book_depreciation_detail},"\
+      " can_rollback: #{@can_rollback}, accounting_book_value: #{@accounting_book_value},"\
+      " is_delete_enabled_for_date: #{@is_delete_enabled_for_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} asset_id: #{@asset_id.inspect}, asset_name: #{@asset_name.inspect},"\
+      " asset_type_id: #{@asset_type_id.inspect}, asset_number: #{@asset_number.inspect},"\
+      " purchase_date: #{@purchase_date.inspect}, purchase_price: #{@purchase_price.inspect},"\
+      " disposal_date: #{@disposal_date.inspect}, disposal_price: #{@disposal_price.inspect},"\
+      " asset_status: #{@asset_status.inspect}, warranty_expiry_date:"\
+      " #{@warranty_expiry_date.inspect}, serial_number: #{@serial_number.inspect},"\
+      " book_depreciation_setting: #{@book_depreciation_setting.inspect},"\
+      " book_depreciation_detail: #{@book_depreciation_detail.inspect}, can_rollback:"\
+      " #{@can_rollback.inspect}, accounting_book_value: #{@accounting_book_value.inspect},"\
+      " is_delete_enabled_for_date: #{@is_delete_enabled_for_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end