xero-apimatic-sdk 1.0.0

data/lib/xero_ap_is/models/tracking_categories.rb

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

data/lib/xero_ap_is/models/tracking_category.rb

@@ -0,0 +1,140 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TrackingCategory Model.
+  class TrackingCategory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Xero identifier for a tracking category e.g.
+    # 297c2dc5-cc47-4afd-8ec8-74990b8761e9
+    # @return [UUID | String]
+    attr_accessor :tracking_category_id
+
+    # The Xero identifier for a tracking option e.g.
+    # dc54c220-0140-495a-b925-3246adc0075f
+    # @return [UUID | String]
+    attr_accessor :tracking_option_id
+
+    # The name of the tracking category e.g. Department, Region (max length =
+    # 100)
+    # @return [String]
+    attr_accessor :name
+
+    # The option name of the tracking option e.g. East, West (max length = 100)
+    # @return [String]
+    attr_accessor :option
+
+    # The status of a tracking category
+    # @return [Status9]
+    attr_accessor :status
+
+    # See Tracking Options
+    # @return [Array[TrackingOption]]
+    attr_accessor :options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracking_category_id'] = 'TrackingCategoryID'
+      @_hash['tracking_option_id'] = 'TrackingOptionID'
+      @_hash['name'] = 'Name'
+      @_hash['option'] = 'Option'
+      @_hash['status'] = 'Status'
+      @_hash['options'] = 'Options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_category_id
+        tracking_option_id
+        name
+        option
+        status
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracking_category_id: SKIP, tracking_option_id: SKIP,
+                   name: SKIP, option: SKIP, status: SKIP, options: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tracking_category_id = tracking_category_id unless tracking_category_id == SKIP
+      @tracking_option_id = tracking_option_id unless tracking_option_id == SKIP
+      @name = name unless name == SKIP
+      @option = option unless option == SKIP
+      @status = status unless status == SKIP
+      @options = options unless options == 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.
+      tracking_category_id =
+        hash.key?('TrackingCategoryID') ? hash['TrackingCategoryID'] : SKIP
+      tracking_option_id =
+        hash.key?('TrackingOptionID') ? hash['TrackingOptionID'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      option = hash.key?('Option') ? hash['Option'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      options = nil
+      unless hash['Options'].nil?
+        options = []
+        hash['Options'].each do |structure|
+          options << (TrackingOption.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('Options')
+
+      # 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.
+      TrackingCategory.new(tracking_category_id: tracking_category_id,
+                           tracking_option_id: tracking_option_id,
+                           name: name,
+                           option: option,
+                           status: status,
+                           options: options,
+                           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} tracking_category_id: #{@tracking_category_id}, tracking_option_id:"\
+      " #{@tracking_option_id}, name: #{@name}, option: #{@option}, status: #{@status}, options:"\
+      " #{@options}, 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} tracking_category_id: #{@tracking_category_id.inspect}, tracking_option_id:"\
+      " #{@tracking_option_id.inspect}, name: #{@name.inspect}, option: #{@option.inspect},"\
+      " status: #{@status.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/tracking_option.rb

@@ -0,0 +1,109 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # TrackingOption Model.
+  class TrackingOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Xero identifier for a tracking option e.g.
+    # ae777a87-5ef3-4fa0-a4f0-d10e1f13073a
+    # @return [UUID | String]
+    attr_accessor :tracking_option_id
+
+    # The name of the tracking option e.g. Marketing, East (max length = 100)
+    # @return [String]
+    attr_accessor :name
+
+    # The status of a tracking option
+    # @return [Status10]
+    attr_accessor :status
+
+    # Filter by a tracking category e.g. 297c2dc5-cc47-4afd-8ec8-74990b8761e9
+    # @return [UUID | String]
+    attr_accessor :tracking_category_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracking_option_id'] = 'TrackingOptionID'
+      @_hash['name'] = 'Name'
+      @_hash['status'] = 'Status'
+      @_hash['tracking_category_id'] = 'TrackingCategoryID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tracking_option_id
+        name
+        status
+        tracking_category_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracking_option_id: SKIP, name: SKIP, status: SKIP,
+                   tracking_category_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tracking_option_id = tracking_option_id unless tracking_option_id == SKIP
+      @name = name unless name == SKIP
+      @status = status unless status == SKIP
+      @tracking_category_id = tracking_category_id unless tracking_category_id == 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.
+      tracking_option_id =
+        hash.key?('TrackingOptionID') ? hash['TrackingOptionID'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      tracking_category_id =
+        hash.key?('TrackingCategoryID') ? hash['TrackingCategoryID'] : 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.
+      TrackingOption.new(tracking_option_id: tracking_option_id,
+                         name: name,
+                         status: status,
+                         tracking_category_id: tracking_category_id,
+                         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} tracking_option_id: #{@tracking_option_id}, name: #{@name}, status:"\
+      " #{@status}, tracking_category_id: #{@tracking_category_id}, 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} tracking_option_id: #{@tracking_option_id.inspect}, name: #{@name.inspect},"\
+      " status: #{@status.inspect}, tracking_category_id: #{@tracking_category_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/xero_ap_is/models/tracking_options.rb

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

data/lib/xero_ap_is/models/type.rb

@@ -0,0 +1,60 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Bank Transaction Types
+  class Type
+    TYPE = [
+      # TODO: Write general description for RECEIVE
+      RECEIVE = 'RECEIVE'.freeze,
+
+      # TODO: Write general description for RECEIVEOVERPAYMENT
+      RECEIVEOVERPAYMENT = 'RECEIVE-OVERPAYMENT'.freeze,
+
+      # TODO: Write general description for RECEIVEPREPAYMENT
+      RECEIVEPREPAYMENT = 'RECEIVE-PREPAYMENT'.freeze,
+
+      # TODO: Write general description for SPEND
+      SPEND = 'SPEND'.freeze,
+
+      # TODO: Write general description for SPENDOVERPAYMENT
+      SPENDOVERPAYMENT = 'SPEND-OVERPAYMENT'.freeze,
+
+      # TODO: Write general description for SPENDPREPAYMENT
+      SPENDPREPAYMENT = 'SPEND-PREPAYMENT'.freeze,
+
+      # TODO: Write general description for RECEIVETRANSFER
+      RECEIVETRANSFER = 'RECEIVE-TRANSFER'.freeze,
+
+      # TODO: Write general description for SPENDTRANSFER
+      SPENDTRANSFER = 'SPEND-TRANSFER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = RECEIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'receive' then RECEIVE
+      when 'receiveoverpayment' then RECEIVEOVERPAYMENT
+      when 'receiveprepayment' then RECEIVEPREPAYMENT
+      when 'spend' then SPEND
+      when 'spendoverpayment' then SPENDOVERPAYMENT
+      when 'spendprepayment' then SPENDPREPAYMENT
+      when 'receivetransfer' then RECEIVETRANSFER
+      when 'spendtransfer' then SPENDTRANSFER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type1.rb

@@ -0,0 +1,26 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Always INVOICE
+  class Type1
+    TYPE1 = [
+      # TODO: Write general description for INVOICE
+      INVOICE = 'INVOICE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVOICE)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/xero_ap_is/models/type10.rb

@@ -0,0 +1,36 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # See Invoice Types
+  class Type10
+    TYPE10 = [
+      # TODO: Write general description for ACCPAY
+      ACCPAY = 'ACCPAY'.freeze,
+
+      # TODO: Write general description for ACCREC
+      ACCREC = 'ACCREC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE10.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCPAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accpay' then ACCPAY
+      when 'accrec' then ACCREC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/xero_ap_is/models/type11.rb

@@ -0,0 +1,114 @@
+# xero_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module XeroApIs
+  # Identifies the type of error.
+  class Type11
+    TYPE11 = [
+      # TODO: Write general description for INVALIDREQUEST
+      INVALIDREQUEST = 'invalid-request'.freeze,
+
+      # TODO: Write general description for INVALIDAPPLICATION
+      INVALIDAPPLICATION = 'invalid-application'.freeze,
+
+      # TODO: Write general description for INVALIDFEEDCONNECTION
+      INVALIDFEEDCONNECTION = 'invalid-feed-connection'.freeze,
+
+      # TODO: Write general description for DUPLICATESTATEMENT
+      DUPLICATESTATEMENT = 'duplicate-statement'.freeze,
+
+      # TODO: Write general description for INVALIDENDBALANCE
+      INVALIDENDBALANCE = 'invalid-end-balance'.freeze,
+
+      # TODO: Write general description for INVALIDSTARTANDENDDATE
+      INVALIDSTARTANDENDDATE = 'invalid-start-and-end-date'.freeze,
+
+      # TODO: Write general description for INVALIDSTARTDATE
+      INVALIDSTARTDATE = 'invalid-start-date'.freeze,
+
+      # TODO: Write general description for INTERNALERROR
+      INTERNALERROR = 'internal-error'.freeze,
+
+      # TODO: Write general description for
+      # FEEDALREADYCONNECTEDINCURRENTORGANISATION
+      FEEDALREADYCONNECTEDINCURRENTORGANISATION = 'feed-already-connected-in-current-organisation'.freeze,
+
+      # TODO: Write general description for INVALIDENDDATE
+      INVALIDENDDATE = 'invalid-end-date'.freeze,
+
+      # TODO: Write general description for STATEMENTNOTFOUND
+      STATEMENTNOTFOUND = 'statement-not-found'.freeze,
+
+      # TODO: Write general description for FEEDCONNECTEDINDIFFERENTORGANISATION
+      FEEDCONNECTEDINDIFFERENTORGANISATION = 'feed-connected-in-different-organisation'.freeze,
+
+      # TODO: Write general description for
+      # FEEDALREADYCONNECTEDINDIFFERENTORGANISATION
+      FEEDALREADYCONNECTEDINDIFFERENTORGANISATION = 'feed-already-connected-in-different-organisation'.freeze,
+
+      # TODO: Write general description for BANKFEEDNOTFOUND
+      BANKFEEDNOTFOUND = 'bank-feed-not-found'.freeze,
+
+      # TODO: Write general description for INVALIDCOUNTRYSPECIFIED
+      INVALIDCOUNTRYSPECIFIED = 'invalid-country-specified'.freeze,
+
+      # TODO: Write general description for INVALIDORGANISATIONBANKFEEDS
+      INVALIDORGANISATIONBANKFEEDS = 'invalid-organisation-bank-feeds'.freeze,
+
+      # TODO: Write general description for INVALIDORGANISATIONMULTICURRENCY
+      INVALIDORGANISATIONMULTICURRENCY = 'invalid-organisation-multi-currency'.freeze,
+
+      # TODO: Write general description for INVALIDFEEDCONNECTIONFORORGANISATION
+      INVALIDFEEDCONNECTIONFORORGANISATION = 'invalid-feed-connection-for-organisation'.freeze,
+
+      # TODO: Write general description for INVALIDUSERROLE
+      INVALIDUSERROLE = 'invalid-user-role'.freeze,
+
+      # TODO: Write general description for ACCOUNTNOTVALID
+      ACCOUNTNOTVALID = 'account-not-valid'.freeze,
+
+      # TODO: Write general description for FEEDNOTFOUNDORALREADYDELETED
+      FEEDNOTFOUNDORALREADYDELETED = 'feed-not-found-or-already-deleted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE11.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVALIDREQUEST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invalidrequest' then INVALIDREQUEST
+      when 'invalidapplication' then INVALIDAPPLICATION
+      when 'invalidfeedconnection' then INVALIDFEEDCONNECTION
+      when 'duplicatestatement' then DUPLICATESTATEMENT
+      when 'invalidendbalance' then INVALIDENDBALANCE
+      when 'invalidstartandenddate' then INVALIDSTARTANDENDDATE
+      when 'invalidstartdate' then INVALIDSTARTDATE
+      when 'internalerror' then INTERNALERROR
+      when 'feedalreadyconnectedincurrentorganisation' then FEEDALREADYCONNECTEDINCURRENTORGANISATION
+      when 'invalidenddate' then INVALIDENDDATE
+      when 'statementnotfound' then STATEMENTNOTFOUND
+      when 'feedconnectedindifferentorganisation' then FEEDCONNECTEDINDIFFERENTORGANISATION
+      when 'feedalreadyconnectedindifferentorganisation' then FEEDALREADYCONNECTEDINDIFFERENTORGANISATION
+      when 'bankfeednotfound' then BANKFEEDNOTFOUND
+      when 'invalidcountryspecified' then INVALIDCOUNTRYSPECIFIED
+      when 'invalidorganisationbankfeeds' then INVALIDORGANISATIONBANKFEEDS
+      when 'invalidorganisationmulticurrency' then INVALIDORGANISATIONMULTICURRENCY
+      when 'invalidfeedconnectionfororganisation' then INVALIDFEEDCONNECTIONFORORGANISATION
+      when 'invaliduserrole' then INVALIDUSERROLE
+      when 'accountnotvalid' then ACCOUNTNOTVALID
+      when 'feednotfoundoralreadydeleted' then FEEDNOTFOUNDORALREADYDELETED
+      else
+        default_value
+      end
+    end
+  end
+end