xero-ruby 9.3.0 → 18.0.0

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

@@ -47,6 +47,9 @@ module XeroRuby::PayrollUk
     TIPS_NON_DIRECT ||= "TipsNonDirect".freeze
     TIPS_DIRECT ||= "TipsDirect".freeze
     TERMINATION_PAY ||= "TerminationPay".freeze
+    STATUTORY_NEONATAL_CARE_PAY ||= "StatutoryNeonatalCarePay".freeze
+    STATUTORY_NEONATAL_CARE_PAY_NON_PENSIONABLE ||= "StatutoryNeonatalCarePayNonPensionable".freeze
+    STATUTORY_BEREAVEMENT_PAY_NORTHERN_IRELAND ||= "StatutoryBereavementPayNorthernIreland".freeze
     
     # Indicates the type of the earning rate
     attr_accessor :rate_type
@@ -214,7 +217,7 @@ module XeroRuby::PayrollUk
     def valid?
       return false if @name.nil?
       return false if @earnings_type.nil?
-      earnings_type_validator = EnumAttributeValidator.new('String', ["Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay"])
+      earnings_type_validator = EnumAttributeValidator.new('String', ["Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable", "StatutoryBereavementPayNorthernIreland"])
       return false unless earnings_type_validator.valid?(@earnings_type)
       return false if @rate_type.nil?
       rate_type_validator = EnumAttributeValidator.new('String', ["RatePerUnit", "MultipleOfOrdinaryEarningsRate", "FixedAmount"])
@@ -227,7 +230,7 @@ module XeroRuby::PayrollUk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] earnings_type Object to be assigned
     def earnings_type=(earnings_type)
-      validator = EnumAttributeValidator.new('String', ["Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay"])
+      validator = EnumAttributeValidator.new('String', ["Allowance", "BackPay", "Bonus", "Commission", "LumpSum", "OtherEarnings", "OvertimeEarnings", "RegularEarnings", "StatutoryAdoptionPay", "StatutoryAdoptionPayNonPensionable", "StatutoryBereavementPay", "StatutoryMaternityPay", "StatutoryMaternityPayNonPensionable", "StatutoryPaternityPay", "StatutoryPaternityPayNonPensionable", "StatutoryParentalBereavementPayNonPensionable", "StatutorySharedParentalPay", "StatutorySharedParentalPayNonPensionable", "StatutorySickPay", "StatutorySickPayNonPensionable", "TipsNonDirect", "TipsDirect", "TerminationPay", "StatutoryNeonatalCarePay", "StatutoryNeonatalCarePayNonPensionable", "StatutoryBereavementPayNorthernIreland"])
       unless validator.valid?(earnings_type)
         fail ArgumentError, "invalid value for \"earnings_type\", must be one of #{validator.allowable_values}."
       end

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

@@ -60,12 +60,21 @@ module XeroRuby::PayrollUk
     # UTC timestamp when the employee was created in Xero
     attr_accessor :created_date_utc
     
+
+    attr_accessor :ni_category
+    
+    # The employee's NI categories
+    attr_accessor :ni_categories
+    
     # 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
     
+    # The employee's contracts
+    attr_accessor :contracts
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -105,8 +114,11 @@ module XeroRuby::PayrollUk
         :'payroll_calendar_id' => :'payrollCalendarID',
         :'updated_date_utc' => :'updatedDateUTC',
         :'created_date_utc' => :'createdDateUTC',
+        :'ni_category' => :'niCategory',
+        :'ni_categories' => :'niCategories',
         :'national_insurance_number' => :'nationalInsuranceNumber',
-        :'is_off_payroll_worker' => :'isOffPayrollWorker'
+        :'is_off_payroll_worker' => :'isOffPayrollWorker',
+        :'contracts' => :'contracts'
       }
     end
 
@@ -127,8 +139,11 @@ module XeroRuby::PayrollUk
         :'payroll_calendar_id' => :'String',
         :'updated_date_utc' => :'DateTime',
         :'created_date_utc' => :'DateTime',
+        :'ni_category' => :'NICategoryLetter',
+        :'ni_categories' => :'Array<NICategory>',
         :'national_insurance_number' => :'String',
-        :'is_off_payroll_worker' => :'Boolean'
+        :'is_off_payroll_worker' => :'Boolean',
+        :'contracts' => :'Array<Contracts>'
       }
     end
 
@@ -203,6 +218,16 @@ module XeroRuby::PayrollUk
         self.created_date_utc = attributes[:'created_date_utc']
       end
 
+      if attributes.key?(:'ni_category')
+        self.ni_category = attributes[:'ni_category']
+      end
+
+      if attributes.key?(:'ni_categories')
+        if (value = attributes[:'ni_categories']).is_a?(Array)
+          self.ni_categories = value
+        end
+      end
+
       if attributes.key?(:'national_insurance_number')
         self.national_insurance_number = attributes[:'national_insurance_number']
       end
@@ -210,18 +235,54 @@ module XeroRuby::PayrollUk
       if attributes.key?(:'is_off_payroll_worker')
         self.is_off_payroll_worker = attributes[:'is_off_payroll_worker']
       end
+
+      if attributes.key?(:'contracts')
+        if (value = attributes[:'contracts']).is_a?(Array)
+          self.contracts = 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 @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
+      end
+
+      if @address.nil?
+        invalid_properties.push('invalid value for "address", address cannot be nil.')
+      end
+
+      if @gender.nil?
+        invalid_properties.push('invalid value for "gender", gender 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 @title.nil?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      return false if @date_of_birth.nil?
+      return false if @address.nil?
+      return false if @gender.nil?
       gender_validator = EnumAttributeValidator.new('String', ["M", "F"])
       return false unless gender_validator.valid?(@gender)
       true
@@ -256,8 +317,11 @@ module XeroRuby::PayrollUk
           payroll_calendar_id == o.payroll_calendar_id &&
           updated_date_utc == o.updated_date_utc &&
           created_date_utc == o.created_date_utc &&
+          ni_category == o.ni_category &&
+          ni_categories == o.ni_categories &&
           national_insurance_number == o.national_insurance_number &&
-          is_off_payroll_worker == o.is_off_payroll_worker
+          is_off_payroll_worker == o.is_off_payroll_worker &&
+          contracts == o.contracts
     end
 
     # @see the `==` method
@@ -269,7 +333,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, is_off_payroll_worker].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, ni_category, ni_categories, national_insurance_number, is_off_payroll_worker, contracts].hash
     end
 
     # Builds the object from hash

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

@@ -68,12 +68,17 @@ module XeroRuby::PayrollUk
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @earning_templates.nil?
+        invalid_properties.push('invalid value for "earning_templates", earning_templates 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 @earning_templates.nil?
       true
     end
 

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

@@ -23,6 +23,8 @@ module XeroRuby::PayrollUk
     MATERNITY ||= "Maternity".freeze
     PATERNITY ||= "Paternity".freeze
     SHAREDPARENTAL ||= "Sharedparental".freeze
+    BEREAVEMENT ||= "Bereavement".freeze
+    NEONATAL_CARE ||= "NeonatalCare".freeze
     
     # The balance remaining for the corresponding leave type as of specified date.
     attr_accessor :balance_remaining
@@ -109,7 +111,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?
-      leave_type_validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental"])
+      leave_type_validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare"])
       return false unless leave_type_validator.valid?(@leave_type)
       units_validator = EnumAttributeValidator.new('String', ["Hours"])
       return false unless units_validator.valid?(@units)
@@ -119,7 +121,7 @@ module XeroRuby::PayrollUk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] leave_type Object to be assigned
     def leave_type=(leave_type)
-      validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental"])
+      validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare"])
       unless validator.valid?(leave_type)
         fail ArgumentError, "invalid value for \"leave_type\", must be one of #{validator.allowable_values}."
       end

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

@@ -29,6 +29,9 @@ module XeroRuby::PayrollUk
     MATERNITY ||= "Maternity".freeze
     PATERNITY ||= "Paternity".freeze
     SHAREDPARENTAL ||= "Sharedparental".freeze
+    BEREAVEMENT ||= "Bereavement".freeze
+    NEONATAL_CARE ||= "NeonatalCare".freeze
+    BEREAVEMENT_NIRE ||= "BereavementNire".freeze
     
     # The date when the leave starts
     attr_accessor :start_date
@@ -147,7 +150,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?
-      type_validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental"])
+      type_validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare", "BereavementNire"])
       return false unless type_validator.valid?(@type)
       status_validator = EnumAttributeValidator.new('String', ["Pending", "In-Progress", "Completed"])
       return false unless status_validator.valid?(@status)
@@ -157,7 +160,7 @@ module XeroRuby::PayrollUk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental"])
+      validator = EnumAttributeValidator.new('String', ["Sick", "Adoption", "Maternity", "Paternity", "Sharedparental", "Bereavement", "NeonatalCare", "BereavementNire"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

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

@@ -25,51 +25,24 @@ module XeroRuby::PayrollUk
     # The employment number of the employee
     attr_accessor :employee_number
     
-    # The NI Category of the employee
+
     attr_accessor :ni_category
-    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
-    S ||= "S".freeze
-    V ||= "V".freeze
-    X ||= "X".freeze
-    Z ||= "Z".freeze
     
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
+    # The employee's NI categories
+    attr_accessor :ni_categories
+    
+    # The employee's contracts
+    attr_accessor :contracts
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'payroll_calendar_id' => :'payrollCalendarID',
         :'start_date' => :'startDate',
         :'employee_number' => :'employeeNumber',
-        :'ni_category' => :'niCategory'
+        :'ni_category' => :'niCategory',
+        :'ni_categories' => :'niCategories',
+        :'contracts' => :'contracts'
       }
     end
 
@@ -79,7 +52,9 @@ module XeroRuby::PayrollUk
         :'payroll_calendar_id' => :'String',
         :'start_date' => :'Date',
         :'employee_number' => :'String',
-        :'ni_category' => :'String'
+        :'ni_category' => :'NICategoryLetter',
+        :'ni_categories' => :'Array<NICategory>',
+        :'contracts' => :'Array<Contracts>'
       }
     end
 
@@ -113,33 +88,53 @@ module XeroRuby::PayrollUk
       if attributes.key?(:'ni_category')
         self.ni_category = attributes[:'ni_category']
       end
+
+      if attributes.key?(:'ni_categories')
+        if (value = attributes[:'ni_categories']).is_a?(Array)
+          self.ni_categories = value
+        end
+      end
+
+      if attributes.key?(:'contracts')
+        if (value = attributes[:'contracts']).is_a?(Array)
+          self.contracts = 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 @payroll_calendar_id.nil?
+        invalid_properties.push('invalid value for "payroll_calendar_id", payroll_calendar_id cannot be nil.')
+      end
+
+      if @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      if @employee_number.nil?
+        invalid_properties.push('invalid value for "employee_number", employee_number cannot be nil.')
+      end
+
+      if @ni_categories.nil?
+        invalid_properties.push('invalid value for "ni_categories", ni_categories 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?
-      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)
+      return false if @payroll_calendar_id.nil?
+      return false if @start_date.nil?
+      return false if @employee_number.nil?
+      return false if @ni_categories.nil?
       true
     end
 
-    # 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", "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
-      @ni_category = ni_category
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -148,7 +143,9 @@ module XeroRuby::PayrollUk
           payroll_calendar_id == o.payroll_calendar_id &&
           start_date == o.start_date &&
           employee_number == o.employee_number &&
-          ni_category == o.ni_category
+          ni_category == o.ni_category &&
+          ni_categories == o.ni_categories &&
+          contracts == o.contracts
     end
 
     # @see the `==` method
@@ -160,7 +157,7 @@ module XeroRuby::PayrollUk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [payroll_calendar_id, start_date, employee_number, ni_category].hash
+      [payroll_calendar_id, start_date, employee_number, ni_category, ni_categories, contracts].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,37 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollUk
+  class EmploymentStatus
+    EMPLOYEE ||= "Employee".freeze
+    WORKER ||= "Worker".freeze
+    UNSPECIFIED ||= "Unspecified".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 = EmploymentStatus.constants.select { |c| EmploymentStatus::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #EmploymentStatus" if constantValues.empty?
+      value
+    end
+  end
+end