Class: XeroRuby::PayrollNz::WorkingWeek

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkingWeek

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
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 68

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

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

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

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

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

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

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

Instance Attribute Details

#fridayObject

The number of hours worked on a Friday



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

def friday
  @friday
end

#mondayObject

The number of hours worked on a Monday



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

def monday
  @monday
end

#saturdayObject

The number of hours worked on a Saturday



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

def saturday
  @saturday
end

#sundayObject

The number of hours worked on a Sunday



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

def sunday
  @sunday
end

#thursdayObject

The number of hours worked on a Thursday



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

def thursday
  @thursday
end

#tuesdayObject

The number of hours worked on a Tuesday



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

def tuesday
  @tuesday
end

#wednesdayObject

The number of hours worked on a Wednesday



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

def wednesday
  @wednesday
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_nz/working_week.rb', line 41

def self.attribute_map
  {
    :'monday' => :'monday',
    :'tuesday' => :'tuesday',
    :'wednesday' => :'wednesday',
    :'thursday' => :'thursday',
    :'friday' => :'friday',
    :'saturday' => :'saturday',
    :'sunday' => :'sunday'
  }
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



187
188
189
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 187

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_nz/working_week.rb', line 54

def self.openapi_types
  {
    :'monday' => :'BigDecimal',
    :'tuesday' => :'BigDecimal',
    :'wednesday' => :'BigDecimal',
    :'thursday' => :'BigDecimal',
    :'friday' => :'BigDecimal',
    :'saturday' => :'BigDecimal',
    :'sunday' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



160
161
162
163
164
165
166
167
168
169
170
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      monday == o.monday &&
      tuesday == o.tuesday &&
      wednesday == o.wednesday &&
      thursday == o.thursday &&
      friday == o.friday &&
      saturday == o.saturday &&
      sunday == o.sunday
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 215

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

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 288

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 194

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


174
175
176
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 174

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



180
181
182
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 180

def hash
  [monday, tuesday, wednesday, thursday, friday, saturday, sunday].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  if @monday.nil?
    invalid_properties.push('invalid value for "monday", monday cannot be nil.')
  end

  if @tuesday.nil?
    invalid_properties.push('invalid value for "tuesday", tuesday cannot be nil.')
  end

  if @wednesday.nil?
    invalid_properties.push('invalid value for "wednesday", wednesday cannot be nil.')
  end

  if @thursday.nil?
    invalid_properties.push('invalid value for "thursday", thursday cannot be nil.')
  end

  if @friday.nil?
    invalid_properties.push('invalid value for "friday", friday cannot be nil.')
  end

  if @saturday.nil?
    invalid_properties.push('invalid value for "saturday", saturday cannot be nil.')
  end

  if @sunday.nil?
    invalid_properties.push('invalid value for "sunday", sunday cannot be nil.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object



304
305
306
307
308
309
310
311
312
313
314
315
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 304

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

#to_attributesObject

Returns the object in the form of hash with snake_case



280
281
282
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 280

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



262
263
264
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 262

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



268
269
270
271
272
273
274
275
276
277
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 268

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



256
257
258
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 256

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



147
148
149
150
151
152
153
154
155
156
# File 'lib/xero-ruby/models/payroll_nz/working_week.rb', line 147

def valid?
  return false if @monday.nil?
  return false if @tuesday.nil?
  return false if @wednesday.nil?
  return false if @thursday.nil?
  return false if @friday.nil?
  return false if @saturday.nil?
  return false if @sunday.nil?
  true
end