Class: XeroRuby::PayrollNz::TimesheetLine

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimesheetLine

Initializes the object

Parameters:

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

    Model attributes in the form of hash


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 58

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

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

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

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

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

Instance Attribute Details

#dateObject

The Date that this Timesheet Line is for (YYYY-MM-DD)


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

def date
  @date
end

#earnings_rate_idObject

The Xero identifier for the Earnings Rate that the Timesheet is for


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

def earnings_rate_id
  @earnings_rate_id
end

#number_of_unitsObject

The Number of Units of the Timesheet Line


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

def number_of_units
  @number_of_units
end

#timesheet_line_idObject

The Xero identifier for a Timesheet Line


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

def timesheet_line_id
  @timesheet_line_id
end

#tracking_item_idObject

The Xero identifier for the Tracking Item that the Timesheet is for


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

def tracking_item_id
  @tracking_item_id
end

Class Method Details

.attribute_mapObject

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


35
36
37
38
39
40
41
42
43
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 35

def self.attribute_map
  {
    :'timesheet_line_id' => :'timesheetLineID',
    :'date' => :'date',
    :'earnings_rate_id' => :'earningsRateID',
    :'tracking_item_id' => :'trackingItemID',
    :'number_of_units' => :'numberOfUnits'
  }
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


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

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

.openapi_typesObject

Attribute type mapping.


46
47
48
49
50
51
52
53
54
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 46

def self.openapi_types
  {
    :'timesheet_line_id' => :'String',
    :'date' => :'Date',
    :'earnings_rate_id' => :'String',
    :'tracking_item_id' => :'String',
    :'number_of_units' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


122
123
124
125
126
127
128
129
130
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 122

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      timesheet_line_id == o.timesheet_line_id &&
      date == o.date &&
      earnings_rate_id == o.earnings_rate_id &&
      tracking_item_id == o.tracking_item_id &&
      number_of_units == o.number_of_units
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


175
176
177
178
179
180
181
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
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 175

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


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 248

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


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 154

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

134
135
136
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 134

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


140
141
142
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 140

def hash
  [timesheet_line_id, date, earnings_rate_id, tracking_item_id, number_of_units].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 94

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


264
265
266
267
268
269
270
271
272
273
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 264

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


240
241
242
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 240

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


222
223
224
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 222

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


228
229
230
231
232
233
234
235
236
237
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 228

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


216
217
218
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 216

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


113
114
115
116
117
118
# File 'lib/xero-ruby/models/payroll_nz/timesheet_line.rb', line 113

def valid?
  return false if @date.nil?
  return false if @earnings_rate_id.nil?
  return false if @number_of_units.nil?
  true
end