xero-ruby 3.16.0 → 10.0.0

data/lib/xero-ruby/models/payroll_nz/employee_leave_type.rb

@@ -26,15 +26,24 @@ module XeroRuby::PayrollNz
     PERCENTAGE_OF_GROSS_EARNINGS ||= "PercentageOfGrossEarnings".freeze
     NO_ACCRUALS ||= "NoAccruals".freeze
     
-    # The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\"
+    # Deprecated use UnitsAccruedAnnually
     attr_accessor :hours_accrued_annually
     
-    # The maximum number of hours that can be accrued for the leave
+    # The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"
+    attr_accessor :units_accrued_annually
+    
+    # The type of units accrued for the leave annually
+    attr_accessor :type_of_units_to_accrue
+    
+    # The maximum number of units that can be accrued for the leave
     attr_accessor :maximum_to_accrue
     
-    # The initial number of hours assigned when the leave was added to the employee
+    # The initial number of units assigned when the leave was added to the employee
     attr_accessor :opening_balance
     
+    # The type of units for the opening balance
+    attr_accessor :opening_balance_type_of_units
+    
     # The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"
     attr_accessor :rate_accrued_hourly
     
@@ -50,6 +59,9 @@ module XeroRuby::PayrollNz
     # Specific to Annual Leave. Annual leave balance in dollars
     attr_accessor :annual_leave_total_amount_paid
     
+    # The date when an employee becomes entitled to their accrual.
+    attr_accessor :schedule_of_accrual_date
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -78,13 +90,17 @@ module XeroRuby::PayrollNz
         :'leave_type_id' => :'leaveTypeID',
         :'schedule_of_accrual' => :'scheduleOfAccrual',
         :'hours_accrued_annually' => :'hoursAccruedAnnually',
+        :'units_accrued_annually' => :'UnitsAccruedAnnually',
+        :'type_of_units_to_accrue' => :'typeOfUnitsToAccrue',
         :'maximum_to_accrue' => :'maximumToAccrue',
         :'opening_balance' => :'openingBalance',
+        :'opening_balance_type_of_units' => :'openingBalanceTypeOfUnits',
         :'rate_accrued_hourly' => :'rateAccruedHourly',
         :'percentage_of_gross_earnings' => :'percentageOfGrossEarnings',
         :'include_holiday_pay_every_pay' => :'includeHolidayPayEveryPay',
         :'show_annual_leave_in_advance' => :'showAnnualLeaveInAdvance',
-        :'annual_leave_total_amount_paid' => :'annualLeaveTotalAmountPaid'
+        :'annual_leave_total_amount_paid' => :'annualLeaveTotalAmountPaid',
+        :'schedule_of_accrual_date' => :'scheduleOfAccrualDate'
       }
     end
 
@@ -94,13 +110,17 @@ module XeroRuby::PayrollNz
         :'leave_type_id' => :'String',
         :'schedule_of_accrual' => :'String',
         :'hours_accrued_annually' => :'BigDecimal',
+        :'units_accrued_annually' => :'BigDecimal',
+        :'type_of_units_to_accrue' => :'String',
         :'maximum_to_accrue' => :'BigDecimal',
         :'opening_balance' => :'BigDecimal',
+        :'opening_balance_type_of_units' => :'String',
         :'rate_accrued_hourly' => :'BigDecimal',
         :'percentage_of_gross_earnings' => :'BigDecimal',
         :'include_holiday_pay_every_pay' => :'Boolean',
         :'show_annual_leave_in_advance' => :'Boolean',
-        :'annual_leave_total_amount_paid' => :'BigDecimal'
+        :'annual_leave_total_amount_paid' => :'BigDecimal',
+        :'schedule_of_accrual_date' => :'Date'
       }
     end
 
@@ -131,6 +151,14 @@ module XeroRuby::PayrollNz
         self.hours_accrued_annually = attributes[:'hours_accrued_annually']
       end
 
+      if attributes.key?(:'units_accrued_annually')
+        self.units_accrued_annually = attributes[:'units_accrued_annually']
+      end
+
+      if attributes.key?(:'type_of_units_to_accrue')
+        self.type_of_units_to_accrue = attributes[:'type_of_units_to_accrue']
+      end
+
       if attributes.key?(:'maximum_to_accrue')
         self.maximum_to_accrue = attributes[:'maximum_to_accrue']
       end
@@ -139,6 +167,10 @@ module XeroRuby::PayrollNz
         self.opening_balance = attributes[:'opening_balance']
       end
 
+      if attributes.key?(:'opening_balance_type_of_units')
+        self.opening_balance_type_of_units = attributes[:'opening_balance_type_of_units']
+      end
+
       if attributes.key?(:'rate_accrued_hourly')
         self.rate_accrued_hourly = attributes[:'rate_accrued_hourly']
       end
@@ -158,6 +190,10 @@ module XeroRuby::PayrollNz
       if attributes.key?(:'annual_leave_total_amount_paid')
         self.annual_leave_total_amount_paid = attributes[:'annual_leave_total_amount_paid']
       end
+
+      if attributes.key?(:'schedule_of_accrual_date')
+        self.schedule_of_accrual_date = attributes[:'schedule_of_accrual_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -193,13 +229,17 @@ module XeroRuby::PayrollNz
           leave_type_id == o.leave_type_id &&
           schedule_of_accrual == o.schedule_of_accrual &&
           hours_accrued_annually == o.hours_accrued_annually &&
+          units_accrued_annually == o.units_accrued_annually &&
+          type_of_units_to_accrue == o.type_of_units_to_accrue &&
           maximum_to_accrue == o.maximum_to_accrue &&
           opening_balance == o.opening_balance &&
+          opening_balance_type_of_units == o.opening_balance_type_of_units &&
           rate_accrued_hourly == o.rate_accrued_hourly &&
           percentage_of_gross_earnings == o.percentage_of_gross_earnings &&
           include_holiday_pay_every_pay == o.include_holiday_pay_every_pay &&
           show_annual_leave_in_advance == o.show_annual_leave_in_advance &&
-          annual_leave_total_amount_paid == o.annual_leave_total_amount_paid
+          annual_leave_total_amount_paid == o.annual_leave_total_amount_paid &&
+          schedule_of_accrual_date == o.schedule_of_accrual_date
     end
 
     # @see the `==` method
@@ -211,7 +251,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly, percentage_of_gross_earnings, include_holiday_pay_every_pay, show_annual_leave_in_advance, annual_leave_total_amount_paid].hash
+      [leave_type_id, schedule_of_accrual, hours_accrued_annually, units_accrued_annually, type_of_units_to_accrue, maximum_to_accrue, opening_balance, opening_balance_type_of_units, rate_accrued_hourly, percentage_of_gross_earnings, include_holiday_pay_every_pay, show_annual_leave_in_advance, annual_leave_total_amount_paid, schedule_of_accrual_date].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_nz/employee_working_pattern.rb

@@ -0,0 +1,242 @@
+=begin
+#Xero Payroll NZ
+
+#This is the Xero Payroll API for orgs in the NZ region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollNz
+  require 'bigdecimal'
+
+  class EmployeeWorkingPattern
+    # The Xero identifier for for Employee working pattern
+    attr_accessor :payee_working_pattern_id
+    
+    # The effective date of the corresponding salary and wages
+    attr_accessor :effective_from
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'payee_working_pattern_id' => :'payeeWorkingPatternID',
+        :'effective_from' => :'effectiveFrom'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'payee_working_pattern_id' => :'String',
+        :'effective_from' => :'Date'
+      }
+    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::PayrollNz::EmployeeWorkingPattern` 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::PayrollNz::EmployeeWorkingPattern`. 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?(:'payee_working_pattern_id')
+        self.payee_working_pattern_id = attributes[:'payee_working_pattern_id']
+      end
+
+      if attributes.key?(:'effective_from')
+        self.effective_from = attributes[:'effective_from']
+      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
+      if @payee_working_pattern_id.nil?
+        invalid_properties.push('invalid value for "payee_working_pattern_id", payee_working_pattern_id cannot be nil.')
+      end
+
+      if @effective_from.nil?
+        invalid_properties.push('invalid value for "effective_from", effective_from cannot be nil.')
+      end
+
+      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?
+      return false if @payee_working_pattern_id.nil?
+      return false if @effective_from.nil?
+      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 &&
+          payee_working_pattern_id == o.payee_working_pattern_id &&
+          effective_from == o.effective_from
+    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
+      [payee_working_pattern_id, effective_from].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::PayrollNz.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_nz/employee_working_pattern_with_working_weeks.rb

@@ -0,0 +1,254 @@
+=begin
+#Xero Payroll NZ
+
+#This is the Xero Payroll API for orgs in the NZ region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollNz
+  require 'bigdecimal'
+
+  class EmployeeWorkingPatternWithWorkingWeeks
+    # The Xero identifier for for Employee working pattern
+    attr_accessor :payee_working_pattern_id
+    
+    # The effective date of the corresponding salary and wages
+    attr_accessor :effective_from
+    
+
+    attr_accessor :working_weeks
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'payee_working_pattern_id' => :'payeeWorkingPatternID',
+        :'effective_from' => :'effectiveFrom',
+        :'working_weeks' => :'workingWeeks'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'payee_working_pattern_id' => :'String',
+        :'effective_from' => :'Date',
+        :'working_weeks' => :'Array<WorkingWeek>'
+      }
+    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::PayrollNz::EmployeeWorkingPatternWithWorkingWeeks` 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::PayrollNz::EmployeeWorkingPatternWithWorkingWeeks`. 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?(:'payee_working_pattern_id')
+        self.payee_working_pattern_id = attributes[:'payee_working_pattern_id']
+      end
+
+      if attributes.key?(:'effective_from')
+        self.effective_from = attributes[:'effective_from']
+      end
+
+      if attributes.key?(:'working_weeks')
+        if (value = attributes[:'working_weeks']).is_a?(Array)
+          self.working_weeks = 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
+      if @payee_working_pattern_id.nil?
+        invalid_properties.push('invalid value for "payee_working_pattern_id", payee_working_pattern_id cannot be nil.')
+      end
+
+      if @effective_from.nil?
+        invalid_properties.push('invalid value for "effective_from", effective_from cannot be nil.')
+      end
+
+      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?
+      return false if @payee_working_pattern_id.nil?
+      return false if @effective_from.nil?
+      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 &&
+          payee_working_pattern_id == o.payee_working_pattern_id &&
+          effective_from == o.effective_from &&
+          working_weeks == o.working_weeks
+    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
+      [payee_working_pattern_id, effective_from, working_weeks].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::PayrollNz.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