xero-ruby 2.2.4 → 2.3.0

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

@@ -0,0 +1,41 @@
+=begin
+#Xero Payroll AU
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+The version of the OpenAPI document: 2.4.0
+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 CalendarType
+    WEEKLY = "WEEKLY".freeze
+    FORTNIGHTLY = "FORTNIGHTLY".freeze
+    FOURWEEKLY = "FOURWEEKLY".freeze
+    MONTHLY = "MONTHLY".freeze
+    TWICEMONTHLY = "TWICEMONTHLY".freeze
+    QUARTERLY = "QUARTERLY".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 = CalendarType.constants.select { |c| CalendarType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CalendarType" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,258 @@
+=begin
+#Xero Payroll AU
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+The version of the OpenAPI document: 2.4.0
+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 DeductionLine
+    # Xero deduction type identifier
+    attr_accessor :deduction_type_id
+    
+
+    attr_accessor :calculation_type
+    
+    # Deduction type amount
+    attr_accessor :amount
+    
+    # The Percentage of the Deduction
+    attr_accessor :percentage
+    
+    # Deduction number of units
+    attr_accessor :number_of_units
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'deduction_type_id' => :'DeductionTypeID',
+        :'calculation_type' => :'CalculationType',
+        :'amount' => :'Amount',
+        :'percentage' => :'Percentage',
+        :'number_of_units' => :'NumberOfUnits'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'deduction_type_id' => :'String',
+        :'calculation_type' => :'DeductionTypeCalculationType',
+        :'amount' => :'BigDecimal',
+        :'percentage' => :'BigDecimal',
+        :'number_of_units' => :'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::PayrollAu::DeductionLine` 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::DeductionLine`. 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?(:'deduction_type_id')
+        self.deduction_type_id = attributes[:'deduction_type_id']
+      end
+
+      if attributes.key?(:'calculation_type')
+        self.calculation_type = attributes[:'calculation_type']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.key?(:'number_of_units')
+        self.number_of_units = attributes[:'number_of_units']
+      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 @deduction_type_id.nil?
+        invalid_properties.push('invalid value for "deduction_type_id", deduction_type_id cannot be nil.')
+      end
+
+      if @calculation_type.nil?
+        invalid_properties.push('invalid value for "calculation_type", calculation_type 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 @deduction_type_id.nil?
+      return false if @calculation_type.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 &&
+          deduction_type_id == o.deduction_type_id &&
+          calculation_type == o.calculation_type &&
+          amount == o.amount &&
+          percentage == o.percentage &&
+          number_of_units == o.number_of_units
+    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
+      [deduction_type_id, calculation_type, amount, percentage, number_of_units].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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+    # customized data_parser
+    def parse_date(datestring)
+      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+    end
+  end
+end

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

@@ -0,0 +1,340 @@
+=begin
+#Xero Payroll AU
+
+#This is the Xero Payroll API for orgs in Australia region.
+
+The version of the OpenAPI document: 2.4.0
+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 DeductionType
+    # Name of the earnings rate (max length = 100)
+    attr_accessor :name
+    
+    # See Accounts
+    attr_accessor :account_code
+    
+    # Indicates that this is a pre-tax deduction that will reduce the amount of tax you withhold from an employee.
+    attr_accessor :reduces_tax
+    
+    # Most deductions don’t reduce your superannuation guarantee contribution liability, so typically you will not set any value for this.
+    attr_accessor :reduces_super
+    
+    # Boolean to determine if the deduction type is reportable or exempt from W1
+    attr_accessor :is_exempt_from_w1
+    
+    # Xero identifier
+    attr_accessor :deduction_type_id
+    
+    # Last modified timestamp
+    attr_accessor :updated_date_utc
+    
+
+    attr_accessor :deduction_category
+    NONE = "NONE".freeze
+    UNIONFEES = "UNIONFEES".freeze
+    WORKPLACEGIVING = "WORKPLACEGIVING".freeze
+    
+    # Is the current record
+    attr_accessor :current_record
+    
+    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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'Name',
+        :'account_code' => :'AccountCode',
+        :'reduces_tax' => :'ReducesTax',
+        :'reduces_super' => :'ReducesSuper',
+        :'is_exempt_from_w1' => :'IsExemptFromW1',
+        :'deduction_type_id' => :'DeductionTypeID',
+        :'updated_date_utc' => :'UpdatedDateUTC',
+        :'deduction_category' => :'DeductionCategory',
+        :'current_record' => :'CurrentRecord'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'account_code' => :'String',
+        :'reduces_tax' => :'Boolean',
+        :'reduces_super' => :'Boolean',
+        :'is_exempt_from_w1' => :'Boolean',
+        :'deduction_type_id' => :'String',
+        :'updated_date_utc' => :'DateTime',
+        :'deduction_category' => :'String',
+        :'current_record' => :'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::DeductionType` 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::DeductionType`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'account_code')
+        self.account_code = attributes[:'account_code']
+      end
+
+      if attributes.key?(:'reduces_tax')
+        self.reduces_tax = attributes[:'reduces_tax']
+      end
+
+      if attributes.key?(:'reduces_super')
+        self.reduces_super = attributes[:'reduces_super']
+      end
+
+      if attributes.key?(:'is_exempt_from_w1')
+        self.is_exempt_from_w1 = attributes[:'is_exempt_from_w1']
+      end
+
+      if attributes.key?(:'deduction_type_id')
+        self.deduction_type_id = attributes[:'deduction_type_id']
+      end
+
+      if attributes.key?(:'updated_date_utc')
+        self.updated_date_utc = attributes[:'updated_date_utc']
+      end
+
+      if attributes.key?(:'deduction_category')
+        self.deduction_category = attributes[:'deduction_category']
+      end
+
+      if attributes.key?(:'current_record')
+        self.current_record = attributes[:'current_record']
+      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 !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      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 !@name.nil? && @name.to_s.length > 100
+      deduction_category_validator = EnumAttributeValidator.new('String', ["NONE", "UNIONFEES", "WORKPLACEGIVING"])
+      return false unless deduction_category_validator.valid?(@deduction_category)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deduction_category Object to be assigned
+    def deduction_category=(deduction_category)
+      validator = EnumAttributeValidator.new('String', ["NONE", "UNIONFEES", "WORKPLACEGIVING"])
+      unless validator.valid?(deduction_category)
+        fail ArgumentError, "invalid value for \"deduction_category\", must be one of #{validator.allowable_values}."
+      end
+      @deduction_category = deduction_category
+    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 &&
+          name == o.name &&
+          account_code == o.account_code &&
+          reduces_tax == o.reduces_tax &&
+          reduces_super == o.reduces_super &&
+          is_exempt_from_w1 == o.is_exempt_from_w1 &&
+          deduction_type_id == o.deduction_type_id &&
+          updated_date_utc == o.updated_date_utc &&
+          deduction_category == o.deduction_category &&
+          current_record == o.current_record
+    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
+      [name, account_code, reduces_tax, reduces_super, is_exempt_from_w1, deduction_type_id, updated_date_utc, deduction_category, current_record].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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+    # customized data_parser
+    def parse_date(datestring)
+      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+    end
+  end
+end