xero-ruby 3.9.0 → 7.0.0

data/lib/xero-ruby/models/payroll_au/leave_line_calculation_type.rb

@@ -18,7 +18,6 @@ module XeroRuby::PayrollAu
     FIXEDAMOUNTEACHPERIOD ||= "FIXEDAMOUNTEACHPERIOD".freeze
     ENTERRATEINPAYTEMPLATE ||= "ENTERRATEINPAYTEMPLATE".freeze
     BASEDONORDINARYEARNINGS ||= "BASEDONORDINARYEARNINGS".freeze
-    EMPTY ||= "".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/xero-ruby/models/payroll_au/leave_period_status.rb

@@ -16,6 +16,8 @@ module XeroRuby::PayrollAu
   class LeavePeriodStatus
     SCHEDULED ||= "SCHEDULED".freeze
     PROCESSED ||= "PROCESSED".freeze
+    REQUESTED ||= "REQUESTED".freeze
+    REJECTED ||= "REJECTED".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

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

@@ -43,6 +43,12 @@ module XeroRuby::PayrollAu
     # Is the current record
     attr_accessor :current_record
     
+
+    attr_accessor :leave_category_code
+    
+    # Set this to indicate that the leave type is exempt from superannuation guarantee contribution
+    attr_accessor :sgc_exempt
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -54,7 +60,9 @@ module XeroRuby::PayrollAu
         :'updated_date_utc' => :'UpdatedDateUTC',
         :'is_paid_leave' => :'IsPaidLeave',
         :'show_on_payslip' => :'ShowOnPayslip',
-        :'current_record' => :'CurrentRecord'
+        :'current_record' => :'CurrentRecord',
+        :'leave_category_code' => :'LeaveCategoryCode',
+        :'sgc_exempt' => :'SGCExempt'
       }
     end
 
@@ -69,7 +77,9 @@ module XeroRuby::PayrollAu
         :'updated_date_utc' => :'DateTime',
         :'is_paid_leave' => :'Boolean',
         :'show_on_payslip' => :'Boolean',
-        :'current_record' => :'Boolean'
+        :'current_record' => :'Boolean',
+        :'leave_category_code' => :'LeaveCategoryCode',
+        :'sgc_exempt' => :'Boolean'
       }
     end
 
@@ -123,6 +133,14 @@ module XeroRuby::PayrollAu
       if attributes.key?(:'current_record')
         self.current_record = attributes[:'current_record']
       end
+
+      if attributes.key?(:'leave_category_code')
+        self.leave_category_code = attributes[:'leave_category_code']
+      end
+
+      if attributes.key?(:'sgc_exempt')
+        self.sgc_exempt = attributes[:'sgc_exempt']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -166,7 +184,9 @@ module XeroRuby::PayrollAu
           updated_date_utc == o.updated_date_utc &&
           is_paid_leave == o.is_paid_leave &&
           show_on_payslip == o.show_on_payslip &&
-          current_record == o.current_record
+          current_record == o.current_record &&
+          leave_category_code == o.leave_category_code &&
+          sgc_exempt == o.sgc_exempt
     end
 
     # @see the `==` method
@@ -178,7 +198,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, type_of_units, leave_type_id, normal_entitlement, leave_loading_rate, updated_date_utc, is_paid_leave, show_on_payslip, current_record].hash
+      [name, type_of_units, leave_type_id, normal_entitlement, leave_loading_rate, updated_date_utc, is_paid_leave, show_on_payslip, current_record, leave_category_code, sgc_exempt].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/opening_balances.rb

@@ -37,6 +37,9 @@ module XeroRuby::PayrollAu
 
     attr_accessor :leave_lines
     
+
+    attr_accessor :paid_leave_earnings_lines
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +49,8 @@ module XeroRuby::PayrollAu
         :'deduction_lines' => :'DeductionLines',
         :'super_lines' => :'SuperLines',
         :'reimbursement_lines' => :'ReimbursementLines',
-        :'leave_lines' => :'LeaveLines'
+        :'leave_lines' => :'LeaveLines',
+        :'paid_leave_earnings_lines' => :'PaidLeaveEarningsLines'
       }
     end
 
@@ -59,7 +63,8 @@ module XeroRuby::PayrollAu
         :'deduction_lines' => :'Array<DeductionLine>',
         :'super_lines' => :'Array<SuperLine>',
         :'reimbursement_lines' => :'Array<ReimbursementLine>',
-        :'leave_lines' => :'Array<LeaveLine>'
+        :'leave_lines' => :'Array<LeaveLine>',
+        :'paid_leave_earnings_lines' => :'Array<PaidLeaveEarningsLine>'
       }
     end
 
@@ -115,6 +120,12 @@ module XeroRuby::PayrollAu
           self.leave_lines = value
         end
       end
+
+      if attributes.key?(:'paid_leave_earnings_lines')
+        if (value = attributes[:'paid_leave_earnings_lines']).is_a?(Array)
+          self.paid_leave_earnings_lines = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -141,7 +152,8 @@ module XeroRuby::PayrollAu
           deduction_lines == o.deduction_lines &&
           super_lines == o.super_lines &&
           reimbursement_lines == o.reimbursement_lines &&
-          leave_lines == o.leave_lines
+          leave_lines == o.leave_lines &&
+          paid_leave_earnings_lines == o.paid_leave_earnings_lines
     end
 
     # @see the `==` method
@@ -153,7 +165,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [opening_balance_date, tax, earnings_lines, deduction_lines, super_lines, reimbursement_lines, leave_lines].hash
+      [opening_balance_date, tax, earnings_lines, deduction_lines, super_lines, reimbursement_lines, leave_lines, paid_leave_earnings_lines].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/paid_leave_earnings_line.rb

@@ -0,0 +1,272 @@
+=begin
+#Xero Payroll AU API
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollAu
+  require 'bigdecimal'
+
+  class PaidLeaveEarningsLine
+    # Xero leave type identifier
+    attr_accessor :leave_type_id
+    
+    # Paid leave amount
+    attr_accessor :amount
+    
+    # The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories
+    attr_accessor :sgc_applied_leave_loading_amount
+    
+    # The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories
+    attr_accessor :sgc_exempted_leave_loading_amount
+    
+    # Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories
+    attr_accessor :reset_stp_categorisation
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'leave_type_id' => :'LeaveTypeID',
+        :'amount' => :'Amount',
+        :'sgc_applied_leave_loading_amount' => :'SGCAppliedLeaveLoadingAmount',
+        :'sgc_exempted_leave_loading_amount' => :'SGCExemptedLeaveLoadingAmount',
+        :'reset_stp_categorisation' => :'ResetSTPCategorisation'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'leave_type_id' => :'String',
+        :'amount' => :'BigDecimal',
+        :'sgc_applied_leave_loading_amount' => :'BigDecimal',
+        :'sgc_exempted_leave_loading_amount' => :'BigDecimal',
+        :'reset_stp_categorisation' => :'Boolean'
+      }
+    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::PayrollAu::PaidLeaveEarningsLine` 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::PayrollAu::PaidLeaveEarningsLine`. 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?(:'leave_type_id')
+        self.leave_type_id = attributes[:'leave_type_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'sgc_applied_leave_loading_amount')
+        self.sgc_applied_leave_loading_amount = attributes[:'sgc_applied_leave_loading_amount']
+      end
+
+      if attributes.key?(:'sgc_exempted_leave_loading_amount')
+        self.sgc_exempted_leave_loading_amount = attributes[:'sgc_exempted_leave_loading_amount']
+      end
+
+      if attributes.key?(:'reset_stp_categorisation')
+        self.reset_stp_categorisation = attributes[:'reset_stp_categorisation']
+      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 @leave_type_id.nil?
+        invalid_properties.push('invalid value for "leave_type_id", leave_type_id cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount 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 @leave_type_id.nil?
+      return false if @amount.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 &&
+          leave_type_id == o.leave_type_id &&
+          amount == o.amount &&
+          sgc_applied_leave_loading_amount == o.sgc_applied_leave_loading_amount &&
+          sgc_exempted_leave_loading_amount == o.sgc_exempted_leave_loading_amount &&
+          reset_stp_categorisation == o.reset_stp_categorisation
+    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
+      [leave_type_id, amount, sgc_applied_leave_loading_amount, sgc_exempted_leave_loading_amount, reset_stp_categorisation].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::PayrollAu.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_au/pay_out_type.rb

@@ -0,0 +1,36 @@
+=begin
+#Xero Payroll AU API
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollAu
+  class PayOutType
+    DEFAULT ||= "DEFAULT".freeze
+    CASHED_OUT ||= "CASHED_OUT".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = PayOutType.constants.select { |c| PayOutType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #PayOutType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/xero-ruby/models/payroll_au/senior_marital_status.rb

@@ -0,0 +1,37 @@
+=begin
+#Xero Payroll AU API
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollAu
+  class SeniorMaritalStatus
+    MEMBEROFCOUPLE ||= "MEMBEROFCOUPLE".freeze
+    MEMBEROFILLNESSSEPARATEDCOUPLE ||= "MEMBEROFILLNESSSEPARATEDCOUPLE".freeze
+    SINGLE ||= "SINGLE".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = SeniorMaritalStatus.constants.select { |c| SeniorMaritalStatus::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #SeniorMaritalStatus" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/xero-ruby/models/payroll_au/settings.rb

@@ -25,12 +25,16 @@ module XeroRuby::PayrollAu
     # Number of days in the Payroll year
     attr_accessor :days_in_payroll_year
     
+    # Indicates if the organisation has been enabled for STP Phase 2 editing of employees.
+    attr_accessor :employees_are_stp2
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'accounts' => :'Accounts',
         :'tracking_categories' => :'TrackingCategories',
-        :'days_in_payroll_year' => :'DaysInPayrollYear'
+        :'days_in_payroll_year' => :'DaysInPayrollYear',
+        :'employees_are_stp2' => :'EmployeesAreSTP2'
       }
     end
 
@@ -39,7 +43,8 @@ module XeroRuby::PayrollAu
       {
         :'accounts' => :'Array<Account>',
         :'tracking_categories' => :'SettingsTrackingCategories',
-        :'days_in_payroll_year' => :'Integer'
+        :'days_in_payroll_year' => :'Integer',
+        :'employees_are_stp2' => :'Boolean'
       }
     end
 
@@ -71,6 +76,10 @@ module XeroRuby::PayrollAu
       if attributes.key?(:'days_in_payroll_year')
         self.days_in_payroll_year = attributes[:'days_in_payroll_year']
       end
+
+      if attributes.key?(:'employees_are_stp2')
+        self.employees_are_stp2 = attributes[:'employees_are_stp2']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,7 +102,8 @@ module XeroRuby::PayrollAu
       self.class == o.class &&
           accounts == o.accounts &&
           tracking_categories == o.tracking_categories &&
-          days_in_payroll_year == o.days_in_payroll_year
+          days_in_payroll_year == o.days_in_payroll_year &&
+          employees_are_stp2 == o.employees_are_stp2
     end
 
     # @see the `==` method
@@ -105,7 +115,7 @@ module XeroRuby::PayrollAu
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [accounts, tracking_categories, days_in_payroll_year].hash
+      [accounts, tracking_categories, days_in_payroll_year, employees_are_stp2].hash
     end
 
     # Builds the object from hash