xero-ruby 3.16.0 → 10.0.0

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

@@ -0,0 +1,244 @@
+=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 EmployeeWorkingPatternsObject
+
+    attr_accessor :pagination
+    
+
+    attr_accessor :problem
+    
+
+    attr_accessor :payee_working_patterns
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pagination' => :'pagination',
+        :'problem' => :'problem',
+        :'payee_working_patterns' => :'payeeWorkingPatterns'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pagination' => :'Pagination',
+        :'problem' => :'Problem',
+        :'payee_working_patterns' => :'Array<EmployeeWorkingPattern>'
+      }
+    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::EmployeeWorkingPatternsObject` 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::EmployeeWorkingPatternsObject`. 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?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      end
+
+      if attributes.key?(:'problem')
+        self.problem = attributes[:'problem']
+      end
+
+      if attributes.key?(:'payee_working_patterns')
+        if (value = attributes[:'payee_working_patterns']).is_a?(Array)
+          self.payee_working_patterns = 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 &&
+          pagination == o.pagination &&
+          problem == o.problem &&
+          payee_working_patterns == o.payee_working_patterns
+    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
+      [pagination, problem, payee_working_patterns].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/employment.rb

@@ -25,12 +25,20 @@ module XeroRuby::PayrollNz
     # Start date of the employment (YYYY-MM-DD)
     attr_accessor :start_date
     
+    # Engagement type of the employee
+    attr_accessor :engagement_type
+    
+    # End date for an employee with a fixed-term engagement type
+    attr_accessor :fixed_term_end_date
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'payroll_calendar_id' => :'payrollCalendarID',
         :'pay_run_calendar_id' => :'payRunCalendarID',
-        :'start_date' => :'startDate'
+        :'start_date' => :'startDate',
+        :'engagement_type' => :'engagementType',
+        :'fixed_term_end_date' => :'fixedTermEndDate'
       }
     end
 
@@ -39,7 +47,9 @@ module XeroRuby::PayrollNz
       {
         :'payroll_calendar_id' => :'String',
         :'pay_run_calendar_id' => :'String',
-        :'start_date' => :'Date'
+        :'start_date' => :'Date',
+        :'engagement_type' => :'String',
+        :'fixed_term_end_date' => :'Date'
       }
     end
 
@@ -69,6 +79,14 @@ module XeroRuby::PayrollNz
       if attributes.key?(:'start_date')
         self.start_date = attributes[:'start_date']
       end
+
+      if attributes.key?(:'engagement_type')
+        self.engagement_type = attributes[:'engagement_type']
+      end
+
+      if attributes.key?(:'fixed_term_end_date')
+        self.fixed_term_end_date = attributes[:'fixed_term_end_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,7 +109,9 @@ module XeroRuby::PayrollNz
       self.class == o.class &&
           payroll_calendar_id == o.payroll_calendar_id &&
           pay_run_calendar_id == o.pay_run_calendar_id &&
-          start_date == o.start_date
+          start_date == o.start_date &&
+          engagement_type == o.engagement_type &&
+          fixed_term_end_date == o.fixed_term_end_date
     end
 
     # @see the `==` method
@@ -103,7 +123,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [payroll_calendar_id, pay_run_calendar_id, start_date].hash
+      [payroll_calendar_id, pay_run_calendar_id, start_date, engagement_type, fixed_term_end_date].hash
     end
 
     # Builds the object from hash

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

@@ -25,10 +25,20 @@ module XeroRuby::PayrollNz
     # The Number of Units for the leave
     attr_accessor :number_of_units
     
-    # Period Status
+    # The number of units taken for the leave
+    attr_accessor :number_of_units_taken
+    
+    # The type of units paid for the leave
+    attr_accessor :type_of_units
+    
+    # The type of units taken for the leave
+    attr_accessor :type_of_units_taken
+    
+    # Status of leave
     attr_accessor :period_status
     APPROVED ||= "Approved".freeze
     COMPLETED ||= "Completed".freeze
+    ESTIMATED ||= "Estimated".freeze
     
     class EnumAttributeValidator
       attr_reader :datatype
@@ -58,6 +68,9 @@ module XeroRuby::PayrollNz
         :'period_start_date' => :'periodStartDate',
         :'period_end_date' => :'periodEndDate',
         :'number_of_units' => :'numberOfUnits',
+        :'number_of_units_taken' => :'numberOfUnitsTaken',
+        :'type_of_units' => :'typeOfUnits',
+        :'type_of_units_taken' => :'typeOfUnitsTaken',
         :'period_status' => :'periodStatus'
       }
     end
@@ -68,6 +81,9 @@ module XeroRuby::PayrollNz
         :'period_start_date' => :'Date',
         :'period_end_date' => :'Date',
         :'number_of_units' => :'BigDecimal',
+        :'number_of_units_taken' => :'Float',
+        :'type_of_units' => :'String',
+        :'type_of_units_taken' => :'String',
         :'period_status' => :'String'
       }
     end
@@ -99,6 +115,18 @@ module XeroRuby::PayrollNz
         self.number_of_units = attributes[:'number_of_units']
       end
 
+      if attributes.key?(:'number_of_units_taken')
+        self.number_of_units_taken = attributes[:'number_of_units_taken']
+      end
+
+      if attributes.key?(:'type_of_units')
+        self.type_of_units = attributes[:'type_of_units']
+      end
+
+      if attributes.key?(:'type_of_units_taken')
+        self.type_of_units_taken = attributes[:'type_of_units_taken']
+      end
+
       if attributes.key?(:'period_status')
         self.period_status = attributes[:'period_status']
       end
@@ -114,7 +142,7 @@ module XeroRuby::PayrollNz
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      period_status_validator = EnumAttributeValidator.new('String', ["Approved", "Completed"])
+      period_status_validator = EnumAttributeValidator.new('String', ["Approved", "Completed", "Estimated"])
       return false unless period_status_validator.valid?(@period_status)
       true
     end
@@ -122,7 +150,7 @@ module XeroRuby::PayrollNz
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] period_status Object to be assigned
     def period_status=(period_status)
-      validator = EnumAttributeValidator.new('String', ["Approved", "Completed"])
+      validator = EnumAttributeValidator.new('String', ["Approved", "Completed", "Estimated"])
       unless validator.valid?(period_status)
         fail ArgumentError, "invalid value for \"period_status\", must be one of #{validator.allowable_values}."
       end
@@ -137,6 +165,9 @@ module XeroRuby::PayrollNz
           period_start_date == o.period_start_date &&
           period_end_date == o.period_end_date &&
           number_of_units == o.number_of_units &&
+          number_of_units_taken == o.number_of_units_taken &&
+          type_of_units == o.type_of_units &&
+          type_of_units_taken == o.type_of_units_taken &&
           period_status == o.period_status
     end
 
@@ -149,7 +180,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [period_start_date, period_end_date, number_of_units, period_status].hash
+      [period_start_date, period_end_date, number_of_units, number_of_units_taken, type_of_units, type_of_units_taken, period_status].hash
     end
 
     # Builds the object from hash

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

@@ -34,6 +34,12 @@ module XeroRuby::PayrollNz
     # Shows whether the leave type is active or not
     attr_accessor :is_active
     
+    # The type of units to be paid for the leave type
+    attr_accessor :type_of_units
+    
+    # The type of units to be accrued for the leave type
+    attr_accessor :type_of_units_to_accrue
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -42,7 +48,9 @@ module XeroRuby::PayrollNz
         :'is_paid_leave' => :'isPaidLeave',
         :'show_on_payslip' => :'showOnPayslip',
         :'updated_date_utc' => :'updatedDateUTC',
-        :'is_active' => :'isActive'
+        :'is_active' => :'isActive',
+        :'type_of_units' => :'typeOfUnits',
+        :'type_of_units_to_accrue' => :'typeOfUnitsToAccrue'
       }
     end
 
@@ -54,7 +62,9 @@ module XeroRuby::PayrollNz
         :'is_paid_leave' => :'Boolean',
         :'show_on_payslip' => :'Boolean',
         :'updated_date_utc' => :'DateTime',
-        :'is_active' => :'Boolean'
+        :'is_active' => :'Boolean',
+        :'type_of_units' => :'String',
+        :'type_of_units_to_accrue' => :'String'
       }
     end
 
@@ -96,6 +106,14 @@ module XeroRuby::PayrollNz
       if attributes.key?(:'is_active')
         self.is_active = attributes[:'is_active']
       end
+
+      if attributes.key?(:'type_of_units')
+        self.type_of_units = attributes[:'type_of_units']
+      end
+
+      if attributes.key?(:'type_of_units_to_accrue')
+        self.type_of_units_to_accrue = attributes[:'type_of_units_to_accrue']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -136,7 +154,9 @@ module XeroRuby::PayrollNz
           is_paid_leave == o.is_paid_leave &&
           show_on_payslip == o.show_on_payslip &&
           updated_date_utc == o.updated_date_utc &&
-          is_active == o.is_active
+          is_active == o.is_active &&
+          type_of_units == o.type_of_units &&
+          type_of_units_to_accrue == o.type_of_units_to_accrue
     end
 
     # @see the `==` method
@@ -148,7 +168,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [leave_type_id, name, is_paid_leave, show_on_payslip, updated_date_utc, is_active].hash
+      [leave_type_id, name, is_paid_leave, show_on_payslip, updated_date_utc, is_active, type_of_units, type_of_units_to_accrue].hash
     end
 
     # Builds the object from hash

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

@@ -51,6 +51,11 @@ module XeroRuby::PayrollNz
     SALARY ||= "Salary".freeze
     HOURLY ||= "Hourly".freeze
     
+    # The type of the Working Pattern of the corresponding salary and wages
+    attr_accessor :work_pattern_type
+    DAYS_AND_HOURS ||= "DaysAndHours".freeze
+    REGULAR_WEEK ||= "RegularWeek".freeze
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -85,7 +90,8 @@ module XeroRuby::PayrollNz
         :'effective_from' => :'effectiveFrom',
         :'annual_salary' => :'annualSalary',
         :'status' => :'status',
-        :'payment_type' => :'paymentType'
+        :'payment_type' => :'paymentType',
+        :'work_pattern_type' => :'workPatternType'
       }
     end
 
@@ -101,7 +107,8 @@ module XeroRuby::PayrollNz
         :'effective_from' => :'Date',
         :'annual_salary' => :'BigDecimal',
         :'status' => :'String',
-        :'payment_type' => :'String'
+        :'payment_type' => :'String',
+        :'work_pattern_type' => :'String'
       }
     end
 
@@ -159,6 +166,10 @@ module XeroRuby::PayrollNz
       if attributes.key?(:'payment_type')
         self.payment_type = attributes[:'payment_type']
       end
+
+      if attributes.key?(:'work_pattern_type')
+        self.work_pattern_type = attributes[:'work_pattern_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -210,6 +221,8 @@ module XeroRuby::PayrollNz
       return false if @payment_type.nil?
       payment_type_validator = EnumAttributeValidator.new('String', ["Salary", "Hourly"])
       return false unless payment_type_validator.valid?(@payment_type)
+      work_pattern_type_validator = EnumAttributeValidator.new('String', ["DaysAndHours", "RegularWeek"])
+      return false unless work_pattern_type_validator.valid?(@work_pattern_type)
       true
     end
 
@@ -233,6 +246,16 @@ module XeroRuby::PayrollNz
       @payment_type = payment_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] work_pattern_type Object to be assigned
+    def work_pattern_type=(work_pattern_type)
+      validator = EnumAttributeValidator.new('String', ["DaysAndHours", "RegularWeek"])
+      unless validator.valid?(work_pattern_type)
+        fail ArgumentError, "invalid value for \"work_pattern_type\", must be one of #{validator.allowable_values}."
+      end
+      @work_pattern_type = work_pattern_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -247,7 +270,8 @@ module XeroRuby::PayrollNz
           effective_from == o.effective_from &&
           annual_salary == o.annual_salary &&
           status == o.status &&
-          payment_type == o.payment_type
+          payment_type == o.payment_type &&
+          work_pattern_type == o.work_pattern_type
     end
 
     # @see the `==` method
@@ -259,7 +283,7 @@ module XeroRuby::PayrollNz
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [salary_and_wages_id, earnings_rate_id, number_of_units_per_week, rate_per_unit, number_of_units_per_day, days_per_week, effective_from, annual_salary, status, payment_type].hash
+      [salary_and_wages_id, earnings_rate_id, number_of_units_per_week, rate_per_unit, number_of_units_per_day, days_per_week, effective_from, annual_salary, status, payment_type, work_pattern_type].hash
     end
 
     # Builds the object from hash