Class: XeroRuby::PayrollAu::Timesheet

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Timesheet

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 78

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

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

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

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

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

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

  if attributes.key?(:'timesheet_lines')
    if (value = attributes[:'timesheet_lines']).is_a?(Array)
      self.timesheet_lines = value
    end
  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

#employee_idObject

The Xero identifier for an employee


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

def employee_id
  @employee_id
end

#end_dateObject

Period end date (YYYY-MM-DD)


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

def end_date
  @end_date
end

#hoursObject

Timesheet total hours


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

def hours
  @hours
end

#start_dateObject

Period start date (YYYY-MM-DD)


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

def start_date
  @start_date
end

#statusObject

Returns the value of attribute status


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

def status
  @status
end

#timesheet_idObject

The Xero identifier for a Payroll Timesheet


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

def timesheet_id
  @timesheet_id
end

#timesheet_linesObject

Returns the value of attribute timesheet_lines


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

def timesheet_lines
  @timesheet_lines
end

#updated_date_utcObject

Last modified timestamp


41
42
43
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 41

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


44
45
46
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 44

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

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


47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 47

def self.attribute_map
  {
    :'employee_id' => :'EmployeeID',
    :'start_date' => :'StartDate',
    :'end_date' => :'EndDate',
    :'status' => :'Status',
    :'hours' => :'Hours',
    :'timesheet_id' => :'TimesheetID',
    :'timesheet_lines' => :'TimesheetLines',
    :'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


191
192
193
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 191

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

.openapi_typesObject

Attribute type mapping.


62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 62

def self.openapi_types
  {
    :'employee_id' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'status' => :'TimesheetStatus',
    :'hours' => :'BigDecimal',
    :'timesheet_id' => :'String',
    :'timesheet_lines' => :'Array<TimesheetLine>',
    :'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


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employee_id == o.employee_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      status == o.status &&
      hours == o.hours &&
      timesheet_id == o.timesheet_id &&
      timesheet_lines == o.timesheet_lines &&
      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


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
253
254
255
256
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 219

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


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 292

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


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 198

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

178
179
180
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 178

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


184
185
186
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 184

def hash
  [employee_id, start_date, end_date, status, hours, timesheet_id, timesheet_lines, 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


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 134

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


308
309
310
311
312
313
314
315
316
317
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 308

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


284
285
286
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 284

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


266
267
268
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 266

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


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

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


260
261
262
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 260

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


153
154
155
156
157
158
# File 'lib/xero-ruby/models/payroll_au/timesheet.rb', line 153

def valid?
  return false if @employee_id.nil?
  return false if @start_date.nil?
  return false if @end_date.nil?
  true
end