xero-ruby 9.3.0 → 18.0.0

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

@@ -0,0 +1,318 @@
+=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
+  require 'bigdecimal'
+
+  class NICategory
+    # The start date of the NI category (YYYY-MM-DD)
+    attr_accessor :start_date
+    
+
+    attr_accessor :ni_category
+    
+    # Xero unique identifier for the NI category
+    attr_accessor :ni_category_id
+    
+    # The date in which the employee was first employed as a civilian (YYYY-MM-DD)
+    attr_accessor :date_first_employed_as_civilian
+    
+    # The workplace postcode
+    attr_accessor :workplace_postcode
+    
+    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
+      {
+        :'start_date' => :'startDate',
+        :'ni_category' => :'niCategory',
+        :'ni_category_id' => :'niCategoryID',
+        :'date_first_employed_as_civilian' => :'dateFirstEmployedAsCivilian',
+        :'workplace_postcode' => :'workplacePostcode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'start_date' => :'Date',
+        :'ni_category' => :'NICategoryLetter',
+        :'ni_category_id' => :'Float',
+        :'date_first_employed_as_civilian' => :'Date',
+        :'workplace_postcode' => :'String'
+      }
+    end
+
+    # List of class defined in oneOf (OpenAPI v3)
+    def self.openapi_one_of
+      [
+      :'NICategoryOneOf',
+      :'NICategoryOneOf1'
+      ]
+    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::PayrollUk::NICategory` 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::PayrollUk::NICategory`. 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?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'ni_category')
+        self.ni_category = attributes[:'ni_category']
+      end
+
+      if attributes.key?(:'ni_category_id')
+        self.ni_category_id = attributes[:'ni_category_id']
+      end
+
+      if attributes.key?(:'date_first_employed_as_civilian')
+        self.date_first_employed_as_civilian = attributes[:'date_first_employed_as_civilian']
+      end
+
+      if attributes.key?(:'workplace_postcode')
+        self.workplace_postcode = attributes[:'workplace_postcode']
+      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 @ni_category.nil?
+        invalid_properties.push('invalid value for "ni_category", ni_category cannot be nil.')
+      end
+
+      if @workplace_postcode.nil?
+        invalid_properties.push('invalid value for "workplace_postcode", workplace_postcode 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 @ni_category.nil?
+      return false if @workplace_postcode.nil?
+      _one_of_found = false
+      self.class.openapi_one_of.each do |_class|
+        _one_of = XeroRuby::PayrollUk.const_get(_class).build_from_hash(self.to_hash)
+        if _one_of.valid?
+          if _one_of_found
+            return false
+          else
+            _one_of_found = true
+          end
+        end
+      end
+
+      if !_one_of_found
+        return false
+      end
+
+      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 &&
+          start_date == o.start_date &&
+          ni_category == o.ni_category &&
+          ni_category_id == o.ni_category_id &&
+          date_first_employed_as_civilian == o.date_first_employed_as_civilian &&
+          workplace_postcode == o.workplace_postcode
+    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
+      [start_date, ni_category, ni_category_id, date_first_employed_as_civilian, workplace_postcode].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::PayrollUk.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/ni_category_letter.rb

@@ -0,0 +1,51 @@
+=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 NICategoryLetter
+    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
+    D ||= "D".freeze
+    E ||= "E".freeze
+    K ||= "K".freeze
+    N ||= "N".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 = NICategoryLetter.constants.select { |c| NICategoryLetter::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #NICategoryLetter" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,264 @@
+=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
+  require 'bigdecimal'
+
+  class NICategoryOneOf
+
+    attr_accessor :ni_category
+    F ||= "F".freeze
+    I ||= "I".freeze
+    L ||= "L".freeze
+    S ||= "S".freeze
+    N ||= "N".freeze
+    E ||= "E".freeze
+    D ||= "D".freeze
+    K ||= "K".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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ni_category' => :'niCategory'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ni_category' => :'String'
+      }
+    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::PayrollUk::NICategoryOneOf` 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::PayrollUk::NICategoryOneOf`. 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?(:'ni_category')
+        self.ni_category = attributes[:'ni_category']
+      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?
+      ni_category_validator = EnumAttributeValidator.new('String', ["F", "I", "L", "S", "N", "E", "D", "K"])
+      return false unless ni_category_validator.valid?(@ni_category)
+      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', ["F", "I", "L", "S", "N", "E", "D", "K"])
+      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)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          ni_category == o.ni_category
+    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
+      [ni_category].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::PayrollUk.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