Class: XeroRuby::Projects::TimeEntry

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACTIVE =
"ACTIVE".freeze
LOCKED =
"LOCKED".freeze
INVOICED =
"INVOICED".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimeEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 103

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#date_entered_utcObject

The date time that time entry is created. UTC Date Time in ISO-8601 format. By default it is set to server time.


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

def date_entered_utc
  @date_entered_utc
end

#date_utcObject

The date time that time entry is logged on. UTC Date Time in ISO-8601 format.


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

def date_utc
  @date_utc
end

#descriptionObject

A description of the time entry.


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

def description
  @description
end

#durationObject

The duration of logged minutes.


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

def duration
  @duration
end

#project_idObject

Identifier of the project, that the task (which the time entry is logged against) belongs to.


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

def project_id
  @project_id
end

#statusObject

Status of the time entry. By default a time entry is created with status of `ACTIVE`. A `LOCKED` state indicates that the time entry is currently changing state (for example being invoiced). Updates are not allowed when in this state. It will have a status of INVOICED once it is invoiced.


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

def status
  @status
end

#task_idObject

Identifier of the task that time entry is logged against.


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

def task_id
  @task_id
end

#time_entry_idObject

Identifier of the time entry.


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

def time_entry_id
  @time_entry_id
end

#user_idObject

The xero user identifier of the person who logged time.


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

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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


72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 72

def self.attribute_map
  {
    :'time_entry_id' => :'timeEntryId',
    :'user_id' => :'userId',
    :'project_id' => :'projectId',
    :'task_id' => :'taskId',
    :'date_utc' => :'dateUtc',
    :'date_entered_utc' => :'dateEnteredUtc',
    :'duration' => :'duration',
    :'description' => :'description',
    :'status' => :'status'
  }
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


209
210
211
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 209

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

.openapi_typesObject

Attribute type mapping.


87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 87

def self.openapi_types
  {
    :'time_entry_id' => :'String',
    :'user_id' => :'String',
    :'project_id' => :'String',
    :'task_id' => :'String',
    :'date_utc' => :'DateTime',
    :'date_entered_utc' => :'DateTime',
    :'duration' => :'Integer',
    :'description' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      time_entry_id == o.time_entry_id &&
      user_id == o.user_id &&
      project_id == o.project_id &&
      task_id == o.task_id &&
      date_utc == o.date_utc &&
      date_entered_utc == o.date_entered_utc &&
      duration == o.duration &&
      description == o.description &&
      status == o.status
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


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 237

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::Projects.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


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 310

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


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 216

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

196
197
198
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 196

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


202
203
204
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 202

def hash
  [time_entry_id, user_id, project_id, task_id, date_utc, date_entered_utc, duration, description, status].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


155
156
157
158
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


326
327
328
329
330
331
332
333
334
335
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 326

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


302
303
304
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 302

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


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

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


290
291
292
293
294
295
296
297
298
299
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 290

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


278
279
280
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 278

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


162
163
164
165
166
# File 'lib/xero-ruby/models/projects/time_entry.rb', line 162

def valid?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "LOCKED", "INVOICED"])
  return false unless status_validator.valid?(@status)
  true
end