xero-ruby 3.6.0 → 3.8.0

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

@@ -0,0 +1,274 @@
+=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 StatementResponse
+    # Xero Identifier of statement
+    attr_accessor :statement_id
+    
+    # Start date of statement
+    attr_accessor :start_date
+    
+    # End date of statement
+    attr_accessor :end_date
+    
+    # Utc date time of when the statement was imported in Xero
+    attr_accessor :imported_date_time_utc
+    
+    # Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi)
+    attr_accessor :import_source
+    
+    # List of statement lines
+    attr_accessor :statement_lines
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'statement_id' => :'statementId',
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate',
+        :'imported_date_time_utc' => :'importedDateTimeUtc',
+        :'import_source' => :'importSource',
+        :'statement_lines' => :'statementLines'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'statement_id' => :'String',
+        :'start_date' => :'Date',
+        :'end_date' => :'Date',
+        :'imported_date_time_utc' => :'DateTime',
+        :'import_source' => :'String',
+        :'statement_lines' => :'Array<StatementLineResponse>'
+      }
+    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::StatementResponse` 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::StatementResponse`. 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_id')
+        self.statement_id = attributes[:'statement_id']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'imported_date_time_utc')
+        self.imported_date_time_utc = attributes[:'imported_date_time_utc']
+      end
+
+      if attributes.key?(:'import_source')
+        self.import_source = attributes[:'import_source']
+      end
+
+      if attributes.key?(:'statement_lines')
+        if (value = attributes[:'statement_lines']).is_a?(Array)
+          self.statement_lines = 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_id == o.statement_id &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          imported_date_time_utc == o.imported_date_time_utc &&
+          import_source == o.import_source &&
+          statement_lines == o.statement_lines
+    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_id, start_date, end_date, imported_date_time_utc, import_source, statement_lines].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/payroll_uk/employee.rb

@@ -63,6 +63,9 @@ module XeroRuby::PayrollUk
     # National insurance number of the employee
     attr_accessor :national_insurance_number
     
+    # Whether the employee is an off payroll worker
+    attr_accessor :is_off_payroll_worker
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -102,7 +105,8 @@ module XeroRuby::PayrollUk
         :'payroll_calendar_id' => :'payrollCalendarID',
         :'updated_date_utc' => :'updatedDateUTC',
         :'created_date_utc' => :'createdDateUTC',
-        :'national_insurance_number' => :'nationalInsuranceNumber'
+        :'national_insurance_number' => :'nationalInsuranceNumber',
+        :'is_off_payroll_worker' => :'isOffPayrollWorker'
       }
     end
 
@@ -123,7 +127,8 @@ module XeroRuby::PayrollUk
         :'payroll_calendar_id' => :'String',
         :'updated_date_utc' => :'DateTime',
         :'created_date_utc' => :'DateTime',
-        :'national_insurance_number' => :'String'
+        :'national_insurance_number' => :'String',
+        :'is_off_payroll_worker' => :'Boolean'
       }
     end
 
@@ -201,6 +206,10 @@ module XeroRuby::PayrollUk
       if attributes.key?(:'national_insurance_number')
         self.national_insurance_number = attributes[:'national_insurance_number']
       end
+
+      if attributes.key?(:'is_off_payroll_worker')
+        self.is_off_payroll_worker = attributes[:'is_off_payroll_worker']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -247,7 +256,8 @@ module XeroRuby::PayrollUk
           payroll_calendar_id == o.payroll_calendar_id &&
           updated_date_utc == o.updated_date_utc &&
           created_date_utc == o.created_date_utc &&
-          national_insurance_number == o.national_insurance_number
+          national_insurance_number == o.national_insurance_number &&
+          is_off_payroll_worker == o.is_off_payroll_worker
     end
 
     # @see the `==` method
@@ -259,7 +269,7 @@ module XeroRuby::PayrollUk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [employee_id, title, first_name, last_name, date_of_birth, address, email, gender, phone_number, start_date, end_date, payroll_calendar_id, updated_date_utc, created_date_utc, national_insurance_number].hash
+      [employee_id, title, first_name, last_name, date_of_birth, address, email, gender, phone_number, start_date, end_date, payroll_calendar_id, updated_date_utc, created_date_utc, national_insurance_number, is_off_payroll_worker].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_uk/employment.rb

@@ -30,11 +30,16 @@ module XeroRuby::PayrollUk
     A ||= "A".freeze
     B ||= "B".freeze
     C ||= "C".freeze
+    F ||= "F".freeze
     H ||= "H".freeze
+    I ||= "I".freeze
     J ||= "J".freeze
+    L ||= "L".freeze
     M ||= "M".freeze
-    Z ||= "Z".freeze
+    S ||= "S".freeze
+    V ||= "V".freeze
     X ||= "X".freeze
+    Z ||= "Z".freeze
     
     class EnumAttributeValidator
       attr_reader :datatype
@@ -120,7 +125,7 @@ module XeroRuby::PayrollUk
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      ni_category_validator = EnumAttributeValidator.new('String', ["A", "B", "C", "H", "J", "M", "Z", "X"])
+      ni_category_validator = EnumAttributeValidator.new('String', ["A", "B", "C", "F", "H", "I", "J", "L", "M", "S", "V", "X", "Z"])
       return false unless ni_category_validator.valid?(@ni_category)
       true
     end
@@ -128,7 +133,7 @@ module XeroRuby::PayrollUk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] ni_category Object to be assigned
     def ni_category=(ni_category)
-      validator = EnumAttributeValidator.new('String', ["A", "B", "C", "H", "J", "M", "Z", "X"])
+      validator = EnumAttributeValidator.new('String', ["A", "B", "C", "F", "H", "I", "J", "L", "M", "S", "V", "X", "Z"])
       unless validator.valid?(ni_category)
         fail ArgumentError, "invalid value for \"ni_category\", must be one of #{validator.allowable_values}."
       end

data/lib/xero-ruby/version.rb

@@ -7,9 +7,9 @@ Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
-The version of the XeroOpenAPI document: 2.17.4
+The version of the XeroOpenAPI document: 2.21.0
 =end
 
 module XeroRuby
-  VERSION = '3.6.0'
+  VERSION = '3.8.0'
 end

data/lib/xero-ruby.rb

@@ -24,7 +24,9 @@ require 'xero-ruby/models/finance/balance_sheet_account_detail'
 require 'xero-ruby/models/finance/balance_sheet_account_group'
 require 'xero-ruby/models/finance/balance_sheet_account_type'
 require 'xero-ruby/models/finance/balance_sheet_response'
+require 'xero-ruby/models/finance/bank_statement_accounting_response'
 require 'xero-ruby/models/finance/bank_statement_response'
+require 'xero-ruby/models/finance/bank_transaction_response'
 require 'xero-ruby/models/finance/cash_account_response'
 require 'xero-ruby/models/finance/cash_balance'
 require 'xero-ruby/models/finance/cash_validation_response'
@@ -33,26 +35,35 @@ require 'xero-ruby/models/finance/cashflow_activity'
 require 'xero-ruby/models/finance/cashflow_response'
 require 'xero-ruby/models/finance/cashflow_type'
 require 'xero-ruby/models/finance/contact_detail'
+require 'xero-ruby/models/finance/contact_response'
 require 'xero-ruby/models/finance/contact_total_detail'
 require 'xero-ruby/models/finance/contact_total_other'
+require 'xero-ruby/models/finance/credit_note_response'
 require 'xero-ruby/models/finance/current_statement_response'
 require 'xero-ruby/models/finance/data_source_response'
 require 'xero-ruby/models/finance/history_record_response'
 require 'xero-ruby/models/finance/income_by_contact_response'
+require 'xero-ruby/models/finance/invoice_response'
+require 'xero-ruby/models/finance/line_item_response'
 require 'xero-ruby/models/finance/lock_history_model'
 require 'xero-ruby/models/finance/lock_history_response'
 require 'xero-ruby/models/finance/manual_journal_total'
+require 'xero-ruby/models/finance/overpayment_response'
+require 'xero-ruby/models/finance/payment_response'
 require 'xero-ruby/models/finance/pnl_account'
 require 'xero-ruby/models/finance/pnl_account_class'
 require 'xero-ruby/models/finance/pnl_account_type'
 require 'xero-ruby/models/finance/practice_response'
+require 'xero-ruby/models/finance/prepayment_response'
 require 'xero-ruby/models/finance/problem'
 require 'xero-ruby/models/finance/problem_type'
 require 'xero-ruby/models/finance/profit_and_loss_response'
 require 'xero-ruby/models/finance/report_history_model'
 require 'xero-ruby/models/finance/report_history_response'
 require 'xero-ruby/models/finance/statement_balance_response'
+require 'xero-ruby/models/finance/statement_line_response'
 require 'xero-ruby/models/finance/statement_lines_response'
+require 'xero-ruby/models/finance/statement_response'
 require 'xero-ruby/models/finance/total_detail'
 require 'xero-ruby/models/finance/total_other'
 require 'xero-ruby/models/finance/trial_balance_account'
@@ -444,6 +455,7 @@ require 'xero-ruby/models/accounting/journal_line'
 require 'xero-ruby/models/accounting/journals'
 require 'xero-ruby/models/accounting/line_amount_types'
 require 'xero-ruby/models/accounting/line_item'
+require 'xero-ruby/models/accounting/line_item_item'
 require 'xero-ruby/models/accounting/line_item_tracking'
 require 'xero-ruby/models/accounting/linked_transaction'
 require 'xero-ruby/models/accounting/linked_transactions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -181,6 +181,7 @@ files:
 - lib/xero-ruby/models/accounting/journals.rb
 - lib/xero-ruby/models/accounting/line_amount_types.rb
 - lib/xero-ruby/models/accounting/line_item.rb
+- lib/xero-ruby/models/accounting/line_item_item.rb
 - lib/xero-ruby/models/accounting/line_item_tracking.rb
 - lib/xero-ruby/models/accounting/linked_transaction.rb
 - lib/xero-ruby/models/accounting/linked_transactions.rb
@@ -274,7 +275,9 @@ files:
 - lib/xero-ruby/models/finance/balance_sheet_account_group.rb
 - lib/xero-ruby/models/finance/balance_sheet_account_type.rb
 - lib/xero-ruby/models/finance/balance_sheet_response.rb
+- lib/xero-ruby/models/finance/bank_statement_accounting_response.rb
 - lib/xero-ruby/models/finance/bank_statement_response.rb
+- lib/xero-ruby/models/finance/bank_transaction_response.rb
 - lib/xero-ruby/models/finance/cash_account_response.rb
 - lib/xero-ruby/models/finance/cash_balance.rb
 - lib/xero-ruby/models/finance/cash_validation_response.rb
@@ -283,26 +286,35 @@ files:
 - lib/xero-ruby/models/finance/cashflow_response.rb
 - lib/xero-ruby/models/finance/cashflow_type.rb
 - lib/xero-ruby/models/finance/contact_detail.rb
+- lib/xero-ruby/models/finance/contact_response.rb
 - lib/xero-ruby/models/finance/contact_total_detail.rb
 - lib/xero-ruby/models/finance/contact_total_other.rb
+- lib/xero-ruby/models/finance/credit_note_response.rb
 - lib/xero-ruby/models/finance/current_statement_response.rb
 - lib/xero-ruby/models/finance/data_source_response.rb
 - lib/xero-ruby/models/finance/history_record_response.rb
 - lib/xero-ruby/models/finance/income_by_contact_response.rb
+- lib/xero-ruby/models/finance/invoice_response.rb
+- lib/xero-ruby/models/finance/line_item_response.rb
 - lib/xero-ruby/models/finance/lock_history_model.rb
 - lib/xero-ruby/models/finance/lock_history_response.rb
 - lib/xero-ruby/models/finance/manual_journal_total.rb
+- lib/xero-ruby/models/finance/overpayment_response.rb
+- lib/xero-ruby/models/finance/payment_response.rb
 - lib/xero-ruby/models/finance/pnl_account.rb
 - lib/xero-ruby/models/finance/pnl_account_class.rb
 - lib/xero-ruby/models/finance/pnl_account_type.rb
 - lib/xero-ruby/models/finance/practice_response.rb
+- lib/xero-ruby/models/finance/prepayment_response.rb
 - lib/xero-ruby/models/finance/problem.rb
 - lib/xero-ruby/models/finance/problem_type.rb
 - lib/xero-ruby/models/finance/profit_and_loss_response.rb
 - lib/xero-ruby/models/finance/report_history_model.rb
 - lib/xero-ruby/models/finance/report_history_response.rb
 - lib/xero-ruby/models/finance/statement_balance_response.rb
+- lib/xero-ruby/models/finance/statement_line_response.rb
 - lib/xero-ruby/models/finance/statement_lines_response.rb
+- lib/xero-ruby/models/finance/statement_response.rb
 - lib/xero-ruby/models/finance/total_detail.rb
 - lib/xero-ruby/models/finance/total_other.rb
 - lib/xero-ruby/models/finance/trial_balance_account.rb