xero-ruby 2.2.2 → 2.4.0

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

@@ -0,0 +1,389 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+The version of the OpenAPI document: 2.6.0
+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 PayRun
+    # Xero unique identifier for the pay run
+    attr_accessor :pay_run_id
+    
+    # Xero unique identifier for the payroll calendar
+    attr_accessor :payroll_calendar_id
+    
+    # Period start date of the payroll calendar
+    attr_accessor :period_start_date
+    
+    # Period end date of the payroll calendar
+    attr_accessor :period_end_date
+    
+    # Payment date of the pay run
+    attr_accessor :payment_date
+    
+    # Total cost of the pay run
+    attr_accessor :total_cost
+    
+    # Total pay of the pay run
+    attr_accessor :total_pay
+    
+    # Pay run status
+    attr_accessor :pay_run_status
+    DRAFT = "Draft".freeze
+    POSTED = "Posted".freeze
+    
+    # Pay run type
+    attr_accessor :pay_run_type
+    SCHEDULED = "Scheduled".freeze
+    UNSCHEDULED = "Unscheduled".freeze
+    EARLIER_YEAR_UPDATE = "EarlierYearUpdate".freeze
+    
+    # Calendar type of the pay run
+    attr_accessor :calendar_type
+    WEEKLY = "Weekly".freeze
+    FORTNIGHTLY = "Fortnightly".freeze
+    FOUR_WEEKLY = "FourWeekly".freeze
+    MONTHLY = "Monthly".freeze
+    ANNUAL = "Annual".freeze
+    QUARTERLY = "Quarterly".freeze
+    
+    # Posted date time of the pay run
+    attr_accessor :posted_date_time
+    
+
+    attr_accessor :pay_slips
+    
+    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
+      {
+        :'pay_run_id' => :'payRunID',
+        :'payroll_calendar_id' => :'payrollCalendarID',
+        :'period_start_date' => :'periodStartDate',
+        :'period_end_date' => :'periodEndDate',
+        :'payment_date' => :'paymentDate',
+        :'total_cost' => :'totalCost',
+        :'total_pay' => :'totalPay',
+        :'pay_run_status' => :'payRunStatus',
+        :'pay_run_type' => :'payRunType',
+        :'calendar_type' => :'calendarType',
+        :'posted_date_time' => :'postedDateTime',
+        :'pay_slips' => :'paySlips'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pay_run_id' => :'String',
+        :'payroll_calendar_id' => :'String',
+        :'period_start_date' => :'Date',
+        :'period_end_date' => :'Date',
+        :'payment_date' => :'Date',
+        :'total_cost' => :'Float',
+        :'total_pay' => :'Float',
+        :'pay_run_status' => :'String',
+        :'pay_run_type' => :'String',
+        :'calendar_type' => :'String',
+        :'posted_date_time' => :'Date',
+        :'pay_slips' => :'Array<Payslip>'
+      }
+    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::PayRun` 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::PayRun`. 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?(:'pay_run_id')
+        self.pay_run_id = attributes[:'pay_run_id']
+      end
+
+      if attributes.key?(:'payroll_calendar_id')
+        self.payroll_calendar_id = attributes[:'payroll_calendar_id']
+      end
+
+      if attributes.key?(:'period_start_date')
+        self.period_start_date = attributes[:'period_start_date']
+      end
+
+      if attributes.key?(:'period_end_date')
+        self.period_end_date = attributes[:'period_end_date']
+      end
+
+      if attributes.key?(:'payment_date')
+        self.payment_date = attributes[:'payment_date']
+      end
+
+      if attributes.key?(:'total_cost')
+        self.total_cost = attributes[:'total_cost']
+      end
+
+      if attributes.key?(:'total_pay')
+        self.total_pay = attributes[:'total_pay']
+      end
+
+      if attributes.key?(:'pay_run_status')
+        self.pay_run_status = attributes[:'pay_run_status']
+      end
+
+      if attributes.key?(:'pay_run_type')
+        self.pay_run_type = attributes[:'pay_run_type']
+      end
+
+      if attributes.key?(:'calendar_type')
+        self.calendar_type = attributes[:'calendar_type']
+      end
+
+      if attributes.key?(:'posted_date_time')
+        self.posted_date_time = attributes[:'posted_date_time']
+      end
+
+      if attributes.key?(:'pay_slips')
+        if (value = attributes[:'pay_slips']).is_a?(Array)
+          self.pay_slips = 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
+      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?
+      pay_run_status_validator = EnumAttributeValidator.new('String', ["Draft", "Posted"])
+      return false unless pay_run_status_validator.valid?(@pay_run_status)
+      pay_run_type_validator = EnumAttributeValidator.new('String', ["Scheduled", "Unscheduled", "EarlierYearUpdate"])
+      return false unless pay_run_type_validator.valid?(@pay_run_type)
+      calendar_type_validator = EnumAttributeValidator.new('String', ["Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly"])
+      return false unless calendar_type_validator.valid?(@calendar_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pay_run_status Object to be assigned
+    def pay_run_status=(pay_run_status)
+      validator = EnumAttributeValidator.new('String', ["Draft", "Posted"])
+      unless validator.valid?(pay_run_status)
+        fail ArgumentError, "invalid value for \"pay_run_status\", must be one of #{validator.allowable_values}."
+      end
+      @pay_run_status = pay_run_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pay_run_type Object to be assigned
+    def pay_run_type=(pay_run_type)
+      validator = EnumAttributeValidator.new('String', ["Scheduled", "Unscheduled", "EarlierYearUpdate"])
+      unless validator.valid?(pay_run_type)
+        fail ArgumentError, "invalid value for \"pay_run_type\", must be one of #{validator.allowable_values}."
+      end
+      @pay_run_type = pay_run_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] calendar_type Object to be assigned
+    def calendar_type=(calendar_type)
+      validator = EnumAttributeValidator.new('String', ["Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly"])
+      unless validator.valid?(calendar_type)
+        fail ArgumentError, "invalid value for \"calendar_type\", must be one of #{validator.allowable_values}."
+      end
+      @calendar_type = calendar_type
+    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 &&
+          pay_run_id == o.pay_run_id &&
+          payroll_calendar_id == o.payroll_calendar_id &&
+          period_start_date == o.period_start_date &&
+          period_end_date == o.period_end_date &&
+          payment_date == o.payment_date &&
+          total_cost == o.total_cost &&
+          total_pay == o.total_pay &&
+          pay_run_status == o.pay_run_status &&
+          pay_run_type == o.pay_run_type &&
+          calendar_type == o.calendar_type &&
+          posted_date_time == o.posted_date_time &&
+          pay_slips == o.pay_slips
+    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
+      [pay_run_id, payroll_calendar_id, period_start_date, period_end_date, payment_date, total_cost, total_pay, pay_run_status, pay_run_type, calendar_type, posted_date_time, pay_slips].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
+      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_uk/pay_run_calendar.rb

@@ -0,0 +1,328 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+The version of the OpenAPI document: 2.6.0
+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 PayRunCalendar
+    # Xero unique identifier for the payroll calendar
+    attr_accessor :payroll_calendar_id
+    
+    # Name of the calendar
+    attr_accessor :name
+    
+    # Type of the calendar
+    attr_accessor :calendar_type
+    WEEKLY = "Weekly".freeze
+    FORTNIGHTLY = "Fortnightly".freeze
+    FOUR_WEEKLY = "FourWeekly".freeze
+    MONTHLY = "Monthly".freeze
+    ANNUAL = "Annual".freeze
+    QUARTERLY = "Quarterly".freeze
+    
+    # Period start date of the calendar
+    attr_accessor :period_start_date
+    
+    # Period end date of the calendar
+    attr_accessor :period_end_date
+    
+    # Payment date of the calendar
+    attr_accessor :payment_date
+    
+    # UTC timestamp of the last update to the pay run calendar
+    attr_accessor :updated_date_utc
+    
+    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
+      {
+        :'payroll_calendar_id' => :'payrollCalendarID',
+        :'name' => :'name',
+        :'calendar_type' => :'calendarType',
+        :'period_start_date' => :'periodStartDate',
+        :'period_end_date' => :'periodEndDate',
+        :'payment_date' => :'paymentDate',
+        :'updated_date_utc' => :'updatedDateUTC'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'payroll_calendar_id' => :'String',
+        :'name' => :'String',
+        :'calendar_type' => :'String',
+        :'period_start_date' => :'Date',
+        :'period_end_date' => :'Date',
+        :'payment_date' => :'Date',
+        :'updated_date_utc' => :'DateTime'
+      }
+    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::PayRunCalendar` 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::PayRunCalendar`. 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?(:'payroll_calendar_id')
+        self.payroll_calendar_id = attributes[:'payroll_calendar_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'calendar_type')
+        self.calendar_type = attributes[:'calendar_type']
+      end
+
+      if attributes.key?(:'period_start_date')
+        self.period_start_date = attributes[:'period_start_date']
+      end
+
+      if attributes.key?(:'period_end_date')
+        self.period_end_date = attributes[:'period_end_date']
+      end
+
+      if attributes.key?(:'payment_date')
+        self.payment_date = attributes[:'payment_date']
+      end
+
+      if attributes.key?(:'updated_date_utc')
+        self.updated_date_utc = attributes[:'updated_date_utc']
+      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?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @calendar_type.nil?
+        invalid_properties.push('invalid value for "calendar_type", calendar_type cannot be nil.')
+      end
+
+      if @period_start_date.nil?
+        invalid_properties.push('invalid value for "period_start_date", period_start_date cannot be nil.')
+      end
+
+      if @payment_date.nil?
+        invalid_properties.push('invalid value for "payment_date", payment_date 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 @name.nil?
+      return false if @calendar_type.nil?
+      calendar_type_validator = EnumAttributeValidator.new('String', ["Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly"])
+      return false unless calendar_type_validator.valid?(@calendar_type)
+      return false if @period_start_date.nil?
+      return false if @payment_date.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] calendar_type Object to be assigned
+    def calendar_type=(calendar_type)
+      validator = EnumAttributeValidator.new('String', ["Weekly", "Fortnightly", "FourWeekly", "Monthly", "Annual", "Quarterly"])
+      unless validator.valid?(calendar_type)
+        fail ArgumentError, "invalid value for \"calendar_type\", must be one of #{validator.allowable_values}."
+      end
+      @calendar_type = calendar_type
+    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 &&
+          payroll_calendar_id == o.payroll_calendar_id &&
+          name == o.name &&
+          calendar_type == o.calendar_type &&
+          period_start_date == o.period_start_date &&
+          period_end_date == o.period_end_date &&
+          payment_date == o.payment_date &&
+          updated_date_utc == o.updated_date_utc
+    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
+      [payroll_calendar_id, name, calendar_type, period_start_date, period_end_date, payment_date, updated_date_utc].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
+      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