class XeroRuby::PayrollNz::PayRun
Constants
- DRAFT
- EARLIER_YEAR_UPDATE
- POSTED
- SCHEDULED
- UNSCHEDULED
Attributes
Xero unique identifier for the pay run
Pay run status
Pay run type
Payment date of the pay run
Xero unique identifier for the payroll calendar
Period end date of the payroll calendar
Period start date of the payroll calendar
Posted date time of the pay run
Total cost of the pay run
Total pay of the pay run
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 83 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 255 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 120 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollNz::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::PayrollNz::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
Attribute type mapping.
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 101 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' => :'BigDecimal', :'total_pay' => :'BigDecimal', :'pay_run_status' => :'String', :'pay_run_type' => :'String', :'calendar_type' => :'CalendarType', :'posted_date_time' => :'Date', :'pay_slips' => :'Array<PaySlip>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 223 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 283 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
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
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 356 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 262 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
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 242 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 248 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 186 def list_invalid_properties invalid_properties = Array.new invalid_properties end
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 372 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
Custom attribute writer method checking allowed values (enum). @param [Object] pay_run_status
Object to be assigned
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 203 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
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 213 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
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 348 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 336 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 string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 324 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/xero-ruby/models/payroll_nz/pay_run.rb, line 193 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) true end