xero-ruby 3.4.0 → 3.7.0

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

@@ -0,0 +1,346 @@
+=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 StatementLineResponse
+    # Xero Identifier of statement line
+    attr_accessor :statement_line_id
+    
+    # Date of when statement line was posted
+    attr_accessor :posted_date
+    
+    # Reference description of statement line
+    attr_accessor :reference
+    
+    # Notes description of statement line
+    attr_accessor :notes
+    
+    # Cheque number of statement line
+    attr_accessor :cheque_no
+    
+    # Amount of statement line
+    attr_accessor :amount
+    
+    # Transaction date of statement line
+    attr_accessor :transaction_date
+    
+    # Type of statement line
+    attr_accessor :type
+    
+    # Boolean to show if statement line is reconciled
+    attr_accessor :is_reconciled
+    
+    # Boolean to show if statement line is duplicate
+    attr_accessor :is_duplicate
+    
+    # Boolean to show if statement line is deleted
+    attr_accessor :is_deleted
+    
+    # List of payments associated with reconciled statement lines
+    attr_accessor :payments
+    
+    # List of bank transactions associated with reconciled statement lines
+    attr_accessor :bank_transactions
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'statement_line_id' => :'statementLineId',
+        :'posted_date' => :'postedDate',
+        :'reference' => :'reference',
+        :'notes' => :'notes',
+        :'cheque_no' => :'chequeNo',
+        :'amount' => :'amount',
+        :'transaction_date' => :'transactionDate',
+        :'type' => :'type',
+        :'is_reconciled' => :'isReconciled',
+        :'is_duplicate' => :'isDuplicate',
+        :'is_deleted' => :'isDeleted',
+        :'payments' => :'payments',
+        :'bank_transactions' => :'bankTransactions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'statement_line_id' => :'String',
+        :'posted_date' => :'DateTime',
+        :'reference' => :'String',
+        :'notes' => :'String',
+        :'cheque_no' => :'String',
+        :'amount' => :'BigDecimal',
+        :'transaction_date' => :'DateTime',
+        :'type' => :'String',
+        :'is_reconciled' => :'Boolean',
+        :'is_duplicate' => :'Boolean',
+        :'is_deleted' => :'Boolean',
+        :'payments' => :'Array<PaymentResponse>',
+        :'bank_transactions' => :'Array<BankTransactionResponse>'
+      }
+    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::StatementLineResponse` 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::StatementLineResponse`. 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?(:'statement_line_id')
+        self.statement_line_id = attributes[:'statement_line_id']
+      end
+
+      if attributes.key?(:'posted_date')
+        self.posted_date = attributes[:'posted_date']
+      end
+
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.key?(:'notes')
+        self.notes = attributes[:'notes']
+      end
+
+      if attributes.key?(:'cheque_no')
+        self.cheque_no = attributes[:'cheque_no']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'transaction_date')
+        self.transaction_date = attributes[:'transaction_date']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'is_reconciled')
+        self.is_reconciled = attributes[:'is_reconciled']
+      end
+
+      if attributes.key?(:'is_duplicate')
+        self.is_duplicate = attributes[:'is_duplicate']
+      end
+
+      if attributes.key?(:'is_deleted')
+        self.is_deleted = attributes[:'is_deleted']
+      end
+
+      if attributes.key?(:'payments')
+        if (value = attributes[:'payments']).is_a?(Array)
+          self.payments = value
+        end
+      end
+
+      if attributes.key?(:'bank_transactions')
+        if (value = attributes[:'bank_transactions']).is_a?(Array)
+          self.bank_transactions = value
+        end
+      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 &&
+          statement_line_id == o.statement_line_id &&
+          posted_date == o.posted_date &&
+          reference == o.reference &&
+          notes == o.notes &&
+          cheque_no == o.cheque_no &&
+          amount == o.amount &&
+          transaction_date == o.transaction_date &&
+          type == o.type &&
+          is_reconciled == o.is_reconciled &&
+          is_duplicate == o.is_duplicate &&
+          is_deleted == o.is_deleted &&
+          payments == o.payments &&
+          bank_transactions == o.bank_transactions
+    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
+      [statement_line_id, posted_date, reference, notes, cheque_no, amount, transaction_date, type, is_reconciled, is_duplicate, is_deleted, payments, bank_transactions].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