Class: XeroRuby::PayrollAu::PayrollCalendar

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/payroll_au/payroll_calendar.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayrollCalendar

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 68

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollAu::PayrollCalendar` 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::PayrollCalendar`. 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?(:'calendar_type')
    self.calendar_type = attributes[:'calendar_type']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'payment_date')
    self.payment_date = attributes[:'payment_date']
  end

  if attributes.key?(:'payroll_calendar_id')
    self.payroll_calendar_id = attributes[:'payroll_calendar_id']
  end

  if attributes.key?(:'updated_date_utc')
    self.updated_date_utc = attributes[:'updated_date_utc']
  end

  if attributes.key?(:'validation_errors')
    if (value = attributes[:'validation_errors']).is_a?(Array)
      self.validation_errors = value
    end
  end
end

Instance Attribute Details

#calendar_typeObject

Returns the value of attribute calendar_type


23
24
25
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 23

def calendar_type
  @calendar_type
end

#nameObject

Name of the Payroll Calendar


20
21
22
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 20

def name
  @name
end

#payment_dateObject

The date on which employees will be paid for the upcoming pay period (YYYY-MM-DD)


29
30
31
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 29

def payment_date
  @payment_date
end

#payroll_calendar_idObject

Xero identifier


32
33
34
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 32

def payroll_calendar_id
  @payroll_calendar_id
end

#start_dateObject

The start date of the upcoming pay period. The end date will be calculated based upon this date, and the calendar type selected (YYYY-MM-DD)


26
27
28
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 26

def start_date
  @start_date
end

#updated_date_utcObject

Last modified timestamp


35
36
37
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 35

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


38
39
40
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 38

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


41
42
43
44
45
46
47
48
49
50
51
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 41

def self.attribute_map
  {
    :'name' => :'Name',
    :'calendar_type' => :'CalendarType',
    :'start_date' => :'StartDate',
    :'payment_date' => :'PaymentDate',
    :'payroll_calendar_id' => :'PayrollCalendarID',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'validation_errors' => :'ValidationErrors'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


154
155
156
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 154

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.


54
55
56
57
58
59
60
61
62
63
64
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 54

def self.openapi_types
  {
    :'name' => :'String',
    :'calendar_type' => :'CalendarType',
    :'start_date' => :'Date',
    :'payment_date' => :'Date',
    :'payroll_calendar_id' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


127
128
129
130
131
132
133
134
135
136
137
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 127

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      calendar_type == o.calendar_type &&
      start_date == o.start_date &&
      payment_date == o.payment_date &&
      payroll_calendar_id == o.payroll_calendar_id &&
      updated_date_utc == o.updated_date_utc &&
      validation_errors == o.validation_errors
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 182

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

#_to_hash(value, downcase: false) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 255

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 161

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

141
142
143
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 141

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


147
148
149
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 147

def hash
  [name, calendar_type, start_date, payment_date, payroll_calendar_id, updated_date_utc, validation_errors].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


114
115
116
117
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 114

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


271
272
273
274
275
276
277
278
279
280
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 271

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
  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

#to_attributesObject

Returns the object in the form of hash with snake_case


247
248
249
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 247

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


229
230
231
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 229

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


235
236
237
238
239
240
241
242
243
244
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 235

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


223
224
225
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 223

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


121
122
123
# File 'lib/xero-ruby/models/payroll_au/payroll_calendar.rb', line 121

def valid?
  true
end