Class: Samsara::Types::DocumentResponseObjectResponseBody

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

Overview

A single document.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conditional_field_sections: OMIT, created_at_time:, document_type:, driver:, fields:, id:, name: OMIT, notes: OMIT, route: OMIT, route_stop: OMIT, state:, updated_at_time: OMIT, vehicle: OMIT, additional_properties: nil) ⇒ Samsara::Types::DocumentResponseObjectResponseBody

Parameters:

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

    Time the document was updated in RFC 3339 format.

  • vehicle (Samsara::Types::GoaVehicleTinyResponseResponseBody) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 78

def initialize(conditional_field_sections: OMIT, created_at_time:, document_type:, driver:, fields:, id:, name: OMIT, notes: OMIT, route: OMIT, route_stop: OMIT, state:, updated_at_time: OMIT, vehicle: OMIT, additional_properties: nil)
  @conditional_field_sections = conditional_field_sections if conditional_field_sections != OMIT
  @created_at_time = created_at_time
  @document_type = document_type
  @driver = driver
  @fields = fields
  @id = id
  @name = name if name != OMIT
  @notes = notes if notes != OMIT
  @route = route if route != OMIT
  @route_stop = route_stop if route_stop != OMIT
  @state = state
  @updated_at_time = updated_at_time if updated_at_time != OMIT
  @vehicle = vehicle if vehicle != OMIT
  @additional_properties = additional_properties
  @_field_set = { "conditionalFieldSections": conditional_field_sections, "createdAtTime": created_at_time, "documentType": document_type, "driver": driver, "fields": fields, "id": id, "name": name, "notes": notes, "route": route, "routeStop": route_stop, "state": state, "updatedAtTime": updated_at_time, "vehicle": vehicle }.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



51
52
53
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 51

def additional_properties
  @additional_properties
end

#conditional_field_sections ⇒ Array<Samsara::Types::ConditionalFieldSectionObjectResponseBody> (readonly)

Returns List of the document conditional field sections.

Returns:



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

def conditional_field_sections
  @conditional_field_sections
end

#created_at_time ⇒ DateTime (readonly)

Returns Time the document was created in RFC 3339 format.

Returns:

  • (DateTime) —

    Time the document was created in RFC 3339 format.



22
23
24
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 22

def created_at_time
  @created_at_time
end

#document_type ⇒ Samsara::Types::GoaDocumentTypeTinyResponseResponseBody (readonly)

Returns:



24
25
26
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 24

def document_type
  @document_type
end

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

Returns:



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

def driver
  @driver
end

#fields ⇒ Array<Samsara::Types::FieldObjectResponseBody> (readonly)

Returns The fields associated with this document.

Returns:



28
29
30
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 28

def fields
  @fields
end

#id ⇒ String (readonly)

Returns Universally unique identifier for the document.

Returns:

  • (String) —

    Universally unique identifier for the document.



30
31
32
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 30

def id
  @id
end

#name ⇒ String (readonly)

Returns Name of the document.

Returns:

  • (String) —

    Name of the document.



32
33
34
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 32

def name
  @name
end

#notes ⇒ String (readonly)

Returns Notes on the document.

Returns:

  • (String) —

    Notes on the document.



34
35
36
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 34

def notes
  @notes
end

#route ⇒ Samsara::Types::GoaRouteTinyResponseResponseBody (readonly)

Returns:



36
37
38
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 36

def route
  @route
end

#route_stop ⇒ Samsara::Types::GoaRouteStopTinyResponseResponseBody (readonly)

Returns:



38
39
40
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 38

def route_stop
  @route_stop
end

#state ⇒ Object (readonly)

‘required`, `archived`



45
46
47
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 45

def state
  @state
end

#updated_at_time ⇒ DateTime (readonly)

Returns Time the document was updated in RFC 3339 format.

Returns:

  • (DateTime) —

    Time the document was updated in RFC 3339 format.



47
48
49
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 47

def updated_at_time
  @updated_at_time
end

#vehicle ⇒ Samsara::Types::GoaVehicleTinyResponseResponseBody (readonly)

Returns:



49
50
51
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 49

def vehicle
  @vehicle
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 101

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  conditional_field_sections = parsed_json["conditionalFieldSections"]&.map do | item |
  item = item.to_json
  Samsara::Types::ConditionalFieldSectionObjectResponseBody.from_json(json_object: item)
end
  created_at_time = unless parsed_json["createdAtTime"].nil?
  DateTime.parse(parsed_json["createdAtTime"])
else
  nil
end
  unless parsed_json["documentType"].nil?
    document_type = parsed_json["documentType"].to_json
    document_type = Samsara::Types::GoaDocumentTypeTinyResponseResponseBody.from_json(json_object: document_type)
  else
    document_type = nil
  end
  unless parsed_json["driver"].nil?
    driver = parsed_json["driver"].to_json
    driver = Samsara::Types::GoaDriverTinyResponseResponseBody.from_json(json_object: driver)
  else
    driver = nil
  end
  fields = parsed_json["fields"]&.map do | item |
  item = item.to_json
  Samsara::Types::FieldObjectResponseBody.from_json(json_object: item)
end
  id = parsed_json["id"]
  name = parsed_json["name"]
  notes = parsed_json["notes"]
  unless parsed_json["route"].nil?
    route = parsed_json["route"].to_json
    route = Samsara::Types::GoaRouteTinyResponseResponseBody.from_json(json_object: route)
  else
    route = nil
  end
  unless parsed_json["routeStop"].nil?
    route_stop = parsed_json["routeStop"].to_json
    route_stop = Samsara::Types::GoaRouteStopTinyResponseResponseBody.from_json(json_object: route_stop)
  else
    route_stop = nil
  end
  state = parsed_json["state"]
  updated_at_time = unless parsed_json["updatedAtTime"].nil?
  DateTime.parse(parsed_json["updatedAtTime"])
else
  nil
end
  unless parsed_json["vehicle"].nil?
    vehicle = parsed_json["vehicle"].to_json
    vehicle = Samsara::Types::GoaVehicleTinyResponseResponseBody.from_json(json_object: vehicle)
  else
    vehicle = nil
  end
  new(
    conditional_field_sections: conditional_field_sections,
    created_at_time: created_at_time,
    document_type: document_type,
    driver: driver,
    fields: fields,
    id: id,
    name: name,
    notes: notes,
    route: route,
    route_stop: route_stop,
    state: state,
    updated_at_time: updated_at_time,
    vehicle: vehicle,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 185

def self.validate_raw(obj:)
  obj.conditional_field_sections&.is_a?(Array) != false || raise("Passed value for field obj.conditional_field_sections is not the expected type, validation failed.")
  obj.created_at_time.is_a?(DateTime) != false || raise("Passed value for field obj.created_at_time is not the expected type, validation failed.")
  Samsara::Types::GoaDocumentTypeTinyResponseResponseBody.validate_raw(obj: obj.document_type)
  Samsara::Types::GoaDriverTinyResponseResponseBody.validate_raw(obj: obj.driver)
  obj.fields.is_a?(Array) != false || raise("Passed value for field obj.fields 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.notes&.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
  obj.route.nil? || Samsara::Types::GoaRouteTinyResponseResponseBody.validate_raw(obj: obj.route)
  obj.route_stop.nil? || Samsara::Types::GoaRouteStopTinyResponseResponseBody.validate_raw(obj: obj.route_stop)
  obj.state.is_a?(Samsara::Types::DocumentResponseObjectResponseBodyState) != false || raise("Passed value for field obj.state 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.")
  obj.vehicle.nil? || Samsara::Types::GoaVehicleTinyResponseResponseBody.validate_raw(obj: obj.vehicle)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


176
177
178
 
# File 'lib/samsara_api/types/document_response_object_response_body.rb', line 176

def to_json
  @_field_set&.to_json
end