Class: Merge::Hris::TimesheetEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/types/timesheet_entry.rb

Overview

# The Timesheet Entry Object

### Description
The `Timesheet Entry` object is used to track coverage for hours worked by an
'Employee'.
### Usage Example
GET and POST Timesheet Entries

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT, hours_worked: OMIT, start_time: OMIT, end_time: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::TimesheetEntry

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • employee (String) (defaults to: OMIT) —

    The employee the timesheet entry is for.

  • hours_worked (Float) (defaults to: OMIT) —

    The number of hours logged by the employee.

  • start_time (DateTime) (defaults to: OMIT) —

    The time at which the employee started work.

  • end_time (DateTime) (defaults to: OMIT) —

    The time at which the employee ended work.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform.

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Hash{String => Object}>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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/merge_ruby_client/hris/types/timesheet_entry.rb', line 61

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT,
               hours_worked: OMIT, start_time: OMIT, end_time: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @employee = employee if employee != OMIT
  @hours_worked = hours_worked if hours_worked != OMIT
  @start_time = start_time if start_time != OMIT
  @end_time = end_time if end_time != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "employee": employee,
    "hours_worked": hours_worked,
    "start_time": start_time,
    "end_time": end_time,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



40
41
42
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 40

def additional_properties
  @additional_properties
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



21
22
23
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 21

def created_at
  @created_at
end

#employee ⇒ String (readonly)

Returns The employee the timesheet entry is for.

Returns:

  • (String) —

    The employee the timesheet entry is for.



25
26
27
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 25

def employee
  @employee
end

#end_time ⇒ DateTime (readonly)

Returns The time at which the employee ended work.

Returns:

  • (DateTime) —

    The time at which the employee ended work.



31
32
33
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 31

def end_time
  @end_time
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


36
37
38
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 36

def field_mappings
  @field_mappings
end

#hours_worked ⇒ Float (readonly)

Returns The number of hours logged by the employee.

Returns:

  • (Float) —

    The number of hours logged by the employee.



27
28
29
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 27

def hours_worked
  @hours_worked
end

#id ⇒ String (readonly)

Returns:

  • (String) 


17
18
19
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 17

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



23
24
25
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 23

def modified_at
  @modified_at
end

#remote_data ⇒ Array<Hash{String => Object}> (readonly)

Returns:

  • (Array<Hash{String => Object}>) 


38
39
40
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 38

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



19
20
21
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 19

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



34
35
36
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 34

def remote_was_deleted
  @remote_was_deleted
end

#start_time ⇒ DateTime (readonly)

Returns The time at which the employee started work.

Returns:

  • (DateTime) —

    The time at which the employee started work.



29
30
31
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 29

def start_time
  @start_time
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Hris::TimesheetEntry

Deserialize a JSON object to an instance of TimesheetEntry

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 96

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  employee = parsed_json["employee"]
  hours_worked = parsed_json["hours_worked"]
  start_time = (DateTime.parse(parsed_json["start_time"]) unless parsed_json["start_time"].nil?)
  end_time = (DateTime.parse(parsed_json["end_time"]) unless parsed_json["end_time"].nil?)
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    employee: employee,
    hours_worked: hours_worked,
    start_time: start_time,
    end_time: end_time,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 139

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.employee&.is_a?(String) != false || raise("Passed value for field obj.employee is not the expected type, validation failed.")
  obj.hours_worked&.is_a?(Float) != false || raise("Passed value for field obj.hours_worked is not the expected type, validation failed.")
  obj.start_time&.is_a?(DateTime) != false || raise("Passed value for field obj.start_time is not the expected type, validation failed.")
  obj.end_time&.is_a?(DateTime) != false || raise("Passed value for field obj.end_time is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of TimesheetEntry to a JSON object

Returns:

  • (String) 


129
130
131
 
# File 'lib/merge_ruby_client/hris/types/timesheet_entry.rb', line 129

def to_json(*_args)
  @_field_set&.to_json
end