Class: Samsara::Types::CoachingSessionsResponseResponseBody

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/types/coaching_sessions_response_response_body.rb

Overview

List of coaching sessions objects.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(assigned_coach_id: OMIT, behaviors:, coaching_type:, completed_at_time: OMIT, completed_coach_id: OMIT, driver:, due_at_time:, id:, session_note: OMIT, session_status:, updated_at_time:, additional_properties: nil) ⇒ Samsara::Types::CoachingSessionsResponseResponseBody

Parameters:

  • updated_at_time (DateTime) —

    Time coaching session was updated in UTC.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 69

def initialize(assigned_coach_id: OMIT, behaviors:, coaching_type:, completed_at_time: OMIT, completed_coach_id: OMIT, driver:, due_at_time:, id:, session_note: OMIT, session_status:, updated_at_time:, additional_properties: nil)
  @assigned_coach_id = assigned_coach_id if assigned_coach_id != OMIT
  @behaviors = behaviors
  @coaching_type = coaching_type
  @completed_at_time = completed_at_time if completed_at_time != OMIT
  @completed_coach_id = completed_coach_id if completed_coach_id != OMIT
  @driver = driver
  @due_at_time = due_at_time
  @id = id
  @session_note = session_note if session_note != OMIT
  @session_status = session_status
  @updated_at_time = updated_at_time
  @additional_properties = additional_properties
  @_field_set = { "assignedCoachId": assigned_coach_id, "behaviors": behaviors, "coachingType": coaching_type, "completedAtTime": completed_at_time, "completedCoachId": completed_coach_id, "driver": driver, "dueAtTime": due_at_time, "id": id, "sessionNote": session_note, "sessionStatus": session_status, "updatedAtTime": updated_at_time }.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



44
45
46
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 44

def additional_properties
  @additional_properties
end

#assigned_coach_id ⇒ Object (readonly)

is “incomplete”.



18
19
20
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 18

def assigned_coach_id
  @assigned_coach_id
end

#behaviors ⇒ Array<Samsara::Types::BehaviorResponseBody> (readonly)

Returns Object references for the behaviors within the session.

Returns:



20
21
22
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 20

def behaviors
  @behaviors
end

#coaching_type ⇒ Object (readonly)

‘selfCoaching`, `unknown`, `unshared`, `withManager`



23
24
25
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 23

def coaching_type
  @coaching_type
end

#completed_at_time ⇒ Object (readonly)

status is “completed”.



26
27
28
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 26

def completed_at_time
  @completed_at_time
end

#completed_coach_id ⇒ Object (readonly)

session status is “completed”.



29
30
31
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 29

def completed_coach_id
  @completed_coach_id
end

#driver ⇒ Samsara::Types::DriverWithExternalIdObjectResponseBody (readonly)

Returns:



31
32
33
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 31

def driver
  @driver
end

#due_at_time ⇒ DateTime (readonly)

Returns Time coaching session is due in UTC.

Returns:

  • (DateTime) —

    Time coaching session is due in UTC.



33
34
35
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 33

def due_at_time
  @due_at_time
end

#id ⇒ String (readonly)

Returns Unique ID for the coaching session.

Returns:

  • (String) —

    Unique ID for the coaching session.



35
36
37
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 35

def id
  @id
end

#session_note ⇒ String (readonly)

Returns Associated note for the coaching session. Returned when present.

Returns:

  • (String) —

    Associated note for the coaching session. Returned when present.



37
38
39
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 37

def session_note
  @session_note
end

#session_status ⇒ Object (readonly)

‘completed`, `deleted`



40
41
42
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 40

def session_status
  @session_status
end

#updated_at_time ⇒ DateTime (readonly)

Returns Time coaching session was updated in UTC.

Returns:

  • (DateTime) —

    Time coaching session was updated in UTC.



42
43
44
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 42

def updated_at_time
  @updated_at_time
end

Class Method Details

.from_json(json_object:) ⇒ Samsara::Types::CoachingSessionsResponseResponseBody

Parameters:

  • json_object (String)

Returns:



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
131
132
133
134
135
136
137
138
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 90

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  assigned_coach_id = parsed_json["assignedCoachId"]
  behaviors = parsed_json["behaviors"]&.map do | item |
  item = item.to_json
  Samsara::Types::BehaviorResponseBody.from_json(json_object: item)
end
  coaching_type = parsed_json["coachingType"]
  completed_at_time = unless parsed_json["completedAtTime"].nil?
  DateTime.parse(parsed_json["completedAtTime"])
else
  nil
end
  completed_coach_id = parsed_json["completedCoachId"]
  unless parsed_json["driver"].nil?
    driver = parsed_json["driver"].to_json
    driver = Samsara::Types::DriverWithExternalIdObjectResponseBody.from_json(json_object: driver)
  else
    driver = nil
  end
  due_at_time = unless parsed_json["dueAtTime"].nil?
  DateTime.parse(parsed_json["dueAtTime"])
else
  nil
end
  id = parsed_json["id"]
  session_note = parsed_json["sessionNote"]
  session_status = parsed_json["sessionStatus"]
  updated_at_time = unless parsed_json["updatedAtTime"].nil?
  DateTime.parse(parsed_json["updatedAtTime"])
else
  nil
end
  new(
    assigned_coach_id: assigned_coach_id,
    behaviors: behaviors,
    coaching_type: coaching_type,
    completed_at_time: completed_at_time,
    completed_coach_id: completed_coach_id,
    driver: driver,
    due_at_time: due_at_time,
    id: id,
    session_note: session_note,
    session_status: session_status,
    updated_at_time: updated_at_time,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 151

def self.validate_raw(obj:)
  obj.assigned_coach_id&.is_a?(String) != false || raise("Passed value for field obj.assigned_coach_id is not the expected type, validation failed.")
  obj.behaviors.is_a?(Array) != false || raise("Passed value for field obj.behaviors is not the expected type, validation failed.")
  obj.coaching_type.is_a?(Samsara::Types::CoachingSessionsResponseResponseBodyCoachingType) != false || raise("Passed value for field obj.coaching_type is not the expected type, validation failed.")
  obj.completed_at_time&.is_a?(DateTime) != false || raise("Passed value for field obj.completed_at_time is not the expected type, validation failed.")
  obj.completed_coach_id&.is_a?(String) != false || raise("Passed value for field obj.completed_coach_id is not the expected type, validation failed.")
  Samsara::Types::DriverWithExternalIdObjectResponseBody.validate_raw(obj: obj.driver)
  obj.due_at_time.is_a?(DateTime) != false || raise("Passed value for field obj.due_at_time is not the expected type, validation failed.")
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.session_note&.is_a?(String) != false || raise("Passed value for field obj.session_note is not the expected type, validation failed.")
  obj.session_status.is_a?(Samsara::Types::CoachingSessionsResponseResponseBodySessionStatus) != false || raise("Passed value for field obj.session_status is not the expected type, validation failed.")
  obj.updated_at_time.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at_time is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


142
143
144
 
# File 'lib/samsara_api/types/coaching_sessions_response_response_body.rb', line 142

def to_json
  @_field_set&.to_json
end