xero-ruby 3.16.0 → 10.0.0

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

@@ -0,0 +1,317 @@
+=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 WorkingWeek
+    # The number of hours worked on a Monday
+    attr_accessor :monday
+    
+    # The number of hours worked on a Tuesday
+    attr_accessor :tuesday
+    
+    # The number of hours worked on a Wednesday
+    attr_accessor :wednesday
+    
+    # The number of hours worked on a Thursday
+    attr_accessor :thursday
+    
+    # The number of hours worked on a Friday
+    attr_accessor :friday
+    
+    # The number of hours worked on a Saturday
+    attr_accessor :saturday
+    
+    # The number of hours worked on a Sunday
+    attr_accessor :sunday
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'monday' => :'monday',
+        :'tuesday' => :'tuesday',
+        :'wednesday' => :'wednesday',
+        :'thursday' => :'thursday',
+        :'friday' => :'friday',
+        :'saturday' => :'saturday',
+        :'sunday' => :'sunday'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'monday' => :'BigDecimal',
+        :'tuesday' => :'BigDecimal',
+        :'wednesday' => :'BigDecimal',
+        :'thursday' => :'BigDecimal',
+        :'friday' => :'BigDecimal',
+        :'saturday' => :'BigDecimal',
+        :'sunday' => :'BigDecimal'
+      }
+    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::WorkingWeek` 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::WorkingWeek`. 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?(:'monday')
+        self.monday = attributes[:'monday']
+      end
+
+      if attributes.key?(:'tuesday')
+        self.tuesday = attributes[:'tuesday']
+      end
+
+      if attributes.key?(:'wednesday')
+        self.wednesday = attributes[:'wednesday']
+      end
+
+      if attributes.key?(:'thursday')
+        self.thursday = attributes[:'thursday']
+      end
+
+      if attributes.key?(:'friday')
+        self.friday = attributes[:'friday']
+      end
+
+      if attributes.key?(:'saturday')
+        self.saturday = attributes[:'saturday']
+      end
+
+      if attributes.key?(:'sunday')
+        self.sunday = attributes[:'sunday']
+      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 @monday.nil?
+        invalid_properties.push('invalid value for "monday", monday cannot be nil.')
+      end
+
+      if @tuesday.nil?
+        invalid_properties.push('invalid value for "tuesday", tuesday cannot be nil.')
+      end
+
+      if @wednesday.nil?
+        invalid_properties.push('invalid value for "wednesday", wednesday cannot be nil.')
+      end
+
+      if @thursday.nil?
+        invalid_properties.push('invalid value for "thursday", thursday cannot be nil.')
+      end
+
+      if @friday.nil?
+        invalid_properties.push('invalid value for "friday", friday cannot be nil.')
+      end
+
+      if @saturday.nil?
+        invalid_properties.push('invalid value for "saturday", saturday cannot be nil.')
+      end
+
+      if @sunday.nil?
+        invalid_properties.push('invalid value for "sunday", sunday 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 @monday.nil?
+      return false if @tuesday.nil?
+      return false if @wednesday.nil?
+      return false if @thursday.nil?
+      return false if @friday.nil?
+      return false if @saturday.nil?
+      return false if @sunday.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 &&
+          monday == o.monday &&
+          tuesday == o.tuesday &&
+          wednesday == o.wednesday &&
+          thursday == o.thursday &&
+          friday == o.friday &&
+          saturday == o.saturday &&
+          sunday == o.sunday
+    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
+      [monday, tuesday, wednesday, thursday, friday, saturday, sunday].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_uk/earnings_rate.rb

@@ -25,7 +25,7 @@ module XeroRuby::PayrollUk
     # Indicates how an employee will be paid when taking this type of earning
     attr_accessor :earnings_type
     ALLOWANCE ||= "Allowance".freeze
-    BACKPAY ||= "Backpay".freeze
+    BACK_PAY ||= "BackPay".freeze
     BONUS ||= "Bonus".freeze
     COMMISSION ||= "Commission".freeze
     LUMP_SUM ||= "LumpSum".freeze
@@ -214,7 +214,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"])
       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 +227,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"])
       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_leave_type.rb

@@ -38,6 +38,9 @@ module XeroRuby::PayrollUk
     # 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
     
+    # The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\"
+    attr_accessor :schedule_of_accrual_date
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -68,7 +71,8 @@ module XeroRuby::PayrollUk
         :'hours_accrued_annually' => :'hoursAccruedAnnually',
         :'maximum_to_accrue' => :'maximumToAccrue',
         :'opening_balance' => :'openingBalance',
-        :'rate_accrued_hourly' => :'rateAccruedHourly'
+        :'rate_accrued_hourly' => :'rateAccruedHourly',
+        :'schedule_of_accrual_date' => :'scheduleOfAccrualDate'
       }
     end
 
@@ -80,7 +84,8 @@ module XeroRuby::PayrollUk
         :'hours_accrued_annually' => :'Float',
         :'maximum_to_accrue' => :'Float',
         :'opening_balance' => :'Float',
-        :'rate_accrued_hourly' => :'Float'
+        :'rate_accrued_hourly' => :'Float',
+        :'schedule_of_accrual_date' => :'Date'
       }
     end
 
@@ -122,6 +127,10 @@ module XeroRuby::PayrollUk
       if attributes.key?(:'rate_accrued_hourly')
         self.rate_accrued_hourly = attributes[:'rate_accrued_hourly']
       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?
@@ -169,7 +178,8 @@ module XeroRuby::PayrollUk
           hours_accrued_annually == o.hours_accrued_annually &&
           maximum_to_accrue == o.maximum_to_accrue &&
           opening_balance == o.opening_balance &&
-          rate_accrued_hourly == o.rate_accrued_hourly
+          rate_accrued_hourly == o.rate_accrued_hourly &&
+          schedule_of_accrual_date == o.schedule_of_accrual_date
     end
 
     # @see the `==` method
@@ -181,7 +191,7 @@ module XeroRuby::PayrollUk
     # 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].hash
+      [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly, schedule_of_accrual_date].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/projects/currency_code.rb

@@ -177,7 +177,6 @@ module XeroRuby::Projects
     ZMW ||= "ZMW".freeze
     ZMK ||= "ZMK".freeze
     ZWD ||= "ZWD".freeze
-    EMPTY ||= "".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

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.33.1
+The version of the XeroOpenAPI document: 7.0.0
 =end
 
 module XeroRuby
-  VERSION = '3.16.0'
+  VERSION = '10.0.0'
 end

data/lib/xero-ruby/where.rb

@@ -17,51 +17,51 @@ module XeroRuby
 
     private
 
-    def parameterize_option(key, value)
-      quoted_key = quote_key(key)
+      def parameterize_option(key, value)
+        quoted_key = quote_key(key)
 
-      case value
-      when Array
-        operator, query = value
+        case value
+        when Array
+          operator, query = value
 
-        if STRING_FUNCTIONS.include?(camelize_key(operator))
-          "#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
+          if STRING_FUNCTIONS.include?(camelize_key(operator))
+            "#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
+          else
+            "#{quoted_key} #{operator} #{quote_value(query)}"
+          end
+        when Range
+          "#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
+        when /^\./
+          "#{quoted_key}#{value}"
         else
-        "#{quoted_key} #{operator} #{quote_value(query)}"
+          "#{quoted_key} #{value}"
         end
-      when Range
-        "#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
-      when /^\./
-        "#{quoted_key}#{value}"
-      else
-        "#{quoted_key} #{value}"
       end
-    end
 
-    def quote_key(key)
-      case key
-      when :contact_id
-        'Contact.ContactID'
-      when :contact_number
-        'Contact.ContactNumber'
-      when :invoice_id
-        'Invoice.InvoiceId'
-      else
-        camelize_key(key)
+      def quote_key(key)
+        case key
+        when :contact_id
+          'Contact.ContactID'
+        when :contact_number
+          'Contact.ContactNumber'
+        when :invoice_id
+          'Invoice.InvoiceId'
+        else
+          camelize_key(key)
+        end
       end
-    end
 
-    def quote_value(value)
-      case value
-      when DateTime, Date, Time
-        "DateTime(#{value.strftime("%Y,%m,%d")})"
-      when Numeric, false, true
-        value.to_s
-      when UUID_REGEXP
-        %{guid("#{value}")}
-      else
-        %{"#{value.to_s.gsub('"', '""')}"}
+      def quote_value(value)
+        case value
+        when DateTime, Date, Time
+          "DateTime(#{value.strftime("%Y,%m,%d")})"
+        when Numeric, false, true
+          value.to_s
+        when UUID_REGEXP
+          %{guid("#{value}")}
+        else
+          %{"#{value.to_s.gsub('"', '""')}"}
+        end
       end
-    end
   end
 end

data/lib/xero-ruby.rb

@@ -218,6 +218,11 @@ require 'xero-ruby/models/payroll_nz/employee_statutory_sick_leave_object'
 require 'xero-ruby/models/payroll_nz/employee_statutory_sick_leaves'
 require 'xero-ruby/models/payroll_nz/employee_tax'
 require 'xero-ruby/models/payroll_nz/employee_tax_object'
+require 'xero-ruby/models/payroll_nz/employee_working_pattern'
+require 'xero-ruby/models/payroll_nz/employee_working_pattern_with_working_weeks'
+require 'xero-ruby/models/payroll_nz/employee_working_pattern_with_working_weeks_object'
+require 'xero-ruby/models/payroll_nz/employee_working_pattern_with_working_weeks_request'
+require 'xero-ruby/models/payroll_nz/employee_working_patterns_object'
 require 'xero-ruby/models/payroll_nz/employees'
 require 'xero-ruby/models/payroll_nz/employment'
 require 'xero-ruby/models/payroll_nz/employment_object'
@@ -271,6 +276,7 @@ require 'xero-ruby/models/payroll_nz/timesheet_object'
 require 'xero-ruby/models/payroll_nz/timesheets'
 require 'xero-ruby/models/payroll_nz/tracking_categories'
 require 'xero-ruby/models/payroll_nz/tracking_category'
+require 'xero-ruby/models/payroll_nz/working_week'
 require 'xero-ruby/models/payroll_au/api_exception'
 require 'xero-ruby/models/payroll_au/account'
 require 'xero-ruby/models/payroll_au/account_type'
@@ -310,8 +316,10 @@ require 'xero-ruby/models/payroll_au/leave_type'
 require 'xero-ruby/models/payroll_au/leave_type_contribution_type'
 require 'xero-ruby/models/payroll_au/manual_tax_type'
 require 'xero-ruby/models/payroll_au/opening_balances'
+require 'xero-ruby/models/payroll_au/paid_leave_earnings_line'
 require 'xero-ruby/models/payroll_au/pay_item'
 require 'xero-ruby/models/payroll_au/pay_items'
+require 'xero-ruby/models/payroll_au/pay_out_type'
 require 'xero-ruby/models/payroll_au/pay_run'
 require 'xero-ruby/models/payroll_au/pay_run_status'
 require 'xero-ruby/models/payroll_au/pay_runs'
@@ -458,6 +466,7 @@ require 'xero-ruby/models/accounting/import_summary_accounts'
 require 'xero-ruby/models/accounting/import_summary_object'
 require 'xero-ruby/models/accounting/import_summary_organisation'
 require 'xero-ruby/models/accounting/invoice'
+require 'xero-ruby/models/accounting/invoice_address'
 require 'xero-ruby/models/accounting/invoice_reminder'
 require 'xero-ruby/models/accounting/invoice_reminders'
 require 'xero-ruby/models/accounting/invoices'
@@ -481,6 +490,7 @@ require 'xero-ruby/models/accounting/organisation'
 require 'xero-ruby/models/accounting/organisations'
 require 'xero-ruby/models/accounting/overpayment'
 require 'xero-ruby/models/accounting/overpayments'
+require 'xero-ruby/models/accounting/pagination'
 require 'xero-ruby/models/accounting/payment'
 require 'xero-ruby/models/accounting/payment_delete'
 require 'xero-ruby/models/accounting/payment_service'
@@ -516,6 +526,7 @@ require 'xero-ruby/models/accounting/row_type'
 require 'xero-ruby/models/accounting/sales_tracking_category'
 require 'xero-ruby/models/accounting/schedule'
 require 'xero-ruby/models/accounting/setup'
+require 'xero-ruby/models/accounting/tax_breakdown_component'
 require 'xero-ruby/models/accounting/tax_component'
 require 'xero-ruby/models/accounting/tax_rate'
 require 'xero-ruby/models/accounting/tax_rates'