xero-ruby 3.2.1 → 3.6.0

data/lib/xero-ruby/models/finance/statement_balance_response.rb

@@ -0,0 +1,232 @@
+=begin
+#Xero Finance API
+
+#The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::Finance
+  require 'bigdecimal'
+
+  class StatementBalanceResponse
+    # Total closing balance of the account. This includes both reconciled and unreconciled bank statement lines. The closing balance will always be represented as a positive number, with it’s debit/credit status defined in the statementBalanceDebitCredit field.
+    attr_accessor :value
+    
+    # The DEBIT or CREDIT status of the account. Cash accounts in credit have a negative balance.
+    attr_accessor :type
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'value' => :'value',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'value' => :'BigDecimal',
+        :'type' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::StatementBalanceResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Finance::StatementBalanceResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          value == o.value &&
+          type == o.type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [value, type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(parse_date(value))
+      when :Date
+        Date.parse(parse_date(value))
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        XeroRuby::Finance.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash(downcase: false)
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
+      end
+      hash
+    end
+
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value, downcase: false)
+      if value.is_a?(Array)
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(downcase: downcase)
+      else
+        value
+      end
+    end
+
+    def parse_date(datestring)
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
+    end
+  end
+end

data/lib/xero-ruby/models/finance/statement_lines_response.rb

@@ -0,0 +1,382 @@
+=begin
+#Xero Finance API
+
+#The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::Finance
+  require 'bigdecimal'
+
+  class StatementLinesResponse
+    # Sum of the amounts of all statement lines where both the reconciled flag is set to FALSE, and the amount is positive.
+    attr_accessor :unreconciled_amount_pos
+    
+    # Sum of the amounts of all statement lines where both the reconciled flag is set to FALSE, and the amount is negative.
+    attr_accessor :unreconciled_amount_neg
+    
+    # Count of all statement lines where the reconciled flag is set to FALSE.
+    attr_accessor :unreconciled_lines
+    
+    # Sum-product of age of statement line in days multiplied by transaction amount, divided by the sum of transaction amount - in for those statement lines in which the reconciled flag is set to FALSE, and the amount is positive. Provides an indication of the age of unreconciled transactions.
+    attr_accessor :avg_days_unreconciled_pos
+    
+    # Sum-product of age of statement line in days multiplied by transaction amount, divided by the sum of transaction amount - in for those statement lines in which the reconciled flag is set to FALSE, and the amount is negative. Provides an indication of the age of unreconciled transactions.
+    attr_accessor :avg_days_unreconciled_neg
+    
+    # UTC Date which is the earliest transaction date of a statement line for which the reconciled flag is set to FALSE.  This date is represented in ISO 8601 format.
+    attr_accessor :earliest_unreconciled_transaction
+    
+    # UTC Date which is the latest transaction date of a statement line for which the reconciled flag is set to FALSE.  This date is represented in ISO 8601 format.
+    attr_accessor :latest_unreconciled_transaction
+    
+    # Sum of the amounts of all deleted statement lines.  Transactions may be deleted due to duplication or otherwise.
+    attr_accessor :deleted_amount
+    
+    # Sum of the amounts of all statement lines.  This is used as a metric of comparison to the unreconciled figures above.
+    attr_accessor :total_amount
+    
+
+    attr_accessor :data_source
+    
+    # UTC Date which is the earliest transaction date of a statement line for which the reconciled flag is set to TRUE.  This date is represented in ISO 8601 format.
+    attr_accessor :earliest_reconciled_transaction
+    
+    # UTC Date which is the latest transaction date of a statement line for which the reconciled flag is set to TRUE.  This date is represented in ISO 8601 format.
+    attr_accessor :latest_reconciled_transaction
+    
+    # Sum of the amounts of all statement lines where both the reconciled flag is set to TRUE, and the amount is positive.
+    attr_accessor :reconciled_amount_pos
+    
+    # Sum of the amounts of all statement lines where both the reconciled flag is set to TRUE, and the amount is negative.
+    attr_accessor :reconciled_amount_neg
+    
+    # Count of all statement lines where the reconciled flag is set to TRUE
+    attr_accessor :reconciled_lines
+    
+    # Sum of the amounts of all statement lines where the amount is positive
+    attr_accessor :total_amount_pos
+    
+    # Sum of the amounts of all statement lines where the amount is negative.
+    attr_accessor :total_amount_neg
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unreconciled_amount_pos' => :'unreconciledAmountPos',
+        :'unreconciled_amount_neg' => :'unreconciledAmountNeg',
+        :'unreconciled_lines' => :'unreconciledLines',
+        :'avg_days_unreconciled_pos' => :'avgDaysUnreconciledPos',
+        :'avg_days_unreconciled_neg' => :'avgDaysUnreconciledNeg',
+        :'earliest_unreconciled_transaction' => :'earliestUnreconciledTransaction',
+        :'latest_unreconciled_transaction' => :'latestUnreconciledTransaction',
+        :'deleted_amount' => :'deletedAmount',
+        :'total_amount' => :'totalAmount',
+        :'data_source' => :'dataSource',
+        :'earliest_reconciled_transaction' => :'earliestReconciledTransaction',
+        :'latest_reconciled_transaction' => :'latestReconciledTransaction',
+        :'reconciled_amount_pos' => :'reconciledAmountPos',
+        :'reconciled_amount_neg' => :'reconciledAmountNeg',
+        :'reconciled_lines' => :'reconciledLines',
+        :'total_amount_pos' => :'totalAmountPos',
+        :'total_amount_neg' => :'totalAmountNeg'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'unreconciled_amount_pos' => :'BigDecimal',
+        :'unreconciled_amount_neg' => :'BigDecimal',
+        :'unreconciled_lines' => :'Integer',
+        :'avg_days_unreconciled_pos' => :'BigDecimal',
+        :'avg_days_unreconciled_neg' => :'BigDecimal',
+        :'earliest_unreconciled_transaction' => :'Date',
+        :'latest_unreconciled_transaction' => :'Date',
+        :'deleted_amount' => :'BigDecimal',
+        :'total_amount' => :'BigDecimal',
+        :'data_source' => :'DataSourceResponse',
+        :'earliest_reconciled_transaction' => :'Date',
+        :'latest_reconciled_transaction' => :'Date',
+        :'reconciled_amount_pos' => :'BigDecimal',
+        :'reconciled_amount_neg' => :'BigDecimal',
+        :'reconciled_lines' => :'Integer',
+        :'total_amount_pos' => :'BigDecimal',
+        :'total_amount_neg' => :'BigDecimal'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Finance::StatementLinesResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Finance::StatementLinesResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'unreconciled_amount_pos')
+        self.unreconciled_amount_pos = attributes[:'unreconciled_amount_pos']
+      end
+
+      if attributes.key?(:'unreconciled_amount_neg')
+        self.unreconciled_amount_neg = attributes[:'unreconciled_amount_neg']
+      end
+
+      if attributes.key?(:'unreconciled_lines')
+        self.unreconciled_lines = attributes[:'unreconciled_lines']
+      end
+
+      if attributes.key?(:'avg_days_unreconciled_pos')
+        self.avg_days_unreconciled_pos = attributes[:'avg_days_unreconciled_pos']
+      end
+
+      if attributes.key?(:'avg_days_unreconciled_neg')
+        self.avg_days_unreconciled_neg = attributes[:'avg_days_unreconciled_neg']
+      end
+
+      if attributes.key?(:'earliest_unreconciled_transaction')
+        self.earliest_unreconciled_transaction = attributes[:'earliest_unreconciled_transaction']
+      end
+
+      if attributes.key?(:'latest_unreconciled_transaction')
+        self.latest_unreconciled_transaction = attributes[:'latest_unreconciled_transaction']
+      end
+
+      if attributes.key?(:'deleted_amount')
+        self.deleted_amount = attributes[:'deleted_amount']
+      end
+
+      if attributes.key?(:'total_amount')
+        self.total_amount = attributes[:'total_amount']
+      end
+
+      if attributes.key?(:'data_source')
+        self.data_source = attributes[:'data_source']
+      end
+
+      if attributes.key?(:'earliest_reconciled_transaction')
+        self.earliest_reconciled_transaction = attributes[:'earliest_reconciled_transaction']
+      end
+
+      if attributes.key?(:'latest_reconciled_transaction')
+        self.latest_reconciled_transaction = attributes[:'latest_reconciled_transaction']
+      end
+
+      if attributes.key?(:'reconciled_amount_pos')
+        self.reconciled_amount_pos = attributes[:'reconciled_amount_pos']
+      end
+
+      if attributes.key?(:'reconciled_amount_neg')
+        self.reconciled_amount_neg = attributes[:'reconciled_amount_neg']
+      end
+
+      if attributes.key?(:'reconciled_lines')
+        self.reconciled_lines = attributes[:'reconciled_lines']
+      end
+
+      if attributes.key?(:'total_amount_pos')
+        self.total_amount_pos = attributes[:'total_amount_pos']
+      end
+
+      if attributes.key?(:'total_amount_neg')
+        self.total_amount_neg = attributes[:'total_amount_neg']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          unreconciled_amount_pos == o.unreconciled_amount_pos &&
+          unreconciled_amount_neg == o.unreconciled_amount_neg &&
+          unreconciled_lines == o.unreconciled_lines &&
+          avg_days_unreconciled_pos == o.avg_days_unreconciled_pos &&
+          avg_days_unreconciled_neg == o.avg_days_unreconciled_neg &&
+          earliest_unreconciled_transaction == o.earliest_unreconciled_transaction &&
+          latest_unreconciled_transaction == o.latest_unreconciled_transaction &&
+          deleted_amount == o.deleted_amount &&
+          total_amount == o.total_amount &&
+          data_source == o.data_source &&
+          earliest_reconciled_transaction == o.earliest_reconciled_transaction &&
+          latest_reconciled_transaction == o.latest_reconciled_transaction &&
+          reconciled_amount_pos == o.reconciled_amount_pos &&
+          reconciled_amount_neg == o.reconciled_amount_neg &&
+          reconciled_lines == o.reconciled_lines &&
+          total_amount_pos == o.total_amount_pos &&
+          total_amount_neg == o.total_amount_neg
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [unreconciled_amount_pos, unreconciled_amount_neg, unreconciled_lines, avg_days_unreconciled_pos, avg_days_unreconciled_neg, earliest_unreconciled_transaction, latest_unreconciled_transaction, deleted_amount, total_amount, data_source, earliest_reconciled_transaction, latest_reconciled_transaction, reconciled_amount_pos, reconciled_amount_neg, reconciled_lines, total_amount_pos, total_amount_neg].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(parse_date(value))
+      when :Date
+        Date.parse(parse_date(value))
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        XeroRuby::Finance.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash(downcase: false)
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
+      end
+      hash
+    end
+
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value, downcase: false)
+      if value.is_a?(Array)
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(downcase: downcase)
+      else
+        value
+      end
+    end
+
+    def parse_date(datestring)
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
+    end
+  end
+end